You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The Permutive RTD module sets Audience Connector cohorts as bidder-specific `ortb2.user.data` first-party data, following the Prebid `ortb2` convention, for any bidder included in `acBidders`. The module also supports bidder-specific data locations per ad unit (custom parameters) for the below bidders:
The parameters below provide configurability for general behaviours of the RTD submodule,
56
+
as well as enabling settings for specific use cases mentioned above (e.g. acbidders).
59
57
60
-
Key-values details for custom parameters:
61
-
***Custom Cohorts:** The module configuration will automatically reflect the SSP integrations (_Activations_) you have enabled in your Permutive dashboard. Any additional bidders you want to pass data to will need to be configured. Permutive cohorts will be sent in the permutive key-value.
58
+
## Parameters
62
59
63
-
***Audience Connector:** You'll need to define which bidders should receive Audience Connector cohorts. You need to include the `ID` of any bidder in the `acBidders` array. Audience Connector cohorts will be sent in the `p_standard` key-value.
| name | String | This should always be `permutive`| - |
64
+
| waitForIt | Boolean | Should be `true` if there's an `auctionDelay` defined (optional) |`false`|
65
+
| params | Object || - |
66
+
| params.acBidders | String[]| An array of bidders which should receive Audience Connector cohorts. |`[]`|
67
+
| params.maxSegs | Integer | Maximum number of cohorts to be included in either the `permutive` or `p_standard` key-value. |`500`|
68
+
| params.transformations | Object[]| An array of configurations for ORTB2 user data transformations ||
64
69
70
+
##### The `transformations` parameter
65
71
66
-
## Parameters
72
+
This array contains configurations for transformations we'll apply to the Permutive object in the ORTB2 `user.data` array. The results of these transformations will be appended to the `user.data` array that's attached to ORTB2 bid requests.
| IAB taxonomies | iab |```{ segtax: number, iabIds: Object<number, number>}```| Transform segment IDs from Permutive to IAB (note: alpha version, subject to change) |
80
+
81
+
#### Context
82
+
83
+
Permutive is not listed as a TCF vendor as all data collection is on behalf of the publisher and based on consent the publisher has received from the user.
84
+
Rather than through the TCF framework, this consent is provided to Permutive when the user gives the relevant permissions on the publisher website which allow the Permutive SDK to run.
85
+
This means that if GDPR enforcement is configured _and_ the user consent isn’t given for Permutive to fire, no cohorts will populate.
86
+
As Prebid utilizes TCF vendor consent, for the Permutive RTD module to load, Permutive needs to be labeled within the Vendor Exceptions
87
+
88
+
#### Instructions
89
+
90
+
1. Publisher enables GDPR rules within Prebid.
91
+
2. Label Permutive as an exception, as shown below.
92
+
```javascript
93
+
[
94
+
{
95
+
purpose:'storage',
96
+
enforcePurpose:true,
97
+
enforceVendor:true,
98
+
vendorExceptions: ["permutive"]
99
+
},
100
+
{
101
+
purpose:'basicAds',
102
+
enforcePurpose:true,
103
+
enforceVendor:true,
104
+
vendorExceptions: []
105
+
}
106
+
]
107
+
```
108
+
109
+
Before making any updates to this configuration, please ensure that this approach aligns with internal policies and current regulations regarding consent.
110
+
111
+
## Cohort Activation with Permutive RTD Module
112
+
113
+
### _Enabling Standard Cohorts_
114
+
115
+
**Note**: Publishers must be enabled on the above Permutive RTD Submodule to enable Standard Cohorts.
116
+
117
+
The acbidders config in the Permutive RTD module allows publishers to determine which demand partners (SSPs) will receive standard cohorts via the <u>user.data</u> ortb2 object. Cohorts will be sent in the `p_standard` key-value.
118
+
119
+
The Permutive RTD module sets standard cohort IDs as bidder-specific ortb2.user.data first-party data, following the Prebid ortb2 convention.
120
+
121
+
There are **two** ways to assign which demand partner bidders (e.g. SSPs) will receive Standard Cohort information via the Audience Connector (acbidders) config:
122
+
123
+
#### Option 1 - Automated
124
+
125
+
New demand partner bidders may be added to the acbidders config directly within the Permutive Platform.
126
+
127
+
**Permutive can do this on your behalf**. Simply contact your Permutive CSM with [email protected] on cc,
128
+
indicating which bidders you would like added.
129
+
130
+
Or, a publisher may do this themselves within the UI using the below instructions.
131
+
132
+
##### Create Integration
133
+
134
+
In order to update acbidders via the Permutive dashboard,
135
+
it is necessary to first enable the prebid integration in the integrations page (settings).
Acbidders can be added or removed from the list using this feature, however, this will not impact any acbidders that have been applied using the manual method below.
152
+
153
+
#### Option 2 - Manual
154
+
155
+
As a secondary option, new demand partner bidders may be added manually.
156
+
157
+
To do so, a Publisher may define which bidders should receive Standard Cohorts by
158
+
including the _bidder code_ of any bidder in the `acBidders` array.
159
+
160
+
**Note:** If a Publisher ever needs to remove a manually-added bidder, the bidder will also need to be removed manually.
161
+
162
+
### _Enabling Custom Cohort IDs for Targeting_
163
+
164
+
Separately from Standard Cohorts - The Permutive RTD module also supports passing any of the **custom** cohorts created in the dashboard to some SSP partners for targeting
165
+
e.g. setting up publisher deals. For these activations, cohort IDs are set in bidder-specific locations per ad unit (custom parameters).
166
+
167
+
Currently, bidders with known support for custom cohort targeting are:
168
+
169
+
- Xandr
170
+
- Magnite
76
171
172
+
When enabling the respective Activation for a cohort in Permutive, this module will automatically attach that cohort ID to the bid request.
173
+
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.
174
+
Permutive cohorts will be sent in the permutive key-value.
0 commit comments