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.
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.
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.
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.
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.
[null,null,["Last updated 2025-08-20 UTC."],[[["\u003cp\u003e\u003ccode\u003eVODStreamRequest\u003c/code\u003e is a class used for defining properties of video-on-demand stream requests, extending the \u003ccode\u003eStreamRequest\u003c/code\u003e class.\u003c/p\u003e\n"],["\u003cp\u003eIt includes properties like \u003ccode\u003econtentSourceId\u003c/code\u003e and \u003ccode\u003evideoId\u003c/code\u003e, which are mandatory for on-demand streams and identify the content source.\u003c/p\u003e\n"],["\u003cp\u003eThis class inherits properties from \u003ccode\u003eStreamRequest\u003c/code\u003e, including \u003ccode\u003eapiKey\u003c/code\u003e, \u003ccode\u003eauthToken\u003c/code\u003e, \u003ccode\u003eadTagParameters\u003c/code\u003e, \u003ccode\u003eformat\u003c/code\u003e, and others for managing stream authorization, ad parameters, and format.\u003c/p\u003e\n"],["\u003cp\u003ePublishers can utilize \u003ccode\u003econtentSourceId\u003c/code\u003e for content management and \u003ccode\u003evideoId\u003c/code\u003e to identify video content, both essential for on-demand stream requests.\u003c/p\u003e\n"],["\u003cp\u003eWhile inheriting various properties from \u003ccode\u003eStreamRequest\u003c/code\u003e, \u003ccode\u003eVODStreamRequest\u003c/code\u003e focuses on the specifics of on-demand video streaming, including content identification and authorization.\u003c/p\u003e\n"]]],["The `VODStreamRequest` class manages properties for on-demand video stream requests. Key actions include setting `contentSourceId` and `videoId` for content identification. Publishers can override ad tag parameters, including `dai-ot` and `dai-ov` for stream variant preferences. It allows configuration of `apiKey` or `authToken` for content access and authorization. The `format` property allows for selecting `hls` or `dash`. Additionally, you can provide `networkCode` and determine if `senderCanSkip` is enabled for skippable ads.\n"],null,["# Class: VODStreamRequest\n\nVODStreamRequest\n================\n\nclass public\n\nA class for specifying properties of the VOD stream request.\n\nConstructor\n-----------\n\n### VODStreamRequest\n\nnew\nVODStreamRequest()\n\nExtends\n: [StreamRequest](/ad-manager/dynamic-ad-insertion/sdk/cast/reference/js/StreamRequest)\n\nProperties\n----------\n\n### adTagParameters\n\nunknown\n\nYou can override a limited set of ad tag parameters on your stream\nrequest. Values added must be strings.\n[Supply targeting parameters to your stream](//support.google.com/dfp_premium/answer/7320899) provides more information.\nYou can use the dai-ot and dai-ov parameters for stream variant\npreference.\nSee [Override Stream Variant Parameters](//support.google.com/dfp_premium/answer/7320898) for more information.\n\nInherited from\n: [StreamRequest#adTagParameters](/ad-manager/dynamic-ad-insertion/sdk/cast/reference/js/StreamRequest#adTagParameters)\n\n### apiKey\n\nunknown\n\nThe stream request API key. It's configured through the\n[DFP Admin UI](//support.google.com/dfp_premium/answer/6381445) and provided to the publisher to unlock their content.\nIt verifies the applications that are attempting to access the content.\n\nInherited from\n: [StreamRequest#apiKey](/ad-manager/dynamic-ad-insertion/sdk/cast/reference/js/StreamRequest#apiKey)\n\n### authToken\n\nunknown\n\nThe stream request authorization token. Used in place of the API key\nfor stricter content authorization. The publisher can control individual\ncontent streams authorizations based on this token.\n\nInherited from\n: [StreamRequest#authToken](/ad-manager/dynamic-ad-insertion/sdk/cast/reference/js/StreamRequest#authToken)\n\n### consentSettings\n\nunknown\n\nSettings related to regulations and consent.\n\nInherited from\n: [StreamRequest#consentSettings](/ad-manager/dynamic-ad-insertion/sdk/cast/reference/js/StreamRequest#consentSettings)\n\n### contentSourceId\n\nstring\n\nUnique identifier for the publisher content, from a CMS. Required for\non-demand streams.\n\n### format\n\nunknown\n\nThe stream format to request. Accepts the following string values:\n\n- `hls` (default)\n- `dash`\n\n. If an invalid string is provided, the default value will be used. Note: Values must be lowercase.\n\nInherited from\n: [StreamRequest#format](/ad-manager/dynamic-ad-insertion/sdk/cast/reference/js/StreamRequest#format)\n\n### networkCode\n\nunknown\n\nThe network code for the publisher making this stream request. Network\ncodes are required for Pod serving stream requests (PodStreamRequest or\nPodVodStreamRequest) and Cloud stitching stream requests\n(VideoStitcherLiveStreamRequest or VideoStitcherVodStreamRequest) and\nare optional but recommended for Full service stream requests\n(LiveStreamRequest or VODStreamRequest). The code is used to apply\nsettings selected in the Ad Manager UI such as programmatic limited\nads enablement. For Pod serving and Cloud stitching it is also used to\nlocate and play the stream. To find the network code, see [this article](//support.google.com/admanager/answer/7674889).\n\nInherited from\n: [StreamRequest#networkCode](/ad-manager/dynamic-ad-insertion/sdk/cast/reference/js/StreamRequest#networkCode)\n\n### senderCanSkip\n\nunknown\n\nWhether or not the sender(s) display a CAF skip UI to the end user.\nUsed to enable skippable ads.\n\nInherited from\n: [StreamRequest#senderCanSkip](/ad-manager/dynamic-ad-insertion/sdk/cast/reference/js/StreamRequest#senderCanSkip)\n\n### streamActivityMonitorId\n\nunknown\n\nThe ID to be used to debug the stream with the stream activity monitor.\nThis is used to provide a convenient way to allow publishers to find a\nstream log in the stream activity monitor tool.\n\nInherited from\n: [StreamRequest#streamActivityMonitorId](/ad-manager/dynamic-ad-insertion/sdk/cast/reference/js/StreamRequest#streamActivityMonitorId)\n\n### videoId\n\nstring\n\nIdentifier for the video content source. Required for on-demand streams."]]
