Dynamische Anzeigenbereitstellung – Live-API für die Pod-Auslieferung

Mit der API für die dynamische Anzeigenbereitstellung können Sie DAI-Livestreams anfordern und verfolgen.

Dienst: dai.google.com

Alle URIs beziehen sich auf https://dai.google.com.

Methode: Stream

Methoden
stream POST /ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

Registriert eine Livestreamsitzung für die Pod-Auslieferung mit dynamischer Anzeigenbereitstellung.

HTTP-Anfrage

POST https://dai.google.com/ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

Pfadparameter

Parameter
network_code string

Der Google Ad Manager-Netzwerkcode des Publishers.

custom_asset_key string

Die benutzerdefinierte ID, die diesem Ereignis in Google Ad Manager zugewiesen ist.

Anfragetext

Der Anfragetext hat den Typ application/x-www-form-urlencoded und enthält die folgenden Parameter:

Parameter
DFP-Targeting-Parameter Optional Zusätzliche Targeting-Parameter.
Streamparameter überschreiben Optional Standardwerte eines Parameters zur Streamerstellung überschreiben.
HMAC-Authentifizierung Optional Mit einem HMAC-basierten Token authentifizieren.

Antworttext

Bei Erfolg enthält der Antworttext ein neues Stream-Objekt.

Offene Messung

Die DAI API enthält Informationen zur Open Measurement-Überprüfung im Feld Verifications. Dieses Feld enthält ein oder mehrere Verification-Elemente, in denen die Ressourcen und Metadaten aufgeführt sind, die zum Ausführen von Drittanbieter-Messcode zur Überprüfung der Creative-Wiedergabe erforderlich sind. Nur JavaScriptResource wird unterstützt. Weitere Informationen finden Sie auf der IAB Tech Lab-Website und in der VAST 4.1-Spezifikation.

Methode: Pod-Segment

Methoden
pod segment GET /linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

Erstellt einen DAI-Stream für die angegebene Ereignis-ID.

HTTP-Anfrage

GET https://dai.google.com/linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

Pfadparameter

Parameter
network_code string

Der Google Ad Manager-Netzwerkcode des Publishers.

custom_asset_key string

Die benutzerdefinierte ID, die diesem Ereignis in Google Ad Manager zugewiesen ist.

pod_identifier

Die folgenden Formate werden unterstützt:

pod/{integer}

Die numerische Kennung für die aktuelle Werbeunterbrechung. Anzeigen-Pod-IDs werden für jedes Ereignis vom Typ „Werbeunterbrechung“ inkrementell zugewiesen, beginnend mit 1.

ad_break_id/{string}

Die String-Kennung für die aktuelle Werbeunterbrechung. Bei einer unbekannten Ad Break-ID, die an diesen Endpunkt gesendet wird, wird eine neue Ad Break für das Livestream-Event erstellt.

Für benutzerdefinierte Pausen-IDs gelten die folgenden Einschränkungen:

  • Muss zwischen 1 und 63 Zeichen lang sein
  • Darf nur Kleinbuchstaben, Ziffern und Bindestriche enthalten.
profile_name string

Der Name des angeforderten Google Ad Manager-Codierungsprofils für die dynamische Anzeigenbereitstellung. Das Codierungsprofil muss eines der konfigurierten Codierungsprofile für das ausgewählte Ereignis sein.

segment_number integer

Der Index des angeforderten Segments im aktuellen Anzeigen-Pod, beginnend bei null.
segment_format string

Die Dateiendung, die dem angeforderten Segmentformat zugeordnet ist. Zulässige Erweiterungen sind: ts, mp4, vtt, aac, ac3 oder eac3.

Suchparameter

Parameter
stream_id required string

Die Stream-ID für die Sitzung des aktuellen Nutzers. Dieser Wert wird bei einer erfolgreichen Anfrage an den stream-Endpunkt zurückgegeben.
sd required1 integer

Die Dauer des angeforderten Segments in Millisekunden.
so optional

Der Offset des angeforderten Segments im Anzeigen-Pod in Millisekunden. Wenn Sie den Parameter so weglassen, wird er berechnet, indem Sie die Segmentdauer mit der Segmentnummer multiplizieren.
pd erforderlich2 integer

Die Dauer des Anzeigen-Pods in Millisekunden.
auth-token required string

Die auth-token besteht aus einem codierten HMAC-Token mit den folgenden Daten:

  • pod_id oder ad_break_id
  • network_code
  • custom_asset_key
  • cust_params
  • pd
  • scte35
  • exp
last optional boolean

