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

Mit der Dynamic Ad Insertion API kannst du Livestreams mit dynamischer Anzeigenbereitstellung anfordern und erfassen.

Dienst: dai.google.com

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

Methode: stream

HTTP-Anfrage

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

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 ein neues Stream-Objekt.

Open Measurement

Die DAI API enthält im Feld Verifications Informationen zur Open Measurement-Überprüfung. Dieses Feld enthält ein oder mehrere Verification-Elemente mit den Ressourcen und Metadaten, die zum Ausführen des Messcodes von Drittanbietern erforderlich sind, um die Creative-Wiedergabe zu überprüfen. Nur JavaScriptResource wird unterstützt. Weitere Informationen finden Sie im IAB Tech Lab und in der VAST 4.1-Spezifikation.

Methode: Pod-Segment

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

Abfrageparameter

Fußnoten

1. sd ist für Initialisierungssegmente nicht erforderlich. ↩
2. Für Ereignisse mit aktivierten Werbeunterbrechungen ohne Dauer ist pd 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 enthält der Antworttext ein abspielbares Streamsegment, das dem in der Anfrage angegebenen Format und den angegebenen Parametern entspricht.

Methode: HLS-Pod-Manifest

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

HTTP-Anfrage

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

Pfadparameter

Abfrageparameter

Antworttext

Bei Erfolg enthält der Antworttext eine HLS-Playlist mit mehreren Varianten.

Methode: DASH-Pod-Manifest

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

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

Abfrageparameter

Antworttext

Bei Erfolg enthält der Antworttext eine MPEG-DASH-mpd-Playlist.

Methode: DASH-Pod-Zeitraumvorlage

HTTP-Anfrage

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

Pfadparameter

Abfrageparameter

Antworttext

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

Methode: Medienüberprüfung

Wenn während der Wiedergabe eine Anzeigen-Media-ID erkannt wird, sende sofort eine Anfrage mit der media_verification_url, die du oben über den stream-Endpunkt abgerufen hast. Diese Anfragen sind für serverseitige Beaconing-Streams nicht erforderlich, bei denen der Server die Medienüberprüfung initiiert.

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 Medienüberprüfung erfolgreich ist und alle Pings gesendet werden.
• HTTP/1.1 404 Not Found, wenn die Medien aufgrund einer falschen URL-Formatierung oder eines Ablaufdatums nicht überprüft werden können.
• HTTP/1.1 404 Not Found, wenn eine vorherige Bestätigungsanfrage für diese ID erfolgreich war.
• HTTP/1.1 409 Conflict, wenn eine andere Anfrage derzeit bereits Pings sendet.

Anzeigenmedien-IDs

Anzeigenmedien-IDs werden in einem separaten Metadaten-Track codiert – zeitbezogene Metadaten für HLS-Transportstreams oder emsg für MP4-Dateien. IDs für Anzeigenmedien beginnen immer mit der Zeichenfolge google_.

Der gesamte Textinhalt des Metadateneintrags muss der URL für die Anzeigenüberprüfung vor jeder Anfrage zur Anzeigenüberprüfung angehängt werden.

Methode: metadata

Der Metadaten-Endpunkt unter metadata_url gibt Informationen zurück, die zum Erstellen einer Anzeigen-UI verwendet werden. Der Metadatenendpunkt ist nicht für serverseitige Beaconing-Streams verfügbar, bei denen der Server für die Initiierung der Überprüfung von Anzeigenmedien verantwortlich ist.

HTTP-Anfrage

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

GET https://{metadata_url}

Antworttext

Bei Erfolg 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. Gehe dann die Tags durch und suche nach dem ersten Eintrag, dessen Name ein Präfix für die Anzeigenmedien-ID im Videostream ist. Eine Anzeigenmedien-ID könnte beispielsweise so aussehen:

google_1234567890

Dann finden Sie ein Tag-Objekt mit dem Namen google_12345. In diesem Fall entspricht sie der Anzeigenmedien-ID. Sobald Sie das richtige Anzeigenmedienpräfixobjekt gefunden haben, können Sie die Anzeigen-IDs, Werbeunterbrechungen-IDs und den Ereignistyp abrufen. Anschließend werden die ads-Objekte mit Anzeigen-IDs indexiert und die breaks-Objekte mit den Werbeunterbrechungs-IDs.

Antwortdaten

Stream

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

PodMetadata

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

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

PodTemplateResponse

{
  "dash_period_template": string,
  "segment_duration_ms": int64,
}

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,
}

Überprüfung

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