From 2ef141b1f62b584558e85c6e32f0a34073e69925 Mon Sep 17 00:00:00 2001 From: CKBrennan <69460288+CKBrennan@users.noreply.github.com> Date: Wed, 22 Jan 2025 14:02:20 +0100 Subject: [PATCH 1/6] Create overtoneRtdProvider.md --- dev-docs/modules/overtoneRtdProvider.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 dev-docs/modules/overtoneRtdProvider.md diff --git a/dev-docs/modules/overtoneRtdProvider.md b/dev-docs/modules/overtoneRtdProvider.md new file mode 100644 index 0000000000..e0af3cba4a --- /dev/null +++ b/dev-docs/modules/overtoneRtdProvider.md @@ -0,0 +1,14 @@ + --- + layout: page_v2 + title: Overtone RTD Provider + display_name: Overtone + description: Contextual data for publishers on brand safety, editorial type, emotional tone and custom models. + page_type: module + module_type: rtd + module_code : overtoneRtdProvider + enable_download : true + sidebarType : 1 + --- +**Overtone** + Contextual data for publishers on brand safety, editorial type, emotional tone and custom models. + Please contact tech@overtone.ai in order to be whitelisted for use of our API and to explore dozens of contextual signals. From 928d4b0495017cc8cefad4f91e22523175ec7eaf Mon Sep 17 00:00:00 2001 From: CKBrennan <69460288+CKBrennan@users.noreply.github.com> Date: Tue, 28 Jan 2025 11:15:46 +0100 Subject: [PATCH 2/6] Update overtoneRtdProvider.md Changed structure --- dev-docs/modules/overtoneRtdProvider.md | 102 ++++++++++++++++++++---- 1 file changed, 88 insertions(+), 14 deletions(-) diff --git a/dev-docs/modules/overtoneRtdProvider.md b/dev-docs/modules/overtoneRtdProvider.md index e0af3cba4a..a7e5bc783d 100644 --- a/dev-docs/modules/overtoneRtdProvider.md +++ b/dev-docs/modules/overtoneRtdProvider.md @@ -1,14 +1,88 @@ - --- - layout: page_v2 - title: Overtone RTD Provider - display_name: Overtone - description: Contextual data for publishers on brand safety, editorial type, emotional tone and custom models. - page_type: module - module_type: rtd - module_code : overtoneRtdProvider - enable_download : true - sidebarType : 1 - --- -**Overtone** - Contextual data for publishers on brand safety, editorial type, emotional tone and custom models. - Please contact tech@overtone.ai in order to be whitelisted for use of our API and to explore dozens of contextual signals. +# 1plusX Real-time Data Submodule + +## Overview + + Module Name: Overtone Rtd Provider + Module Type: Rtd Provider + Maintainer: tech@overtone.ai + +## Description + +The Overtone RTD module appends Contextual segments to the bidding object based on the Overtone taxonomy and custom metrics added by the publisher. Please contact tech@overtone.ai in order to be whitelisted for use of our API and to explore dozens of contextual signals. + +## Usage + + +To install and enable the Overtone RTD module, follow these steps: + +### Step 1: Prepare the base Prebid file + +* **Option 1**: Use Prebid [Download](https://docs.prebid.org/download.html) page to build the Prebid package. Ensure that you check the **Overtone Real-Time Data Module** checkbox. +* **Option 2**: From the command line, run `gulp build --modules=overtoneRtdProvider,...`. + +### Step 2: Configure the module + +### Configuration + +Use `setConfig` to instruct Prebid.js to initilize the Overtone RTD module, as specified below. + +This module is configured as part of the `realTimeData.dataProviders` + +```javascript +pbjs.setConfig({ + realTimeData: { + dataProviders: [{ + name: 'overtone', + params: { + apiKey: 'YOUR_API_KEY', + domains: ['example.com'], + timeout: 500 + } + }] + } +}); +``` + +| Name | Type | Description | Default | +| :------------------------ | :------------ | :--------------------------------------------------------------- |:----------------- | +| name | String | Real time data module name | Always 'overtone' | + | +| params | Object | | | +| params.apiKey | String | Your unique API key provided by Overtone | YOUR_API_KEY | +| params.domains | Array | Array of whitelisted domains for contextual analysis | | +| params.timeout | Integer | timeout (ms) | 500ms | + + + + +## Validation and Testing + +Validation of the Overtone RTD module is essential to ensure proper configuration. Use the provided test suite in the Prebid.js repository: + +File: `test/spec/modules/overtoneRtdProvider_spec.mjs` + +### Test Scenarios + +#### Successful Response + +**Input**: Valid domain with contextual data. + +**Expected Output**: Populated `categories` array with status `1`. + +#### Failed Request + +**Input**: Invalid domain or missing API key. + +**Expected Output**: Empty `categories` array with status `3`. + +#### Ignored URL + +**Input**: Domain not whitelisted by Overtone. + +**Expected Output**: Empty `categories` array with status `4`. + +--- + +## Support and Contact + +For questions, issues, or support, contact the Overtone technical team at **tech@overtone.ai**. From 14c5f8843a1563e7d7d9cca356ab1c2da712d01d Mon Sep 17 00:00:00 2001 From: CKBrennan <69460288+CKBrennan@users.noreply.github.com> Date: Tue, 28 Jan 2025 11:16:09 +0100 Subject: [PATCH 3/6] Update overtoneRtdProvider.md --- dev-docs/modules/overtoneRtdProvider.md | 1 - 1 file changed, 1 deletion(-) diff --git a/dev-docs/modules/overtoneRtdProvider.md b/dev-docs/modules/overtoneRtdProvider.md index a7e5bc783d..ba48c8d4c1 100644 --- a/dev-docs/modules/overtoneRtdProvider.md +++ b/dev-docs/modules/overtoneRtdProvider.md @@ -46,7 +46,6 @@ pbjs.setConfig({ | Name | Type | Description | Default | | :------------------------ | :------------ | :--------------------------------------------------------------- |:----------------- | | name | String | Real time data module name | Always 'overtone' | - | | params | Object | | | | params.apiKey | String | Your unique API key provided by Overtone | YOUR_API_KEY | | params.domains | Array | Array of whitelisted domains for contextual analysis | | From 7babea14e47ea746bcb761e54e0bd52135cb117f Mon Sep 17 00:00:00 2001 From: CKBrennan <69460288+CKBrennan@users.noreply.github.com> Date: Tue, 28 Jan 2025 11:16:47 +0100 Subject: [PATCH 4/6] Update overtoneRtdProvider.md --- dev-docs/modules/overtoneRtdProvider.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dev-docs/modules/overtoneRtdProvider.md b/dev-docs/modules/overtoneRtdProvider.md index ba48c8d4c1..b00e846b03 100644 --- a/dev-docs/modules/overtoneRtdProvider.md +++ b/dev-docs/modules/overtoneRtdProvider.md @@ -1,4 +1,4 @@ -# 1plusX Real-time Data Submodule +# Overtone Real-time Data Submodule ## Overview From fc255811eb5282c93967f413b544097727dfc3d2 Mon Sep 17 00:00:00 2001 From: CKBrennan <69460288+CKBrennan@users.noreply.github.com> Date: Mon, 10 Feb 2025 10:24:05 +0100 Subject: [PATCH 5/6] Update dev-docs/modules/overtoneRtdProvider.md Co-authored-by: Muki Seiler --- dev-docs/modules/overtoneRtdProvider.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dev-docs/modules/overtoneRtdProvider.md b/dev-docs/modules/overtoneRtdProvider.md index b00e846b03..0fcc6baf1c 100644 --- a/dev-docs/modules/overtoneRtdProvider.md +++ b/dev-docs/modules/overtoneRtdProvider.md @@ -8,7 +8,7 @@ ## Description -The Overtone RTD module appends Contextual segments to the bidding object based on the Overtone taxonomy and custom metrics added by the publisher. Please contact tech@overtone.ai in order to be whitelisted for use of our API and to explore dozens of contextual signals. +The Overtone RTD module appends Contextual segments to the bidding object based on the Overtone taxonomy and custom metrics added by the publisher. Please contact in order to be whitelisted for use of our API and to explore dozens of contextual signals. ## Usage From 0d64b1d7132f89be7bbe28e6cee0cc79928a133b Mon Sep 17 00:00:00 2001 From: CKBrennan <69460288+CKBrennan@users.noreply.github.com> Date: Mon, 10 Feb 2025 10:24:15 +0100 Subject: [PATCH 6/6] Update dev-docs/modules/overtoneRtdProvider.md Co-authored-by: Muki Seiler --- dev-docs/modules/overtoneRtdProvider.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/dev-docs/modules/overtoneRtdProvider.md b/dev-docs/modules/overtoneRtdProvider.md index 0fcc6baf1c..319b6dd079 100644 --- a/dev-docs/modules/overtoneRtdProvider.md +++ b/dev-docs/modules/overtoneRtdProvider.md @@ -11,8 +11,6 @@ The Overtone RTD module appends Contextual segments to the bidding object based on the Overtone taxonomy and custom metrics added by the publisher. Please contact in order to be whitelisted for use of our API and to explore dozens of contextual signals. ## Usage - - To install and enable the Overtone RTD module, follow these steps: ### Step 1: Prepare the base Prebid file