From 5f262ca2a4813e65abc8e9ad9a209a3f9be9edf3 Mon Sep 17 00:00:00 2001 From: Konstantin Mikhalyov Date: Thu, 10 Oct 2024 17:41:29 +0300 Subject: [PATCH 1/3] UserID submodule: rewardedInterestIdSystem --- dev-docs/modules/userId.md | 3 +- .../userid-submodules/rewardedInterest.md | 38 +++++++++++++++++++ 2 files changed, 40 insertions(+), 1 deletion(-) create mode 100644 dev-docs/modules/userid-submodules/rewardedInterest.md diff --git a/dev-docs/modules/userId.md b/dev-docs/modules/userId.md index 200b39ad95..853b10345f 100644 --- a/dev-docs/modules/userId.md +++ b/dev-docs/modules/userId.md @@ -85,7 +85,7 @@ The table below has the options that are common across ID systems. See the secti {: .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 -%}{% if count == 1 %}{{ name_string │ append: ", " -}}{% endif %}{% assign count = 1 %}`"{{ name_string │ append: name_string -}}{{ name_string │ append: page.useridmodule -}}"`{% endfor %} | `"unifiedId"` | +| name | Required | String | May be any of the following values: {% for page in userid_pages -%}{% if count == 1 %}{{ name_string | append: ", " -}}{% endif %}{% assign count = 1 %}`"{{ name_string | append: name_string -}}{{ name_string | append: page.useridmodule -}}"`{% endfor %} | `"unifiedId"` | | params | Based on User ID sub-module | Object | | | | bidders | Optional | Array of Strings | An array of bidder codes to which this user ID may be sent. | `['bidderA', 'bidderB']` | | storage | Optional | Object | The publisher can specify some kind of local storage in which to store the results of the call to get the user ID. This can be a cookie, HTML5 storage or both.| | @@ -252,6 +252,7 @@ Bidders that want to support the User ID module in Prebid.js need to update thei | 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" | diff --git a/dev-docs/modules/userid-submodules/rewardedInterest.md b/dev-docs/modules/userid-submodules/rewardedInterest.md new file mode 100644 index 0000000000..77bb051af2 --- /dev/null +++ b/dev-docs/modules/userid-submodules/rewardedInterest.md @@ -0,0 +1,38 @@ +--- +layout: userid +title: Rewarded Interest ID +description: Rewarded Interest User ID Submodule +useridmodule: rewardedInterestIdSystem +--- + +[Rewarded Interest](https://www.rewardedinterest.com/) is an identity provider that enables users to monetize and manage the exposure of their identity to various ad providers through the Rewarded Interest browser extension. + +This submodule passes the Rewarded Interest Identity Token, obtained from the browser extension, into the oRTB request. The Identity Token is included only if the browser has the Rewarded Interest extension installed, and the user has authorized it to share the token. + +The Rewarded Interest Identity Token itself does not reveal the user's identity, as it is encrypted and refreshed frequently. Rewarded Interest partners (such as DSPs, SSPs, and publishers) can use the Rewarded Interest Backend API to exchange the Identity Token for a CMAID (Consumer Mediated Advertising Identifier). The CMAID is a durable, cross-site, cross-device advertising identifier that remains consistent across visits and devices enrolled by a Rewarded Interest user, unless they choose to reset or pause it. + +Add this submodule to your Prebid.js wrapper with: + +{: .alert.alert-info :} +gulp build --modules=userId,rewardedInterestIdSystem + +## Rewarded Interest ID Configuration + +
+| Param under userSync.userIds[] | Scope | Type | Description | Example | +| --- | --- | --- | --- | --- | +| name | Required | String | The name of the Rewarded Interest user ID submodule. | `"rewardedInterestId"` | +{: .table .table-bordered .table-striped } +
+ +## Rewarded Interest ID Example + +```javascript +pbjs.setConfig({ + userSync: { + userIds: [{ + name: "rewardedInterestId" + }] + } +}) +``` From b2367915f1c93d9e8958cca96cf25762abd2a50d Mon Sep 17 00:00:00 2001 From: Eugene Dorfman Date: Thu, 17 Oct 2024 16:15:01 +0200 Subject: [PATCH 2/3] rewardedInterest: wording update --- dev-docs/modules/userid-submodules/rewardedInterest.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dev-docs/modules/userid-submodules/rewardedInterest.md b/dev-docs/modules/userid-submodules/rewardedInterest.md index 77bb051af2..2f79562cb6 100644 --- a/dev-docs/modules/userid-submodules/rewardedInterest.md +++ b/dev-docs/modules/userid-submodules/rewardedInterest.md @@ -9,7 +9,7 @@ useridmodule: rewardedInterestIdSystem This submodule passes the Rewarded Interest Identity Token, obtained from the browser extension, into the oRTB request. The Identity Token is included only if the browser has the Rewarded Interest extension installed, and the user has authorized it to share the token. -The Rewarded Interest Identity Token itself does not reveal the user's identity, as it is encrypted and refreshed frequently. Rewarded Interest partners (such as DSPs, SSPs, and publishers) can use the Rewarded Interest Backend API to exchange the Identity Token for a CMAID (Consumer Mediated Advertising Identifier). The CMAID is a durable, cross-site, cross-device advertising identifier that remains consistent across visits and devices enrolled by a Rewarded Interest user, unless they choose to reset or pause it. +The Rewarded Interest Identity Token itself does not reveal the user's identity, as it is encrypted and refreshed frequently. Rewarded Interest partners (such as DSPs, SSPs, and publishers) can use the Rewarded Interest Identity Resolution API to resolve the Identity Token into a CMAID (Consumer Mediated Advertising Identifier). The CMAID is a durable, cross-site, cross-device advertising identifier that remains consistent across visits and devices enrolled by a Rewarded Interest user, unless they choose to reset or pause it. Add this submodule to your Prebid.js wrapper with: From 88efddb33d0916bcd36c2f4de26c181557bace24 Mon Sep 17 00:00:00 2001 From: Konstantin Mikhalyov Date: Thu, 17 Oct 2024 20:04:56 +0300 Subject: [PATCH 3/3] UserID submodule: rewardedInterestIdSystem - fixed styles --- dev-docs/modules/userId.md | 2 +- dev-docs/modules/userid-submodules/rewardedInterest.md | 8 +++----- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/dev-docs/modules/userId.md b/dev-docs/modules/userId.md index 853b10345f..1cab17df2a 100644 --- a/dev-docs/modules/userId.md +++ b/dev-docs/modules/userId.md @@ -85,7 +85,7 @@ The table below has the options that are common across ID systems. See the secti {: .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 -%}{% if count == 1 %}{{ name_string | append: ", " -}}{% endif %}{% assign count = 1 %}`"{{ name_string | append: name_string -}}{{ name_string | append: page.useridmodule -}}"`{% endfor %} | `"unifiedId"` | +| name | Required | String | May be any of the following values: {% for page in userid_pages -%}`"{{ page.useridmodule -}}"`{% if forloop.last == false -%}, {% endif -%}{% endfor -%} | `"unifiedId"` | | params | Based on User ID sub-module | Object | | | | bidders | Optional | Array of Strings | An array of bidder codes to which this user ID may be sent. | `['bidderA', 'bidderB']` | | storage | Optional | Object | The publisher can specify some kind of local storage in which to store the results of the call to get the user ID. This can be a cookie, HTML5 storage or both.| | diff --git a/dev-docs/modules/userid-submodules/rewardedInterest.md b/dev-docs/modules/userid-submodules/rewardedInterest.md index 2f79562cb6..9a1617d47f 100644 --- a/dev-docs/modules/userid-submodules/rewardedInterest.md +++ b/dev-docs/modules/userid-submodules/rewardedInterest.md @@ -18,12 +18,10 @@ gulp build --modules=userId,rewardedInterestIdSystem ## Rewarded Interest ID Configuration -
-| Param under userSync.userIds[] | Scope | Type | Description | Example | -| --- | --- | --- | --- | --- | -| name | Required | String | The name of the Rewarded Interest user ID submodule. | `"rewardedInterestId"` | {: .table .table-bordered .table-striped } -
+| Param under usersync.userIds[] | Scope | Type | Description | Example | +|--------------------------------|----------|--------|--------------------------|------------------------| +| name | Required | String | The name of this module. | `"rewardedInterestId"` | ## Rewarded Interest ID Example