logo

THEOplayer > GoogleDAIConfiguration

GoogleDAIConfiguration interface

Inherits from ServerSideAdInsertionConfiguration . See parent page for inherited properties and methods.

Represents a configuration for server-side ad insertion with the Google DAI pre-integration.

Signature:

export interface GoogleDAIConfiguration extends ServerSideAdInsertionConfiguration 

Remarks


- Available since v2.30.0.

Properties

Property

Type

Description

adTagParameters (optional)

Record<string, string>

The ad tag parameters added to stream request.

apiKey

string

The API key for the stream request.

authToken (optional)

string

The authorization token for the stream request.

availabilityType (optional)

DAIAvailabilityType

The type of the requested stream.

integration

GoogleDAISSAIIntegrationID

The identifier for the SSAI pre-integration.

streamActivityMonitorID (optional)

string

The identifier for a stream activity monitor session.

Property Details

adTagParameters

The ad tag parameters added to stream request.

Signature:

adTagParameters?: Record<string, string>;

Remarks


- Each entry contains the parameter name with associated value.

Valid parameters:
- Supply targeting parameters to your stream
- Override stream variant parameters

apiKey

The API key for the stream request.

Signature:

apiKey: string;

Remarks


- This key is used to verify applications that are attempting to access the content.
- This key is configured through the Google Ad Manager UI.

authToken

The authorization token for the stream request.

Signature:

authToken?: string;

Remarks


- If present, this token is used instead of the API key for stricter content authorization.
- The publisher can control individual content streams authorizations based on this token.

availabilityType

The type of the requested stream.

Signature:

readonly availabilityType?: DAIAvailabilityType;

integration

The identifier for the SSAI pre-integration.

Signature:

integration: GoogleDAISSAIIntegrationID;

streamActivityMonitorID

The identifier for a stream activity monitor session.

Signature:

streamActivityMonitorID?: string;
github
Make sure to follow us on GitHub!
THEO-logo-white
twitter
facebook
linkedin
Copyright © 2020. All Rights Reserved.
Leuven
New York
Singapore
Barcelona