Stay organized with collections
Save and categorize content based on your preferences.
StreamRequest
classpublic
A class for specifying properties of the stream request.
Constructor
StreamRequest
new
StreamRequest()
Properties
adTagParameters
(null or non-null Object with string properties)
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.
apiKey
string
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.
authToken
string
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 stream format to request. Accepts the following string values:
hls (default)
dash
.
If an invalid string is provided, the default value will be used.
networkCode
string
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.
senderCanSkip
boolean
Whether or not the sender(s) display a CAF skip UI to the end user.
Used to enable skippable ads.
streamActivityMonitorId
string
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\u003eStreamRequest\u003c/code\u003e class defines properties for requesting ad-integrated streams.\u003c/p\u003e\n"],["\u003cp\u003eIt utilizes \u003ccode\u003eapiKey\u003c/code\u003e or \u003ccode\u003eauthToken\u003c/code\u003e for content authorization and access control.\u003c/p\u003e\n"],["\u003cp\u003ePublishers can customize ad parameters, stream format (\u003ccode\u003ehls\u003c/code\u003e or \u003ccode\u003edash\u003c/code\u003e), and consent settings.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003enetworkCode\u003c/code\u003e is crucial for Pod/Cloud stitching requests & applying Ad Manager settings.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003esenderCanSkip\u003c/code\u003e enables skippable ads and \u003ccode\u003estreamActivityMonitorId\u003c/code\u003e aids in stream debugging.\u003c/p\u003e\n"]]],["The `StreamRequest` class defines stream properties, including: `adTagParameters` for overriding ad tag settings, `apiKey` and `authToken` for content access authorization, and `consentSettings` for regulatory compliance. The `format` property specifies the stream type (`hls` or `dash`). `networkCode` is for publisher network identification, with requirements depending on the stream type. `senderCanSkip` enables skippable ads, and `streamActivityMonitorId` is used for debugging through stream activity monitoring.\n"],null,["# Class: StreamRequest\n\nStreamRequest\n=============\n\nclass public\n\nA class for specifying properties of the stream request.\n\nConstructor\n-----------\n\n### StreamRequest\n\nnew\nStreamRequest()\n\nProperties\n----------\n\n### adTagParameters\n\n(null or non-null Object with string properties)\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\n### apiKey\n\nstring\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\n### authToken\n\nstring\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\n### consentSettings\n\n(null or non-null [ConsentSettings](/ad-manager/dynamic-ad-insertion/sdk/cast/reference/js/ConsentSettings))\n\nSettings related to regulations and consent.\n\n### format\n\nstring\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\n### networkCode\n\nstring\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\n### senderCanSkip\n\nboolean\n\nWhether or not the sender(s) display a CAF skip UI to the end user.\nUsed to enable skippable ads.\n\n### streamActivityMonitorId\n\nstring\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."]]