Gibt das letzte Segment in der Werbeunterbrechung an. Lassen Sie diesen Parameter für alle anderen Segmente weg.
scte35 optional string

Base64-codiertes SCTE-35-Signal für diese Werbeunterbrechung.
cust_params optional string

Mehrere Schlüssel/Wert-Paare, die für das Targeting einer Ad Manager-Kampagne verwendet werden. Diese Paare müssen als URL-codierter Abfragestring dargestellt werden.

Beispiel:
Parameter
  • section = sports
  • page = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

Fußnoten

  1. sd ist für Initialisierungssegmente nicht erforderlich. ↩
  2. pd ist für Ereignisse mit aktivierten Pausen ohne Dauer nicht erforderlich. ↩

Beispiel

GET https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/ad_break_id/adbreak-2/profile/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99d7-860aa4a674cb:TEST

GET https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/pod/2/profile/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99d7-860aa4a674cb:TEST

Antworttext

Bei Erfolg ist der Antworttext ein abspielbares Streamsegment, das dem im Antrag angegebenen Format und den Parametern entspricht.

Methode: HLS-Pod-Manifest

Ruft ein HLS-Anzeigen-Pod-Manifest eines Livestreams ab, das für einen Client-Videoplayer zum Laden und Abspielen bereit ist.

Methoden
GET GET /linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset}/{pod_identifier}.m3u8;

API zum Abrufen einer HLS-Playlist mit mehreren Varianten für einen Anzeigen-Pod.

HTTP-Anfrage

GET https://dai.google.com/linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}.m3u8?stream_id={stream_id}&pd={pod_duration}

Pfadparameter

Parameter
network_code string

Der Google Ad Manager-Netzwerkcode des Publishers.
custom_asset_key string

Die benutzerdefinierte ID, die diesem Ereignis in Google Ad Manager zugeordnet ist
pod_identifier

Die folgenden Formate werden unterstützt:

pod/{integer}

Die numerische Kennung für die aktuelle Werbeunterbrechung. Anzeigen-Pod-IDs werden für jedes Ereignis vom Typ „Werbeunterbrechung“ inkrementell zugewiesen, beginnend mit 1.

ad_break_id/{string}

Die String-Kennung für die aktuelle Werbeunterbrechung. Bei einer unbekannten Ad Break-ID, die an diesen Endpunkt gesendet wird, wird eine neue Ad Break für das Livestream-Event erstellt.

Für benutzerdefinierte Pausen-IDs gelten die folgenden Einschränkungen:

  • Muss zwischen 1 und 63 Zeichen lang sein
  • Darf nur Kleinbuchstaben, Ziffern und Bindestriche enthalten.

Suchparameter

Parameter
stream_id Erforderlich string

Die Stream-ID für die Sitzung des aktuellen Nutzers. Dieser Wert wird von einer erfolgreichen Anfrage an den stream-Endpunkt zurückgegeben.
pd Erforderlich integer

Die Dauer des Anzeigen-Pods in Millisekunden.
scte35 optional string

Base64-codiertes SCTE-35-Signal für diese Werbeunterbrechung.
cust_params optional string

Mehrere Schlüssel/Wert-Paare, die für das Targeting einer Ad Manager-Kampagne verwendet werden. Diese Paare müssen als URL-codierter Abfragestring dargestellt werden.

Beispiel:
Parameter
  • section = sports
  • page = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...
auth-token required string

Die auth-token besteht aus einem codierten HMAC-Token mit den folgenden Daten:

  • pod_id oder ad_break_id
  • network_code
  • custom_asset_key
  • cust_params
  • pd
  • scte35
  • exp

Antworttext

Bei Erfolg ist der Antworttext eine HLS-Playlist mit mehreren Varianten.

Methode: DASH-Pod-Manifest

Ruft ein MPEG-DASH-Anzeigen-Pod-Manifest eines Livestreams ab, das von einem Client-Videoplayer geladen und wiedergegeben werden kann.

Methoden
GET GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset}/stream/{stream_id}/{pod_identifier}/manifest.mpd

API zum Abrufen einer MPEG-DASH-MPD-Playlist für einen Anzeigen-Pod.

HTTP-Anfrage

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/stream/{stream_id}/pod/{pod_id}/manifest.mpd?pd={pod_duration}

Pfadparameter

Parameter
network_code string

Der Google Ad Manager-Netzwerkcode des Publishers.
custom_asset_key string

Die benutzerdefinierte ID, die diesem Ereignis in Google Ad Manager zugeordnet ist
stream_id string

