Skip to content

Commit eb48a25

Browse files
authored
Add userId link to module overview page (prebid#5708)
1 parent 02f7561 commit eb48a25

4 files changed

Lines changed: 38 additions & 0 deletions

File tree

_data/sidebar.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -490,6 +490,14 @@
490490
sectionTitle:
491491
subgroup: 5
492492

493+
- sbSecId: 1
494+
title: User ID Modules
495+
link: /dev-docs/modules/index.html#user-id-modules
496+
isHeader: 0
497+
isSectionHeader: 0
498+
sectionTitle:
499+
subgroup: 5
500+
493501
- sbSecId: 1
494502
title: External Interfaces
495503
link:

dev-docs/modules/index.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,32 @@ These modules may require accounts with a service provider.
8989
</tbody>
9090
</table>
9191

92+
## User ID Modules
93+
94+
UserID modules conform to a consistent set of publisher controls. The publisher can choose to run multiple user id modules, define an overall amount of time they're willing to wait for
95+
results. See [the userSync setConfig](/dev-docs/publisher-api-reference/setConfig.html#setConfig-ConfigureUserSyncing-UserSyncProperties) reference and the [User ID Module](/dev-docs/modules/userId.md) for more details.
96+
97+
{% assign userid_module_pages = site.pages | where: "layout", "userid" %}
98+
99+
<table class="table table-bordered table-striped">
100+
<thead>
101+
<tr>
102+
<th>Module</th>
103+
<th>Description</th>
104+
<th>EID Source</th>
105+
</tr>
106+
</thead>
107+
<tbody>
108+
{% for page in userid_module_pages %}
109+
<tr>
110+
<td><a href="{{page.url}}"><strong>{{page.title}}</strong></a></td>
111+
<td>{{page.description}}</td>
112+
<td>{{page.eidsource}}</td>
113+
</tr>
114+
{% endfor %}
115+
</tbody>
116+
</table>
117+
92118
## Further Reading
93119

94120
- [Source code of all modules](https://github.com/prebid/Prebid.js/tree/master/modules)

dev-docs/modules/userId.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ Publishers using Google AdManager may want to sync one of the identifiers as the
7171
The PPID in GAM (which is unrelated to the PPID UserId Submodule) has strict rules; refer to [Google AdManager documentation](https://support.google.com/admanager/answer/2880055?hl=en) for them. Please note, Prebid uses a [GPT command](https://developers.google.com/publisher-tag/reference#googletag.PubAdsService) to sync identifiers for publisher convenience. It doesn't currently work for instream video requests, as Prebid typically interacts with the player, which in turn may interact with IMA. IMA does has a [similar method](https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/js/google.ima.ImaSdkSettings#setPpid) as GPT, but IMA does not gather this ID from GPT.
7272

7373
{: .table .table-bordered .table-striped }
74+
7475
| Param under userSync | Scope | Type | Description | Example |
7576
| --- | --- | --- | --- | --- |
7677
| ppid | Optional | String | Must be a source from the [pbjs.getUserIdsAsEids()](#getUserIdsAsEids) array | `"pubcid.org"` |
@@ -83,6 +84,7 @@ The table below has the options that are common across ID systems. See the secti
8384
{% assign count = 0 %}
8485

8586
{: .table .table-bordered .table-striped }
87+
8688
| Param under userSync.userIds[] | Scope | Type | Description | Example |
8789
| --- | --- | --- | --- | --- |
8890
| name | Required | String | May be any of the following values: {% for page in userid_pages -%}`"{{ page.useridmodule -}}"`{% if forloop.last == false -%}, {% endif -%}{% endfor -%} | `"unifiedId"` |
@@ -364,6 +366,7 @@ Please find more details [Share encrypted signals with bidders (Beta)](https://s
364366
Alternatively, GAM can now pull IDs from Prebid for UserId submodules that [register with GAM](https://services.google.com/fb/forms/encryptedsignalsforpublishers-signalcollectorform/) For those registered submodules, publishers can [select Prebid UserID module (Beta) under "Signal collection deployment."](https://support.google.com/admanager/answer/10488752?hl=en). Publishers selecting this option should not also select those identifiers in the `encryptedSignalSources.sources.source` array.
365367

366368
{: .table .table-bordered .table-striped }
369+
367370
| Param under userSync | Scope | Type | Description | Example |
368371
| --- | --- | --- | --- | --- |
369372
| encryptedSignalSources | Optional | Object | Publisher can specify the ESP config by adding encryptedSignal Object under userSync Object | |

dev-docs/modules/userid-submodules/utiq.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Utiq is also the brand name of the service, which is provided by Utiq SA/NV.
1212
## Utiq ID configuration
1313

1414
{: .table .table-bordered .table-striped }
15+
1516
| Param under userSync.userIds[] | Scope | Type | Description | Example |
1617
| --- | --- | --- | --- | --- |
1718
| name | Required | String | The name of the module | `"utiqId"` |

0 commit comments

Comments
 (0)