From 44c1b8e999080f74e6077df22eb0520be82e2ade Mon Sep 17 00:00:00 2001 From: Muki Seiler Date: Thu, 28 Nov 2024 17:17:20 +0100 Subject: [PATCH] Implement initial proposal for new userId module meta fields - #5060 (#5673) * Implement initial proposal for new userId module meta fields * Fix linting errors in sharedid md * Migrate all meta data to userId files * Fix linting issues in hadron.md * fix table in mediawallah * Fix dmd table * Fix novatiq id table * fix publisherlink table * Fix liveramp table * Fix trustpid table * Fix yahoo table * Fix yahoo table * Remove empty line * Remove empty line #2 --- _layouts/userid.html | 18 +++++ dev-docs/modules/idLibrary.md | 4 +- dev-docs/modules/userId.md | 64 ++++-------------- .../modules/userid-submodules/33across.md | 4 ++ dev-docs/modules/userid-submodules/admixer.md | 7 +- dev-docs/modules/userid-submodules/adquery.md | 3 + dev-docs/modules/userid-submodules/adriver.md | 4 ++ .../modules/userid-submodules/adtelligent.md | 6 +- dev-docs/modules/userid-submodules/amxrtb.md | 3 + .../modules/userid-submodules/audienceone.md | 7 +- .../modules/userid-submodules/britepool.md | 7 +- .../modules/userid-submodules/ceeIdSystem.md | 4 ++ dev-docs/modules/userid-submodules/cpexid.md | 7 +- dev-docs/modules/userid-submodules/criteo.md | 6 +- .../modules/userid-submodules/deepintent.md | 4 ++ dev-docs/modules/userid-submodules/dmd.md | 11 ++- dev-docs/modules/userid-submodules/euid.md | 7 +- dev-docs/modules/userid-submodules/fabrick.md | 7 +- dev-docs/modules/userid-submodules/floc.md | 3 + .../modules/userid-submodules/freepass.md | 4 ++ dev-docs/modules/userid-submodules/ftrack.md | 4 ++ dev-docs/modules/userid-submodules/gravito.md | 7 +- .../modules/userid-submodules/growthcode.md | 7 +- dev-docs/modules/userid-submodules/hadron.md | 8 ++- dev-docs/modules/userid-submodules/id5.md | 7 +- dev-docs/modules/userid-submodules/idplus.md | 6 +- dev-docs/modules/userid-submodules/idx.md | 4 +- dev-docs/modules/userid-submodules/imuid.md | 4 +- .../modules/userid-submodules/intentiq.md | 6 +- dev-docs/modules/userid-submodules/kinesso.md | 8 ++- .../modules/userid-submodules/liveintent.md | 4 ++ dev-docs/modules/userid-submodules/lotame.md | 7 +- .../modules/userid-submodules/mediawallah.md | 11 +-- dev-docs/modules/userid-submodules/merkle.md | 3 + dev-docs/modules/userid-submodules/netid.md | 3 + dev-docs/modules/userid-submodules/novatiq.md | 14 ++-- dev-docs/modules/userid-submodules/onekey.md | 4 +- dev-docs/modules/userid-submodules/pair.md | 4 +- .../modules/userid-submodules/parrable.md | 7 +- .../userid-submodules/publisherlink.md | 6 +- .../modules/userid-submodules/pubprovided.md | 67 ++++++++++--------- .../modules/userid-submodules/quantcast.md | 7 +- dev-docs/modules/userid-submodules/ramp.md | 11 ++- .../modules/userid-submodules/sharedid.md | 15 +++-- dev-docs/modules/userid-submodules/tapad.md | 7 +- dev-docs/modules/userid-submodules/teads.md | 4 ++ .../modules/userid-submodules/tncIdSystem.md | 3 +- .../modules/userid-submodules/trustpid.md | 6 +- dev-docs/modules/userid-submodules/unified.md | 7 +- .../modules/userid-submodules/unified2.md | 4 +- dev-docs/modules/userid-submodules/utiq.md | 3 + dev-docs/modules/userid-submodules/utiqMtp.md | 4 ++ dev-docs/modules/userid-submodules/yahoo.md | 19 +++--- dev-docs/modules/userid-submodules/yandex.md | 6 +- 54 files changed, 326 insertions(+), 141 deletions(-) diff --git a/_layouts/userid.html b/_layouts/userid.html index aff73773ec..deb991406f 100644 --- a/_layouts/userid.html +++ b/_layouts/userid.html @@ -30,6 +30,24 @@

Back to User ID Module

{{ page.title }}

