-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Verizon Media user id module documentation #2368
Changes from 5 commits
91880b4
dbcc44d
959c065
bd8efad
a819076
549d66a
ac864ce
faef2eb
68a0fcc
41894ce
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -58,7 +58,7 @@ of sub-objects. The table below has the options that are common across ID system | |||||
{: .table .table-bordered .table-striped } | ||||||
| Param under userSync.userIds[] | Scope | Type | Description | Example | | ||||||
| --- | --- | --- | --- | --- | | ||||||
| name | Required | String | May be: `"britepoolId"`, `"criteo"`, `"haloId"`, `"id5id"`, `identityLink`, `"intentIqId"`, `"liveIntentId"`, `"lotamePanoramaId"`, `"merkleId"`, `"netId"`, `"parrableId"`, `"quantcastId"`, `"pubCommonId"`, `"sharedId"`, `"unifiedId"`, `"zeotapIdPlus"` | `"unifiedId"` | | ||||||
| name | Required | String | May be: `"britepoolId"`, `"criteo"`, `"haloId"`, `"id5id"`, `identityLink`, `"intentIqId"`, `"liveIntentId"`, `"lotamePanoramaId"`, `"merkleId"`, `"netId"`, `"parrableId"`, `"quantcastId"`, `"pubCommonId"`, `"sharedId"`, `"unifiedId"`, `"verizonMedia"`, `"zeotapIdPlus"` | `"unifiedId"` | | ||||||
| params | Based on User ID sub-module | Object | | | | ||||||
| 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 either cookie or HTML5 storage. This is not needed when `value` is specified or the ID system is managing its own storage | | | ||||||
| storage.type | Required | String | Must be either `"cookie"` or `"html5"`. This is where the results of the user ID will be stored. | `"cookie"` | | ||||||
|
@@ -933,6 +933,56 @@ pbjs.setConfig({ | |||||
}); | ||||||
{% endhighlight %} | ||||||
|
||||||
### Verizon Media ID | ||||||
|
||||||
Verizon Media's ID is a person based ID and doesn't depend on 3rd party cookies. | ||||||
|
||||||
Verizon Media's ID is designed to enable ad tech platforms to recognize and match users consistently across the open web. The Verizon Media ID is built on top of Verizon Media's robust and proprietary ID Graph, delivering a higher find rate of audiences on publishers' sites user targeting that respects privacy. | ||||||
|
||||||
The Verizon Media ID honors privacy choices from our own [Privacy Dashboard](https://www.verizonmedia.com/policies/us/en/verizonmedia/privacy/dashboard/index.html), as well as global privacy acts. | ||||||
|
||||||
Please reach out to VerizonMedia-UIDsupport@verizonmedia.com for assistance with setup. | ||||||
|
||||||
Add Verizon Media ID to your Prebid.js package with: | ||||||
|
||||||
{: .alert.alert-info :} | ||||||
gulp build --modules=userId,verizonMediaIdSystem | ||||||
|
||||||
|
||||||
#### Verizon Media ID configuration | ||||||
|
||||||
{: .table .table-bordered .table-striped } | ||||||
| Param under userSync.userIds[] | Scope | Type | Description | Example | | ||||||
| --- | --- | --- | --- | --- | | ||||||
| name | Required | String | The name of this module. | `'verizonMedia'` | | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. should be verizonMediaId
Suggested change
|
||||||
| params | Required | Object | Container of all module params. || | ||||||
| params.he | Required | String | The SHA-256 hashed user email address |`'ed8ddbf5a171981db8ef938596ca297d5e3f84bcc280041c5880dba3baf9c1d4'`| | ||||||
| storage | Required | Object | This object defines where and for how long the results of the call to get a user ID will be stored. | | | ||||||
| storage.type | Required | String | This parameter defines where the resolved user ID will be stored (either `'cookie'` or `'html5'` localstorage).| `'cookie'` | | ||||||
| storage.name | Required | String | The name of the cookie or html5 localstorage where the resolved user ID will be stored. | `'vmuid'` | | ||||||
| storage.expires | Recommended | Integer | How long (in days) the user ID information will be stored. The recommended value is `1` | `1` | | ||||||
|
||||||
#### Verizon Media ID examples | ||||||
|
||||||
``` | ||||||
pbjs.setConfig({ | ||||||
userSync: { | ||||||
userIds: [{ | ||||||
name: "verizonMedia", | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
params: { | ||||||
he: "ed8ddbf5a171981db8ef938596ca297d5e3f84bcc280041c5880dba3baf9c1d4" | ||||||
}, | ||||||
storage: { | ||||||
type: "cookie", | ||||||
name: "vmuid", | ||||||
expires: 1 | ||||||
} | ||||||
}] | ||||||
} | ||||||
}) | ||||||
``` | ||||||
|
||||||
|
||||||
## Adapters Supporting the User ID Sub-Modules | ||||||
|
||||||
{% assign bidder_pages = site.pages | where: "layout", "bidder" %} | ||||||
|
@@ -971,6 +1021,7 @@ Bidders that want to support the User ID module in Prebid.js, need to update the | |||||
| Quantcast ID | n/a | bidRequest.userId.quantcastId | `"1111"` | | ||||||
| Shared ID | SharedId | bidRequest.userId.sharedid | `{"id":"01EAJWWNEPN3CYMM5N8M5VXY22","third":"01EAJWWNEPN3CYMM5N8M5VXY22"}` | | ||||||
| Unified ID | Trade Desk | bidRequest.userId.tdid | `"1111"` | | ||||||
| Verizon Media ID | Verizon Media | bidRequest.userId.vmuid | `72d04af6e07c2eb93e9c584a131f48b6a9b963bcb2736d624e987ff8cf36d472` | | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. the value should be a string
Suggested change
|
||||||
|
||||||
For example, the adapter code might do something like: | ||||||
|
||||||
|
@@ -1057,6 +1108,11 @@ Bidders that want to support the User ID module in Prebid Server, need to update | |||||
"third": "01EAJWWNEPN3CYMM5N8M5VXY22" | ||||||
} | ||||||
}] | ||||||
},{ | ||||||
"source": "verizonmedia.com", | ||||||
"uids": [{ | ||||||
"id": "61cef5656fb05f16d53938069f1684df4b2257e27" | ||||||
}] | ||||||
}] | ||||||
} | ||||||
} | ||||||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should be
verizonMediaId
I think