-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Add ABTShield User ID docs #6559
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
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| --- | ||
| layout: userid | ||
| title: ABTShield ID | ||
| description: ABTShield ID User ID sub-module | ||
| useridmodule: abtshieldIdSystem | ||
| bidRequestUserId: abtshieldId | ||
| eidsource: abtshield.com | ||
| example: '"abc-123-def-456"' | ||
| --- | ||
|
|
||
| ABTShield provides cookie-less user identification and audience segmentation for publishers. The module fetches a unique user UUID and optional audience segments from the ABTShield MCR endpoint and surfaces them to bid adapters via the standard Prebid.js `user.eids` interface. | ||
|
|
||
| For more information and to obtain a service ID, visit [abtshield.com](https://abtshield.com). | ||
|
|
||
| ## ABTShield ID Prerequisites | ||
|
|
||
| Before using this module you need a **service ID (`sid`)** - register at [abtshield.com](https://abtshield.com) to obtain a unique identifier for your integration. You must also whitelist every domain from which the module will be loaded in the ABTShield dashboard. | ||
|
|
||
| ## ABTShield ID Configuration | ||
|
|
||
| Add the module to your Prebid.js build: | ||
|
|
||
| ```bash | ||
| gulp build --modules=userId,abtshieldIdSystem | ||
| ``` | ||
|
|
||
| Then configure the module in your `userSync` configuration: | ||
|
|
||
| ```javascript | ||
| pbjs.setConfig({ | ||
| userSync: { | ||
| userIds: [{ | ||
| name: 'abtshieldId', | ||
| params: { | ||
| sid: 'pb.your-service-id' // required | ||
| }, | ||
| storage: { | ||
| type: 'html5', | ||
| name: 'abtshield_id', | ||
| expires: 1 | ||
| } | ||
| }] | ||
| } | ||
| }); | ||
| ``` | ||
|
|
||
| {: .table .table-bordered .table-striped } | ||
| | Param | Scope | Type | Description | | ||
| | --- | --- | --- | --- | | ||
| | `params.sid` | Required | String | Service ID obtained from abtshield.com. | | ||
| | `params.endpoint` | Optional | String | Override the MCR endpoint. For test environments only. Must use HTTPS. | | ||
| | `storage` | Recommended | Object | Standard Prebid User ID storage block (`html5` or `cookie`). | | ||
|
|
||
| ## ABTShield ID Example | ||
|
|
||
| This will add a `userId.abtshieldId` property to bid requests: | ||
|
|
||
| ```javascript | ||
| { | ||
| abtshieldId: { | ||
| uuid: 'abc-123-def-456', | ||
| segments: ['seg-1', 'seg-2'] // omitted when no segments are returned | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| The `user.eids` entry will look like: | ||
|
|
||
| ```javascript | ||
| { | ||
| source: 'abtshield.com', | ||
| uids: [{ | ||
| id: 'abc-123-def-456', | ||
| atype: 1, | ||
| ext: { segments: ['seg-1', 'seg-2'] } // omitted when no segments are returned | ||
| }] | ||
| } | ||
| ``` | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.