From b6a0d5622868c469957c2945e1e5dcb3c650d036 Mon Sep 17 00:00:00 2001 From: Shiloh Date: Wed, 25 Sep 2024 15:14:38 -0700 Subject: [PATCH 1/2] updates config param to be opt in --- modules/qortexRtdProvider.js | 6 +++--- modules/qortexRtdProvider.md | 4 ++-- test/spec/modules/qortexRtdProvider_spec.js | 7 +++---- 3 files changed, 8 insertions(+), 9 deletions(-) diff --git a/modules/qortexRtdProvider.js b/modules/qortexRtdProvider.js index 0751da50541..182d6947e24 100644 --- a/modules/qortexRtdProvider.js +++ b/modules/qortexRtdProvider.js @@ -20,7 +20,7 @@ function init (config) { return false; } else { initializeModuleData(config); - if (!config?.params?.disableBidEnrichment) { + if (config?.params?.enableBidEnrichment) { logMessage('Requesting Qortex group configuration') getGroupConfig() .then(groupConfig => { @@ -324,10 +324,10 @@ export function initializeBidEnrichment() { * @param {Object} config module config obtained during init */ export function initializeModuleData(config) { - const {apiUrl, groupId, bidders, disableBidEnrichment} = config.params; + const {apiUrl, groupId, bidders, enableBidEnrichment} = config.params; const qortexUrlBase = apiUrl || DEFAULT_API_URL; const windowUrl = window.top.location.host; - qortexSessionInfo.bidEnrichmentDisabled = disableBidEnrichment !== null ? disableBidEnrichment : false; + qortexSessionInfo.bidEnrichmentDisabled = enableBidEnrichment !== null ? !enableBidEnrichment : true; qortexSessionInfo.bidderArray = bidders; qortexSessionInfo.impressionIds = new Set(); qortexSessionInfo.currentSiteContext = null; diff --git a/modules/qortexRtdProvider.md b/modules/qortexRtdProvider.md index a499f35d6c3..23c5570c3ec 100644 --- a/modules/qortexRtdProvider.md +++ b/modules/qortexRtdProvider.md @@ -69,5 +69,5 @@ pbjs.setConfig({ - If this parameter is not present, the Qortex integration can still be configured and loaded manually on your page outside of prebid. The RTD module will continue to initialize and operate as normal. -#### `disableBidEnrichment` - optional -- This optional parameter allows a publisher to opt out of the RTD module from using our API to enrich bids with first party data for contextuality \ No newline at end of file +#### `enableBidEnrichment` - optional +- This optional parameter allows a publisher to opt-in to the features of the RTD module that use our API to enrich bids with first party data for contextuality. Enabling this feature will allow this module to collect and send the content of the page (video, text, image, etc.) to our AI analysis server for indexing and analysis. Please use caution when adding this module to pages that may contain personal user data or proprietary information. \ No newline at end of file diff --git a/test/spec/modules/qortexRtdProvider_spec.js b/test/spec/modules/qortexRtdProvider_spec.js index 2c7fb85a0d6..49e6f7ea950 100644 --- a/test/spec/modules/qortexRtdProvider_spec.js +++ b/test/spec/modules/qortexRtdProvider_spec.js @@ -1,5 +1,4 @@ import * as utils from 'src/utils.js'; -import * as ajax from 'src/ajax.js'; import * as events from 'src/events.js'; import { EVENTS } from '../../../src/constants.js'; import {loadExternalScript} from 'src/adloader.js'; @@ -37,15 +36,15 @@ describe('qortexRtdProvider', () => { params: { groupId: defaultGroupId, apiUrl: defaultApiHost, - bidders: validBidderArray + bidders: validBidderArray, + enableBidEnrichment: true } } const bidEnrichmentDisabledModuleConfig = { params: { groupId: defaultGroupId, apiUrl: defaultApiHost, - bidders: validBidderArray, - disableBidEnrichment: true + bidders: validBidderArray } } const emptyModuleConfig = { From 223fd3d3765b08ba03dd12c1ffc4ddbfcc540160 Mon Sep 17 00:00:00 2001 From: Shiloh Date: Wed, 25 Sep 2024 15:19:18 -0700 Subject: [PATCH 2/2] update markdown --- modules/qortexRtdProvider.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/qortexRtdProvider.md b/modules/qortexRtdProvider.md index 23c5570c3ec..e6b8e89974e 100644 --- a/modules/qortexRtdProvider.md +++ b/modules/qortexRtdProvider.md @@ -12,7 +12,7 @@ Maintainer: mannese@qortex.ai The Qortex RTD module appends contextual segments to the bidding object based on the content of a page using the Qortex API. -If the `Qortex Group Id` provided during configuration is active and enabled for bid enrichment, the Qortex context API will analyze the bidder page (video, text, image, etc.) and will return a [Content object](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf#page=26). The module will then merge that object into the appropriate bidders' `ortb2.site.content`, which can be used by prebid adapters that use `site.content` data. +If the `Qortex Group Id` and module parameters provided during configuration is active and enabled for bid enrichment, the Qortex context API will analyze the bidder page and will return a [Content object](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf#page=26). The module will then merge that object into the appropriate bidders' `ortb2.site.content`, which can be used by prebid adapters that use `site.content` data. ## Build @@ -40,7 +40,7 @@ pbjs.setConfig({ params: { groupId: 'ABC123', //required bidders: ['qortex', 'adapter2'], //optional (see below) - disableBidEnrichment: false, //optional (see below) + enableBidEnrichment: true, //optional (see below) tagConfig: { // optional, please reach out to your account manager for configuration reccommendation videoContainer: 'string', htmlContainer: 'string', @@ -70,4 +70,4 @@ pbjs.setConfig({ - If this parameter is not present, the Qortex integration can still be configured and loaded manually on your page outside of prebid. The RTD module will continue to initialize and operate as normal. #### `enableBidEnrichment` - optional -- This optional parameter allows a publisher to opt-in to the features of the RTD module that use our API to enrich bids with first party data for contextuality. Enabling this feature will allow this module to collect and send the content of the page (video, text, image, etc.) to our AI analysis server for indexing and analysis. Please use caution when adding this module to pages that may contain personal user data or proprietary information. \ No newline at end of file +- This optional parameter allows a publisher to opt-in to the features of the RTD module that use our API to enrich bids with first party data for contextuality. Enabling this feature will allow this module to collect and send the contextual components of the page (meta, video, header, and paragraph tags) to our AI contextuality server for indexing and analysis. Please use caution when adding this module to pages that may contain personal user data or proprietary information. \ No newline at end of file