Die Stream-ID für die Sitzung des aktuellen Nutzers. Dieser Wert wird von einer erfolgreichen Anfrage an den stream-Endpunkt zurückgegeben.
pod_identifier

Die folgenden Formate werden unterstützt:

pod/{integer}

Die numerische Kennung für die aktuelle Werbeunterbrechung. Anzeigen-Pod-IDs werden für jedes Ereignis vom Typ „Werbeunterbrechung“ inkrementell zugewiesen, beginnend mit 1.

ad_break_id/{string}

Die String-Kennung für die aktuelle Werbeunterbrechung. Bei einer unbekannten Ad Break-ID, die an diesen Endpunkt gesendet wird, wird eine neue Ad Break für das Livestream-Event erstellt.

Für benutzerdefinierte Pausen-IDs gelten die folgenden Einschränkungen:

  • Muss zwischen 1 und 63 Zeichen lang sein
  • Darf nur Kleinbuchstaben, Ziffern und Bindestriche enthalten.

Suchparameter

Parameter
pd Erforderlich integer

Die Dauer des Anzeigen-Pods in Millisekunden.
scte35 optional string

Base64-codiertes SCTE-35-Signal für diese Werbeunterbrechung.
cust_params optional string

Mehrere Schlüssel/Wert-Paare, die für das Targeting einer Ad Manager-Kampagne verwendet werden. Diese Paare müssen als URL-codierter Abfragestring dargestellt werden.

Beispiel:
Parameter
  • section = sports
  • page = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...
auth-token required string

Die auth-token besteht aus einem codierten HMAC-Token mit den folgenden Daten:

  • pod_id oder ad_break_id
  • network_code
  • custom_asset_key
  • cust_params
  • pd
  • scte35
  • exp

Antworttext

Bei Erfolg ist der Antworttext eine MPEG-DASH-MPD-Playlist.

Methode: DASH-Pod-Zeitraumvorlage

Methoden
pods GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

Fordert eine DASH-Zeitraumvorlage von Google Ad Manager an. Diese Vorlage enthält Makros, die Sie mit Ihren Streamparametern füllen müssen. Sobald diese Makros eingefügt wurden, wird die Vorlage zu deinem Werbeunterbrechungszeitraum und kann in dein DASH-Manifest eingefügt werden.

HTTP-Anfrage

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

Pfadparameter

Parameter
network_code string

Der Google Ad Manager-Netzwerkcode des Publishers.

custom_asset_key string

Die benutzerdefinierte ID, die diesem Ereignis in Google Ad Manager zugewiesen ist.

Suchparameter

Parameter
stream_id required string

Die Stream-ID für die Sitzung des aktuellen Nutzers. Dieser Wert wird bei einer erfolgreichen Anfrage an den stream-Endpunkt zurückgegeben.
tv optional integer

Die Vorlagenversion. Die Standardeinstellung ist 0. Gibt die zurückzugebende Pod-Vorlagenversion an.

  • 0: Fordert eine Vorlage an, die die Pod-Sequenz-ID verwendet.
  • 1: Fordert eine Vorlage an, die sowohl Pod-Sequenz- als auch Werbeunterbrechungs-IDs unterstützt.

Antworttext

Bei erfolgreicher Ausführung enthält der Antworttext ein neues PodTemplateResponse-Objekt.

Methode: Metadaten zum Timing von Anzeigen-Pods

Methoden
ad pod timing metadata GET /linear/pods/v1/adv/network/{network_code}/custom_asset/{custom_asset_key}/pod.json

Ruft Timing-Metadaten für Anzeigen-Pods ab.

HTTP-Anfrage

GET https://dai.google.com/linear/pods/v1/adv/network/{network_code}/custom_asset/{custom_asset_key}/pod.json

Pfadparameter

Parameter
network_code string

Der Google Ad Manager-Netzwerkcode des Publishers.

custom_asset_key string

Die benutzerdefinierte Kennung, die diesem Livestream in Google Ad Manager zugewiesen ist.

Suchparameter

Parameter
stream_id Erforderlich string

Die Ad Manager-Stream-ID aus der Client-Videoplayer-App.
ad_break_id required string

Die ID der nächsten anstehenden Werbeunterbrechung.

Werbeunterbrechungs-IDs werden vom Stitching-Server oder VTP bereitgestellt und müssen in Benachrichtigungen über bevorstehende Werbeunterbrechungen, Anfragen zu Metadaten für das Timing von Anzeigen-Pods und Segmentweiterleitungsanfragen für dieselbe Werbeunterbrechung übereinstimmen.

