VOD API für die dynamische Anzeigenbereitstellung

Mit der Dynamic Ad Insertion API kannst du Video-on-Demand-Streams (VOD) mit dynamischer Anzeigenbereitstellung anfordern und erfassen. HLS- und DASH-Streams werden unterstützt.

Dienst: dai.google.com

Der Pfad der stream-Methode ist relativ zu https://dai.google.com

Methode: stream

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

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 serverseitigen Beaconing-Streams enthält Stream nur die Felder stream_id und stream_manifest.

Open Measurement

Das Feld Verifications enthält Informationen zur Überprüfung von Open Measurement-Streams ohne serverseitiges Beaconing. Verifications enthält ein oder mehrere Verification-Elemente mit den Ressourcen und Metadaten, die Sie zur Überprüfung der Creative-Wiedergabe mit dem Messcode eines Drittanbieters benötigen. 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 du während der Wiedergabe eine Anzeigenmedien-ID siehst, sende sofort eine Anfrage mit der media_verification_url vom Endpunkt stream. media_verification_url ist ein absoluter Pfad. Anfragen zur Medienüberprüfung sind für serverseitige Beaconing-Streams nicht erforderlich, da die Medienüberprüfung vom Server initiiert wird.

Anfragen an den media verification-Endpunkt sind idempotent.

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 war und alle Pings gesendet wurden.
• HTTP/1.1 404 Not Found, wenn die Medien aufgrund einer falschen URL-Formatierung oder eines Ablaufdatums nicht bestätigt werden können.
• HTTP/1.1 404 Not Found, wenn eine vorherige Bestätigungsanfrage für diesen Ausweis erfolgreich war.
• HTTP/1.1 409 Conflict, wenn zu diesem Zeitpunkt bereits Pings für eine andere Anfrage gesendet werden.

Anzeigen-Media-IDs (HLS)

Anzeigenmedien-IDs werden in HLS-zeitbasierten Metadaten 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 muss für jede Anfrage zur Anzeigenüberprüfung an media_verification_url angehängt werden.

Anzeigenmedien-IDs (DASH)

Anzeigenmedien-IDs werden über das DASH-Element EventStream in das Manifest eingefügt.

Jeder EventStream hat einen Scheme-ID-URI von 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 muss für jede Anfrage zur Anzeigenüberprüfung an media_verification_url angehängt werden.

Antwortdaten

Stream

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

AppleTV

{
  "interstitials_url": string,
}

AdBreak

{
  "type": string,
  "start": number,
  "duration": number,
  "ads": [object(Ad)],
}

Anzeige

{
  "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),
  "skip_metadata": object(SkipMetadata),
  "extensions": [],
}

Ereignis

{
  "time": number,
  "type": string,
}

Untertitel

{
  "language": string,
  "language_name": string,
  "ttml": string,
  "webvtt": string,
}

SkipMetadata

{
  "offset": number,
  "tracking_url": string,
}

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