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 Event ID for the live stream, as setup on the Video Stitcher.
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.
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\u003eVideoStitcherLiveStreamRequest\u003c/code\u003e is a class for specifying properties when requesting live streams from Video Stitcher, extending the \u003ccode\u003ePodStreamRequest\u003c/code\u003e class.\u003c/p\u003e\n"],["\u003cp\u003eIt utilizes properties like \u003ccode\u003eliveStreamEventId\u003c/code\u003e, \u003ccode\u003eprojectNumber\u003c/code\u003e, and \u003ccode\u003eregion\u003c/code\u003e to identify and locate the desired live stream content on Video Stitcher.\u003c/p\u003e\n"],["\u003cp\u003eInherited properties such as \u003ccode\u003eapiKey\u003c/code\u003e, \u003ccode\u003eauthToken\u003c/code\u003e, and \u003ccode\u003eadTagParameters\u003c/code\u003e provide control over stream authorization, content access, and ad targeting.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003evideoStitcherSessionOptions\u003c/code\u003e property allows for customization of Video Stitcher-specific parameters for the stream request.\u003c/p\u003e\n"],["\u003cp\u003eThis class is essential for integrating with Google Ad Manager's Dynamic Ad Insertion and leveraging Video Stitcher's live stream capabilities for ad-supported content delivery.\u003c/p\u003e\n"]]],["The `VideoStitcherLiveStreamRequest` class manages live stream properties. Key actions involve setting parameters like `apiKey`, `authToken`, `customAssetKey`, and `networkCode` for stream authorization and identification. It supports format options (`hls`, `dash`), and setting an `liveStreamEventId` that define the stream's characteristics. Additional settings include `oAuthToken`, `projectNumber`, `region` for Video Stitcher specifics and options related to ads like ad tag parameters, `senderCanSkip`, and stream activity monitoring. `videoStitcherSessionOptions` are used to set Video Stitcher-specific parameters for the request.\n"],null,["# Class: VideoStitcherLiveStreamRequest\n\nVideoStitcherLiveStreamRequest\n==============================\n\nclass public\n\nA class for specifying properties of the video stitcher live stream request.\n\nConstructor\n-----------\n\n### VideoStitcherLiveStreamRequest\n\nnew\nVideoStitcherLiveStreamRequest()\n\nExtends\n: [PodStreamRequest](/ad-manager/dynamic-ad-insertion/sdk/cast/reference/js/PodStreamRequest)\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### customAssetKey\n\nunknown\n\nThe custom asset key is used to determine which stream should be played.\nCustom asset keys are required for pod serving live stream requests.\n\nInherited from\n: [PodStreamRequest#customAssetKey](/ad-manager/dynamic-ad-insertion/sdk/cast/reference/js/PodStreamRequest#customAssetKey)\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### liveStreamEventId\n\nstring\n\nThe Event ID for the live stream, as setup on the Video Stitcher.\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### oAuthToken\n\nstring\n\nThe OAuthToken to use for the Video Stitcher.\n\n### projectNumber\n\nstring\n\nThe project number for the Video Stitcher.\n\n### region\n\nstring\n\nThe region to use for the Video Stitcher.\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### videoStitcherSessionOptions\n\n(null or non-null Object with any type properties)\n\nThe session options are used to set Video Stitcher-specific parameters\nfor this Video Stitcher stream request."]]