Für benutzerdefinierte Pausen-IDs gelten die folgenden Einschränkungen:

  • Muss zwischen 1 und 63 Zeichen lang sein
  • Darf nur Kleinbuchstaben, Ziffern und Bindestriche enthalten.
  • Die ID der Werbeunterbrechung preroll ist für den Abruf des Pre-Roll-Anzeigen-Pods reserviert. Es kann nicht zur Identifizierung anderer Anzeigen-Pods verwendet werden.
auth-token required string

Die auth-token besteht aus einem codierten HMAC-Token mit den folgenden Daten:

  • ad_break_id
  • network_code
  • custom_asset_key
  • cust_params
  • pd
  • scte35
  • exp
timeout optional integer

Die Anzahl der Millisekunden, die die dynamische Anzeigenbereitstellung diese Anfrage blockieren kann, um auf die Anzeigenentscheidung zu warten. Verwenden Sie diesen Parameter für Anfragen, bei denen in der ersten Anfrage Anzeigen zurückgegeben werden müssen, z. B. bei Pre-Roll-Werbeunterbrechungen.

Wenn das Zeitlimit überschritten wird, gibt die Anfrage den Status „Ausstehend“ zurück.

Wenn der Wert angegeben wird, muss er zwischen 1.000 und 15.000 Millisekunden liegen. Wenn dieser Parameter nicht angegeben wird, werden Antworten nicht verzögert, um auf die Anzeigenentscheidung zu warten.
final optional boolean

Auf true gesetzt, um der dynamischen Anzeigenbereitstellung mitzuteilen, dass dies die letzte Anfrage ist, die der VTP für diesen Anzeigen-Pod stellen möchte. Wenn eine Anzeigenentscheidung bis zum optionalen Zeitlimit noch nicht verfügbar ist, gibt DAI für diese Anfrage dauerhaft einen Slate zurück.

Die Standardeinstellung ist false.

Parameter für Anzeigenentscheidungen
pd optional integer

Die Dauer der Werbeunterbrechung in Millisekunden. Auch als Dauer des Anzeigen-Pods bezeichnet.

Wenn EABN verwendet wird, muss der „pd“-Wert mit der Dauer übereinstimmen, die in Ihrer Benachrichtigung über die Werbeunterbrechung angegeben ist. Wenn die Zeiträume nicht übereinstimmen, wird dem EABN-Wert Priorität eingeräumt.

cust_params optional string

Benutzerdefinierte Parameter für das Targeting von Werbeunterbrechungen, wie in der Ad Manager-Hilfe beschrieben.
scte35 optional string

Ein base64-codiertes SCTE-35-Signal.

Wenn das Signal ungültig ist, wird eine Nachricht im X-Ad-Manager-Dai-Warning-HTTP-Header der Antwort gesendet und die Anfrage wird ohne den ungültigen SCTE35-Wert gesendet.

Antworttext

Bei erfolgreicher Ausführung enthält der Antworttext ein neues AdPodTimingMetadataResponse-Objekt.

Methode: Media-Überprüfung

Wenn während der Wiedergabe eine Media-ID für Anzeigen gefunden wird, senden Sie sofort eine Anfrage mit der oben vom stream-Endpunkt abgerufenen media_verification_url. Diese Anfragen sind für Streams mit serverseitigem Beaconing nicht erforderlich, da die Media-Überprüfung vom Server initiiert wird.

Anfragen an den media verification-Endpunkt sind idempotent.

Methoden
media verification GET /{media_verification_url}/{ad_media_id}

Benachrichtigt die API über ein Media-Bestätigungsereignis.

festgelegt ist.

HTTP-Anfrage

GET https://{media-verification-url}/{ad-media-id}

Antworttext

media verification gibt die folgenden Antworten zurück:

  • HTTP/1.1 204 No Content, wenn die Media-Überprüfung erfolgreich ist und alle Pings gesendet werden.
  • HTTP/1.1 404 Not Found, wenn die Media aufgrund einer falschen URL-Formatierung oder eines Ablaufs nicht überprüft werden können.
  • HTTP/1.1 404 Not Found, wenn eine frühere Bestätigungsanfrage für diese ID erfolgreich war.
  • HTTP/1.1 409 Conflict, wenn zu diesem Zeitpunkt bereits eine andere Anfrage Pings sendet.

Media-IDs für Anzeigen

Kennungen für Werbemittel werden in einem separaten Metadatentrack codiert – Zeitmetadaten für HLS-Transportstream oder emsg für MP4-Dateien. Media-IDs für Anzeigen beginnen immer mit dem String google_.

