Lineare API für die dynamische Anzeigenbereitstellung

Mit der API für die dynamische Anzeigenbereitstellung können Sie lineare DAI-Streams (LIVE) anfordern und verfolgen.

Dienst: dai.google.com

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

Methode: stream

HTTP-Anfrage

POST https://dai.google.com/linear/v1/hls/event/{assetKey}/stream

Anfrageheader

Authorization: DCLKDAI key="<api-key>"

Pfadparameter

Anfragetext

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

Antworttext

Bei Erfolg enthält der Antworttext eine neue Stream. Bei Streams mit serverseitigem Beaconing enthält Stream nur die Felder stream_id und stream_manifest.

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: Media-Überprüfung

Wenn während der Wiedergabe eine Media-ID für Anzeigen gefunden wird, senden Sie sofort eine Anfrage über die media_verification_url, die Sie vom stream-Endpunkt erhalten haben. 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.

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 (HLS)

Anzeigen-Media-IDs werden in HLS Timed Metadata mit dem Schlüssel TXXX codiert, der für Frames mit „nutzerdefinierten Textinformationen“ reserviert ist. Der Inhalt des Frames ist unverschlüsselt und beginnt immer mit dem Text "google_".

Der gesamte Textinhalt des Frames sollte vor jeder Anfrage zur Anzeigenüberprüfung an die URL zur Anzeigenüberprüfung 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 nicht für Streams mit serverseitigem Beaconing verfügbar, bei denen der Server für die Initiierung der Überprüfung von Werbemedien verantwortlich ist.

HTTP-Anfrage

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

GET https://{metadata_url}

Suchparameter

Antworttext

Bei Erfolg gibt die Antwort eine Instanz von PodMetadata zurück.

Mit Metadaten arbeiten

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. Anzeigen-IDs werden dann zum Indexieren der ads-Objekte und Werbeunterbrechungs-IDs zum Indexieren der breaks-Objekte verwendet.

Antwortdaten

Stream

{
  "stream_id": string,
  "stream_manifest": string,
  "hls_master_playlist": string,
  "media_verification_url": string,
  "metadata_url": string,
  "session_update_url": string,
  "polling_frequency": number,
}

PodMetadata

{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
  "next_delta_token": string,
  "obsolete_ad_break_ids": [],
}

TagSegment

{
  "ad": string,
  "ad_break_id": string,
  "type": string,
}

AdBreak

{
  "type": string,
  "duration": number,
  "expected_duration": number,
  "ads": number,
}

Anzeige

{
  "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),
}

Symbol

{
  "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

{
  "url": string,
}

FallbackImage

{
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "alt_text": string,
}

Wrapper

{
  "system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
}

Bestätigung

{
  "vendor": string,
  "java_script_resources": [object(JavaScriptResource)],
  "tracking_events": [object(TrackingEvent)],
  "parameters": string,
}

JavaScriptResource

{
  "script_url": string,
  "api_framework": string,
  "browser_optional": boolean,
}

TrackingEvent

{
  "event": string,
  "uri": string,
}

UniversalAdID

{
  "id_value": string,
  "id_registry": string,
}

Companion

{
  "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)],
}

InteractiveFile

{
  "resource": string,
  "type": string,
  "variable_duration": boolean,
  "ad_parameters": string,
}