|
| 1 | +--- |
| 2 | +layout: userid |
| 3 | +title: Taboola ID |
| 4 | +description: Taboola ID User ID sub-module |
| 5 | +useridmodule: taboolaIdSystem |
| 6 | +bidRequestUserId: taboolaId |
| 7 | +eidsource: taboola.com |
| 8 | +example: '"abc123def456"' |
| 9 | +--- |
| 10 | + |
| 11 | + |
| 12 | +Taboola is a global leader in powering recommendations across the open web. The Taboola ID module allows publishers to enable identity support for Taboola demand by leveraging a persistent user ID from Taboola's identity infrastructure. |
| 13 | + |
| 14 | +This ID helps improve addressability, performance, and monetization opportunities across Taboola-integrated supply paths, particularly in environments where third-party cookies are limited or unavailable. |
| 15 | + |
| 16 | +The Taboola privacy policy can be found at [www.taboola.com/privacy-policy](https://www.taboola.com/privacy-policy). |
| 17 | + |
| 18 | +Add it to your Prebid.js package with: |
| 19 | + |
| 20 | +```bash |
| 21 | +gulp build --modules=taboolaIdSystem,userId |
| 22 | +``` |
| 23 | + |
| 24 | +## Taboola ID Configuration |
| 25 | + |
| 26 | +The Taboola ID module does not require any configuration parameters. If needed, it supports an optional `storage` config to persist the ID locally. |
| 27 | + |
| 28 | +{: .alert.alert-info :} |
| 29 | +NOTE: The Taboola ID module supports both first-party and server-side Prebid identity environments. |
| 30 | + |
| 31 | +The following configuration parameters are available: |
| 32 | + |
| 33 | +{: .table .table-bordered .table-striped } |
| 34 | + |
| 35 | +| Param under userSync.userIds[] | Scope | Type | Description | Example | |
| 36 | +| --- | --- | --- |-----------------------------------------------------------|-----------------------------------------------------------| |
| 37 | +| name | Required | String | The name of this sub-module | `"taboolaId"` | |
| 38 | +| storage ||| | | |
| 39 | +| storage.name | Required | String | The name of the cookie or html5 local storage key | `"taboolaId"` (recommended) | |
| 40 | +| storage.type | Required | String | This is where the taboola user ID will be stored | `"cookie&html5"` (recommended) or `"html5"` | |
| 41 | +| storage.expires | Strongly Recommended | Number | How long (in days) the user ID information will be stored | `365` (recommended) | |
| 42 | + |
| 43 | +## Taboola ID Example |
| 44 | + |
| 45 | +```javascript |
| 46 | +pbjs.setConfig({ |
| 47 | + userSync: { |
| 48 | + userIds: [ |
| 49 | + { |
| 50 | + name: 'taboolaId', |
| 51 | + storage: { //Optionally specify where to store the ID, e.g. cookies or localStorage |
| 52 | + name: 'taboolaId', |
| 53 | + type: 'html5', // or 'html5&cookie' |
| 54 | + expires: 365 // days |
| 55 | + } |
| 56 | + } |
| 57 | + ] |
| 58 | + } |
| 59 | +}); |
| 60 | +``` |
0 commit comments