-
- google.ima.dai.api.Ad
- google.ima.dai.api.AdPodInfo
- google.ima.dai.api.AdProgressData
- google.ima.dai.api.CompanionAd
- google.ima.dai.api.CuePoint
- google.ima.dai.api.LiveStreamRequest
- google.ima.dai.api.StreamData
- google.ima.dai.api.StreamEvent
- google.ima.dai.api.StreamEvent.Type
- google.ima.dai.api.StreamManager
- google.ima.dai.api.StreamRequest
- google.ima.dai.api.VODStreamRequest
- google.ima.VERSION
Klasse google.ima.dai.api.Ad
Methoden
Eine Klasse, die ein Anzeigenobjekt bei der dynamischen Anzeigenbereitstellung darstellt. Diese Klasse stellt eine Teilmenge der ima.Ad-Properties bereit.
getAdId()
Rückgaben string
:
getAdPodInfo()
Rückgaben google.ima.dai.api.AdPodInfo
:
getAdSystem()
Rückgaben string
:
getAdvertiserName()
Rückgaben string
:
getApiFramework()
Rückgaben string
:
getCompanionAds()
Rückgaben Array.<google.ima.dai.api.CompanionAd>
:
getCreativeAdId()
Rückgaben string
:
getCreativeId()
Rückgaben string
:
getDealId()
Rückgaben string
:
getDescription()
Rückgaben string
:
getDuration()
Rückgaben number
:
getTitle()
Rückgaben string
:
getVastMediaHeight()
Rückgaben number
:
getVastMediaWidth()
Rückgaben number
:
getWrapperAdIds()
Rückgaben Array.<string>
:
getWrapperAdSystems()
Rückgaben Array.<string>
:
getWrapperCreativeIds()
Rückgaben Array.<string>
:
Klasse google.ima.dai.api.AdPodInfo
Methoden
Eine Klasse, die ein Anzeigen-Pod-Informationsobjekt bei der dynamischen Anzeigenbereitstellung darstellt. Diese Klasse stellt einen Teil der Eigenschaften von „ima.AdPodInfo“ bereit.
getAdPosition()
Rückgaben number
:
getMaxDuration()
Rückgaben number
:
getPodIndex()
Rückgaben number
:
getTimeOffset()
Rückgaben number
:
getTotalAds()
Rückgaben number
:
Klasse google.ima.dai.api.AdProgressData
Fields
Eine Klasse zum Angeben von Daten zum Anzeigenfortschritt.
Attribute
Name | Typ | Beschreibung |
---|---|---|
adBreakDuration |
|
|
adPosition |
|
|
currentTime |
|
|
duration |
|
|
totalAds |
|
Klasse google.ima.dai.api.CompanionAd
Methoden
Eine Klasse, die ein Companion-Anzeigenobjekt bei der dynamischen Anzeigenbereitstellung darstellt. Diese Klasse stellt einen Teil der Eigenschaften von „ima.CompanionAd“ bereit.
getAdSlotId()
Rückgaben string
:
getContent()
Rückgaben string
:
getContentType()
Rückgaben string
:
getHeight()
Rückgaben number
:
getWidth()
Rückgaben number
:
Klasse google.ima.dai.api.CuePoint
Fields
Eine Klasse zum Angeben von Eigenschaften eines Cue-Punkts, der eine Werbeunterbrechung in DAI-VOD-Streams darstellt.
Attribute
Name | Typ | Beschreibung |
---|---|---|
end |
|
Die Endzeit für diesen Cue-Punkt. |
played |
|
Gibt an, ob dieser Cue-Punkt wiedergegeben wurde. |
start |
|
Die Startzeit dieses Cue-Punkts. |
Klasse google.ima.dai.api.LiveStreamRequest
Fields
Eine Klasse zum Angeben von Eigenschaften der Livestreamanfrage.
Konstruktor:Parameter | Typ | Beschreibung |
---|---|---|
opt_liveStreamRequest |
Object |
Objekt, dem bereits Streamanfrageeigenschaften zugewiesen sind. |
Attribute
Name | Typ | Beschreibung |
---|---|---|
assetKey |
|
Damit wird festgelegt, welcher Stream wiedergegeben werden soll. Der Asset-Schlüssel der Livestreamanfrage ist eine Kennung, die in der DFP-Benutzeroberfläche zu finden ist. |
Klasse google.ima.dai.api.StreamData
Fields
Eine Klasse zum Angeben von Streamdaten.
Attribute
Name | Typ | Beschreibung |
---|---|---|
adProgressData |
|
Zeitbezogene Informationen zur aktuell wiedergegebenen Anzeige. |
cuepoints |
|
Die Anzeigen-Cuepoints für den On-Demand-Stream. Diese können sich im Laufe des Streams ändern. Diese Variable wird nur im Ereignis-Listener für das Ereignis „CUEPOINTS_CHANGED“ |
errorMessage |
|
|
streamId |
|
|
subtitles |
|
|
url |
|
Klasse google.ima.dai.api.StreamEvent
Methoden
Dieser Ereignistyp wird vom Stream-Manager als Benachrichtigung ausgegeben, wenn sich der Stream-Status ändert.
getAd()
Returns google.ima.dai.api.Ad
:Gibt ein Objekt mit Anzeigeninformationen zurück.
getStreamData()
Returns google.ima.dai.api.StreamData
:Gibt ein Objekt mit Streaminformationen zurück.
Enum google.ima.dai.api.StreamEvent.Type
Fields
Liste der vom IMA SDK unterstützten Ereignistypen.
Werte
Wert | Beschreibung |
---|---|
AD_BREAK_ENDED |
Wird ausgelöst, wenn eine Werbeunterbrechung endet. |
AD_BREAK_STARTED |
Wird ausgelöst, wenn eine Werbeunterbrechung beginnt. |
AD_PROGRESS |
Wird ausgelöst, wenn es Neuigkeiten zum Fortschritt einer Anzeige gibt. |
CLICK |
Wird ausgelöst, wenn während der Wiedergabe einer Anzeige auf das Klickelement geklickt oder getippt wird. |
COMPLETE |
Wird ausgelöst, wenn eine Anzeige abgeschlossen ist. |
CUEPOINTS_CHANGED |
Wird für On-Demand-Streams gesendet, wenn sich die Cuepoints ändern. |
ERROR |
Wird ausgelöst, wenn ein Fehler auftritt. |
FIRST_QUARTILE |
Wird ausgelöst, wenn eine Anzeige das erste Quartil erreicht. |
LOADED |
Wird ausgelöst, wenn das Stream-Manifest verfügbar ist. |
MIDPOINT |
Wird ausgelöst, wenn eine Anzeige die Mitte erreicht. |
STARTED |
Wird ausgelöst, wenn eine Anzeige beginnt. |
STREAM_INITIALIZED |
Wird ausgelöst, wenn der Stream initialisiert wird. |
THIRD_QUARTILE |
Wird ausgelöst, wenn eine Anzeige das dritte Quartil erreicht. |
Klasse google.ima.dai.api.StreamManager
Methoden
Verwaltet Streams mit dynamischer Anzeigenbereitstellung. Er verwaltet die Interaktionen mit dem DAI-Backend und verarbeitet Tracking-Pings sowie die Weiterleitung von Stream- und Anzeigenereignissen an den Publisher. Dieser Manager wird nicht von BaseAdsManager abgeleitet, da er nicht für eine bestimmte Anzeige, sondern für den gesamten Stream zuständig ist.
Konstruktor:Parameter | Typ | Beschreibung |
---|---|---|
videoElement |
HTMLVideoElement |
Das eigentliche Videoplayer-Element. |
contentTimeForStreamTime(streamTime)
Gibt die Zeitspanne des Inhalts ohne Anzeigen für eine bestimmte Streamzeit zurück. Gibt die angegebene Streamzeit für Livestreams zurück.
Gibt number
zurück:die Zeitspanne des Inhalts, die der angegebenen Streamzeit entspricht, nachdem Anzeigen entfernt wurden.
Parameter | Typ | Beschreibung |
---|---|---|
streamTime |
number |
die Wiedergabezeit mit eingefügten Anzeigen (in Sekunden). |
onTimedMetadata(metadata)
Hier wird ein Wörterbuch mit verarbeiteten Metadaten übergeben. Das Dictionary erwartet den Schlüssel „TXXX“ mit dem benutzerdefinierten Metadaten-String als Wert.
Wenn dein Player Rohmetadaten bereitstellt, rufe stattdessen ima.dai.api.StreamManager.processMetadata
auf.
Parameter | Typ | Beschreibung |
---|---|---|
metadata |
Object |
Das Wörterbuch mit Metadaten. |
previousCuePointForStreamTime(streamTime)
Gibt den vorherigen Cue-Punkt für die angegebene Streamzeit zurück. Gibt „null“ zurück, wenn kein solcher Cue-Punkt vorhanden ist. Dieser Parameter wird verwendet, um Funktionen wie „Zurückspringen“ zu implementieren. Er wird aufgerufen, wenn der Publisher erkennt, dass der Nutzer vorwärtsgesprungen ist, um ihn zu einer Werbeunterbrechung zurückzusenden.
Gibt google.ima.dai.api.CuePoint
zurück:den vorherigen Cue-Punkt für die angegebene Streamzeit.
Parameter | Typ | Beschreibung |
---|---|---|
streamTime |
number |
die Streamzeit, zu der gesprungen wurde. |
processMetadata(type, data, timestamp)
Verarbeitet zeitbezogene Metadaten für Livestreams. Verwende diese Funktion, wenn dein Videoplayer unformatierte Metadaten zusammen mit Zeitstempeln bereitstellt. Andernfalls rufe ima.dai.api.StreamManager.onTimedMetadata
auf.
Parameter | Typ | Beschreibung |
---|---|---|
type |
string |
Typ für Metadaten. Muss „ID3“ sein. |
data |
Uint8Array |
Rohe Tag-Daten Bei ID3 muss es sich um das gesamte Tag handeln. |
timestamp |
number |
Zeitpunkt, zu dem die Daten verarbeitet werden sollen. |
requestStream(streamRequest)
Hiermit wird ein Stream mit den angegebenen Streamparametern geladen.
Parameter | Typ | Beschreibung |
---|---|---|
streamRequest |
google.ima.dai.api.StreamRequest |
enthält Parameter zum Laden der Stream-Metadaten. |
setClickElement(clickElement)
Hier wird das Element für die Weiterleitung nach dem Klick auf die Anzeige festgelegt. Dieses Element wird als Empfänger für Klicks oder Tippen verwendet, während eine Anzeige wiedergegeben wird. Dies kann dazu führen, dass die aktuelle Seite verlassen wird.
Parameter | Typ | Beschreibung |
---|---|---|
clickElement |
Element |
das Element, das als Klick-Element für die Anzeige verwendet wird. |
streamTimeForContentTime(contentTime)
Gibt die Streamzeit mit Anzeigen für eine bestimmte Contentdauer zurück. Gibt die angegebene Zeit für den Inhalt von Livestreams zurück.
Gibt number
zurück:die Streamzeit, die der angegebenen Contentdauer nach dem Einfügen von Anzeigen entspricht.
Parameter | Typ | Beschreibung |
---|---|---|
contentTime |
number |
die Dauer des Inhalts ohne Werbeunterbrechungen (in Sekunden). |
Klasse google.ima.dai.api.StreamRequest
Fields
Eine Klasse zum Angeben von Eigenschaften der Streamanfrage.
Attribute
Name | Typ | Beschreibung |
---|---|---|
adTagParameters |
|
Sie können eine begrenzte Anzahl von Anzeigen-Tag-Parametern in Ihrer Streamanfrage überschreiben. Weitere Informationen finden Sie unter Targeting-Parameter an einen Stream übertragen. Du kannst die Parameter „dai-ot“ und „dai-ov“ für die Streamvariantenpriorität verwenden. Weitere Informationen findest du unter Parameter von Streamvarianten überschreiben. |
apiKey |
|
Der API-Schlüssel für die Streamanfrage. Sie wird über die DFP-Benutzeroberfläche für die Verwaltung konfiguriert und dem Publisher zur Verfügung gestellt, damit er seine Inhalte entsperren kann. Es werden die Anwendungen überprüft, die auf die Inhalte zugreifen möchten. |
streamActivityMonitorId |
|
Die ID, die für die Fehlerbehebung des Streams mit der Überwachung der Streamingaktivitäten verwendet werden soll. So können Publisher ganz einfach ein Streamprotokoll im Tool zur Überwachung der Streamingaktivitäten finden. |
Klasse google.ima.dai.api.VODStreamRequest
Fields
Eine Klasse zum Angeben von Eigenschaften der VOD-Streamanfrage.
Konstruktor:Parameter | Typ | Beschreibung |
---|---|---|
opt_VODStreamRequest |
Object |
Objekt, dem bereits Streamanfrageeigenschaften zugewiesen sind. |
Attribute
Name | Typ | Beschreibung |
---|---|---|
contentSourceId |
|
Eindeutige Kennung für die Publisher-Inhalte aus einem CMS. Erforderlich für On-Demand-Streams. |
videoId |
|
Kennung für die Videocontentquelle. Erforderlich für On-Demand-Streams. |
Konstante „google.ima.VERSION“
Ein String mit der vollständigen Version des SDKs.