Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Verizon Media user id module documentation #2368

Merged
merged 10 commits into from
Oct 29, 2020
Merged

Verizon Media user id module documentation #2368

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
91880b4
Updates to Verizon Media documentation
Sep 24, 2020
dbcc44d
Add Verizon Media module name to list of options in basic configurati…
Sep 24, 2020
959c065
Copy update
Sep 24, 2020
bd8efad
Merge branch 'master' into feature/verizonmedia-user-id-docs
Sep 24, 2020
a819076
Remove previously shifed docs for a different provider.
Sep 24, 2020
549d66a
Addressing PR feedback
Sep 28, 2020
ac864ce
Merge branch 'master' of https://github.com/prebid/prebid.github.io i…
Oct 18, 2020
faef2eb
Add documentation for pixelId parameter
Oct 18, 2020
68a0fcc
Addressing PR feedback
Oct 20, 2020
41894ce
Merge branch 'master' into feature/verizonmedia-user-id-docs
slimkrazy Oct 29, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 62 additions & 4 deletions dev-docs/modules/userId.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"`, `"fabrickId"`, `"haloId"`, `"id5id"`, `identityLink`, `"idx"`, `"intentIqId"`, `"liveIntentId"`, `"lotamePanoramaId"`, `"merkleId"`, `"netId"`, `"parrableId"`, `"quantcastId"`, `"pubCommonId"`, `"pubProvidedId"`, `"sharedId"`, `"unifiedId"`, `"zeotapIdPlus"` | `"unifiedId"` |
| name | Required | String | May be: `"britepoolId"`, `"criteo"`, `"fabrickId"`, `"haloId"`, `"id5id"`, `identityLink`, `"idx"`, `"intentIqId"`, `"liveIntentId"`, `"lotamePanoramaId"`, `"merkleId"`, `"netId"`, `"parrableId"`, `"quantcastId"`, `"pubCommonId"`, `"pubProvidedId"`, `"sharedId"`, `"unifiedId"`, `"verizonMediaId"`, `"zeotapIdPlus"` | `"unifiedId"` |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

zeotapidplus should be last

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jdwieland8282 - Correct me if I'm wrong, but it is last. "unifiedId" is in the example column as it always has been.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry you are correct @slimkrazy my bad, I was reading the md incorrectly

| 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"` |
Expand Down Expand Up @@ -1169,6 +1169,58 @@ 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. | `'verizonMediaId'` |
| params | Required | Object | Container of all module params. ||
| params.pixelId | Required | Number | The Verizon Media supplied publisher specific pixel Id | `8976` |
| 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: "verizonMediaId",
params: {
pixelId: 8976,
he: "ed8ddbf5a171981db8ef938596ca297d5e3f84bcc280041c5880dba3baf9c1d4"
},
storage: {
type: "cookie",
name: "vmuid",
expires: 1
}
}]
}
})
```


## Adapters Supporting the User ID Sub-Modules

{% assign bidder_pages = site.pages | where: "layout", "bidder" %}
Expand Down Expand Up @@ -1208,6 +1260,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"` |

For example, the adapter code might do something like:

Expand Down Expand Up @@ -1297,8 +1350,7 @@ Bidders that want to support the User ID module in Prebid Server, need to update
"third": "01EAJWWNEPN3CYMM5N8M5VXY22"
}
}]
},
{
},{
"source": "pub.com", // Publisher must configure their domain here
"uids": [{
"id": "01EAJWWNEPN3CYMM5N8M5VXY22",
Expand All @@ -1307,7 +1359,13 @@ Bidders that want to support the User ID module in Prebid Server, need to update
"stype": "dmp" //currently supported values (dmp,ppuid,other)
}
}]
}]
},{
"source": "verizonmedia.com",
"uids": [{
"id": "61cef5656fb05f16d53938069f1684df4b2257e27"
}]
}
]
}
}
}
Expand Down
3 changes: 3 additions & 0 deletions download.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -558,6 +558,9 @@ Prebid.js is open source software that is offered for free as a convenience. Whi
<label><input type="checkbox" moduleCode="unifiedIdSystem" class="bidder-check-box"> User ID: Unified ID</label>
</div></div>
<div class="col-md-4"><div class="checkbox">
<label><input type="checkbox" moduleCode="verizonMediaIdSystem" class="bidder-check-box"> User ID: Verizon Media ID</label>
</div></div>
<div class="col-md-4"><div class="checkbox">
<label><input type="checkbox" moduleCode="zeotapIdPlusIdSystem" class="bidder-check-box"> User ID: Zeotap ID+</label>
</div></div>
</div>
Expand Down