Der gesamte Textinhalt des Metadateneintrags sollte vor jeder Anfrage zur Anzeigenüberprüfung an die Bestätigungs-URL angehängt werden.

Methode: Metadaten

Der Metadaten-Endpunkt unter metadata_url gibt Informationen zurück, die zum Erstellen einer Benutzeroberfläche für Anzeigen verwendet werden. Der Metadatenendpunkt ist für Streams mit serverseitigem Beaconing nicht verfügbar, da der Server für die Initiierung der Überprüfung von Werbemedien verantwortlich ist.

Methoden
metadata GET /{metadata_url}/{ad-media-id}

GET /{metadata_url}

Ruft Metadateninformationen zur Anzeige ab.

HTTP-Anfrage

GET https://{metadata_url}/{ad-media-id}

GET https://{metadata_url}

Suchparameter

Parameter
delta_token optional string

Ein intransparentes Token, das den aktuellen Synchronisierungsstatus des Clients darstellt. Falls angegeben, gibt der Server nur die Metadaten zurück, die sich seit der Generierung des Tokens geändert haben, sowie ein neues next_delta_token in der Antwort. Falls nicht angegeben, gibt der Server die vollständigen Metadaten für das gesamte DVR-Zeitfenster zurück.

Antworttext

Bei erfolgreicher Ausführung gibt die Antwort eine Instanz von PodMetadata zurück.

Metadaten parsen

Metadaten haben drei separate Abschnitte: tags, ads und breaks. Der Einstiegspunkt in die Daten ist der Bereich tags. Durchlaufen Sie die Tags und suchen Sie nach dem ersten Eintrag, dessen Name ein Präfix für die Media-ID der Anzeige im Videostream ist. Beispiel:

google_1234567890

Anschließend finden Sie ein Tag-Objekt mit dem Namen google_12345. In diesem Fall entspricht sie Ihrer Media-ID für Anzeigen. Sobald Sie das richtige Präfixobjekt für Anzeigenmedien gefunden haben, können Sie nach Anzeigen-IDs, Werbeunterbrechungs-IDs und dem Ereignistyp suchen. Anschließend werden Anzeigen-IDs zum Indexieren der ads-Objekte und Werbeunterbrechungs-IDs zum Indexieren der breaks-Objekte verwendet.

API-Objekte

Stream

Mit „Stream“ wird eine Liste von Ressourcen für einen neu erstellten Stream im JSON-Format gerendert.
JSON-Darstellung
{
  "stream_id": string,
  "media_verification_url": string,
  "metadata_url": string,
  "session_update_url": string,
  "heartbeat_url": string,
  "polling_frequency": number,
  "pod_manifest_url": string,
  "manifest_format": string,
}
Felder
stream_id string

Die GAM-Stream-ID.
media_verification_url string

Die Bestätigungs-URL für Medien, die als Basisendpunkt für das Tracking von Wiedergabeereignissen verwendet wird.
metadata_url string

Metadaten-URL, die zum Abrufen von regelmäßigen Informationen zu anstehenden Stream-Werbeereignissen verwendet wird.
session_update_url string

Die Aktualisierungs-URL der Sitzung, die zum Aktualisieren der Ausrichtungsparameter für diesen Stream verwendet wird. Die ursprünglichen Werte für die Targeting-Parameter werden bei der ersten Anfrage zum Erstellen des Streams erfasst.
heartbeat_url string

Die Heartbeat-URL, die verwendet wird, um den serverseitigen Beaconing-Stream aktiv zu halten. Sie muss alle {PollingFrequency} Sekunden angepingt werden. Wird für Streams mit serverseitigem Beaconing ausgefüllt.
polling_frequency number

Die Abfragehäufigkeit in Sekunden beim Anfordern von metadata_url oder heartbeat_url.
pod_manifest_url string

Die URL-Vorlage für das Pod-Manifest wird verwendet, um die URL zum Abrufen des Pod-Manifests eines Streams zu generieren. Sie entspricht der URL der multivarianten Playlist in HLS oder der MPD in DASH. Wird für Livestream-Events des Typs POD_SERVING_MANIFEST für die dynamische Anzeigenbereitstellung ausgefüllt. https://developers.google.com/ad-manager/api/reference/v202305/LiveStreamEventService.DynamicAdInsertionType
manifest_format string

Manifestformat ist das Format des Manifests, das von pod_manifest_url abgerufen wird, entweder DASH oder HLS.

PodMetadata

PodMetadata enthält Metadaten zu Anzeigen, Werbeunterbrechungen und Media ID-Tags.
JSON-Darstellung
{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
  "next_delta_token": string,
  "obsolete_ad_break_ids": [],
}
Felder
tags map[string, object(TagSegment)]

