Interface StreamRequest

Base interface for specifying properties of the stream request.

Properties
adTagParameters	You can override a limited set of ad tag parameters on your stream request.
apiKey	The stream request API key.
authToken	The stream request authorization token.
enableNonce	Adds a nonce to the request.
format	The stream format to request.
networkCode	The stream request network code.
omidAccessModeRules	Settings object for mapping verification vendors to OMID Access Modes.
streamActivityMonitorId	The ID to troubleshoot the stream with the stream activity monitor.

Properties

---

adTagParameters

adTagParameters: {
  [key: string]: string;
}

You can override a limited set of ad tag parameters on your stream request. The values you add must be strings. For details, see Supply targeting parameters to your stream. You can use the dai-ot and dai-ov parameters for stream variant preference. For details, see Override stream parameters.

---

apiKey

apiKey: string

The stream request API key. Configure your stream API key in the Google Ad Manager UI. For details, see Authenticate DAI video stream requests. The API key authenticates apps that attempt to access the stream.

---

authToken

authToken: string

The stream request authorization token. Use the token in place of the API key for secure content authorization. You can control individual content streams authorizations based on this token.

---

enableNonce

enableNonce: boolean

Adds a nonce to the request. When you request ads from a third-party server, you must set this parameter to transmit monetization signals to Google servers. Defaults to a false value.

---

format

format: StreamFormat

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

• hls: default
• dash

Note: Values must be lowercase.

---

networkCode

networkCode: string

The stream request network code. To find the network code, see Find Google Ad Manager account information.

---

omidAccessModeRules

omidAccessModeRules: {
  [key: string]: OmidAccessMode;
}

Settings object for mapping verification vendors to OMID Access Modes. The keys must be values from the OmidVerificationVendor enum, and the values must be values from the OmidAccessMode enum.

---

streamActivityMonitorId

streamActivityMonitorId: string

The ID to troubleshoot the stream with the stream activity monitor. Use this ID to find a stream log in the stream activity monitor tool.