Skip to content

Commit

Permalink
Add Quantcast userId submodule documentation (#2339)
Browse files Browse the repository at this point in the history
  • Loading branch information
mckurt authored Sep 16, 2020
1 parent e494b5d commit 20b7fac
Showing 1 changed file with 37 additions and 1 deletion.
38 changes: 37 additions & 1 deletion dev-docs/modules/userId.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ The User ID module supports multiple ways of establishing pseudonymous IDs for u
* **Lotame Panorama ID** - a people-based identifier available across all browsers -- including when third-party cookies are not available -- to connect and activate first, second, and third party data for programmatic advertising.
* **Parrable ID** - an encrypted pseudonymous ID that is consistent across all browsers and webviews on a device for every publisher the device visits. This module contacts Parrable to obtain the Parrable EID belonging to the specific device which can then be used by the bidder.
* **PubCommon ID** – an ID is generated on the user’s browser and stored for later use on this publisher’s domain.
* **Quantcast ID** - an ID independent of third-party cookies for publishers with Quantcast Measure tag.
* **Unified ID** – a simple cross-vendor approach – it calls out to a URL that responds with that user’s ID in one or more ID spaces (e.g. adsrvr.org).
* **netID** – provides an open, standardized, EU-GDPR compliant, IAB TCF aware, cross-device enabled Advertising Identifier Framework, which can be leveraged by publishers and advertisers (and vendors supporting them) to efficiently deliver targeted advertising bought through programmatic systems.

Expand Down Expand Up @@ -71,7 +72,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"`, `"id5id"`, `identityLink`, `"intentIqId"`, `"liveIntentId"`, `"lotamePanoramaId"`, `"parrableId"`, `"netId"`, `"pubCommonId"`, `"unifiedId"`, `"zeotapIdPlus"` | `"unifiedId"` |
| name | Required | String | May be: `"britepoolId"`, `"criteo"`, `"id5id"`, `identityLink`, `"intentIqId"`, `"liveIntentId"`, `"lotamePanoramaId"`, `"parrableId"`, `"quantcastId"`, `"netId"`, `"pubCommonId"`, `"unifiedId"`, `"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"` |
Expand Down Expand Up @@ -715,6 +716,41 @@ pbjs.setConfig({
});
{% endhighlight %}

### Quantcast ID

Quantcast ID enables publishers that use Quantcast Measure tag to uniquely identify
their clients within Quantcast's extensive publisher network without relying on third party
cookies. The Quantcast User ID submodule makes the existing Quantcast first party
cookie available in the bid request. The first party cookie allows Quantcast to correlate
the bid request with Quantcast's Measure dataset.

Currently, Quantcast ID only works with the presence of Quantcast Measure tag. More information
about Measure can be found in https://www.quantcast.com/measure.

The Quantcast privacy policy is at https://www.quantcast.com/privacy/.

Add it to your Prebid.js package with:

{: .alert.alert-info :}
gulp build --modules=userId,quantcastIdSystem

#### Quantcast ID Configuration

Quantcast ID module does not require any configuration parameters at this time.

#### Quantcast ID Example

{% highlight javascript %}
pbjs.setConfig({
userSync: {
userIds: [{
name: "quantcastId",
}]
}
});
{% endhighlight %}


### Shared ID User ID Submodule

Shared ID User ID Module generates a UUID that can be utilized to improve user matching.This module enables timely synchronization which handles sharedId.org optout. This module does not require any registration.
Expand Down

0 comments on commit 20b7fac

Please sign in to comment.