Skip to content

Latest commit

 

History

History
68 lines (47 loc) · 3.22 KB

qortexRtdProvider.md

File metadata and controls

68 lines (47 loc) · 3.22 KB

Qortex Real-time Data Submodule

Overview

Module Name: Qortex RTD Provider
Module Type: RTD Provider
Maintainer: [email protected]

Description

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 and module parameters provided during configuration is active, the Qortex context API will attempt to generate and return a Content object using indexed data from provided page content. 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

gulp build --modules="rtdModule,qortexRtdProvider,qortexBidAdapter,..."

rtdModule is a required module to use Qortex RTD module.

Configuration

Please refer to Prebid Documentation on RTD module configuration for details on required and optional parameters of realTimeData

When configuring Qortex as a data provider, refer to the template below to add the necessary information to ensure the proper connection is made.

RTD Module Setup

pbjs.setConfig({
    realTimeData: {
        auctionDelay: 1000,
        dataProviders: [{
            name: 'qortex',
            waitForIt: true,
            params: {
                groupId: 'ABC123', //required
                bidders: ['qortex', 'adapter2'], //optional (see below)
                enableBidEnrichment: true, //optional (see below)
                tagConfig: { } // optional, please reach out to your account manager for configuration reccommendation
            }
        }]
    }
});

Paramter Details

groupId - Required

  • The Qortex groupId linked to the publisher, this is required to make a request using this adapter

bidders - optional

  • If this parameter is included, it must be an array of the strings that match the bidder code of the prebid adapters you would like this module to impact. ortb2.site.content will be updated only for adapters in this array

  • If this parameter is omitted, the RTD module will default to updating ortb2.site.content on all bid adapters being used on the page

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 interact with the Qortex 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.

tagConfig - optional

  • This optional parameter is an object containing the config settings that could be usedto initialize the Qortex integration on your page. A preconfigured object for this step will be provided to you by the Qortex team.

  • 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.