THEOplayer Web SDK
    Preparing search index...

    Interface GoogleDAIVodConfiguration

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


    - Available since v2.30.0.

    interface GoogleDAIVodConfiguration {
        adTagParameters?: Record<string, string>;
        apiKey: string;
        authToken?: string;
        availabilityType: "vod";
        contentSourceID: string;
        enableNonce?: boolean;
        integration: "google-dai";
        networkCode?: string;
        omidAccessModeRules?: Record<number, string>;
        streamActivityMonitorID?: string;
        videoID: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    adTagParameters? apiKey authToken? availabilityType contentSourceID enableNonce? integration networkCode? omidAccessModeRules? streamActivityMonitorID? videoID

    Properties

    adTagParameters?: Record<string, string>

    The ad tag parameters added to stream request.


    - Each entry contains the parameter name with associated value.
    - See https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/html5/reference/js/StreamRequest#adTagParameters for more information.

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

    apiKey: string

    The API key for the stream request.


    - This key is used to verify applications that are attempting to access the content.
    - This key is configured through the Google Ad Manager UI.
    - See https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/html5/reference/js/StreamRequest#apiKey for more information.

    authToken?: string

    The authorization token for the stream request.


    - 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.
    - See https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/html5/reference/js/StreamRequest#authToken for more information.

    availabilityType: "vod"

    The type of the requested stream.

    contentSourceID: string

    The identifier for the publisher content for on-demand streams.


    - The publisher content comes from a CMS.
    - This property is required for on-demand streams.

    enableNonce?: boolean

    A flag to indicate that the DAI SDK should send an encrypted nonce to the DAI servers.


    - See https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/html5/sending-ad-signals-through-third-party-servers for more information.
    - Available since 9.2.0.

    integration: "google-dai"

    The identifier for the SSAI pre-integration.

    networkCode?: string

    The network code for the publisher making this stream request.


    - See https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/html5/reference/js/StreamRequest#networkCode for more information.

    omidAccessModeRules?: Record<number, string>

    Optional settings object for mapping verification vendors (google.ima.OmidVerificationVendor) to OMID Access Modes (google.ima.OmidAccessMode).


    - See https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/html5/reference/js/StreamRequest#omidAccessModeRules for more information.

    streamActivityMonitorID?: string

    The identifier for a stream activity monitor session.


    - See https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/html5/reference/js/StreamRequest#streamActivityMonitorId for more information.

    videoID: string

    The identifier for the video content source for on-demand streams.


    - This property is required for on-demand streams.

    Settings

    Member Visibility

    On This Page

    Properties