Skip to content

Commit

Permalink
Add userId link to module overview page (prebid#5708)
Browse files Browse the repository at this point in the history
  • Loading branch information
muuki88 authored Nov 28, 2024
1 parent 02f7561 commit eb48a25
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 0 deletions.
8 changes: 8 additions & 0 deletions _data/sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -490,6 +490,14 @@
sectionTitle:
subgroup: 5

- sbSecId: 1
title: User ID Modules
link: /dev-docs/modules/index.html#user-id-modules
isHeader: 0
isSectionHeader: 0
sectionTitle:
subgroup: 5

- sbSecId: 1
title: External Interfaces
link:
Expand Down
26 changes: 26 additions & 0 deletions dev-docs/modules/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,32 @@ These modules may require accounts with a service provider.
</tbody>
</table>

## User ID Modules

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
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.

{% assign userid_module_pages = site.pages | where: "layout", "userid" %}

<table class="table table-bordered table-striped">
<thead>
<tr>
<th>Module</th>
<th>Description</th>
<th>EID Source</th>
</tr>
</thead>
<tbody>
{% for page in userid_module_pages %}
<tr>
<td><a href="{{page.url}}"><strong>{{page.title}}</strong></a></td>
<td>{{page.description}}</td>
<td>{{page.eidsource}}</td>
</tr>
{% endfor %}
</tbody>
</table>

## Further Reading

- [Source code of all modules](https://github.com/prebid/Prebid.js/tree/master/modules)
Expand Down
3 changes: 3 additions & 0 deletions dev-docs/modules/userId.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ Publishers using Google AdManager may want to sync one of the identifiers as the
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.

{: .table .table-bordered .table-striped }

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

{: .table .table-bordered .table-striped }

| Param under userSync.userIds[] | Scope | Type | Description | Example |
| --- | --- | --- | --- | --- |
| name | Required | String | May be any of the following values: {% for page in userid_pages -%}`"{{ page.useridmodule -}}"`{% if forloop.last == false -%}, {% endif -%}{% endfor -%} | `"unifiedId"` |
Expand Down Expand Up @@ -364,6 +366,7 @@ Please find more details [Share encrypted signals with bidders (Beta)](https://s
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.

{: .table .table-bordered .table-striped }

| Param under userSync | Scope | Type | Description | Example |
| --- | --- | --- | --- | --- |
| encryptedSignalSources | Optional | Object | Publisher can specify the ESP config by adding encryptedSignal Object under userSync Object | |
Expand Down
1 change: 1 addition & 0 deletions dev-docs/modules/userid-submodules/utiq.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Utiq is also the brand name of the service, which is provided by Utiq SA/NV.
## Utiq ID configuration

{: .table .table-bordered .table-striped }

| Param under userSync.userIds[] | Scope | Type | Description | Example |
| --- | --- | --- | --- | --- |
| name | Required | String | The name of the module | `"utiqId"` |
Expand Down

0 comments on commit eb48a25

Please sign in to comment.