Skip to content

Commit e006ecb

Browse files
AntonioGargaroclaude
AntonioGargaro
and
claude
authored
Permutive RTD: document msft bidder custom cohort support (#6522)
* docs: update permutiveRtdProvider.md for msft bidder custom cohorts Add msft to supported custom cohort bidders list, document the new params.bidders configuration, and note the appnexus-to-msft migration path. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: align markdown table columns to pass MD060 lint rule Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * remove hardcoded msft default from docs, add publisher config example Mirrors the code change in Prebid.js PR #14655. The params.bidders default is now {} and publishers must explicitly configure msft custom cohort sources. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 8c22be4 commit e006ecb

1 file changed

Lines changed: 25 additions & 7 deletions

File tree

‎dev-docs/modules/permutiveRtdProvider.md‎

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,13 +61,17 @@ as well as enabling settings for specific use cases mentioned above (e.g. acbidd
6161

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

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

7276
### Context
7377

@@ -132,11 +136,25 @@ Currently, bidders with known support for custom cohort targeting are:
132136

133137
* Xandr
134138
* Magnite
139+
* Microsoft (msft)
135140

136141
When enabling the respective Activation for a cohort in Permutive, this module will automatically attach that cohort ID to the bid request.
137142
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.
138143
Permutive cohorts will be sent in the permutive key-value.
139144

145+
**Note:** Publishers migrating from the `appnexus` bidder to `msft` need to configure the `params.bidders` object so the module knows where to read custom cohorts from. The Permutive SDK writes `msft` custom cohorts to the same localStorage key used by `appnexus` (`_papns`), so publishers should add the following to their Permutive RTD config:
146+
147+
```javascript
148+
params: {
149+
acBidders: ['msft'],
150+
bidders: {
151+
msft: {
152+
customCohorts: { source: 'ls', key: '_papns' }
153+
}
154+
}
155+
}
156+
```
157+
140158
### _Enabling Advertiser Cohorts_
141159

142160
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.

0 commit comments

Comments
 (0)