+ + + + + + + + + + + + + + + + + +
Module{{ page.useridmodule }}
EID Source{{ page.eidsource }}
bidRequest.userId{{ page.bidRequestUserId }}
Example{{ page.example }}
{{content}} diff --git a/dev-docs/modules/idLibrary.md b/dev-docs/modules/idLibrary.md index f30dfa34ef..730cfde505 100644 --- a/dev-docs/modules/idLibrary.md +++ b/dev-docs/modules/idLibrary.md @@ -26,8 +26,9 @@ The module attempts to extract a persistant identifier in the following ways: To get started, add the module to your Prebid.js wrapper. From the command line: -{: .alert.alert-info :} +```bash gulp build --modules=idImportLibrary +``` ## Application Flow @@ -45,6 +46,7 @@ In the idLibrary module, the persistant id is fetched from the page and synced w ## Configuration {: .table .table-bordered .table-striped } + | Param | Required | Description | | --- | --- | --- | | url | yes | The url endpoint is used to post the MD5 hasheds| diff --git a/dev-docs/modules/userId.md b/dev-docs/modules/userId.md index 09f311c199..33d2e1b68d 100644 --- a/dev-docs/modules/userId.md +++ b/dev-docs/modules/userId.md @@ -204,9 +204,22 @@ The corresponding user id object and the eids array will look like this: {% assign userid_pages = site.pages | where: "layout", "userid" | sort_natural: "title" %} + + + + + + + {% for page in userid_pages %} -
  • {{page.title}}
    • + + + + + + {% endfor %} +
    ID System NamePrebid.js Attr: bidRequest.userIdEID SourceExample
    {{page.title}}{{page.bidRequestUserId}}{{page.eidsource}}{{page.example}}
    ## Bidder Adapter Implementation @@ -218,53 +231,6 @@ To add a custom data type for the response of `pbjs.getUserIdsAsEids()`, see oth Bidders that want to support the User ID module in Prebid.js need to update their bidder adapter to read the indicated bidRequest attributes and pass them to their endpoint. -{: .table .table-bordered .table-striped } -| ID System Name | ID System Host | Prebid.js Attr: bidRequest.userId. | EID Source | Example Value | -| --- | --- | --- | --- | --- | --- | -| 33Across ID | 33Across | 33acrossId | 33across.com | "1111" | -| Admixer ID | Admixer | admixerId | admixer.net | "1111" | -| adQuery QiD | adQuery | qid | adquery.io | "p9v2dpnuckkzhuc..." | -| Adriver ID | Adriver | adriverId | adriver.ru | "1111" | -| Adtelligent ID | Adtelligent | adtelligentId | adtelligent.com | `"1111"` | -| AMX ID | AMX | amxId | amxdt.net | "3ca11058-..." | -| BritePool ID | BritePool | britepoolid | britepool.com | "1111" | -| AudienceOne ID | DAC | dacId | dac.co.jp | {"id": "1111"} | -| DeepIntent ID | Deep Intent | deepintentId | deepintent.com | "1111" | -| DMD ID | DMD | dmdId | hcn.health | "1111" | -| ceeId | ceeId | ceeId | ceeid.eu | "111111" | -| Czech Ad ID | czechAdId | czechAdId | czechadid.cz | "1111" | -| CriteoID | Criteo | criteoId | criteo.com | "1111" | -| Fabrick ID | Neustar | fabrickId | neustar.biz | "1111" | -| FLoC ID | n/a | flocId | | | -| GrowthCode ID | GrowthCode | growthCodeId | growthcode.io | "1111" | -| Hadron ID | Audigent | hadronId | audigent.com | {"hadronId":"user-hadron-id", "auSeg":["segment1", "segment2"]} | -| ID+ | Zeotap | IDP | zeotap.com | "1111" | -| ID5 ID | ID5 | id5id | id5-sync.com | {uid: "1111", ext: { linkType: 2, abTestingControlGroup: false } } | -| IdentityLink | LiveRamp | idl_env | liveramp.com | "1111" | -| Intent IQ ID | Intent IQ | intentiqid | intentiq.com | "1111" | -| Kinesso ID | Kinesso | kpuid | kpuid.com | "1111" | -| LiveIntent ID | Live Intent | lipb.lipbid | liveintent.com | "1111" | -| Lotame Panorama ID | Lotame | lotamePanoramaId | crwdcntrl.net | "e4b9..." | -| MediaWallah OpenLink ID | MediaWallah | mwOpenLinkId | mediawallahscript.com | "1111" | -| merkleID | Merkle | merkleId | merkleinc.com | "1111" | -| naveggId | Navegg | naveggId | navegg.com | "1111" | -| netID | netID | netId | netid.de | "fH5A..." | -| Novatiq ID | Novatiq | novatiqId | novatiq.com | "1111" | -| Parrable ID | Parrable | parrableId | parrable.com | {"eid":"01.15946..."} | -| Publisher Link ID | n/a | publinkId | epsilon.com | | -| PubProvided ID | n/a | pubProvidedId | publisher domain | "1111" | -| Quantcast ID | n/a | quantcastId | quantcast.com | "1111" | -| Rewarded Interest ID | Rewarded Interest | rewardedInterestId | rewardedinterest.com | "1111" | -| Tapad ID | Tapad | tapadId | tapad.com | "1111" | -| Teads ID | Teads | teadsId | teads.com | "1111" | -| SharedID (PBJS 5.x) | n/a | pubcid | pubcid.org | "1111" | -| SharedID (PBJS 4.x)| Prebid | sharedid | sharedid.org | {"id":"01EAJWWN...", "third":"01EAJ..."} | -| Unified ID | Trade Desk | tdid | adserver.org | "1111" | -| ConnectID | Yahoo | connectId | yahoo.com | {"connectId": "72d04af6..."} | -| FreePass ID | FreePass | freepassId | | "1111" | -| UtiqMtp ID | Utiq | utiqMtpId | utiq-mtp.com | "1111" | -| Yandex ID | Yandex | yandexId | yandex.com | "11111111111111111" | - For example, the adapter code might do something like: ```javascript @@ -355,8 +321,6 @@ If you're an ID provider that wants to get on this page: * Add a new row to `/dev-docs/modules/userId.md#prebidjs-adapters` * Submit a documentation Pull Request - - ## ESP Configurations Google now supports Encrypted Signals for Publishers(ESP), a program that allows publishers can explicitly share encrypted signals on bid requests with third-party bidders. User ID modules now support code which will register the signal sources and encrypted signals are created and are sent to GAM request in a3p parameter. 'encryptedSignal' configuration under userSync Module will help to configure signal sources. diff --git a/dev-docs/modules/userid-submodules/33across.md b/dev-docs/modules/userid-submodules/33across.md index d63c246e10..0ec7bd2237 100644 --- a/dev-docs/modules/userid-submodules/33across.md +++ b/dev-docs/modules/userid-submodules/33across.md @@ -3,6 +3,9 @@ layout: userid title: 33Across ID description: 33Across ID User ID sub-module useridmodule: 33acrossIdSystem +bidRequestUserId: 33acrossId +eidsource: 33across.com +example: '"1111"' --- @@ -21,6 +24,7 @@ gulp build --modules=33acrossIdSystem,userId The following configuration parameters are available: {: .table .table-bordered .table-striped } + | Param under userSync.userIds[] | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | | name | Required | String | The name of this sub-module | `"33acrossId"` | diff --git a/dev-docs/modules/userid-submodules/admixer.md b/dev-docs/modules/userid-submodules/admixer.md index 1ceb62cafb..4a56a0f0d3 100644 --- a/dev-docs/modules/userid-submodules/admixer.md +++ b/dev-docs/modules/userid-submodules/admixer.md @@ -3,6 +3,9 @@ layout: userid title: AdmixerID description: AdmixerID User ID sub-module useridmodule: admixerIdSystem +bidRequestUserId: admixerId +eidsource: admixer.net +example: '"1111"' --- @@ -12,12 +15,14 @@ The Admixer privacy policy is at Add Admixer ID module to your Prebid.js package with: -{: .alert.alert-info :} +```bash gulp build --modules=admixerIdSystem +``` ## AdmixerID Configuration {: .table .table-bordered .table-striped } + | Param under userSync.userIds[] | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | | name | Required | String | `"admixerId"` | `"admixerId"` | diff --git a/dev-docs/modules/userid-submodules/adquery.md b/dev-docs/modules/userid-submodules/adquery.md index df509d54ea..7b24a99d9b 100644 --- a/dev-docs/modules/userid-submodules/adquery.md +++ b/dev-docs/modules/userid-submodules/adquery.md @@ -3,6 +3,9 @@ layout: userid title: adQuery QiD description: adQuery QiD User ID sub-module useridmodule: adqueryIdSystem +bidRequestUserId: qid +eidsource: adquery.io +example: '"p9v2dpnuckkzhuc"' --- diff --git a/dev-docs/modules/userid-submodules/adriver.md b/dev-docs/modules/userid-submodules/adriver.md index e1f6b48b7f..a4d57747aa 100644 --- a/dev-docs/modules/userid-submodules/adriver.md +++ b/dev-docs/modules/userid-submodules/adriver.md @@ -3,11 +3,15 @@ layout: userid title: Adriver ID description: Adriver ID User ID sub-module useridmodule: adriverId +bidRequestUserId: adriverId +eidsource: adriver.ru +example: '"1111"' --- ## Adriver ID Configuration {: .table .table-bordered .table-striped } + | Param under userSync.userIds[] | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | | name | Required | String | The name of this module: `"adriverId"` | `"adriverId"` | diff --git a/dev-docs/modules/userid-submodules/adtelligent.md b/dev-docs/modules/userid-submodules/adtelligent.md index ac210e75fd..f10adc76b6 100644 --- a/dev-docs/modules/userid-submodules/adtelligent.md +++ b/dev-docs/modules/userid-submodules/adtelligent.md @@ -3,6 +3,9 @@ layout: userid title: Adtelligent description: Adtelligent User ID sub-module useridmodule: adtelligentIdSystem +bidRequestUserId: adtelligentId +eidsource: adtelligent.com +example: '"1111"' --- @@ -10,8 +13,9 @@ The [Adtelligent](https://adtelligent.com) ID system is a unique per-session use Add it to your Prebid.js package with: -{: .alert.alert-info :} +```bash gulp build --modules=userId,adtelligentIdSystem +``` ## Adtelligent Configuration diff --git a/dev-docs/modules/userid-submodules/amxrtb.md b/dev-docs/modules/userid-submodules/amxrtb.md index 8ab6d0eef4..b03199e172 100644 --- a/dev-docs/modules/userid-submodules/amxrtb.md +++ b/dev-docs/modules/userid-submodules/amxrtb.md @@ -3,6 +3,9 @@ layout: userid title: AMX ID description: AMX ID User ID sub-module useridmodule: amxIdSystem +bidRequestUserId: amxId +eidsource: amxdt.net +example: '"3ca11058-..."' --- diff --git a/dev-docs/modules/userid-submodules/audienceone.md b/dev-docs/modules/userid-submodules/audienceone.md index 74d8d5bfee..158640c893 100644 --- a/dev-docs/modules/userid-submodules/audienceone.md +++ b/dev-docs/modules/userid-submodules/audienceone.md @@ -3,6 +3,9 @@ layout: userid title: AudienceOne ID by DAC description: AudienceOne ID by DAC User ID sub-module useridmodule: dacIdSystem +bidRequestUserId: dacId +eidsource: dac.co.jp +example: {"id": "1111"} --- @@ -11,12 +14,14 @@ Please visit [solutions.dac.co.jp/audienceone](https://solutions.dac.co.jp/audie Add the AudienceOne ID to your Prebid.js Package with: -{: .alert.alert-info :} +```bash gulp build --modules=dacIdSystem +``` ## AudienceOne ID Configuration {: .table .table-bordered .table-striped } + | Param under userSync.userIds[] | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | | name | Required | String | The name of this module | `"dacId"` | diff --git a/dev-docs/modules/userid-submodules/britepool.md b/dev-docs/modules/userid-submodules/britepool.md index 9e24d92391..d96c00a0d5 100644 --- a/dev-docs/modules/userid-submodules/britepool.md +++ b/dev-docs/modules/userid-submodules/britepool.md @@ -4,6 +4,9 @@ title: BritePool description: BritePool User ID sub-module useridmodule: britepoolIdSystem enable_download: false +bidRequestUserId: britepoolid +eidsource: britepool.com +example: '"1111"' --- {: .alert.alert-warning :} @@ -14,8 +17,9 @@ integration partners (such as PubMatic), are able to maximize revenues without c Add it to your Prebid.js package with: -{: .alert.alert-info :} +```bash gulp build --modules=britepoolIdSystem +``` ## BritePool Registration @@ -24,6 +28,7 @@ Please reach out to [prebid@britepool.com](mailto:prebid@britepool.com) and requ ## BritePool Configuration {: .table .table-bordered .table-striped } + | Param under userSync.userIds[] | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | | name | Required | String | `"britepoolId"` | `"britepoolId"` | diff --git a/dev-docs/modules/userid-submodules/ceeIdSystem.md b/dev-docs/modules/userid-submodules/ceeIdSystem.md index 59194e1150..3ab6277289 100644 --- a/dev-docs/modules/userid-submodules/ceeIdSystem.md +++ b/dev-docs/modules/userid-submodules/ceeIdSystem.md @@ -3,6 +3,9 @@ layout: userid title: CEEIdSystem description: CEEID User ID sub-module useridmodule: ceeIdSystem +bidRequestUserId: ceeId +eidsource: ceeid.eu +example: '"1111"' --- ## Prebid Configuration @@ -16,6 +19,7 @@ gulp build --modules=ceeIdSystem ## CEEID Configuration {: .table .table-bordered .table-striped } + | Param under userSync.userIds[] | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | | name | Required | String | The name of CEEID user ID module. | `"ceeId"` | diff --git a/dev-docs/modules/userid-submodules/cpexid.md b/dev-docs/modules/userid-submodules/cpexid.md index ee9a48fa42..f1c543c6c0 100644 --- a/dev-docs/modules/userid-submodules/cpexid.md +++ b/dev-docs/modules/userid-submodules/cpexid.md @@ -3,16 +3,21 @@ layout: userid title: Czech Ad ID (czechAdId) description: Czech Ad ID (czechAdId) User ID sub-module useridmodule: czechAdIdSystem +bidRequestUserId: czechAdId +eidsource: czechadid.cz +example: '"1111"' --- Czech Ad ID is a joint project of publishers of the [CPEx alliance](https://www.cpex.cz/) and [Seznam.cz](https://www.seznam.cz). It is a deterministic user ID that offers cross-domain and cross-device identification. For more information see [czechadid.cz](https://www.czechadid.cz)). -{: .alert.alert-info :} +```bash gulp build --modules=czechAdIdSystem +``` ## czechAdId Configuration {: .table .table-bordered .table-striped } + | Param under userSync.userIds[] | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | | name | Required | String | The name of this module | `"czechAdId"` | diff --git a/dev-docs/modules/userid-submodules/criteo.md b/dev-docs/modules/userid-submodules/criteo.md index 8e48b94ce2..27d43641bd 100644 --- a/dev-docs/modules/userid-submodules/criteo.md +++ b/dev-docs/modules/userid-submodules/criteo.md @@ -3,6 +3,9 @@ layout: userid title: Criteo ID for Exchanges description: Criteo ID for Exchanges User ID sub-module useridmodule: criteoIdSystem +bidRequestUserId: criteoId +eidsource: criteo.com +example: '"1111"' --- @@ -13,8 +16,9 @@ The Criteo privacy policy is at [www.criteo.com/privacy/](https://www.criteo.com Add it to your Prebid.js package with: -{: .alert.alert-info :} +```bash gulp build --modules=criteoIdSystem +``` ## Criteo ID Configuration diff --git a/dev-docs/modules/userid-submodules/deepintent.md b/dev-docs/modules/userid-submodules/deepintent.md index 4640088296..171b2c0b4d 100644 --- a/dev-docs/modules/userid-submodules/deepintent.md +++ b/dev-docs/modules/userid-submodules/deepintent.md @@ -3,6 +3,9 @@ layout: userid title: Deepintent description: Deepintent User ID sub-module useridmodule: deepintentDpesIdSystem +bidRequestUserId: deepintentId +eidsource: deepintent.com +example: '"1111"' --- @@ -17,6 +20,7 @@ DPES ID is free to use and requires a simple registration with DeepIntent. Pleas ## Deepintent DPES ID Configuration {: .table .table-bordered .table-striped } + | Param under userSync.userIds[] | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | | name | Required | String | The name of this module: `"deepintentId"` | `"deepintentId"` | diff --git a/dev-docs/modules/userid-submodules/dmd.md b/dev-docs/modules/userid-submodules/dmd.md index 7e932dc0c0..95b86aea3f 100644 --- a/dev-docs/modules/userid-submodules/dmd.md +++ b/dev-docs/modules/userid-submodules/dmd.md @@ -3,6 +3,9 @@ layout: userid title: DMD ID by DMD Marketing Corp description: DMD ID by DMD Marketing Corp User ID sub-module useridmodule: dmdIdSystem +bidRequestUserId: dmdId +eidsource: hcn.health +example: '"1111"' --- @@ -12,8 +15,9 @@ For assistance setting up your module, please contact us at ` | `` | `` | `` | `` | @@ -23,8 +27,9 @@ Kinesso will then attach these users to deals ids that they will target in the O Add it to your Prebid.js package with: -{: .alert.alert-info :} +```bash gulp build --modules=kinessoIdSystem +``` ## Kinesso ID Registration @@ -33,6 +38,7 @@ You can set up Kinesso ID sub adapter by contacting Kinesso at +{: .table .table-bordered .table-striped } + | Param under userSync.userIds[] | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | | name | Required | String | The name of this module. | `'mwOpenLinkId'` | @@ -27,8 +32,6 @@ MediaWallah requires the creation of an accountId a partnerId in order to take a | params.accountId | Required | String | The MediaWallah assigned Account Id | `1000` | | params.partnerId | Required | String | The MediaWallah assign partner Id |`'1001'`| | params.uid | Optional | String | Your unique Id for the user or browser. Used for matching. | `'u-123xyz'` | -{: .table .table-bordered .table-striped } - ## MediaWallah OpenLinkID Examples diff --git a/dev-docs/modules/userid-submodules/merkle.md b/dev-docs/modules/userid-submodules/merkle.md index 71f583c6a9..9dd890e0f7 100644 --- a/dev-docs/modules/userid-submodules/merkle.md +++ b/dev-docs/modules/userid-submodules/merkle.md @@ -3,6 +3,9 @@ layout: userid title: Merkle ID description: Merkle IDUser ID sub-module useridmodule: merkleIdSystem +bidRequestUserId:merkleId +eidsource: merkleinc.com +example: '"1111"' --- diff --git a/dev-docs/modules/userid-submodules/netid.md b/dev-docs/modules/userid-submodules/netid.md index 67c2ff79a2..d02020a2bc 100644 --- a/dev-docs/modules/userid-submodules/netid.md +++ b/dev-docs/modules/userid-submodules/netid.md @@ -3,6 +3,9 @@ layout: userid title: netID description: netID User ID sub-module useridmodule: netIdSystem +bidRequestUserId: netId +eidsource: netid.de +example: '"fH5A..."' --- diff --git a/dev-docs/modules/userid-submodules/novatiq.md b/dev-docs/modules/userid-submodules/novatiq.md index cf86db5854..c409e68f16 100644 --- a/dev-docs/modules/userid-submodules/novatiq.md +++ b/dev-docs/modules/userid-submodules/novatiq.md @@ -3,6 +3,9 @@ layout: userid title: Novatiq Hyper ID description: Novatiq Hyper ID User ID sub-module useridmodule: novatiqIdSystem +bidRequestUserId: novatiqId +eidsource: novatiq.com +example: '"1111"' --- @@ -12,8 +15,9 @@ The [Novatiq](https://www.novatiq.com) proprietary dynamic Hyper ID is a unique, Enable by adding the Novatiq submodule to your Prebid.js package with: -{: .alert.alert-info :} +```bash gulp build --modules=novatiqIdSystem,userId +``` Module activation and configuration: @@ -39,7 +43,8 @@ pbjs.setConfig({ ## Parameters for the Novatiq Module -
    +{: .table .table-bordered .table-striped } + | Param | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | | name | Required | String | Module identification: `"novatiq"` | `"novatiq"` | @@ -53,8 +58,6 @@ pbjs.setConfig({ | params.urlParams.useStandardUuid | Optional | Boolean | Use a standard UUID format, or the Novatiq UUID format | `false` | | params.urlParams.useSspId | Optional | Boolean | Send the sspid (sourceid) along with the sync request
    Makes the params.sourceid optional if set | `false` | | params.urlParams.useSspHost | Optional | Boolean | Send the ssphost along with the sync request | `false` | -{: .table .table-bordered .table-striped } -
    ## Novatiq Hyper ID with Prebid SharedID Support @@ -62,8 +65,9 @@ You can make use of the Prebid.js SharedId module as follows. Enable by adding the Novatiq and SharedId submodule to your Prebid.js package with: -{: .alert.alert-info :} +```bash gulp build --modules=novatiqIdSystem,userId +``` Module activation and configuration: diff --git a/dev-docs/modules/userid-submodules/onekey.md b/dev-docs/modules/userid-submodules/onekey.md index 9b4d937868..f371228764 100644 --- a/dev-docs/modules/userid-submodules/onekey.md +++ b/dev-docs/modules/userid-submodules/onekey.md @@ -19,8 +19,9 @@ Background information: It can be added to you Prebid.js package with: -{: .alert.alert-info :} +```bash gulp build –modules=userId,oneKeyIdSystem +``` ⚠️ This module works with a RTD module. Both must be configured. See the [OneKey RTD Module](/dev-docs/modules/oneKeyRtdProvider.html). @@ -32,6 +33,7 @@ Go to [onekey.community](https://onekey.community/) for more details. ## OneKey Configuration {: .table .table-bordered .table-striped } + | Param under userSync.userIds[] | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | | name | Required | String | The name of this module | `"oneKeyData"` | diff --git a/dev-docs/modules/userid-submodules/pair.md b/dev-docs/modules/userid-submodules/pair.md index db98f896af..883c19d65b 100644 --- a/dev-docs/modules/userid-submodules/pair.md +++ b/dev-docs/modules/userid-submodules/pair.md @@ -11,12 +11,14 @@ reliance on third-party cookies. PAIR can help advertisers and publishers mainta Add it to your Prebid.js package with: -{: .alert.alert-info :} +```bash gulp build --modules=pairIdSystem +``` ## PAIR ID Configuration {: .table .table-bordered .table-striped } + | Param under userSync.userIds[] | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | | name | Required | String | The name of PAIR ID user ID module. | `"pairId"` | diff --git a/dev-docs/modules/userid-submodules/parrable.md b/dev-docs/modules/userid-submodules/parrable.md index d8aa3be3ea..99bdf612ec 100644 --- a/dev-docs/modules/userid-submodules/parrable.md +++ b/dev-docs/modules/userid-submodules/parrable.md @@ -4,6 +4,9 @@ title: Parrable ID description: Parrable ID User ID sub-module pbjs_version_notes: removed in 9.0 useridmodule: parrableIdSystem +bidRequestUserId: parrableId +eidsource: parrable.com +example: '{"eid":"01.15946..."}' --- @@ -11,8 +14,9 @@ The Parrable ID is a Full Device Identifier that can be used to identify a devic Add it to your Prebid.js package with: -{: .alert.alert-info :} +```bash gulp build --modules=parrableIdSystem +``` ## Parrable ID Registration @@ -25,6 +29,7 @@ The Parrable privacy policy as at [www.parrable.com/privacy-policy/](https://www In addition to the parameters documented above in the Basic Configuration section the following Parrable specific configuration is required: {: .table .table-bordered .table-striped } + | Param under userSync.userIds[] | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | | params | Required | Object | Details for the Parrable ID. | | diff --git a/dev-docs/modules/userid-submodules/publisherlink.md b/dev-docs/modules/userid-submodules/publisherlink.md index 2f6f44e965..6cbace8f08 100644 --- a/dev-docs/modules/userid-submodules/publisherlink.md +++ b/dev-docs/modules/userid-submodules/publisherlink.md @@ -3,6 +3,9 @@ layout: userid title: Publisher Link description: Publisher Link User ID sub-module useridmodule: publinkIdSystem +bidRequestUserId: publinkId +eidsource: epsilon.com +example: --- @@ -24,13 +27,14 @@ The Publisher Link opt-out is included [here](https://www.epsilon.com/privacy/dm In addition to the parameters documented above in the Basic Configuration section the following Publisher Link specific configuration is available: {: .table .table-bordered .table-striped } + | Param under userSync.userIds[] | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | | name | Required | String | The name of this module. | `'publinkId'` | | params | Required | Object | Customized parameters. | | | params.e | Required | String | Hashed email address of the user. Supports MD5 and SHA256. | `'7D320454942620664D96EF78ED4E3A2A'` | | params.site_id | Required | String | Site ID provided by Epsilon. | `'123456'` | -| params.api_key | Required | String | API key provided by Epsilon. | `'00000000-0000-0000-0000-00000000000'` +| params.api_key | Required | String | API key provided by Epsilon. | `'00000000-0000-0000-0000-00000000000'` | ## Publisher Link Examples diff --git a/dev-docs/modules/userid-submodules/pubprovided.md b/dev-docs/modules/userid-submodules/pubprovided.md index ba15abfe25..e533bd8c15 100644 --- a/dev-docs/modules/userid-submodules/pubprovided.md +++ b/dev-docs/modules/userid-submodules/pubprovided.md @@ -3,6 +3,9 @@ layout: userid title: PubProvided ID description: PubProvided ID User ID sub-module useridmodule: pubProvidedIdSystem +bidRequestUserId: pubProvidedId +eidsource: publisher domain +example: '"1111"' --- @@ -57,37 +60,37 @@ The PubProvided ID module allows publishers to set and pass a first-party user i }); ``` -If multiple parties are writing to this object in an undetermined order, a setup that feels quite awkward, they should each do something of this nature: - -```javascript -pbjs.mergeConfig({ - userSync: { - userIds: (() => { - const uidCfgs = pbjs.getConfig('userSync.userIds') || []; - let ppid = uidCfgs.find(cfg => cfg.name === 'pubProvidedId'); - if (!ppid) { - ppid = {name: 'pubProvidedId', params: {eids: []}}; - uidCfgs.push(ppid); - } - ppid.params.eids.push({ - source: "example.com", - uids: [{ - id: "example", - atype: 1, - ext: { - stype: "ppuid" - } - - }] - }) - return uidCfgs; - })() - } -}) -pbjs.refreshUserIds({submoduleNames: ['pubProvidedId']}) -``` + If multiple parties are writing to this object in an undetermined order, a setup that feels quite awkward, they should each do something of this nature: + + ```javascript + pbjs.mergeConfig({ + userSync: { + userIds: (() => { + const uidCfgs = pbjs.getConfig('userSync.userIds') || []; + let ppid = uidCfgs.find(cfg => cfg.name === 'pubProvidedId'); + if (!ppid) { + ppid = {name: 'pubProvidedId', params: {eids: []}}; + uidCfgs.push(ppid); + } + ppid.params.eids.push({ + source: "example.com", + uids: [{ + id: "example", + atype: 1, + ext: { + stype: "ppuid" + } -In each case, bid adapters will receive the eid values after consent is validated. The above examples, if calling `setConfig` instead of `mergeConfig`, will overwrite existing known IDs. If there is any possibility other id submodules have already been initiated or multiple scripts on the page are setting these fields, be sure to prefer `mergeConfig`. + }] + }) + return uidCfgs; + })() + } + }) + pbjs.refreshUserIds({submoduleNames: ['pubProvidedId']}) + ``` + + In each case, bid adapters will receive the eid values after consent is validated. The above examples, if calling `setConfig` instead of `mergeConfig`, will overwrite existing known IDs. If there is any possibility other id submodules have already been initiated or multiple scripts on the page are setting these fields, be sure to prefer `mergeConfig`. 2. This design allows for the setting of any number of uuids in the eids object. Publishers may work with multiple ID providers and nest their own ID within the same eids object. The opportunity to link a 1st party uuid and a 3rd party generated UUID presents publishers with a unique ability to address their users in a way demand sources will understand. @@ -105,12 +108,14 @@ This module is distinct from the Google Ad Manager PPID; which we enable setting Add it to your Prebid.js package with: -{: .alert.alert-info :} +```bash gulp build --modules=pubProvidedIdSystem +``` ## PubProvided Configuration {: .table .table-bordered .table-striped } + | Params under usersync.userIds[]| Scope | Type | Description | Example | | --- | --- | --- | --- | --- | | name | Required | String | ID value for the ID module | `"PubProvided"` | diff --git a/dev-docs/modules/userid-submodules/quantcast.md b/dev-docs/modules/userid-submodules/quantcast.md index 14ded4e370..0b4b145dff 100644 --- a/dev-docs/modules/userid-submodules/quantcast.md +++ b/dev-docs/modules/userid-submodules/quantcast.md @@ -3,14 +3,18 @@ layout: userid title: Quantcast ID description: Quantcast ID User ID sub-module useridmodule: quantcastIdSystem +bidRequestUserId: quantcastId +eidsource: quantcast.com +example: '"1111"' --- The Prebid Quantcast ID module stores a Quantcast ID in a first party cookie. The ID is then made available in the bid request. The ID from the cookie added in the bidstream allows Quantcast to more accurately bid on publisher inventories without third party cookies, which can result in better monetization across publisher sites from Quantcast. And, it’s free to use! For easier integration, you can work with one of our SSP partners, like PubMatic, who can facilitate the legal process as well as the software integration for you. Add it to your Prebid.js package with: -{: .alert.alert-info :} +```bash gulp build --modules=userId,quantcastIdSystem +``` Quantcast’s privacy policies for the services rendered can be found at @@ -26,6 +30,7 @@ The Quantcast ID module will only perform any action and return an ID in situati ## Quantcast ID Configuration {: .table .table-bordered .table-striped } + | Param under userSync.userIds[] | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | | name | Required | String | `"quantcastId"` | `"quantcastId"` | diff --git a/dev-docs/modules/userid-submodules/ramp.md b/dev-docs/modules/userid-submodules/ramp.md index bde1b08d33..84f8f7e6d6 100644 --- a/dev-docs/modules/userid-submodules/ramp.md +++ b/dev-docs/modules/userid-submodules/ramp.md @@ -3,6 +3,9 @@ layout: userid title: LiveRamp RampID description: LiveRamp RampID User ID sub-module useridmodule: identityLinkIdSystem +bidRequestUserId: idl_env +eidsource: liveramp.com +example: '"1111"' --- @@ -10,8 +13,9 @@ RampID, formerly known as IdentityLink, provided by [LiveRamp](https://liveramp. Add it to your Prebid.js package with: -{: .alert.alert-info :} +```bash gulp build --modules=identityLinkIdSystem +``` ## RampID Registration @@ -22,17 +26,18 @@ The RampID privacy policy is at [liveramp.com/privacy/service-privacy-policy/](h ## RampID Configuration {: .table .table-bordered .table-striped } + | Param under userSync.userIds[] | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | | name | Required | String | The name of LiveRamp's user ID module. | `"identityLink"` | | params | Required | Object | Container of all module params. | | | params.pid | Required | String | This is the Placement ID, a unique identifier that is used to identify each publisher, obtained from registering with LiveRamp. | `"999"` | | params.notUse3P | Not required | Boolean | Property for choosing if a cookieable RampID envelope (RTIS) should be set and stored until the user authenticates which then will be replaced by an authenticated RampID envelope (ATS) (either `true` or `false`). | `false` | -| storage | Required | Object | This object defines where and for how long the results of the call to get a RampID envelope will be stored. | +| storage | Required | Object | This object defines where and for how long the results of the call to get a RampID envelope will be stored. | | | storage.type | Required | String | This parameter defines where the resolved RampID envelope will be stored (either `"cookie"` or `"html5"` localStorage). | `"cookie"` | | storage.name | Required | String | The name of the cookie or html5 localstorage where the resolved RampID envelope will be stored. LiveRamp requires `"idl_env"`. | `"idl_env"` | | storage.expires | Required | Integer | How long (in days) the RampID envelope information will be stored. To be GDPR and CCPA compliant, we strongly advise to set a 15-day TTL ("Time to Live" / expiration time). If you are not planning to obtain RampID envelopes for EU/EEA or U.S. users, we advise you to change the expiration time to 30 days. | `15` | -| storage.refreshInSeconds | Required | Integer | The amount of time (in seconds) the RampID envelope should be cached in storage before calling LiveRamp again to retrieve a potentially updated value for the RampID envelope. | `1800` +| storage.refreshInSeconds | Required | Integer | The amount of time (in seconds) the RampID envelope should be cached in storage before calling LiveRamp again to retrieve a potentially updated value for the RampID envelope. | `1800` | {: .alert.alert-info :} **NOTE:** The RampID envelope that is delivered to Prebid will be encrypted by LiveRamp with a rotating key to avoid unauthorized usage and to enforce privacy requirements. Therefore, we strongly recommend setting `storage.refreshInSeconds` to 30 minutes (1800 seconds) to ensure all demand partners receive an ID that has been encrypted with the latest key, has up-to-date privacy signals, and allows them to transact against it. diff --git a/dev-docs/modules/userid-submodules/sharedid.md b/dev-docs/modules/userid-submodules/sharedid.md index 4c2c224b6a..f68470e6ca 100644 --- a/dev-docs/modules/userid-submodules/sharedid.md +++ b/dev-docs/modules/userid-submodules/sharedid.md @@ -3,6 +3,9 @@ layout: userid title: SharedID description: SharedID User ID sub-module useridmodule: sharedIdSystem +bidRequestUserId: sharedid +eidsource: sharedid.org +example: '{"id":"01EAJWWN...", "third":"01EAJ..."}' --- @@ -13,25 +16,27 @@ SharedID into account. Prebid recommends implementing a method where users can Add it to your Prebid.js package with: -{: .alert.alert-info :} +```bash gulp build --modules=sharedIdSystem +``` ## SharedID ID Configuration In addition to the parameters documented above in the Basic Configuration section the following SharedID specific configuration is available: {: .table .table-bordered .table-striped } + | Param under userSync.userIds[] | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | | name | Required | String | The name of this module. | `'sharedId'` | | params | Optional | Object | Customized parameters | | | params.create | Optional | Boolean | For publisher server support only. If true, the publisher's server will create the (pubcid) cookie. Default is true. | `true` | -| params.pixelUrl | Optional | String | For publisher server support only. Where to call out to for a server cookie -- see [Prebid Identity](/identity/sharedid.html) for more information. | `/wp-json/pubcid/v1/extend/` +| params.pixelUrl | Optional | String | For publisher server support only. Where to call out to for a server cookie -- see [Prebid Identity](/identity/sharedid.html) for more information. | `/wp-json/pubcid/v1/extend/` | | params.extend | Optional | Boolean | If true, the expiration time of the stored IDs will be refreshed during each page load. Default is false. | `false` | -| storage | Required | Object | The publisher must specify some kind of local storage in which to store the results of the call to get the user ID. This can be either cookie or HTML5 storage. | +| storage | Required | Object | The publisher must specify some kind of local storage in which to store the results of the call to get the user ID. This can be either cookie or HTML5 storage.| | | storage.expires | Integer | Required | How long the user ID information will be stored. | `365` | -| storage.name | String | Required | The name of the cookie or html5 local storage where the user ID will be stored. | `_pubcid` -| storage.type | String | Required | This is where the results of the user ID will be stored. Must be either: Must be either: "cookie" or "html5". For server side implementations, which have the best identifier life and revenue impact, this must be a cookie. | `cookie` +| storage.name | String | Required | The name of the cookie or html5 local storage where the user ID will be stored. | `_pubcid` | +| storage.type | String | Required | This is where the results of the user ID will be stored. Must be either: Must be either: "cookie" or "html5". For server side implementations, which have the best identifier life and revenue impact, this must be a cookie. | `cookie` | ## SharedID Examples diff --git a/dev-docs/modules/userid-submodules/tapad.md b/dev-docs/modules/userid-submodules/tapad.md index 7fdd8cfaa0..937ade5078 100644 --- a/dev-docs/modules/userid-submodules/tapad.md +++ b/dev-docs/modules/userid-submodules/tapad.md @@ -3,6 +3,9 @@ layout: userid title: Tapad ID description: Tapad ID User ID sub-module useridmodule: tapadIdSystem +bidRequestUserId: tapadId +eidsource: tapad.com +example: '"1111"' --- @@ -15,12 +18,14 @@ Tapad’s Privacy landing page containing links to region-specific Privacy Notic Add it to your Prebid.js package with: -{: .alert.alert-info :} +```bash gulp build --modules=userId,tapadIdSystem +``` ## Tapad ID Configuration {: .table .table-bordered .table-striped } + | Param under userSync.userIds[] | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | | name | Required | String | `"tapadId"` | `"tapadId"` | diff --git a/dev-docs/modules/userid-submodules/teads.md b/dev-docs/modules/userid-submodules/teads.md index dd8f7fffcb..cf29808432 100644 --- a/dev-docs/modules/userid-submodules/teads.md +++ b/dev-docs/modules/userid-submodules/teads.md @@ -4,6 +4,9 @@ title: Teads ID description: Teads ID User ID sub-module useridmodule: teadsIdSystem pbjs_version_notes: please avoid using v7.20.0 and v7.21.0 +bidRequestUserId: teadsId +eidsource: teads.com +example: '"1111"' --- @@ -20,6 +23,7 @@ gulp build --modules=userId,teadsIdSystem Then configure the teadsId in your `userSync` configuration. {: .table .table-bordered .table-striped } + | Param under userSync.userIds[] | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | | name | Required | String | `"teadsId"` | `"teadsId"` | diff --git a/dev-docs/modules/userid-submodules/tncIdSystem.md b/dev-docs/modules/userid-submodules/tncIdSystem.md index d0c499e719..27d005b70e 100644 --- a/dev-docs/modules/userid-submodules/tncIdSystem.md +++ b/dev-docs/modules/userid-submodules/tncIdSystem.md @@ -21,7 +21,7 @@ gulp build --modules=tncIdSystem,userId ## TNCIdSystem module Configuration -Disclosure: This module loads external script unreviewed by the prebid.js community +{% include dev-docs/loads-external-javascript.md %} You can configure this submodule in your `userSync.userIds[]` configuration: @@ -49,6 +49,7 @@ pbjs.setConfig({ The following configuration parameters are available: {: .table .table-bordered .table-striped } + | Param under userSync.userIds[] | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | | name | Required | String | The name of this sub-module | `"tncId"` | diff --git a/dev-docs/modules/userid-submodules/trustpid.md b/dev-docs/modules/userid-submodules/trustpid.md index ab4ec4d7ac..ea4c4b8032 100644 --- a/dev-docs/modules/userid-submodules/trustpid.md +++ b/dev-docs/modules/userid-submodules/trustpid.md @@ -4,6 +4,9 @@ title: Trustpid description: Trustpid User ID sub-module pbjs_version_notes: not in 8.x useridmodule: trustpidSystem +bidRequestUserId: +eidsource: +example: --- {: .alert.alert-info :} @@ -16,9 +19,10 @@ Trustpid is also the brand name of the service, which is provided by Vodafone Sa ## Trustpid configuration {: .table .table-bordered .table-striped } + | Param under userSync.userIds[] | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | -| name | Required | String | The name of the module | `"trustpid"` +| name | Required | String | The name of the module | `"trustpid"` | | params | Required | Object | Object with configuration parameters for trustpid User Id submodule | - | | params.maxDelayTime | Required | Integer | Max amount of time (in seconds) before looking into storage for data | 2500 | | bidders | Required | Array of Strings | An array of bidder codes to which this user ID may be sent. Currently required and supporting AdformOpenRTB | `['adf']` | diff --git a/dev-docs/modules/userid-submodules/unified.md b/dev-docs/modules/userid-submodules/unified.md index 5c9fc0856b..4a94c76a02 100644 --- a/dev-docs/modules/userid-submodules/unified.md +++ b/dev-docs/modules/userid-submodules/unified.md @@ -3,6 +3,9 @@ layout: userid title: Unified ID description: Unified ID User ID sub-module useridmodule: unifiedIdSystem +bidRequestUserId: tdid +eidsource: adserver.org +example: '"1111"' --- @@ -10,8 +13,9 @@ The Unified ID solution is provided by adsrvr.org and the Trade Desk. Add it to your Prebid.js package with: -{: .alert.alert-info :} +```bash gulp build --modules=unifiedIdSystem +``` ## Unified ID Registration @@ -25,6 +29,7 @@ The Unified ID privacy is covered under the [TradeDesk Services Privacy Policy]( ## Unified ID Configuration {: .table .table-bordered .table-striped } + | Param under userSync.userIds[] | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | | name | Required | String | `"unifiedId"` | `"unifiedId"` | diff --git a/dev-docs/modules/userid-submodules/unified2.md b/dev-docs/modules/userid-submodules/unified2.md index 5a6f105f0d..74593d37df 100644 --- a/dev-docs/modules/userid-submodules/unified2.md +++ b/dev-docs/modules/userid-submodules/unified2.md @@ -11,8 +11,9 @@ UID2 relies on user consent before an ID can be added to the bid stream. Consent To add UID2 to your Prebid.js package, run the following: -{: .alert.alert-info :} +```bash gulp build --modules=uid2IdSystem +``` ## Unified ID 2.0 Registration @@ -71,6 +72,7 @@ Prebid.js supports fully client side integration for UID2. See the [official UI The following parameters apply only to the Unified ID 2.0 module integration. {: .table .table-bordered .table-striped } + | Param under userSync.userIds[] | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | | name | Required | String | ID value for the Unified ID 2.0 module - `"uid2"` | `"uid2"` | diff --git a/dev-docs/modules/userid-submodules/utiq.md b/dev-docs/modules/userid-submodules/utiq.md index 1b3f202ac2..0e7b92791f 100644 --- a/dev-docs/modules/userid-submodules/utiq.md +++ b/dev-docs/modules/userid-submodules/utiq.md @@ -3,6 +3,9 @@ layout: userid title: Utiq ID description: Utiq User ID sub-module useridmodule: utiqIdSystem +bidRequestUserId: utiId +eidsource: utiq.com +example: '"1111"' --- Utiq generates unique tokens, enabling improved efficiency in programmatic advertising while safeguarding transparency and control for end customers via `consenthub.utiq.com`. A website visitor’s Utiq is generated based on network identifiers provided by network operators and requires explicit user consent. diff --git a/dev-docs/modules/userid-submodules/utiqMtp.md b/dev-docs/modules/userid-submodules/utiqMtp.md index 854042d27e..94cbc2323c 100644 --- a/dev-docs/modules/userid-submodules/utiqMtp.md +++ b/dev-docs/modules/userid-submodules/utiqMtp.md @@ -3,6 +3,9 @@ layout: userid title: UtiqMtp ID description: UtiqMtp User ID sub-module useridmodule: utiqMtpIdSystem +bidRequestUserId: utiqMtpId +eidsource: utiq-mtp.com +example: '"1111"' --- Utiq generates unique tokens, enabling improved efficiency in programmatic advertising while safeguarding transparency and control for end customers via `consenthub.utiq.com`. A website visitor’s Utiq ID is generated based on network identifiers provided by network operators and requires explicit user consent. @@ -21,6 +24,7 @@ If you are interested in using Utiq on your website, please contact Utiq on +{: .table .table-bordered .table-striped } + | Param under userSync.userIds[] | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | | name | Required | String | The name of this module. | `"connectId"` | | params | Required | Object | Container of all module params. || -| params.pixelId | Required | Number | -The Yahoo-supplied publisher-specific pixel ID. | `"0000"` | +| params.pixelId | Required | Number | The Yahoo-supplied publisher-specific pixel ID. | `"0000"` | | params.he | Optional | String | The SHA-256 hashed user email address which has been lowercased prior to hashing. |`"ed8ddbf5a171981db8ef938596ca297d5e3f84bcc280041c5880dba3baf9c1d4"`| | params.puid | Optional | String | A domain-specific user identifier such as a first-party cookie. If not passed, a puid value will be auto-generated and stored in local and / or cookie storage. | `"ab9iibf5a231ii1db8ef911596ca297d5e3f84biii00041c5880dba3baf9c1da"` | -{: .table .table-bordered .table-striped } - ## Yahoo ConnectID Examples @@ -107,12 +109,11 @@ Finally, ConnectID follows all global privacy laws (such as the CCPA) and indust Please note that the storage related parameters are optional. We recommend that you omit them, since ConnectID module is pre-configured with the most optimal storage parameters already. -
    +{: .table .table-bordered .table-striped } + | Param under userSync.userIds[] | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | | storage | Optional | Object | Defines where and for how long the results of the call to get a user ID will be stored. | | | storage.type | Optional | String | Defines where the resolved user ID will be stored (either 'cookie' or 'html5' local storage). | `'cookie'` | | storage.name | Optional | String | The name of the cookie or html5 local storage where the resolved user ID will be stored. | `'connectId'` | | storage.expires | Optional | Integer | How long (in days) the user ID information will be stored. | `15` | -{: .table .table-bordered .table-striped } -
    diff --git a/dev-docs/modules/userid-submodules/yandex.md b/dev-docs/modules/userid-submodules/yandex.md index 1b0f8bbbbc..7ff4e9ce0a 100644 --- a/dev-docs/modules/userid-submodules/yandex.md +++ b/dev-docs/modules/userid-submodules/yandex.md @@ -3,6 +3,9 @@ layout: userid title: Yandex ID description: Yandex User ID sub-module useridmodule: yandexIdSystem +bidRequestUserId: yandexId +eidsource: yandex.com +example: '"1111"' --- Yandex ID module is designed to improve the personalization of ads for publishers' users. This documentation provides information about the Yandex User ID module, and instructions to install it. @@ -11,8 +14,9 @@ Yandex ID module is designed to improve the personalization of ads for publisher Add the module to your Prebid.js package: -{: .alert.alert-info :} +```bash gulp build --modules=yandexIdSystem +``` ## Step 2. Enable Yandex ID