Skip to content

contxtfulRtdProvider.md

Latest commit

 

History

History
105 lines (77 loc) · 4.64 KB

contxtfulRtdProvider.md

File metadata and controls

105 lines (77 loc) · 4.64 KB

Overview

Module Name: Contxtful RTD Provider
Module Type: RTD Provider
Maintainer: contact@contxtful.com

Description

The Contxtful RTD module offers a unique feature—Receptivity. Receptivity is an efficiency metric, enabling the qualification of any instant in a session in real time based on attention. The core idea is straightforward: the likelihood of an ad’s success increases when it grabs attention and is presented in the right context at the right time.

To utilize this module, you need to register for an account with Contxtful. For inquiries, please reach out to contact@contxtful.com.

Build Instructions

To incorporate this module into your prebid.js, compile the module using the following command:

gulp build --modules=rtdModule,contxtfulRtdProvider,<other modules...>

Testing

To run the test server locally:

gulp serve --modules=rtdModule,contxtfulRtdProvider,<other modules...> --fix --nolint --notest
chrome http://localhost:9999/integrationExamples/gpt/contxtfulRtdProvider_example.html

To run the unit tests:

gulp test

To run the unit tests for a particular file:

gulp test --file "test/spec/modules/contxtfulRtdProvider_spec.js" --nolint

Configuration

Configure the contxtfulRtdProvider by passing the required settings through the setConfig function in prebid.js.

import pbjs from 'prebid.js';

pbjs.setConfig({
  "realTimeData": {
    "auctionDelay": 1000,
    "dataProviders": [
      {
        "name": "contxtful",
        "waitForIt": true,
        "params": {
          "version": "Contact contact@contxtful.com for the API version",
          "customer": "Contact contact@contxtful.com for the customer ID",
          "hostname": "api.receptivity.io", // Optional, default: "api.receptivity.io"
          "bidders": ["bidderCode1", "bidderCode", "..."], // list of bidders
          "adServerTargeting": true, // Optional, default: true
        }
      }
    ]
  }
});

Parameters

Name Type Scope Description
version String Required Specifies the version of the Contxtful Receptivity API.
customer String Required Your unique customer identifier.
hostname String Optional Target URL for CONTXTFUL external JavaScript file. Default is "api.receptivity.io". Changing default behaviour is not recommended. Please reach out to contact@contxtful.com if you experience issues.
adServerTargeting Boolean Optional Enables the getTargetingData to inject targeting value in ad units. Setting to true enables the feature, false disables the feature. Default is true
bidders Array Optional Setting this array enables Receptivity in the ortb2 object through getBidRequestData for all the listed bidders. Default is [] (an empty array). RECOMMENDED : Add all the active bidders like this ["bidderCode1", "bidderCode", "..."]

Usage: Injection in Ad Servers

The contxtfulRtdProvider module loads an external JavaScript file and authenticates with Contxtful APIs. The getTargetingData function then adds a ReceptivityState to each ad slot, which can have one of two values: Receptive or NonReceptive.

{
  "adUnitCode1": { "ReceptivityState": "Receptive" },
  "adUnitCode2": { "ReceptivityState": "Receptive" }
}

This module also integrates seamlessly with Google Ad Manager, ensuring that the ReceptivityState is available as early as possible in the ad serving process.

Usage: Injection in ortb2 for bidders

Setting the bidders field in the configuration parameters enables Receptivity in the ortb2 object through getBidRequestData for all the listed bidders. On a Bid Request Event, all bidders in the configuration will inherit the Receptivity data through ortb2 Default is [] (an empty array)

RECOMMENDED : Add all the bidders active like this ["bidderCode1", "bidderCode", "..."]

Links