Sirdata Real-time Data Module documentation (#2858)

* Create sirdataRtdProvider.md New Sirdata RTD Segmentation Module documentation * Update cmp-best-practices.md Added guidelines for Sirdata CMP
prebid · Apr 14, 2021 · fa0e7ec · fa0e7ec
1 parent 2061571
commit fa0e7ec
Show file tree

Hide file tree

Showing 2 changed files with 202 additions and 0 deletions.
diff --git a/dev-docs/cmp-best-practices.md b/dev-docs/cmp-best-practices.md
@@ -73,6 +73,10 @@ Please follow the guidelines in the [Didomi documentation](https://developers.di
 
 LiveRamp has verified that they create the tcfapi functions and set gdprApplies=false when their CMP is removed from a geo.
 
+### Sirdata
+
+Please follow the guidelines in the [Sirdata documentation](https://cmp.docs.sirdata.net/v/en/script-management/tag-conditioning) to make sure that the CMP is loaded and the user's choice exposed through the `__tcfapi()` function before the ad server and Prebid.js are invoked.
+
 ## Further Reading
 
 - [IAB TCF Implementation Guidelines](https://github.com/InteractiveAdvertisingBureau/GDPR-Transparency-and-Consent-Framework/blob/master/TCFv2/TCF-Implementation-Guidelines.md)

diff --git a/dev-docs/modules/sirdataRtdProvider.md b/dev-docs/modules/sirdataRtdProvider.md
@@ -0,0 +1,198 @@
+---
+layout: page_v2
+title: Sirdata Real Time Data Provider
+display_name: Sirdata Real-time Segmentation Module
+description: Sirdata Real-time Segmentation Module
+page_type: module
+module_type: rtd
+module_code : sirdataRtdProvider
+enable_download : true
+sidebarType : 1
+---
+
+# Sirdata RTD Segmentation Module
+{:.no_toc}
+
+* TOC
+{:toc}
+
+Sirdata provides a disruptive API that allows publishers and curating SSPs to leverage its cutting-edge contextualization technology and its audience segments based on cookies and consent or without cookies nor consent, even in Europe! 
+
+User-based segments and page-level automatic contextual categories will be attached to bid request objects sent to different SSPs in order to optimize targeting.
+
+Automatic or custom integration with Google Ad Manager and major bidders like Xandr/Appnexus, Smartadserver, Index Exchange, Proxistore, Magnite/Rubicon or Triplelift !
+
+User's country and choice management are included in the module, so it's 100% compliant with local and regional laws like GDPR and CCPA/CPRA.
+
+ORTB2 compliant and FPD support for Prebid versions < 4.29
+
+Please contact prebid@sirdata.com for more information.
+
+## Publisher Usage
+
+### Configure Prebid.js
+
+Compile the Sirdata RTD module into your Prebid build:
+
+`gulp build --modules=rtdModule,sirdataRtdProvider`
+
+Add the Sirdata RTD provider to your Prebid config.
+
+`actualUrl` MUST be set with actual location of parent page if prebid.js is loaded in an iframe (eg. postbid). It can be left blank ('') or removed otherwize.
+
+`partnerId` and `key` should be provided by your partnering SSP or get one and your dedicated taxonomy from Sirdata (prebid@sirdata.com). Segments ids (user-centric) and category ids (page-centric) will be provided salted and hashed : you can use them with a dedicated and private matching table. 
+
+Should you want to allow a SSP or a partner to curate your media and operate cross-publishers campaigns with our data, please ask Sirdata (prebid@sirdata.com) to whitelist him it in your account.
+
+#### Minimal configuration
+
+```
+pbjs.setConfig(
+    ...
+    realTimeData: {
+        auctionDelay: 1000,
+        dataProviders: [
+            {
+                name: "SirdataRTDModule",
+                waitForIt: true,
+                params: {
+                	partnerId: 1,
+                    key: 1,
+                }
+            }
+        ]
+    }
+    ...
+}
+```
+
+#### Advanced configuration
+
+```
+pbjs.setConfig(
+    ...
+    realTimeData: {
+        auctionDelay: 1000,
+        dataProviders: [
+            {
+                name: "SirdataRTDModule",
+                waitForIt: true,
+                params: {
+                    partnerId: 1,
+                    key: 1,
+                    setGptKeyValues: true,
+                    contextualMinRelevancyScore: 50, //Min score to filter contextual category globally (0-100 scale)
+                    actualUrl: '', //top location url, for contextual categories
+                    bidders: [{
+                        bidder: 'appnexus',
+                        adUnitCodes: ['adUnit-1','adUnit-2'],
+                        customFunction: overrideAppnexus,
+                        curationId: '111',
+                    },{
+                        bidder: 'ix',
+                        sizeLimit: 1200 //specific to Index Exchange,
+                        contextualMinRelevancyScore: 50, //Min score to filter contextual category for curation in the bidder (0-100 scale)
+                    }]
+                }
+            }
+        ]
+    }
+    ...
+}
+```
+
+### Parameter Descriptions for the Sirdata Configuration Section
+
+| Name  |Type | Description   | Notes  |
+| :------------ | :------------ | :------------ |:------------ |
+| name | String | Real time data module name | Mandatory. Always 'SirdataRTDModule' |
+| waitForIt | Boolean | Mandatory. Required to ensure that the auction is delayed until prefetch is complete | Optional. Defaults to false but recommended to true |
+| params | Object | | Optional |
+| params.partnerId | Integer | Partner ID, required to get results and provided by Sirdata. Use 1 for tests and get one running at prebid@sirdata.com | Mandatory. Defaults 1. |
+| params.key | Integer | Key linked to Partner ID, required to get results and provided by Sirdata. Use 1 for tests and get one running at prebid@sirdata.com | Mandatory. Defaults 1. |
+| params.setGptKeyValues | Boolean | This parameter Sirdata to set Targeting for GPT/GAM | Optional. Defaults to true. |
+| params.contextualMinRelevancyScore | Integer | Min score to keep filter category in the bidders (0-100 scale). Optional. Defaults to 30. |
+| params.bidders | Object | Dictionary of bidders you would like to supply Sirdata data for. | Optional. In case no bidder is specified Sirdata will atend to ad data custom and ortb2 to all bidders, adUnits & Globalconfig |
+
+Bidders can receive common setting :
+| Name  |Type | Description   | Notes  |
+| :------------ | :------------ | :------------ |:------------ |
+| bidder | String | Bidder name | Mandatory if params.bidders are specified |
+| adUnitCodes | Array of String | Use if you want to limit data injection to specified adUnits for the bidder | Optional. Default is false and data shared with the bidder isn't filtered |
+| customFunction | Function | Use it to override the way data is shared with a bidder | Optional. Default is false |
+| curationId | String | Specify the curation ID of the bidder. Provided by Sirdata, request it at prebid@sirdata.com | Optional. Default curation ids are specified for main bidders |
+| contextualMinRelevancyScore | Integer | Min score to filter contextual categories for curation in the bidder (0-100 scale). Optional. Defaults to 30 or global params.contextualMinRelevancyScore if exits. |
+| sizeLimit | Integer | used only for bidder 'ix' to limit the size of the get parameter in Index Exchange ad call | Optional. Default is 1000 |
+
+
+### Overriding data sharing function
+
+As indicated above, it is possible to provide your own bid augmentation functions. This is useful if you know a bid adapter's API supports segment fields which aren't specifically being added to request objects in the Prebid bid adapter.
+
+Please see the following example, which provides a function to modify bids for a bid adapter called ix and overrides the appnexus.
+
+```
+data Object format for usage in this kind of function :
+{
+	"segments":[111111,222222],
+	"contextual_categories":{"333333":100},
+	"shared_taxonomy":{
+		"27446":{ //CurationId
+			"segments":[444444,555555],
+			"contextual_categories":{"666666":100}
+		}
+	}
+}
+```
+
+```
+function overrideAppnexus (adUnit, segmentsArray, dataObject, bid) {
+	for (var i = 0; i < segmentsArray.length; i++) {
+        if (segmentsArray[i]) {
+            bid.params.user.segments.push(segmentsArray[i]);
+        }
+    }
+}
+
+pbjs.setConfig(
+    ...
+    realTimeData: {
+        auctionDelay: 1000,
+        dataProviders: [
+            {
+                name: "SirdataRTDModule",
+                waitForIt: true,
+                params: {
+                	partnerId: 1,
+                    key: 1,
+                	setGptKeyValues: true,
+                	contextualMinRelevancyScore: 50, //Min score to keep contextual category in the bidders (0-100 scale)
+                	actualUrl: actual_url, //top location url, for contextual categories
+                    bidders: [{
+                        bidder: 'appnexus',
+                        customFunction: overrideAppnexus,
+                        curationId: '111'
+                    },{
+                        bidder: 'ix',
+                        sizeLimit: 1200, //specific to Index Exchange
+                        customFunction: function(adUnit, segmentsArray, dataObject, bid) {
+                            bid.params.contextual.push(dataObject.contextual_categories);
+                        },
+                    }]
+                }
+            }
+        ]
+    }
+    ...
+}
+```
+
+### Testing
+
+To view an example of available segments returned by Sirdata's backends:
+
+`gulp serve --modules=rtdModule,sirdataRtdProvider,appnexusBidAdapter`
+
+and then point your browser at:
+
+`http://localhost:9999/integrationExamples/gpt/sirdataRtdProvider_example.html`