Karte der Tag-Segmente, die nach Tag-Präfix indexiert sind.
ads map[string, object(Ad)]

Karte der nach Anzeigen-ID indexierten Anzeigen.
ad_breaks map[string, object(AdBreak)]

Karte der Werbeunterbrechungen, indexiert nach der ID der Werbeunterbrechung.
next_delta_token string

Ein verschlüsseltes Token, das der Client beim nächsten Poll verwenden soll.
obsolete_ad_break_ids string

Eine Liste mit Anzeigenunterbrechungs-IDs, die nicht mehr aktuell sind und aus dem Cache des Clients entfernt werden sollten.

TagSegment

„TagSegment“ enthält einen Verweis auf eine Anzeige, die zugehörige Werbeunterbrechung und den Ereignistyp. TagSegment mit type="progress" sollte nicht an den Endpunkt für die Überprüfung von Anzeigenmedien gesendet werden.
JSON-Darstellung
{
  "ad": string,
  "ad_break_id": string,
  "type": string,
}
Felder
ad string

Die ID der Anzeige dieses Tags.
ad_break_id string

Die ID der Werbeunterbrechung dieses Tags.
type string

Der Ereignistyp dieses Tags.

AdBreak

„AdBreak“ beschreibt eine einzelne Werbeunterbrechung im Stream. Sie enthält eine Dauer, einen Typ (Mid/Pre/Post) und die Anzahl der Anzeigen.
JSON-Darstellung
{
  "type": string,
  "duration": number,
  "expected_duration": number,
  "ads": number,
}
Felder
type string

Gültige Pausentypen sind: „pre“, „mid“ und „post“.
duration number

Gesamtdauer der Anzeigen für diese Werbeunterbrechung in Sekunden.
expected_duration number

Erwartete Dauer der Werbeunterbrechung (in Sekunden), einschließlich aller Anzeigen und aller Slates.
ads number

Anzahl der Anzeigen in der Werbeunterbrechung.
„Anzeige“ beschreibt eine Anzeige im Stream.
JSON-Darstellung
{
  "ad_break_id": string,
  "position": 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,
  "click_tracking_urls": [],
  "verifications": [object(Verification)],
  "slate": boolean,
  "icons": [object(Icon)],
  "wrappers": [object(Wrapper)],
  "universal_ad_id": object(UniversalAdID),
  "extensions": [],
  "companions": [object(Companion)],
  "interactive_file": object(InteractiveFile),
}
Felder
ad_break_id string

Die ID der Werbeunterbrechung dieser Anzeige.
position number

Position dieser Anzeige in der Werbeunterbrechung, beginnend mit 1.
duration number

Dauer der Anzeige in Sekunden.
title string

Optionaler Titel der Anzeige.
description string

Optionale Beschreibung der Anzeige.
advertiser string

Optionale Werbe-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.
click_tracking_urls string

Optionale Klick-Tracking-URLs
verifications [object(Verification)]

Optionale Einträge für die Open Measurement-Überprüfung, in denen die Ressourcen und Metadaten aufgeführt sind, die zum Ausführen von Drittanbieter-Messcode zur Überprüfung der Creative-Wiedergabe erforderlich sind.
slate boolean

Optionaler boolescher Wert, der angibt, ob der aktuelle Eintrag ein Slate ist.
icons [object(Icon)]

Eine Liste von Symbolen, die ausgelassen wird, wenn sie leer ist.
wrappers [object(Wrapper)]

Eine Liste von Wrappern, die ausgelassen wird, wenn sie leer ist.
universal_ad_id object(UniversalAdID)

Optionale universelle Anzeigen-ID.
extensions string

Optionale Liste aller <Extension>-Knoten im VAST.
companions [object(Companion)]

Optionale Begleit-Creatives, die zusammen mit dieser Anzeige ausgeliefert werden können.
interactive_file object(InteractiveFile)

Optionales interaktives Creative (SIMID), das während der Anzeigenwiedergabe angezeigt werden soll.

PodTemplateResponse

PodTemplateResponse stellt die JSON-Nutzlast dar, die an einen VTP für das Zusammenfügen von Pods zurückgegeben wird.
JSON-Darstellung
{
  "dash_period_template": string,
  "segment_duration_ms": int64,
}
Felder
dash_period_template string

DashPeriodTemplate ist die XML-Vorlage für den Zeitraum, der vor dem Zusammenfügen mit entsprechenden Daten gefüllt werden soll.
segment_duration_ms int64

