Mit der Dynamic Ad Inserting API können Sie Video-on-Demand-Streams (VOD) für die dynamische Anzeigenbereitstellung anfordern und erfassen. HLS- und DASH-Streams werden unterstützt.
Dienst: dai.google.com
Der Pfad der Methode stream
ist relativ zu https://dai.google.com
Methode: stream
Methoden | |
---|---|
stream |
POST /ondemand/v1/hls/content/{content-source}/vid/{video-id}/stream
Erstellt einen HLS-Stream für die dynamische Anzeigenbereitstellung für die angegebene Contentquelle und Video-ID.
Erstellt einen DASH-Stream für die dynamische Anzeigenbereitstellung für die angegebene Contentquelle und Video-ID. |
HTTP-Anfrage
POST https://dai.google.com/ondemand/v1/hls/content/{content-source}/vid/{video-id}/stream
POST https://dai.google.com/ondemand/v1/dash/content/{content-source}/vid/{video-id}/stream
Anfrageheader
Parameter | |
---|---|
api‑key |
string Der API-Schlüssel, der beim Erstellen eines Streams bereitgestellt wird, muss für das Netzwerk des Verlags oder Webpublishers gültig sein. Anstatt den API-Schlüssel im Anfragetext anzugeben, kann er im HTTP-Autorisierungsheader im folgenden Format übergeben werden: Authorization: DCLKDAI key="<api-key>" |
Pfadparameter
Parameter | |
---|---|
content-source |
string Die CMS-ID des Streams. |
video-id |
string Die Video-ID des Streams. |
Anfragetext
Der Anfragetext hat den Typ application/x-www-form-urlencoded
und enthält die folgenden Parameter:
Parameter | ||
---|---|---|
dai-ssb |
Optional | Legen Sie |
DFP-Targeting-Parameter | Optional | Zusätzliche Targeting-Parameter. |
Stream-Parameter überschreiben | Optional | Standardwerte eines Parameters für die Streamerstellung überschreiben. |
HMAC-Authentifizierung | Optional | Authentifizieren Sie sich mit einem HMAC-basierten Token. |
Antworttext
Wenn der Vorgang erfolgreich ist, enthält der Antworttext ein neues Stream
. Für serverseitige Beaconing-Streams enthält Stream
nur die Felder stream_id
und stream_manifest
.
Open Measurement
Das Feld Verifications
enthält Informationen zur Open Measurement-Überprüfung für Streams, die keine serverseitigen Beaconing-Streams sind.
Verifications
enthält ein oder mehrere Verification
-Elemente mit den Ressourcen und Metadaten, die Sie benötigen, um die Creative-Wiedergabe mit Drittanbieter-Messcode zu überprüfen.
Es wird nur JavaScriptResource
unterstützt. Weitere Informationen finden Sie im IAB Tech Lab und in der VAST 4.1-Spezifikation.
Methode: Medienüberprüfung
Wenn Sie bei der Wiedergabe auf eine Werbemedien-ID stoßen, senden Sie sofort eine Anfrage mit der media_verification_url
vom Endpunkt stream
. media_verification_url
ist ein absoluter Pfad.
Für serverseitige Beaconing-Streams, bei denen der Server die Medienüberprüfung initiiert, sind keine Anfragen zur Medienüberprüfung erforderlich.
Anfragen an den Endpunkt media verification
sind idempotent.
Methoden | |
---|---|
media verification |
GET {media_verification_url}/{ad_media_id}
Benachrichtigt die API über Medienüberprüfungsereignisse. |
HTTP-Anfrage
GET {media-verification-url}/{ad-media-id}
Antworttext
media verification
gibt die folgenden Antworten zurück:
HTTP/1.1 204 No Content
, wenn die Medienüberprüfung erfolgreich ist und alle Pings gesendet werden.HTTP/1.1 404 Not Found
, wenn das Medium aufgrund einer falschen URL-Formatierung oder eines falschen Ablaufs nicht überprüft werden kann.HTTP/1.1 404 Not Found
, wenn eine vorherige Bestätigungsanfrage für diese ID erfolgreich war.HTTP/1.1 409 Conflict
, wenn derzeit über eine andere Anfrage bereits Pings gesendet werden.
Media-IDs von Anzeigen (HLS)
Media-IDs von Anzeigen werden in HLS Timed Metadata mit dem Schlüssel TXXX
codiert, der für Frames vom Typ „benutzerdefinierte Textinformationen“ reserviert ist. Der Inhalt des Frames wird entschlüsselt und beginnt immer mit dem Text "google_"
.
Der gesamte Textinhalt des Frames sollte bei jeder Anzeigenüberprüfungsanfrage an media_verification_url angehängt werden.
Media-IDs für Anzeigen (DASH)
Media-IDs für Anzeigen werden über das DASH-Element EventStream
in das Manifest eingefügt.
Jeder EventStream
hat den Schema-ID-URI urn:google:dai:2018
.
Sie enthalten Ereignisse mit dem Attribut messageData
, das eine Anzeigenmedien-ID enthält, die mit “google_”
beginnt. Der gesamte Inhalt des Attributs messageData
sollte bei jeder Anzeigenüberprüfungsanfrage an media_verification_url angehängt werden.
Antwortdaten
Stream
Stream wird verwendet, um eine Liste aller Ressourcen für einen neu erstellten Stream im JSON-Format zu rendern .JSON-Darstellung |
---|
{ "stream_id": string, "total_duration": number, "content_duration": number, "valid_for": string, "valid_until": string, "subtitles": [object(Subtitle)], "hls_master_playlist": string, "stream_manifest": string, "media_verification_url": string, "apple_tv": object(AppleTV), "ad_breaks": [object(AdBreak)], } |
Felder | |
---|---|
stream_id |
string Stream-ID |
total_duration |
number Streamdauer in Sekunden |
content_duration |
number Dauer des Inhalts ohne Anzeigen, in Sekunden. |
valid_for |
string Gültig für den Dauer-Stream im Format „00h00m00s“. |
valid_until |
string Datum, bis zu dem der Stream gültig ist, im RFC 3339-Format. |
subtitles |
[object(Subtitle)] Eine Liste mit Untertiteln. Ausgelassen, wenn leer. Nur HLS. |
hls_master_playlist |
string (EINGESTELLT) URL der HLS-Masterplaylist. stream_manifest verwenden. Nur HLS. |
stream_manifest |
string Manifest des Streams. Entspricht der Masterplaylist in HLS und der MPD-Datei in DASH. Dies ist das einzige Feld neben „stream_id“, das beim Erstellen eines serverseitigen Beaconing-Streams in der Antwort vorhanden ist. |
media_verification_url |
string Medienbestätigungs-URL |
apple_tv |
object(AppleTV) Optionale Informationen speziell für Apple TV-Geräte. Nur HLS. |
ad_breaks |
[object(AdBreak)] Eine Liste der Werbeunterbrechungen Ausgelassen, wenn leer. |
AppleTV
AppleTV enthält Informationen speziell für Apple TV-Geräte.JSON-Darstellung |
---|
{ "interstitials_url": string, } |
Felder | |
---|---|
interstitials_url |
string Interstitial-URL |
AdBreak
Eine Werbeunterbrechung beschreibt eine einzelne Werbeunterbrechung im Stream. Sie enthält eine Position, eine Dauer, einen Typ (MID/Vorher/Nachher) und eine Liste von Anzeigen.JSON-Darstellung |
---|
{ "type": string, "start": number, "duration": number, "ads": [object(Ad)], } |
Felder | |
---|---|
type |
string Gültige Werbeunterbrechungstypen sind: „mid“, „pre“ und „post“. |
start |
number Position im Stream, an der die Pause beginnt (in Sekunden) |
duration |
number Dauer der Werbeunterbrechung in Sekunden |
ads |
[object(Ad)] Eine Liste mit Anzeigen Ausgelassen, wenn leer. |
Ad
„Anzeige“ beschreibt eine Anzeige im Stream. Sie enthält die Position der Anzeige in der Werbeunterbrechung, die Anzeigendauer und einige optionale Metadaten.JSON-Darstellung |
---|
{ "seq": number, "start": number, "duration": number, "title": string, "description": string, "advertiser": string, "ad_system": string, "ad_id": string, "creative_id": string, "creative_ad_id": string, "deal_id": string, "clickthrough_url": string, "icons": [object(Icon)], "wrappers": [object(Wrapper)], "events": [object(Event)], "verifications": [object(Verification)], "universal_ad_id": object(UniversalAdID), "companions": [object(Companion)], "interactive_file": object(InteractiveFile), } |
Felder | |
---|---|
seq |
number Position der Anzeige in der Werbeunterbrechung |
start |
number Position im Stream, an der die Anzeige startet (in Sekunden). |
duration |
number Dauer der Anzeige in Sekunden |
title |
string Optionaler Titel der Anzeige |
description |
string Optionale Beschreibung der Anzeige |
advertiser |
string Optionale Werbetreibenden-ID |
ad_system |
string Optionales Anzeigensystem |
ad_id |
string Optionale Anzeigen-ID |
creative_id |
string Optionale Creative-ID |
creative_ad_id |
string Optionale Creative-Anzeigen-ID |
deal_id |
string Optionale Deal-ID |
clickthrough_url |
string Optionale Klick-URL |
icons |
[object(Icon)] Eine Liste von Symbolen wird weggelassen, wenn sie leer ist. |
wrappers |
[object(Wrapper)] Eine Liste der Wrapper. Ausgelassen, wenn leer. |
events |
[object(Event)] Eine Liste der Ereignisse in der Anzeige |
verifications |
[object(Verification)] Optionale Open Measurement-Bestätigungseinträge, in denen die Ressourcen und Metadaten aufgeführt sind, die zum Ausführen des Drittanbieter-Messcodes erforderlich sind, um die Creative-Wiedergabe zu verifizieren |
universal_ad_id |
object(UniversalAdID) Optionale universelle Anzeigen-ID |
companions |
[object(Companion)] Optionale Companions, die mit dieser Anzeige eingeblendet werden können |
interactive_file |
object(InteractiveFile) Optionales interaktives Creative (SIMID), das während der Anzeigenwiedergabe eingeblendet werden soll. |
Veranstaltung
Das Ereignis enthält einen Ereignistyp und eine Präsentationszeit des Ereignisses.JSON-Darstellung |
---|
{ "time": number, "type": string, } |
Felder | |
---|---|
time |
number Zeitpunkt der Präsentation dieses Termins |
type |
string Der Typ dieses Ereignisses. |
Untertitel
Subtitle beschreibt einen Sidecar-Untertitel für den Videostream. Sie speichert zwei Untertitelformate: TTML und WebVTT. Das TTMLPath-Attribut enthält die URL zur TTML-Sidecar-Datei und das WebVTTPath-Attribut in ähnlicher Weise eine URL zur WebVTT-Sidecar-Datei.JSON-Darstellung |
---|
{ "language": string, "language_name": string, "ttml": string, "webvtt": string, } |
Felder | |
---|---|
language |
string Ein Sprachcode wie „en“ oder „de“. |
language_name |
string Beschreibender Name der Sprache. Es unterscheidet einen bestimmten Satz von Untertiteln, wenn mehrere Sätze für dieselbe Sprache vorhanden sind. |
ttml |
string Optionale URL zur TTML-Sidecar-Datei |
webvtt |
string Optionale URL zur WebVTT-Sidecar-Datei |
Icon
Das Symbol enthält Informationen zu einem VAST-Symbol.JSON-Darstellung |
---|
{ "click_data": object(ClickData), "creative_type": string, "click_fallback_images": [object(FallbackImage)], "height": int32, "width": int32, "resource": string, "type": string, "x_position": string, "y_position": string, "program": string, "alt_text": string, } |
Felder | |
---|---|
click_data |
object(ClickData) |
creative_type |
string |
click_fallback_images |
[object(FallbackImage)] |
height |
int32 |
width |
int32 |
resource |
string |
type |
string |
x_position |
string |
y_position |
string |
program |
string |
alt_text |
string |
ClickData
ClickData enthält Informationen zu einem Click-through eines Symbols.JSON-Darstellung |
---|
{ "url": string, } |
Felder | |
---|---|
url |
string |
FallbackImage
FallbackImage enthält Informationen zu einem VAST-Fallback-Bild.JSON-Darstellung |
---|
{ "creative_type": string, "height": int32, "width": int32, "resource": string, "alt_text": string, } |
Felder | |
---|---|
creative_type |
string |
height |
int32 |
width |
int32 |
resource |
string |
alt_text |
string |
Wrapper
Der Wrapper enthält Informationen zu einer Wrapper-Anzeige. Wenn keine Deal-ID vorhanden ist, wird sie nicht angegeben.JSON-Darstellung |
---|
{ "system": string, "ad_id": string, "creative_id": string, "creative_ad_id": string, "deal_id": string, } |
Felder | |
---|---|
system |
string System-ID des Anzeigensystems |
ad_id |
string Die für die Wrapper-Anzeige verwendete Anzeigen-ID |
creative_id |
string Die für die Wrapper-Anzeige verwendete Creative-ID |
creative_ad_id |
string Die für die Wrapper-Anzeige verwendete Creative-Anzeigen-ID |
deal_id |
string Optionale Deal-ID für die Wrapper-Anzeige |
Überprüfung
Die Überprüfung enthält Informationen für Open Measurement, die die Sichtbarkeitsmessung durch Drittanbieter und die Überprüfungsmessung erleichtern. Derzeit werden nur JavaScript-Ressourcen unterstützt. Weitere Informationen finden Sie unter https://iabtechlab.com/standards/open-measurement-sdk/.JSON-Darstellung |
---|
{ "vendor": string, "java_script_resources": [object(JavaScriptResource)], "tracking_events": [object(TrackingEvent)], "parameters": string, } |
Felder | |
---|---|
vendor |
string Der Überprüfungsanbieter. |
java_script_resources |
[object(JavaScriptResource)] Liste der JavaScript-Ressourcen für die Überprüfung |
tracking_events |
[object(TrackingEvent)] Liste der Tracking-Ereignisse für die Überprüfung |
parameters |
string Ein intransparenter String, der an den Bootstrap-Bestätigungscode übergeben wird. |
JavaScriptResource
JavaScriptResource enthält Informationen zur Überprüfung mit JavaScript.JSON-Darstellung |
---|
{ "script_url": string, "api_framework": string, "browser_optional": boolean, } |
Felder | |
---|---|
script_url |
string URI zur JavaScript-Nutzlast. |
api_framework |
string APIFramework ist der Name des Video-Frameworks, das den Bestätigungscode ausführt. |
browser_optional |
boolean Gibt an, ob das Skript außerhalb eines Browsers ausgeführt werden kann. |
TrackingEvent
TrackingEvent enthält URLs, die in bestimmten Situationen vom Client angepingt werden sollten.JSON-Darstellung |
---|
{ "event": string, "uri": string, } |
Felder | |
---|---|
event |
string Der Typ des Tracking-Ereignisses. |
uri |
string Das Tracking-Ereignis, das gepingt werden soll |
UniversalAdID
Mit UniversalAdID wird eine eindeutige Creative-ID bereitgestellt, die von allen Anzeigensystemen verwaltet wird.JSON-Darstellung |
---|
{ "id_value": string, "id_registry": string, } |
Felder | |
---|---|
id_value |
string Die universelle Anzeigen-ID des ausgewählten Creatives für die Anzeige |
id_registry |
string Ein String, mit dem die URL der Registry-Website identifiziert wird, auf der die universelle Anzeigen-ID des ausgewählten Creatives katalogisiert ist. |
Companion
Die Companion-Anzeige enthält Informationen zu Companion-Anzeigen, die zusammen mit der Anzeige angezeigt werden können.JSON-Darstellung |
---|
{ "click_data": object(ClickData), "creative_type": string, "height": int32, "width": int32, "resource": string, "type": string, "ad_slot_id": string, "api_framework": string, "tracking_events": [object(TrackingEvent)], } |
Felder | |
---|---|
click_data |
object(ClickData) Die Klickdaten für dieses Companion. |
creative_type |
string Das Attribut „CreativeType“ auf dem <StaticResource>-Knoten im VAST, wenn es sich um einen Companion vom Typ „Statisch“ handelt. |
height |
int32 Die Höhe dieses Companion in Pixeln. |
width |
int32 Die Breite dieses Companion in Pixeln. |
resource |
string Bei statischen und iFrame-Companions ist dies die URL, die geladen und angezeigt werden soll. Bei HTML-Companions ist dies das HTML-Snippet, das als Companion angezeigt werden sollte. |
type |
string Der Typ dieses Companion. Er kann entweder statisch, iFrame oder HTML sein. |
ad_slot_id |
string Die Anzeigenflächen-ID für diese Companion-Anzeige. |
api_framework |
string Das API-Framework für diese Companion-Anzeige. |
tracking_events |
[object(TrackingEvent)] Liste der Tracking-Ereignisse für dieses Companion |
InteractiveFile
InteractiveFile enthält Informationen für ein interaktives Creative (z.B. SIMID), das während der Anzeigenwiedergabe eingeblendet werden soll.JSON-Darstellung |
---|
{ "resource": string, "type": string, "variable_duration": boolean, "ad_parameters": string, } |
Felder | |
---|---|
resource |
string Die URL zum interaktiven Creative |
type |
string Der MIME-Typ der Datei, die als Ressource bereitgestellt wird. |
variable_duration |
boolean Gibt an, ob für dieses Creative eine Verlängerung der Dauer angefordert werden kann. |
ad_parameters |
string Der Wert des <AdParameters>-Knotens in VAST. |