Passing Contextual Data to your SSPs
      Back to home
      1. Knowledge Base and Documentation
      2. IRIS-enabled™ Contextual Data: Publishers
      3. Passing Contextual Data to your SSPs

      GumGum SSP: Passing Contextual Data

      This document details how publishers can transmit the IRIS ID to GumGum in OpenRTB, Prebid, and Amazon TAM integrations for video ad requests.

      GumGum SSP maps the IRIS ID to contextual and brand safety/suitability contextual segments for ad targeting. Note there is no need to pass IRIS contextual categories in addition to the IRIS ID.

      OpenRTB Integration

      There are 2 options for passing the IRIS ID in an OpenRTB bid request: using the content.id field or using Seller Defined Context.

      Option 1: content.id

      Code

      Description

      		 
      content : {
          id: "iris_6f9285823a48bne5",
          ...
          context: 1
      }

      The content.id field is described in section 3.2.16 of the OpenRTB Specification 2.6.

      Option 2: Seller Defined Context

      Code

      Description

      		 
      content : {
          "data": [
              {
                "name": "iris.tv",
                "ext": {
                  "segtax": 501,
                  "cids": [
                    "iris_6f9285823a48bne5"
                  ]
                }
              }
            ]
      }

      The IRIS ID can be specified In the content.data.ext.cids object of OpenRTB 2.6 bid requests per the Extended Content IDs extension. Also see the Taxonomy and Data Transparency Standards to Support Seller-defined Audience and Context Signaling.

      Prebid.js Integration

      This section assumes that GumGum is already configured as a bidder with the Publisher’s Prebid.js platform (as described in the Prebid.js Header Bidding Integration Guide – available on request from your GumGum Account Manager).

      Each Publisher page that takes part in header bidding includes Prebid.js ad unit code. See the example adUnits code and description below:To specify the IRIS ID, add an IRIS.TV parameter to the Prebid.js code on the webpage where the auction is running: 

      Code

      Description

      		 
      var adUnits = [
         {
            code: slot.code,
            mediaTypes: {
               ...
            },
            bids: [{
               bidder: 'gumgum',
               params: {
                   ...
               }
            }]
         },
         {...}
      ];

      bids           

      Array of bidders, including:

      • IDs of bidders allowed to bid for ads on the page. 
      • Parameters containing information passed to the bidders. Optional IRIS.TV parameters can be added here.
        For detailed parameter information, refer to the OpenRTB Specification 2.5.
      1. Locate the bidder: 'gumgum' parameters.
      2. Add the video’s unique IRIS ID in an irisid field, for example 
        bids: [{
            bidder: 'gumgum',
            params: {
              zone / pubId: 'ggumtest',     // Your zone or pubId
              irisid: 'iris_6f9285823a48bne5',
            }
          }
        }]

      Amazon TAM

      Publishers using an Amazon TAM integration can send an IRIS.TV parameter to the APS tag from the client-side. The parameter is forwarded to bidders within the server-side bid request. 

      To configure the IRIS ID for a video, modify the APS apstag code for the video unit. Follow these steps: 

         1.    Within the apstag.fetchBids method, look for the slots array of objects. 
         2.    Locate the slotID for the video unit you want to configure, for example:
      apstag.fetchBids({
          slots: [
            {
              slotID: 'VideoSlot1',    //Slot div ID
              mediaType: 'video'
            },
          ...
          ],
        ...
      },  function(bids){...}
      );
         3.    Add a slotParams object to the video unit.
         4.    Set a key-value pair with key as 'irisid' and the value as the unique IRIS ID for the video, for  example 'iris_6f9285823a48bne5'. 
      apstag.fetchBids({
          slots: [
            {
              slotID: 'VideoSlot1',    //Slot div ID
              mediaType: 'video',
              slotParams: {
                  'irisid': 'iris_6f9285823a48bne5'
              }
           },
        ...
        ],
        ...
      },  function(bids){...}
      );

      As a result, the IRIS ID will be transmitted to GumGum in the imp.ext.irisid object:

      imp : {
          ext : {
              irisid: "iris_6f9285823a48bne5"
          }
      }