Class VODStreamRequest

Extends StreamRequest
A class for specifying properties of the VOD stream request.
Constructors
constructor
Properties
adTagParameters
You can override a limited set of ad tag parameters on your stream request.
apiKey
The stream request API key.
authToken
The stream request authorization token.
contentSourceId
Unique identifier for the publisher content, from a content management system (CMS).
enableNonce
Enables the addition of a nonce to the request.
format
The stream format to request.
networkCode
The stream request network code.
omidAccessModeRules
Settings object for mapping verification vendors to OMID Access Modes.
streamActivityMonitorId
The ID to be used to troubleshoot the stream with the stream activity monitor.
videoId
Identifier for the video content source.

Constructors

constructor

new VODStreamRequest(): VODStreamRequest

Properties

adTagParameters

adTagParameters: {
  [key: string]: string;
}
You can override a limited set of ad tag parameters on your stream request. Values added must be strings. For details, see Supply targeting parameters to your stream. You can use the dai-ot and dai-ov parameters for stream variant preference. For details, see Override Stream Variant Parameters.

apiKey

apiKey: string
The stream request API key. Configure your stream API key in the Google Ad Manager UI. For details, see Authenticate DAI video stream requests. Using the API key authenticates applications that attempt to access the stream.

authToken

authToken: string
The stream request authorization token. Used in place of the API key for more secure content authorization. You can control individual content streams authorizations based on this token.

contentSourceId

contentSourceId: string
Unique identifier for the publisher content, from a content management system (CMS). Required for on-demand streams.

enableNonce

enableNonce: boolean
Enables the addition of a nonce to the request. You must set this parameter to transmit monetization signals to Google servers when you request ads server side from a third-party server. Defaults to a false value.

format

format: StreamFormat
The stream format to request. Accepts the following string values:
  • hls (default)
  • dash

networkCode

networkCode: string
The stream request network code. To find the network code, see Find Google Ad Manager account information.

omidAccessModeRules

omidAccessModeRules: {
  [key: string]: OmidAccessMode;
}
Settings object for mapping verification vendors to OMID Access Modes. The keys must be values from the OmidVerificationVendor enum, and the values must be values from the OmidAccessMode enum.

streamActivityMonitorId

streamActivityMonitorId: string
The ID to be used to troubleshoot the stream with the stream activity monitor. Use this ID to find a stream log in the stream activity monitor tool.

videoId

videoId: string
Identifier for the video content source. Required for on-demand streams.