SSAIAdsRequest

Represents base IMA SSAI Ads request.

Inheritors

Properties

Link copied to clipboard
Link copied to clipboard
abstract val adsId: String?

An opaque identifier for associated ad playback state, or null if assetKey (for live) or videoId (for VOD) should be used as the ads identifier.

Link copied to clipboard
abstract val adTagParameters: Map<String, String>?

A map of extra parameters to pass to the ad server. Sets the overridable ad tag parameters on the stream request. Supply targeting parameters to your stream provides more information.

Link copied to clipboard
abstract var adTagUrl: String?
Link copied to clipboard
abstract val apiKey: String?

The stream request API key. This is used for content authentication. The API key is provided to the publisher to unlock their content. It's a security measure used to verify the applications that are attempting to access the content.

Link copied to clipboard
abstract val contentUrl: String?

The deep link to the content's screen. If provided, this parameter is passed to the OM SDK. See Android documentation for more information.

Link copied to clipboard
abstract val format: MediaType

The format MediaType.DASH or MediaType.HLS of the stream request.

Link copied to clipboard
abstract val languageTag: String?
Link copied to clipboard
abstract val loadMediaTimeoutMs: Int?
Link copied to clipboard
abstract val manifestSuffix: String?

The optional stream manifest's suffix, which will be appended to the stream manifest's URL. The provided string must be URL-encoded and must not include a leading question mark.

Link copied to clipboard
abstract val networkCode: String?

(optional but recommended) The network code for the Ad Manager account that owns the stream and is used to apply settings configured in the Ad Manager UI, such as programmatic limited ads enablement. To find the network code, see Find Ad Manager account information. (Your network code is a unique, numeric identifier for your Ad Manager network. This network code is not confidential as it appears in your page's Google Publisher Tags (GPT).)

Link copied to clipboard

The ID for debugging the stream with the stream activity monitor. This is used to provide a convenient way to allow publishers to find a stream log in the stream activity monitor tool.