From 86ba581e1df4e9108ee30e22e04b5eaa39cf6441 Mon Sep 17 00:00:00 2001 From: David Reischer Date: Wed, 28 Jul 2021 14:06:15 +0200 Subject: [PATCH 1/3] Permutive RTD module docs --- dev-docs/modules/permutiveRtdProvider.md | 75 ++++++++++++++++++++++++ 1 file changed, 75 insertions(+) create mode 100644 dev-docs/modules/permutiveRtdProvider.md diff --git a/dev-docs/modules/permutiveRtdProvider.md b/dev-docs/modules/permutiveRtdProvider.md new file mode 100644 index 0000000000..3913c4dd41 --- /dev/null +++ b/dev-docs/modules/permutiveRtdProvider.md @@ -0,0 +1,75 @@ +--- +layout: page_v2 +title: Permutive Real Time Data Provider +display_name: Permutive Real Time Data Module +description: Permutive Real Time Data Module +page_type: module +module_type: rtd +module_code : permutiveRtdProvider +enable_download : true +sidebarType : 1 +--- + +# Permutive RTD Provider +{:.no_toc} + +* TOC +{:toc} + +## Overview +This submodule reads cohorts from Permutive and attaches them as targeting keys to bid requests. Using this module will deliver best targeting results, leveraging Permutive's real-time segmentation and modelling capabilities. + +## Usage +Compile the Permutive RTD module into your Prebid build: +``` +gulp build --modules=rtdModule,permutiveRtdProvider +``` + +> Note that the global RTD module, `rtdModule`, is a prerequisite of the Permutive RTD module. + +You then need to enable the Permutive RTD in your Prebid configuration, using the below format: + +```javascript +pbjs.setConfig({ + ..., + realTimeData: { + auctionDelay: 50, // optional auction delay + dataProviders: [{ + name: 'permutive', + waitForIt: true, // should be true if there's an `auctionDelay` + params: { + acBidders: ['appnexus'] + } + }] + }, + ... +}) +``` + +## Supported Bidders +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: + +{: .table .table-bordered .table-striped } +| Bidder | ID | Custom Cohorts | Audience Connector | +| ----------- | ---------- | -------------------- | ------------------ | +| Xandr | `appnexus` | Yes | Yes | +| Magnite | `rubicon` | Yes | No | +| Ozone | `ozone` | No | Yes | + +Key-values details for custom parameters: +* **Custom Cohorts:** 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. + +* **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. + + +## Parameters + +{: .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 bidders which should receive AC cohorts. | `[]` | +| params.maxSegs | Integer | Maximum number of cohorts to be included in either the `permutive` or `p_standard` key-value. | `500` | + From 0fe710a404ce9d9888f9eac9de45e38b639bc7f6 Mon Sep 17 00:00:00 2001 From: David Reischer Date: Mon, 9 Aug 2021 18:06:39 +0100 Subject: [PATCH 2/3] wording updates --- dev-docs/modules/permutiveRtdProvider.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/dev-docs/modules/permutiveRtdProvider.md b/dev-docs/modules/permutiveRtdProvider.md index 3913c4dd41..7c39fd5657 100644 --- a/dev-docs/modules/permutiveRtdProvider.md +++ b/dev-docs/modules/permutiveRtdProvider.md @@ -17,7 +17,7 @@ sidebarType : 1 {:toc} ## Overview -This submodule reads cohorts from Permutive and attaches them as targeting keys to bid requests. Using this module will deliver best targeting results, leveraging Permutive's real-time segmentation and modelling capabilities. +This module reads cohorts from Permutive and attaches them as targeting keys to bid requests. ## Usage Compile the Permutive RTD module into your Prebid build: @@ -70,6 +70,6 @@ Key-values details for custom parameters: | 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 bidders which should receive AC cohorts. | `[]` | +| params.acBidders | String[] | An array of bidders which should receive Audience Connector cohorts. | `[]` | | params.maxSegs | Integer | Maximum number of cohorts to be included in either the `permutive` or `p_standard` key-value. | `500` | From d6c7bad9041c14cb351f8c9d70c25e06484e766a Mon Sep 17 00:00:00 2001 From: David Reischer Date: Tue, 10 Aug 2021 10:26:29 +0100 Subject: [PATCH 3/3] wording update --- dev-docs/modules/permutiveRtdProvider.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dev-docs/modules/permutiveRtdProvider.md b/dev-docs/modules/permutiveRtdProvider.md index 7c39fd5657..059cdfb49a 100644 --- a/dev-docs/modules/permutiveRtdProvider.md +++ b/dev-docs/modules/permutiveRtdProvider.md @@ -57,7 +57,7 @@ The Permutive RTD module sets Audience Connector cohorts as bidder-specific `ort | Ozone | `ozone` | No | Yes | Key-values details for custom parameters: -* **Custom Cohorts:** 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. +* **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. * **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.