Interface AdsEventMap

The events fired by the ads API.

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

Properties

adbegin: AdEvent<"adbegin">

Fired when an ad begins.

adbreakbegin: AdBreakEvent<"adbreakbegin">

Fired when an ad break begins.

adbreakchange: AdBreakEvent<"adbreakchange">

Fired when an ad break changes.

adbreakend: AdBreakEvent<"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: AdEvent<"addad">

Fired when an ad is added.

Remarks


- Available since v2.60.0.

addadbreak: AdBreakEvent<"addadbreak">

Fired when an ad break is added.

Remarks


- Available since v2.60.0.

adend: AdEvent<"adend">

Fired when an ad ends.

aderror: Event<"aderror">

Fired when an ad errors.

adfirstquartile: AdEvent<"adfirstquartile">

Fired when an ad reaches the first quartile.

adimpression: AdEvent<"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: AdEvent<"admidpoint">

Fired when an ad reaches the mid point.

adskip: AdSkipEvent

Fired when an ad is skipped.

adsmanagerloaded: AdsManagerLoadedEvent

Fired when the google.ima.AdsManager is created.

Remarks


- only available in the Google IMA integration.

adthirdquartile: AdEvent<"adthirdquartile">

Fired when an ad reaches the third quartile.

removeadbreak: AdBreakEvent<"removeadbreak">

Fired when an ad break is removed.

Remarks


- Available since v2.60.0.

updatead: AdEvent<"updatead">

Fired when an ad is updated.

Remarks


- Available since v2.60.0.

updateadbreak: AdBreakEvent<"updateadbreak">

Fired when an AdBreak is updated.

Remarks


- Available since v2.66.0.