Interface AdsEventMap

The events fired by the ads API.

interface AdsEventMap {
    adbegin: Event<"adbegin">;
    adbreakbegin: Event<"adbreakbegin">;
    adbreakchange: Event<"adbreakchange">;
    adbreakend: Event<"adbreakend">;
    adbuffering: AdBufferingEvent;
    addad: Event<"addad">;
    addadbreak: Event<"addadbreak">;
    adend: Event<"adend">;
    aderror: Event<"aderror">;
    adfirstquartile: Event<"adfirstquartile">;
    adimpression: Event<"adimpression">;
    adloaded: Event<"adloaded">;
    admetadata: AdMetadataEvent;
    admidpoint: Event<"admidpoint">;
    adskip: Event<"adskip">;
    adthirdquartile: Event<"adthirdquartile">;
    removeadbreak: Event<"removeadbreak">;
    updatead: Event<"updatead">;
    updateadbreak: Event<"updateadbreak">;
}

Properties

adbegin: Event<"adbegin">

Fired when an ad begins.

adbreakbegin: Event<"adbreakbegin">

Fired when an ad break begins.

adbreakchange: Event<"adbreakchange">

Fired when an ad break changes.

adbreakend: Event<"adbreakend">

Fired when an ad break ends.

adbuffering: AdBufferingEvent

Fired when the ad has stalled playback to buffer.

Remarks


- only available in the Google IMA integration.

addad: Event<"addad">

Fired when an ad is added.

Remarks


- Available since v2.60.0.

addadbreak: Event<"addadbreak">

Fired when an ad break is added.

Remarks


- Available since v2.60.0.

adend: Event<"adend">

Fired when an ad ends.

aderror: Event<"aderror">

Fired when an ad errors.

adfirstquartile: Event<"adfirstquartile">

Fired when an ad reaches the first quartile.

adimpression: Event<"adimpression">

Fired when an ad counts as an impression.

adloaded: Event<"adloaded">

Fired when an ad is loaded.

admetadata: AdMetadataEvent

Fired when an ads list is loaded.

Remarks


- only available in the Google IMA integration.

admidpoint: Event<"admidpoint">

Fired when an ad reaches the mid point.

adskip: Event<"adskip">

Fired when an ad is skipped.

adthirdquartile: Event<"adthirdquartile">

Fired when an ad reaches the third quartile.

removeadbreak: Event<"removeadbreak">

Fired when an ad break is removed.

Remarks


- Available since v2.60.0.

updatead: Event<"updatead">

Fired when an ad is updated.

Remarks


- Available since v2.60.0.

updateadbreak: Event<"updateadbreak">

Fired when an AdBreak is updated.

Remarks


- Available since v2.66.0.

Generated using TypeDoc