From 5214fdffe9a1e87a15a60aab5bb05349d419332a Mon Sep 17 00:00:00 2001 From: captify-osoldatov Date: Mon, 14 Nov 2022 21:40:22 +0000 Subject: [PATCH 1/2] Add Captify RTD documentation --- dev-docs/modules/captifyRtdProvider.md | 75 ++++++++++++++++++++++++++ 1 file changed, 75 insertions(+) create mode 100644 dev-docs/modules/captifyRtdProvider.md diff --git a/dev-docs/modules/captifyRtdProvider.md b/dev-docs/modules/captifyRtdProvider.md new file mode 100644 index 0000000000..e060b15e31 --- /dev/null +++ b/dev-docs/modules/captifyRtdProvider.md @@ -0,0 +1,75 @@ +--- +layout: page_v2 +title: Captify RTD Module +display_name: Captify RTD Module +description: Captify Real Time Data Module +page_type: module +module_type: rtd +module_code : captifyRtdProvider +enable_download : true +vendor_specific: true +sidebarType : 1 +--- + +# Captify RTD Module +{:.no_toc} + +* TOC +{:toc} + +## Description + +Captify uses publisher first-party on-site search data to power machine learning algorithms to create a suite of +contextual based targeting solutions that activate in a cookieless environment. + +The RTD submodule allows bid requests to be classified by our live-classification service, +maximising value for publishers by increasing scale for advertisers. + +Segments will be attached to bid request objects sent to different SSPs in order to optimize targeting. + +Contact prebid@captify.tech for more information. +## Integration + +1) Compile the Captify RTD Module along with your bid adapter and other modules into your Prebid build: + + +``` +gulp build --modules="rtdModule,captifyRtdProvider,appnexusBidAdapter,..." +``` + +2) Use `setConfig` to instruct Prebid.js to initialize the Captify RTD module, as specified below. + +## Configuration + +This module is configured as part of the `realTimeData.dataProviders` + +```javascript +var TIMEOUT = 1500; // in milliseconds +pbjs.setConfig({ + realTimeData: { + auctionDelay: TIMEOUT, + dataProviders: [ + { + name: "CaptifyRTDModule", + waitForIt: true, + params: { + pubId: 123456, + bidders: ['appnexus'], + } + } + ] + } +}); +``` + +## Parameters + +{: .table .table-bordered .table-striped } +| Name |Type | Description |Mandatory | Notes | +| :--------------- | :------------ | :------------------------------------------------------------------ |:---------|:------------ | +| `name` | String | Real time data module name | yes | Always 'CaptifyRTDModule' | +| `waitForIt` | Boolean | Should be `true` if there's an `auctionDelay` defined (recommended) | no | Default `false` | +| `params` | Object | | | | +| `params.pubId` | Integer | Partner ID, required to get results and provided by Captify | yes | Use `123456` for tests, speak to your Captify account manager to receive your pubId | +| `params.bidders` | Array | List of bidders for which you would like data to be set | yes | Currently only 'appnexus' supported | +| `params.url` | String | Captify live-classification service url | no | Defaults to `https://live-classification.cpx.to/prebid-segments` From 3022d2fd6cd5cc4f8aa8228f8170052bc6dad093 Mon Sep 17 00:00:00 2001 From: captify-osoldatov Date: Thu, 24 Nov 2022 12:23:18 +0000 Subject: [PATCH 2/2] reduce timeout in example --- dev-docs/modules/captifyRtdProvider.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dev-docs/modules/captifyRtdProvider.md b/dev-docs/modules/captifyRtdProvider.md index e060b15e31..8249c453ba 100644 --- a/dev-docs/modules/captifyRtdProvider.md +++ b/dev-docs/modules/captifyRtdProvider.md @@ -44,7 +44,7 @@ gulp build --modules="rtdModule,captifyRtdProvider,appnexusBidAdapter,..." This module is configured as part of the `realTimeData.dataProviders` ```javascript -var TIMEOUT = 1500; // in milliseconds +var TIMEOUT = 100; // in milliseconds pbjs.setConfig({ realTimeData: { auctionDelay: TIMEOUT,