Skip to content
Open
Changes from all commits
Commits
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
21 changes: 14 additions & 7 deletions dev-docs/modules/permutiveRtdProvider.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,13 +61,17 @@ as well as enabling settings for specific use cases mentioned above (e.g. acbidd

{: .table .table-bordered .table-striped }

| Name | Type | Description | Default |
| ---------------------- | -------------------- | --------------------------------------------------------------------------------------------- | ------------------ |
| name | String | This should always be `permutive` | - |
| waitForIt | Boolean | Should be `true` if there's an `auctionDelay` defined (optional) | `false` |
| params | Object | | - |
| params.acBidders | String[] | An array of bidder codes to share cohorts with in certain versions of Prebid, see below | `[]` |
| params.maxSegs | Integer | Maximum number of cohorts to be included in either the `permutive` or `p_standard` key-value. | `500` |
| Name | Type | Description | Default |
| ---------------------------------------------- | -------------------- | ---------------------------------------------------------------------------------------------- | --------------------------------------------------------------- |
| name | String | This should always be `permutive` | - |
| waitForIt | Boolean | Should be `true` if there's an `auctionDelay` defined (optional) | `false` |
| params | Object | | - |
| params.acBidders | String[] | An array of bidder codes to share cohorts with in certain versions of Prebid, see below | `[]` |
| params.maxSegs | Integer | Maximum number of cohorts to be included in either the `permutive` or `p_standard` key-value. | `500` |
| params.bidders | Object | Per-bidder configuration for custom cohort sources. Keys are bidder codes. | `{ msft: { customCohorts: { source: 'ls', key: '_papns' } } }` |
| params.bidders.\<bidder\>.customCohorts | Object | Custom cohorts source configuration for a specific bidder. | - |
| params.bidders.\<bidder\>.customCohorts.source | String | Storage type to read custom cohorts from. Currently only `'ls'` (localStorage) is supported. | - |
| params.bidders.\<bidder\>.customCohorts.key | String | The localStorage key to read custom cohorts from. | - |

### Context

Expand Down Expand Up @@ -132,11 +136,14 @@ Currently, bidders with known support for custom cohort targeting are:

* Xandr
* Magnite
* Microsoft (msft)

When enabling the respective Activation for a cohort in Permutive, this module will automatically attach that cohort ID to the bid request.
There is no need to enable individual bidders in the module configuration, it will automatically reflect which SSP integrations you have enabled in your Permutive dashboard.
Permutive cohorts will be sent in the permutive key-value.

**Note:** Publishers migrating from the `appnexus` bidder to `msft` should add `msft` to the `acBidders` array (or via the Permutive platform). The module automatically reads custom cohorts for `msft` from the same localStorage key used by `appnexus`.

### _Enabling Advertiser Cohorts_

If you are connecting to an Advertiser seat within Permutive to share Advertiser Cohorts, populate the acbidders config in the Permutive RTD with an array of bidder codes with whom you wish to share Advertiser Cohorts with.
Expand Down
Loading