StreamRequest

interface StreamRequest : BaseRequest


An object containing the data used to request a stream with server-side ad insertion.

Summary

Nested types

Enum of possible stream formats.

Public functions

(Mutable)Map<String!, String!>?

Returns any parameters that the SDK will attempt to add to ad tags based on a call to setAdTagParameters().

String?

Returns the ad tag associated with this stream request.

String!

Returns the API key for the ad server.

String?

Returns the asset key for server-side ad insertion streams.

String!

Returns the stream request authorization token.

String?

Returns the content source ID for video on demand server-side ad insertion streams.

String?

Returns the source of the content for this stream request.

String?

Returns the custom asset key for a pod serving request.

StreamRequest.StreamFormat!

Returns the format of the stream request.

String!

Returns the suffix that the SDK will append to the query of the stream manifest URL.

String?

Returns the network code of the request.

String?

Returns the video ID for video on demand server-side ad insertion streams.

(Mutable)Map<String!, Any!>?

Returns the associated Video Stitcher-specific session options for a Video Stitcher stream request.

String?

The vodConfig ID for the VOD stream, as set up on the Video Stitcher.

Unit
setAdTagParameters(adTagParameters: (Mutable)Map<String!, String!>!)

Sets the overridable ad tag parameters on the stream request.

Unit
setAuthToken(authToken: String!)

Sets the stream request authorization token.

Unit

Sets the format of the stream request.

Unit
setManifestSuffix(manifestSuffix: String!)

Sets the stream manifest's suffix, which will be appended to the stream manifest's URL.

Unit
setStreamActivityMonitorId(streamActivityMonitorId: String!)

Sets the ID to be used to debug the stream with the stream activity monitor.

Unit
setVideoStitcherSessionOptions(
    videoStitcherSessionOptions: (Mutable)Map<String!, Any!>!
)

Sets Video Stitcher-specific session options for a Video Stitcher stream request.

Inherited functions

From com.google.ads.interactivemedia.v3.api.BaseRequest
String!

Returns the deep link to the content's screen provided in setContentUrl()

SecureSignals?

Returns the Secure Signals with custom data

Any!

Returns the user-provided object that is associated with the request.

Unit

Specifies the deep link to the content's screen.

Unit

Specifies the Secure Signals with custom data for this request.

Unit
setUserRequestContext(userRequestContext: Any!)

Sets the user-provided object that is associated with the request.

Public functions

getAdTagParameters

fun getAdTagParameters(): (Mutable)Map<String!, String!>?

Returns any parameters that the SDK will attempt to add to ad tags based on a call to setAdTagParameters(). This method will return null unless setAdTagParameters was called with some value(s).

getAdTagUrl

fun getAdTagUrl(): String?

Returns the ad tag associated with this stream request. Returns null for all stream requests other than cloud based video on demand request.

getApiKey

fun getApiKey(): String!

Returns the API key for the ad server.

getAssetKey

fun getAssetKey(): String?

Returns the asset key for server-side ad insertion streams. Returns null for video on demand streams and pod streams.

getAuthToken

fun getAuthToken(): String!

Returns the stream request authorization token.

getContentSourceId

fun getContentSourceId(): String?

Returns the content source ID for video on demand server-side ad insertion streams. Returns null for live streams and pod streams.

getContentSourceUrl

fun getContentSourceUrl(): String?

Returns the source of the content for this stream request. Returns null for all stream requests other than cloud based video on demand request

getCustomAssetKey

fun getCustomAssetKey(): String?

Returns the custom asset key for a pod serving request. Returns null for live and video on demand streams.

getFormat

fun getFormat(): StreamRequest.StreamFormat!

Returns the format of the stream request.

getManifestSuffix

fun getManifestSuffix(): String!

Returns the suffix that the SDK will append to the query of the stream manifest URL.

getNetworkCode

fun getNetworkCode(): String?

Returns the network code of the request.

getVideoId

fun getVideoId(): String?

Returns the video ID for video on demand server-side ad insertion streams. Returns null for live and pod streams.

getVideoStitcherSessionOptions

fun getVideoStitcherSessionOptions(): (Mutable)Map<String!, Any!>?

Returns the associated Video Stitcher-specific session options for a Video Stitcher stream request. This method will return null unless setVideoStitcherSessionOptions was called with some value(s).

getVodConfigId

fun getVodConfigId(): String?

The vodConfig ID for the VOD stream, as set up on the Video Stitcher.

setAdTagParameters

fun setAdTagParameters(adTagParameters: (Mutable)Map<String!, String!>!): Unit

Sets the overridable ad tag parameters on the stream request. Supply targeting parameters to your stream provides more information.

You can use the dai-ot and dai-ov parameters for stream variant preference. See Override Stream Variant Parameters for more information.

setAuthToken

fun setAuthToken(authToken: String!): Unit

Sets the stream request authorization token. Used in place of the API key for stricter content authorization. The publisher can control individual content streams authorizations based on this token.

setFormat

fun setFormat(format: StreamRequest.StreamFormat!): Unit

Sets the format of the stream request.

setManifestSuffix

fun setManifestSuffix(manifestSuffix: String!): Unit

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

setStreamActivityMonitorId

fun setStreamActivityMonitorId(streamActivityMonitorId: String!): Unit

Sets the ID to be used to debug 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.

setVideoStitcherSessionOptions

fun setVideoStitcherSessionOptions(
    videoStitcherSessionOptions: (Mutable)Map<String!, Any!>!
): Unit

Sets Video Stitcher-specific session options for a Video Stitcher stream request.