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

Mediawallah #2817

Merged
merged 6 commits into from
Apr 8, 2021
Merged

Mediawallah #2817

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
171dbc7
add mwOpenLink doc
hannapanova190119 Mar 12, 2021
670767a
add mediawallah overview and registration in userId.md
hannapanova190119 Mar 30, 2021
b6a6d57
Merge branch 'master' into mediawallah
hannapanova190119 Mar 31, 2021
7963620
fix typo - partner
hannapanova190119 Apr 1, 2021
1c30b09
Merge branch 'mediawallah' of https://github.com/ericrenebrown/prebid…
hannapanova190119 Apr 1, 2021
92a2002
Merge branch 'master' into mediawallah
hannapanova190119 Apr 8, 2021
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
64 changes: 56 additions & 8 deletions dev-docs/modules/userId.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,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"`, `"novatiqId"`, `"parrableId"`, `"quantcastId"`, `"pubCommonId"`, `"pubProvidedId"`, `"sharedId"`, `"tapadId"`, `"unifiedId"`,`"uid2"`, `"verizonMediaId"`, `"zeotapIdPlus"` | `"unifiedId"`
| params | Based on User ID sub-module | Object | | |
| name | Required | String | May be: `"britepoolId"`, `"criteo"`, `"fabrickId"`, `"haloId"`, `"id5id"`, `identityLink`, `"idx"`, `"intentIqId"`, `"liveIntentId"`, `"lotamePanoramaId"`, `"merkleId"`, `"netId"`, `"novatiqId"`, `"parrableId"`, `"quantcastId"`, `"pubCommonId"`, `"pubProvidedId"`, `"sharedId"`, `"tapadId"`, `"unifiedId"`,`"uid2"`, `"verizonMediaId"`, `"zeotapIdPlus"`, `"mwOpenLinkId"` | `"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 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 @@ -573,7 +572,7 @@ pbjs.setConfig({
userIds: [{
name: "intentIqId",
params: {
parnter: 123456 // valid partner id
parnter: 123456 // valid partner id
},
storage: {
type: "cookie",
Expand All @@ -594,7 +593,7 @@ pbjs.setConfig({
userIds: [{
name: "intentIqId",
params: {
parnter: 123456 // valid partner id
parnter: 123456 // valid partner id
},
storage: {
type: "html5",
Expand All @@ -616,9 +615,9 @@ pbjs.setConfig({
userIds: [{
name: "intentIqId",
params: {
parnter: 123456 // valid partner id
pcid: PCID_VARIABLE // string value, dynamically loaded into a variable before setting the configuration
pai: PAI_VARIABLE // string value, dynamically loaded into a variable before setting the configuration
parnter: 123456 // valid partner id
pcid: PCID_VARIABLE // string value, dynamically loaded into a variable before setting the configuration
pai: PAI_VARIABLE // string value, dynamically loaded into a variable before setting the configuration
},
storage: {
type: "html5",
Expand Down Expand Up @@ -1437,6 +1436,48 @@ pbjs.setConfig({
})
```

### MediaWallah OpenLinkID

MediaWallah's openLink is an anonymous person based ID that enables buyers and sellers of media to connect a person and their devices across the web and mobile apps. openLink facilities the buying of media between DSPs, SSPs and publishers.

Add support for MediaWallah OpenLinkID to your Prebid.js package with:

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

#### MediaWallah OpenLinkID Registration

MediaWallah requires the creation of an accountId a partnerId in order to take advantage of openLink. Please contact your partner resource to get these Ids provisioned.

#### MediaWallah OpenLinkID Configuration

<div class="table-responsive" markdown="1">
| Param under userSync.userIds[] | Scope | Type | Description | Example |
| --- | --- | --- | --- | --- |
| name | Required | String | The name of this module. | `'mwOpenLinkId'` |
| params | Required | Object | Details for mwOLID syncing. ||
| params.accountId | Required | String | The MediaWallah assigned Account Id | `1000` |
| params.partnerId | Required | String | The MediaWallah assign partner Id |`'1001'`|
| params.uid | Optional | String | Your unique Id for the user or browser. Used for matching. | `'u-123xyz'` |
{: .table .table-bordered .table-striped }
</div>

#### MediaWallah OpenLinkID Examples

```
pbjs.setConfig({
userSync: {
userIds: [{
name: 'mwOpenLinkId',
params: {
accountId: '1000',
partnerId: '1001',
uid: 'u-123xyz'
}
}]
}
})
```

## Adapters Supporting the User ID Sub-Modules

Expand Down Expand Up @@ -1479,6 +1520,7 @@ Bidders that want to support the User ID module in Prebid.js, need to update the
| Shared ID | SharedId | bidRequest.userId.sharedid | `{"id":"01EAJWWNEPN3CYMM5N8M5VXY22","third":"01EAJWWNEPN3CYMM5N8M5VXY22"}` |
| Unified ID | Trade Desk | bidRequest.userId.tdid | `"1111"` |
| Verizon Media ConnectID | Verizon Media | bidRequest.userId.connectid | `"72d04af6e07c2eb93e9c584a131f48b6a9b963bcb2736d624e987ff8cf36d472"` |
| MediaWallah OpenLink ID | MediaWallah | bidRequest.userId.mwOpenLinkId | `"1111"` |
{: .table .table-bordered .table-striped }
</div>

Expand Down Expand Up @@ -1591,7 +1633,13 @@ Bidders that want to support the User ID module in Prebid Server, need to update
"uids": [{
"id": "61cef5656fb05f16d53938069f1684df4b2257e27"
}]
}
},{
"source": "mediawallahscript.com",
"uids": [{
"id": "01EAJWWNEPN3CYMM5N8M5VXY22",
"atype": 1
}]
}
]
}
}
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 @@ -283,6 +283,9 @@ Prebid.js is open source software that is offered for free as a convenience. Whi
<div class="col-md-4"><div class="checkbox">
<label><input type="checkbox" moduleCode="zeotapIdPlusIdSystem" class="bidder-check-box"> Zeotap ID+</label>
</div></div>
<div class="col-md-4"><div class="checkbox">
<label><input type="checkbox" moduleCode="mwOpenLinkIdSystem" class="bidder-check-box"> MediaWallah OpenLink ID</label>
</div></div>
</div>

<br>
Expand Down