SegmentDurationMS ist die Dauer der Zeitabschnittsegmente in Millisekunden.

AdpodTimingMetadataResponse

AdpodTimingMetadataResponse enthält Informationen zum Ad-Pod und dazu, wie Segment-URLs dafür erstellt werden.
JSON-Darstellung
{
  "status": string,
  "ads": [object(AdRendering)],
  "slate": object(SlateRendering),
  "dash_representations": map[string, object(DASHRepresentation)],
  "dash_adaptation_sets": map[string, object(DASHAdaptationSet)],
}
Felder
status string

Entscheidungsstatus für den Anzeigen-Pod.
ads [object(AdRendering)]

Array von Ad-Objekten, die beschreiben, wie die URLs des Anzeigensegments gerendert werden sollen. Die Indexierung beginnt bei 0.
slate object(SlateRendering)

Slate, in der beschrieben wird, wie die Slate-Segment-URLs gerendert werden.
dash_representations map[string, object(DASHRepresentation)]

Liste der DASH-Darstellungen für diesen Anzeigen-Pod, die in DASH-Manifesten gerendert werden sollen.
dash_adaptation_sets map[string, object(DASHAdaptationSet)]

Liste der DASH-AdaptationSets für den Anzeigen-Pod, die in DASH-Manifesten gerendert werden sollen.

AdRendering

Unter „AdRendering“ wird beschrieben, wie eine Anzeige mit Entscheidung gerendert wird.
JSON-Darstellung
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
Felder
duration_ms number

Dauer der Anzeige in Millisekunden (Ganzzahl).
variants map[string, object(VariantRendering)]

Dictionary von Variant-Objekten (siehe unten), die nach der in der Benutzeroberfläche konfigurierten Variant-/Profil-ID indexiert werden.

SlateRendering

Unter SlateRendering wird beschrieben, wie Sie Slate-Inhalte rendern.
JSON-Darstellung
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
Felder
duration_ms number

Dauer des Slates in Millisekunden (Ganzzahl).
variants map[string, object(VariantRendering)]

Dictionary mit Variant-Objekten, indexiert nach Varianten-/Profil-ID. Slates müssen so lange wiederholt werden, bis die erforderliche Slate-Länge erreicht ist. Zwischen den Wiederholungen müssen HLS-Diskontinuitäten eingefügt werden. Bei MPEG-DASH müssen neue Zeiträume wiederholt werden.

VariantRendering

„VariantRendering“ beschreibt eine Variante/ein Profil innerhalb der Anzeige/des Slates.
JSON-Darstellung
{
  "segment_extension": string,
  "segment_durations": object(SegmentDurations),
}
Felder
segment_extension string

String, eine der folgenden Optionen: ts, mp4, aac, ac3, ec3, m4a, m4v. Dateiendung der Segment-URLs.
segment_durations object(SegmentDurations)

SegmentDurations-Objekte. Jede Segmentdauer kann in eine Segment-URL übersetzt werden.

SegmentDurations

„SegmentDurations“ beschreibt die Dauer einer Sequenz von Segmenten in einer angegebenen Zeiteinheit.
JSON-Darstellung
{
  "timescale": number,
  "values": [],
}
Felder
timescale number

Die Zeitskala ist die Anzahl der Einheiten pro Sekunde (int). Erwartet werden: 1000 für HLS (Millisekunden) 90000 für DASH-Video (PTS) Audio-Samplerate für DASH-Audio.
values number

Array von Segmentdauern als Ganzzahl in Zeiteinheiten.

DASHRepresentation

DASHRepresentation beschreibt Representation-Knoten, die in DASH-Manifesten gerendert werden sollen.
JSON-Darstellung
{
  "codecs": string,
  "bandwidth": number,
  "width": number,
  "height": number,
  "frame_rate": string,
  "audio_sampling_rate": number,
  "audio_channel_config": object(SchemeIDURIAndValue),
}
Felder
codecs string

Codecs der Darstellung.
bandwidth number

Bandbreite der Darstellung.
width number

Breite der Darstellung.
height number

Höhe der Darstellung.
frame_rate string

Framerate der Darstellung.
audio_sampling_rate number

Audio-Abtastrate der Darstellung.
audio_channel_config object(SchemeIDURIAndValue)

Audiokanal-Konfiguration der Darstellung.

DASHAdaptationSet

DASHAdaptationSet beschreibt AdaptationSet-Knoten, die in DASH-Manifesten gerendert werden sollen.
JSON-Darstellung
{
  "content_type": string,
  "mime_type": string,
  "role": object(SchemeIDURIAndValue),
  "inband_event_stream": object(SchemeIDURIAndValue),
  "min_frame_rate": string,
  "max_frame_rate": string,
  "scan_type": string,
  "start_with_sap": string,
  "segment_alignment": boolean,
  "representations": [],
}
Felder
content_type string

