|
| 1 | +--- |
| 2 | +layout: userid |
| 3 | +title: ABTShield ID |
| 4 | +description: ABTShield ID User ID sub-module |
| 5 | +useridmodule: abtshieldIdSystem |
| 6 | +bidRequestUserId: abtshieldId |
| 7 | +eidsource: abtshield.com |
| 8 | +example: '"abc-123-def-456"' |
| 9 | +--- |
| 10 | + |
| 11 | +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. |
| 12 | + |
| 13 | +For more information and to obtain a service ID, visit [abtshield.com](https://abtshield.com). |
| 14 | + |
| 15 | +## ABTShield ID Prerequisites |
| 16 | + |
| 17 | +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. |
| 18 | + |
| 19 | +## ABTShield ID Configuration |
| 20 | + |
| 21 | +Add the module to your Prebid.js build: |
| 22 | + |
| 23 | +```bash |
| 24 | +gulp build --modules=userId,abtshieldIdSystem |
| 25 | +``` |
| 26 | + |
| 27 | +Then configure the module in your `userSync` configuration: |
| 28 | + |
| 29 | +```javascript |
| 30 | +pbjs.setConfig({ |
| 31 | + userSync: { |
| 32 | + userIds: [{ |
| 33 | + name: 'abtshieldId', |
| 34 | + params: { |
| 35 | + sid: 'pb.your-service-id' // required |
| 36 | + }, |
| 37 | + storage: { |
| 38 | + type: 'html5', |
| 39 | + name: 'abtshield_id', |
| 40 | + expires: 1 |
| 41 | + } |
| 42 | + }] |
| 43 | + } |
| 44 | +}); |
| 45 | +``` |
| 46 | + |
| 47 | +{: .table .table-bordered .table-striped } |
| 48 | +| Param | Scope | Type | Description | |
| 49 | +| --- | --- | --- | --- | |
| 50 | +| `params.sid` | Required | String | Service ID obtained from abtshield.com. | |
| 51 | +| `params.endpoint` | Optional | String | Override the MCR endpoint. For test environments only. Must use HTTPS. | |
| 52 | +| `storage` | Recommended | Object | Standard Prebid User ID storage block (`html5` or `cookie`). | |
| 53 | + |
| 54 | +## ABTShield ID Example |
| 55 | + |
| 56 | +This will add a `userId.abtshieldId` property to bid requests: |
| 57 | + |
| 58 | +```javascript |
| 59 | +{ |
| 60 | + abtshieldId: { |
| 61 | + uuid: 'abc-123-def-456', |
| 62 | + segments: ['seg-1', 'seg-2'] // omitted when no segments are returned |
| 63 | + } |
| 64 | +} |
| 65 | +``` |
| 66 | + |
| 67 | +The `user.eids` entry will look like: |
| 68 | + |
| 69 | +```javascript |
| 70 | +{ |
| 71 | + source: 'abtshield.com', |
| 72 | + uids: [{ |
| 73 | + id: 'abc-123-def-456', |
| 74 | + atype: 1, |
| 75 | + ext: { segments: ['seg-1', 'seg-2'] } // omitted when no segments are returned |
| 76 | + }] |
| 77 | +} |
| 78 | +``` |
0 commit comments