From 024021dd9c1571739912a993eb321e6509af2446 Mon Sep 17 00:00:00 2001 From: Sourabh Gandhe Date: Wed, 7 Apr 2021 14:58:52 +0530 Subject: [PATCH 1/3] deepintent docs added --- dev-docs/modules/userId.md | 61 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) diff --git a/dev-docs/modules/userId.md b/dev-docs/modules/userId.md index e800aa45b7..422d947d7c 100644 --- a/dev-docs/modules/userId.md +++ b/dev-docs/modules/userId.md @@ -220,6 +220,67 @@ pbjs.setConfig({ }); {% endhighlight %} +### Deepintent DPES ID by Deepintent +The Deepintent DPES ID or Healthcare Identity is a shared, neutral identifier that publishers and ad tech platforms can use to recognise users even in environments where 3rd party cookies are not available. The Deepintent DPES ID is designed to respect users' privacy choices and publishers’ preferences throughout the advertising value chain. + +#### Deepintent DPES ID Registration +The Deepintent DPES ID requires a simple registration with Deepintent. Please reach out to [contact@deepintent.com](mailto:contact@deepintent.com) to request. + +#### 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"` | +| params | Required | Object | Details for the Deepinent DPES ID. | | +| params.siteId | Required | Number | This is the Deepintent site id obtained from registering with deepintent. | `10023` | +| params.identityKey | Required | String | This is identity type which healthcare identity will store by using healthcare identity module by deepintent it will be either "hashedEmail" or "hashedNPI" | `hashedEmai` | +| storage | Required | Object | Storage settings for how the User Id module will cache the Deepintent ID locally | | +| storage.type | Required | String | This is where the results of the user ID will be stored. Deepintent`"html5"` or `"cookie"`. | `"html5"` | +| storage.name | Optional | String | The name of the local storage where the user ID will be stored. Deepintent **required** for storage type `"cookie"`. | `"_di"` | +| storage.expires | Optional | Integer | How long (in days) the user ID information will be stored. Deepintent recommends `90`. | `90` | + +#### Deepintent DPES ID Examples +1) Publisher stores the hashed identity from healthcare identity in cookie +{% highlight javascript %} +pbjs.setConfig({ + userSync: { + userIds: [{ + name: 'deepintentId', + params: { + siteId: 173, // change to the siteId number to the one you recieved from Deepintent. + identityKey: "hashedEmail" // HashedEmail or HashedNPI based on type of your integration + }, + storage: { + type: 'cookie', // "html5" is the required storage type option is "html5" + name: '_di', // change to the cookie name you wish to read from, optional if storage type is html5 + expires: 90 // storage lasts for 90 days, optional if storage type is html5 + } + }], + auctionDelay: 50 // 50ms maximum auction delay, applies to all userId modules + } +}); +{% endhighlight %} + +2) Publisher stores the hashed identity from healthcare identity in localstorage +{% highlight javascript %} +pbjs.setConfig({ + userSync: { + userIds: [{ + name: 'deepintentId', + params: { + siteId: 173, // change to the siteId number to the one you recieved from Deepintent. + identityKey: "hashedEmail" // HashedEmail or HashedNPI based on type of your integration + }, + storage: { + type: 'html5' // "html5" is the required storage type option is "html5" + } + }], + auctionDelay: 50 // 50ms maximum auction delay, applies to all userId modules + } +}); +{% endhighlight %} + + ### Fabrick ID by Neustar [Neustar Fabrick™](https://www.home.neustar/fabrick) is a unified identity ecosystem that powers connections between brands, publishers, and consumers to accelerate marketing performance across online and offline channels. From 2fdf378ee4cb575644f757b9b848ea9d6b2b1fbb Mon Sep 17 00:00:00 2001 From: Sourabh Gandhe Date: Mon, 12 Apr 2021 15:55:24 +0530 Subject: [PATCH 2/3] added to download page and corrected documentation --- dev-docs/modules/userId.md | 18 ++++-------------- download.md | 3 +++ 2 files changed, 7 insertions(+), 14 deletions(-) diff --git a/dev-docs/modules/userId.md b/dev-docs/modules/userId.md index 422d947d7c..6c44e890f5 100644 --- a/dev-docs/modules/userId.md +++ b/dev-docs/modules/userId.md @@ -221,7 +221,7 @@ pbjs.setConfig({ {% endhighlight %} ### Deepintent DPES ID by Deepintent -The Deepintent DPES ID or Healthcare Identity is a shared, neutral identifier that publishers and ad tech platforms can use to recognise users even in environments where 3rd party cookies are not available. The Deepintent DPES ID is designed to respect users' privacy choices and publishers’ preferences throughout the advertising value chain. +The Deepintent Id is a shared, healthcare identifier which helps publisher in absence of the 3rd Party cookie matching. This lets publishers set and bid with healthcare identity . Deepintent lets users protect their privacy through advertising value chain, where Healthcare identity when setting the identity takes in consideration of users choices, as well as when passing identity on the cookie itself privacy consent strings are checked. The healthcare identity when set is not stored on Deepintent's servers but is stored on users browsers itself. User can still opt out of the ads by https://option.deepintent.com/adchoices #### Deepintent DPES ID Registration The Deepintent DPES ID requires a simple registration with Deepintent. Please reach out to [contact@deepintent.com](mailto:contact@deepintent.com) to request. @@ -231,12 +231,9 @@ The Deepintent DPES ID requires a simple registration with Deepintent. Please re | Param under userSync.userIds[] | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | | name | Required | String | The name of this module: `"deepintentId"` | `"deepintentId"` | -| params | Required | Object | Details for the Deepinent DPES ID. | | -| params.siteId | Required | Number | This is the Deepintent site id obtained from registering with deepintent. | `10023` | -| params.identityKey | Required | String | This is identity type which healthcare identity will store by using healthcare identity module by deepintent it will be either "hashedEmail" or "hashedNPI" | `hashedEmai` | | storage | Required | Object | Storage settings for how the User Id module will cache the Deepintent ID locally | | | storage.type | Required | String | This is where the results of the user ID will be stored. Deepintent`"html5"` or `"cookie"`. | `"html5"` | -| storage.name | Optional | String | The name of the local storage where the user ID will be stored. Deepintent **required** for storage type `"cookie"`. | `"_di"` | +| storage.name | Optional | String | The name of the local storage where the user ID will be stored. Deepintent | `"_dpes_id"` | | storage.expires | Optional | Integer | How long (in days) the user ID information will be stored. Deepintent recommends `90`. | `90` | #### Deepintent DPES ID Examples @@ -246,13 +243,9 @@ pbjs.setConfig({ userSync: { userIds: [{ name: 'deepintentId', - params: { - siteId: 173, // change to the siteId number to the one you recieved from Deepintent. - identityKey: "hashedEmail" // HashedEmail or HashedNPI based on type of your integration - }, storage: { type: 'cookie', // "html5" is the required storage type option is "html5" - name: '_di', // change to the cookie name you wish to read from, optional if storage type is html5 + name: '_dpes_id', expires: 90 // storage lasts for 90 days, optional if storage type is html5 } }], @@ -267,12 +260,9 @@ pbjs.setConfig({ userSync: { userIds: [{ name: 'deepintentId', - params: { - siteId: 173, // change to the siteId number to the one you recieved from Deepintent. - identityKey: "hashedEmail" // HashedEmail or HashedNPI based on type of your integration - }, storage: { type: 'html5' // "html5" is the required storage type option is "html5" + name: '_dpes_id' } }], auctionDelay: 50 // 50ms maximum auction delay, applies to all userId modules diff --git a/download.md b/download.md index c9683a5669..d2e0192b54 100644 --- a/download.md +++ b/download.md @@ -221,6 +221,9 @@ Prebid.js is open source software that is offered for free as a convenience. Whi
+ +
+
From 0f94d6c62ed75d90550f5f438043e4ff8be9e343 Mon Sep 17 00:00:00 2001 From: Sourabh Gandhe Date: Thu, 15 Apr 2021 13:28:10 +0530 Subject: [PATCH 3/3] additional registration steps added --- dev-docs/modules/userId.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/dev-docs/modules/userId.md b/dev-docs/modules/userId.md index 6c44e890f5..002a12dad0 100644 --- a/dev-docs/modules/userId.md +++ b/dev-docs/modules/userId.md @@ -224,7 +224,8 @@ pbjs.setConfig({ The Deepintent Id is a shared, healthcare identifier which helps publisher in absence of the 3rd Party cookie matching. This lets publishers set and bid with healthcare identity . Deepintent lets users protect their privacy through advertising value chain, where Healthcare identity when setting the identity takes in consideration of users choices, as well as when passing identity on the cookie itself privacy consent strings are checked. The healthcare identity when set is not stored on Deepintent's servers but is stored on users browsers itself. User can still opt out of the ads by https://option.deepintent.com/adchoices #### Deepintent DPES ID Registration -The Deepintent DPES ID requires a simple registration with Deepintent. Please reach out to [contact@deepintent.com](mailto:contact@deepintent.com) to request. +The Deepintent DPES ID is free to use, but requires a simple registration with Deepintent. Please reach to prebid@deepintent.com to get started. +Once publisher registers with deepintents platform for healthcare identity Deepintent provides the Tag code to be placed on the page, this tag code works to capture and store information as per publishers and users agreement. DPES User ID module uses this stored id and passes it on the deepintent prebid adapter. #### Deepintent DPES ID Configuration {: .table .table-bordered .table-striped }