Class: VideoStitcherVodStreamRequest

  • VideoStitcherVodStreamRequest is a class used to define properties for on-demand video stream requests using Google Ad Manager's Video Stitcher.

  • It allows publishers to specify the content source URL (contentSourceUrl), ad tag URL (adTagUrl), and various authentication parameters like API key (apiKey) and OAuth token (oAuthToken).

  • This class inherits properties from StreamRequest, providing flexibility in configuring stream format, network code, and ad tag parameters.

  • It includes Video Stitcher-specific properties such as projectNumber, region, and session options (videoStitcherSessionOptions) for customized stream delivery.

  • Publishers can utilize vodConfigId for specifying configurations and use streamActivityMonitorId for debugging purposes within the stream activity monitor tool.

VideoStitcherVodStreamRequest

class   public

A class for specifying properties of the video stitcher vod stream request.

Constructor

VideoStitcherVodStreamRequest

new VideoStitcherVodStreamRequest(videoStitcherVodStreamRequest)

Constructor.

Parameter

videoStitcherVodStreamRequest

Optional

object that already has stream request properties assigned.
Extends
StreamRequest

Properties

adTagParameters

unknown

You can override a limited set of ad tag parameters on your stream request. Values added must be strings. 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.

Inherited from
StreamRequest#adTagParameters

adTagUrl

string

The ad tag url for the Video Stitcher.

apiKey

unknown

The stream request API key. It's configured through the DFP Admin UI and provided to the publisher to unlock their content. It verifies the applications that are attempting to access the content.

Inherited from
StreamRequest#apiKey

authToken

unknown

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.

Inherited from
StreamRequest#authToken

contentSourceUrl

string

The uri for publisher content. Required for on-demand streams.

format

unknown

The stream format to request. Accepts the following string values:

  • hls (default)
  • dash
Inherited from
StreamRequest#format

networkCode

unknown

The network code for the publisher making this stream request. Network codes are required for Pod serving stream requests (PodStreamRequest or PodVodStreamRequest) and Cloud stitching stream requests (VideoStitcherLiveStreamRequest or VideoStitcherVodStreamRequest) and are optional but recommended for Full service stream requests (LiveStreamRequest or VODStreamRequest). The code is used to apply settings selected in the Ad Manager UI such as programmatic limited ads enablement. For Pod serving and Cloud stitching it is also used to locate and play the stream. To find the network code, see this article.

Inherited from
StreamRequest#networkCode

oAuthToken

string

The OAuthToken to use for the Video Stitcher.

omidAccessModeRules

unknown

Settings object for mapping verification vendors to OMID Access Modes. Verification script URLs are internally matched against vendor provided regular expressions to resolve to an OmidVerificationVendor key. IMA then looks up the access mode for the given vendor using this object.

For script URLs that don't resolve to a known vendor, or if the resolved OmidVerificationVendor is not provided in this object, IMA will use the access mode provided for OmidVerificationVendor.OTHER. If OmidVerificationVendor.OTHER is not provided, then the LIMITED access mode will be used.

Inherited from
StreamRequest#omidAccessModeRules

projectNumber

string

The project number for the Video Stitcher.

region

string

The region to use for the Video Stitcher.

streamActivityMonitorId

unknown

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.

Inherited from
StreamRequest#streamActivityMonitorId

videoStitcherSessionOptions

(null or non-null Object with any type properties)

The session options are used to set Video Stitcher-specific parameters for this Video Stitcher stream request.

vodConfigId

string

The vod config id for the Video Stitcher.