Class: StreamRequest

Properties

adTagParameters

nullable Object

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

format

non-null StreamFormat

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

  • hls (default)
  • dash

omidAccessModeRules

non-null Object with non-null OmidVerificationVendor keys and non-null OmidAccessMode properties

Settings object for mapping verification vendors to OMID Access Modes. Verification script URLs are internally matched against vendor provided regexes 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.

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.