Skip to main content
Version: v1

Ad targeting parameters

With the Google DAI Pod Serving, there is the possibility to pass a limited set of ad targeting parameters on your stream request to personalize your streams. In the player you can easily pass these parameters as key-value pairs via the TheoAdDescription.

note

The player will automatically add the custom parameter theoads_slot in the cust_params field when requesting an ad. The value of this parameter will be determined by the layout mode.

Web SDK​

For the Web SDK, you can set your desired ad tag parameters via adTagParameters in the TheoAdDescription as followed:

player.source = {
  sources: {
    src: 'PATH-TO-SIGNALING-SERVER/hls/MANIFEST-URI',
    type: 'application/x-mpegurl',
    hlsDateRange: true,
  },
  ads: [
    {
      integration: 'theoads',
      networkCode: 'NETWORK-CODE',
      customAssetKey: 'CUSTOM-ASSET-KEY',
      adTagParameters: {
        "YOUR-AD-TAG-PARAMETER-1" : "VALUE-1", // e.g. "cust_params" : "YOUR-CUSTOM-PARAMETERS",
        "YOUR-AD-TAG-PARAMETER-2" : "VALUE-2",
        ...
      }
    },
  ],
};

React Native SDK​

For the React Native SDK, you can set your desired ad tag parameters via adTagParameters in the TheoAdDescription as followed:

player.source = {
  sources: {
    src: 'PATH-TO-SIGNALING-SERVER/hls/MANIFEST-URI',
    type: 'application/x-mpegurl',
    hlsDateRange: true,
  },
  ads: [
    {
      integration: 'theoads',
      networkCode: 'NETWORK-CODE',
      customAssetKey: 'CUSTOM-ASSET-KEY',
      adTagParameters: {
        "YOUR-AD-TAG-PARAMETER-1" : "VALUE-1", // e.g. "cust_params" : "YOUR-CUSTOM-PARAMETERS",
        "YOUR-AD-TAG-PARAMETER-2" : "VALUE-2",
        ...
      }
    },
  ],
};

Android SDK​

For the Android SDK, you can set your desired ad tag parameters via adTagParameters in the TheoAdDescription as followed:

theoPlayerView.player.source = SourceDescription.Builder(
    TypedSource.Builder("PATH-TO-SIGNALING-SERVER/hls/MANIFEST-URI")
        .type(SourceType.HLS)
        .hlsDateRange(true)
        .build()
).ads(
    TheoAdDescription(
        networkCode = "NETWORK-CODE",
        customAssetKey = "CUSTOM-ASSET-KEY",
        adTagParameters = mapOf(
            "YOUR-AD-TAG-PARAMETER-1" to "VALUE-1",
            "YOUR-AD-TAG-PARAMETER-2" to "VALUE-2"
        )
    )
)
.build()

iOS SDK​

For the iOS SDK, you can set your desired ad tag parameters via adTagParameters in the THEOAdDescription as followed:

let theoad = THEOAdDescription(
    networkCode: "NETWORK-CODE",
    customAssetKey: "CUSTOM-ASSET-KEY",
    adTagParameters: [
        "YOUR-AD-TAG-PARAMETER-1" : "VALUE-1",
        "YOUR-AD-TAG-PARAMETER-2" : "VALUE-2"
    ]
)
let sourceDescription = SourceDescription(source: typedSource, ads: [theoad])
self.theoplayer.source = sourceDescription

More information​