Inhaltstyp des Anpassungssatzes.
mime_type string

MIME-Typ des Anpassungssatzes.
role object(SchemeIDURIAndValue)

Rolle des Anpassungssatzes.
inband_event_stream object(SchemeIDURIAndValue)

Inband-Ereignisstream des Anpassungssatzes.
min_frame_rate string

Mindest-Framerate des Anpassungssatzes.
max_frame_rate string

Maximale Framerate des Anpassungssatzes.
scan_type string

Scantyp des Anpassungssatzes.
start_with_sap string

Mit SAP des Anpassungssatzes beginnen:
segment_alignment boolean

Segmentausrichtung des Anpassungssatzes.
representations string

Darstellungen des Anpassungssatzes:

SchemeIDURIAndValue

„SchemeIDURIAndValue“ ist ein Paar aus einer Schema-ID und ihrem Wert.
JSON-Darstellung
{
  "scheme_id_uri": string,
  "value": string,
}
Felder
scheme_id_uri string

Scheme-ID-URI des Werts.
value string

Wert des URI der Schema-ID.

Symbol

„Icon“ 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 Symbol-Clickthrough.
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, ist sie nicht enthalten.
JSON-Darstellung
{
  "system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
}
Felder
system string

Kennung des Anzeigensystems.
ad_id string

Anzeigen-ID, die für die Wrapper-Anzeige verwendet wird.
creative_id string

Creative-ID für die Wrapper-Anzeige.
creative_ad_id string

Creative-Anzeigen-ID, die für die Wrapper-Anzeige verwendet wird.
deal_id string

Optionale Deal-ID für die Wrapper-Anzeige.

Bestätigung

„Verification“ enthält Informationen für Open Measurement, die die Sichtbarkeits- und Verifizierungsmessung durch Drittanbieter 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 Verifikationsanbieter.
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 Bestätigung.
parameters string

Ein nicht transparenter String, der an den Bootstrap-Bestätigungscode übergeben wird.

JavaScriptResource

JavaScriptResource enthält Informationen zur Überprüfung über 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 Videoframeworks, das den Bestätigungscode verwendet.
browser_optional boolean

Gibt an, ob dieses Skript außerhalb eines Browsers ausgeführt werden kann.

TrackingEvent

TrackingEvent enthält URLs, die vom Client in bestimmten Situationen angepingt werden sollen.
JSON-Darstellung
{
  "event": string,
  "uri": string,
}
Felder
event string

Der Typ des Tracking-Ereignisses.
uri string

Das Tracking-Ereignis, das angepingt werden soll.

UniversalAdID

Mit UniversalAdID wird eine eindeutige Creative-Kennung bereitgestellt, die in allen Anzeigensystemen beibehalten 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 zur Identifizierung der URL für die Registry-Website, auf der die Universelle Anzeigen-ID des ausgewählten Creatives katalogisiert ist.

Companion

„Companion“ enthält Informationen zu Companion-Anzeigen, die zusammen mit der Anzeige ausgeliefert 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 diesen Companion.
creative_type string

Das CreativeType-Attribut für den <StaticResource>-Knoten im VAST, wenn es sich um einen Companion vom Typ „static“ handelt.
height int32

Die Höhe dieses Companion in Pixeln.
width int32

Die Breite dieses Companion-Banners in Pixeln.
resource string

Bei statischen und iFrame-Begleit-Creatives ist dies die URL, die geladen und angezeigt werden soll. Bei HTML-Companion-Anzeigen ist das das HTML-Snippet, das als Companion-Anzeige angezeigt werden soll.
type string

Typ dieses Companions. Sie kann statisch, als iFrame oder als HTML-Datei vorliegen.
ad_slot_id string

Die Slot-ID für diesen Companion.
api_framework string

Das API-Framework für diesen Companion.
tracking_events [object(TrackingEvent)]

Liste der Tracking-Ereignisse für diesen Companion.

InteractiveFile

„InteractiveFile“ enthält Informationen für interaktive Creatives (z.B. SIMID), die während der Anzeigenwiedergabe angezeigt werden sollen.
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 als Ressource bereitgestellten Datei.
variable_duration boolean

Gibt an, ob für dieses Creative eine Verlängerung der Dauer angefordert werden darf.
ad_parameters string

Der Wert des Knotens <AdParameters> im VAST.