Overview: The following information is pertaining to details how the IRIS.TV Contextual Video Marketplace activates contextual data to enable publishers to activate contextual private marketplace deals. This page covers how to pass both the asset’s contextual segments (“context”) and hashed IRIS.TV Content ID (“iris_id”) into the ad request.
Passing the “context” Values to the Ad Server:
Overview: Passing the “context” Values Received from IRIS.TV as a Custom Key-Value Pair into the Initial Ad Request
Prerequisite: Your ad server must support passing custom key-value pairs that flow through the demand chain using macros
It is expected to pass the segments as comma separated values to the “context” keyIn your ad server create a new custom key-value pair called “iris_context”.
Pass the “context” values from the IRIS.TV Context API as comma-separated values into the “iris_context” key.
Please consult your ad server’s documentation to learn how custom key-value pairs are passed in the ad request.
Example: Google Ad Manager (GAM)
In GAM,
...
key-value pairs are passed using the “cust_params” parameter either manually or through the IMA SDK.
To manually add “cust_params” to your GAM calls please consult the following documentation provided by Google: https://support.google.com/admanager/answer/1080597
[Note: it is required to encode certain characters
| Note |
|---|
Certain characters (ex = or &) must be encoded within the “cust_params” section |
...
. |
Please consult your specific IMA SDK documentation for specifics on add to add key-value pairs to the “cust_params” parameter.
Example of manual GAM ad request with “cust_params” populated [Note: this request has been simplified and truncated]:
...
iris_
...
context%3Dsport_basketball&sdkv=h.3.384.1&osd=2…
...
...
Passing the “iris_id” Value to the Ad Server:
Overview: Passing the “iris_id” Values Received from IRIS.TV as a Custom Key-Value Pair into the Initial Ad Request
Prerequisite: Your ad server must support passing custom key-value pairs that flow through the demand chain using macros.
In your ad server create a new custom key-value pair called “iris_id”.
Pass the “iris_id” values from the IRIS.TV Context API as a values into the “iris_id” key.
Please consult your ad server’s documentation to learn how custom key-value pairs are passed in the ad request.
Example: Google Ad Manager (GAM)
In GAM, key-value pairs are passed using the “cust_params” parameter either manually or through the IMA SDK.
To manually add “cust_params” to your GAM calls please consult the following documentation provided by Google: https://support.google.com/admanager/answer/1080597
| Note |
|---|
Certain characters (ex = or &) must be encoded within the “cust_params” section. |
Please consult your specific IMA SDK documentation for specifics on add to add key-value pairs to the “cust_params” parameter.
Example of manual GAM ad request with “cust_params” populated [Note: this request has been simplified and truncated]:
https://pubads.g.doubleclick.net/gampad/ads?iu=231779945/Ad_Unit_2&env=vp&gdfp_req=1&output=xml_vast4&sz=640x480&vid=6026440620001&cust_params=iris_id%3Diris_480ajfo0810&sdkv=h.3.384.1&osd=2…
After the Ad Server is Set Up
Once you’re successfully passing in the “iris_context” and “iris_id” key-value pairs for each ad call, move to Passing Contextual Data From the Ad Server to the SSP .