Lineare API für die dynamische Anzeigenbereitstellung

Mit der Dynamic Ad Insert API können Sie die dynamische Anzeigenbereitstellung anfordern und erfassen. lineare Livestreams (LIVE-Streams).

Dienst: dai.google.com

Alle unten angegebenen URIs verweisen 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 folgende Parameter:

Antworttext

Wenn der Vorgang erfolgreich ist, enthält der Antworttext ein neues Stream Für serverseitige Beaconing-Streams: Stream enthält nur die Felder stream_id und stream_manifest.

Open Measurement

Die DAI API enthält Informationen zur Open Measurement-Überprüfung in der Verifications-Feld. Dieses Feld enthält mindestens einen Verification-Elemente, die die für die Ausführung erforderlichen Ressourcen und Metadaten auflisten Drittanbieter-Messcode verwenden, um die Creative-Wiedergabe zu überprüfen. Nur JavaScriptResource wird unterstützt. Weitere Informationen finden Sie in der IAB Tech Lab und die VAST 4.1-Spezifikation.

Methode: Medienüberprüfung

Wenn bei der Wiedergabe eine Medien-ID für die Anzeige erkannt wird, Anfrage mit der media_verification_url aus dem stream Endpunkt oben. Für das serverseitige Beaconing sind diese Anfragen nicht erforderlich. Streams, bei denen der Server die Medienüberprüfung initiiert.

Anfragen an den Endpunkt media verification sind idempotent.

HTTP-Anfrage

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

Antworttext

media verification gibt folgende 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 aus Anzeigen werden mithilfe des Schlüssels in HLS Timed Metadata codiert TXXX, reserviert für „benutzerdefinierte Textinformationen“ Frames. Die Der Inhalt des Frames wird nicht verschlüsselt und beginnt immer mit dem Text. "google_"

Der gesamte Textinhalt des Frames sollte an die Anzeigenüberprüfung angehängt werden. URL vor jeder Anzeigenüberprüfungsanforderung zu sehen.

Methode: metadata

Der Metadaten-Endpunkt metadata_url gibt Informationen zurück, die zum Erstellen einer Anzeige verwendet werden. UI. Der Metadatenendpunkt ist nicht für serverseitige Beaconing-Streams verfügbar, Der Server ist hier für die Initiierung der Überprüfung der Anzeigenmedien zuständig.

HTTP-Anfrage

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

GET https://{metadata_url}

Antworttext

Bei Erfolg gibt die Antwort eine Instanz von PodMetadata

Mit Metadaten arbeiten

Metadaten haben drei separate Abschnitte: tags, ads und Anzeige breaks. Der Eintrag Punkt in die Daten ist der Abschnitt tags. Anschließend können Sie die Tags und suchen Sie den ersten Eintrag, dessen Name ein Präfix für die Die Media-ID der Anzeige wurde im Videostream gefunden. Zum Beispiel haben Sie könnte eine Anzeigenmedien-ID haben, die so aussieht:

google_1234567890

Nun finden Sie ein Tag-Objekt mit dem Namen google_12345. In diesem Fall entspricht er Media-ID der Anzeige. Sobald Sie das richtige Anzeigenmedienpräfix-Objekt gefunden haben, können Sie Anzeigen-IDs, Werbeunterbrechungen-IDs und den Ereignistyp. Die Anzeigen-IDs werden dann zur Indexierung der ads-Objekte und Werbeunterbrechungs-IDs werden verwendet, um die breaks-Objekte zu indexieren.

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

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

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