Interfejs API dynamicznego wstawiania reklam

Interfejs Dynamic Ad Insertion API umożliwia zgłaszanie żądań związanych z DAI i ich śledzenie linearnych transmisji na żywo.

Usługa: dai.google.com

Wszystkie identyfikatory URI wymienione poniżej odnoszą się do elementu https://dai.google.com

Metoda: strumień

Żądanie HTTP

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

Nagłówek żądania

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

Parametry ścieżki

Treść żądania

Treść żądania jest typu application/x-www-form-urlencoded i zawiera następujące parametry:

Treść odpowiedzi

Jeśli operacja się uda, treść odpowiedzi będzie zawierała nowy Stream W przypadku strumieni z sygnalizowaniem po stronie serwera Stream zawiera tylko pola stream_id i stream_manifest.

Open Measurement

Interfejs DAI API zawiera informacje potrzebne do weryfikacji Open Measurement w Verifications. To pole zawiera co najmniej jedno pole Elementy Verification zawierające listę zasobów i metadanych wymaganych do wykonania za pomocą kodu pomiarowego firmy zewnętrznej, by sprawdzić odtwarzanie kreacji. Tylko JavaScriptResource jest obsługiwany. Więcej informacji: IAB Tech Lab i Specyfikacja VAST 4.1.

Metoda: weryfikacja multimediów

Po napotkaniu identyfikatora multimediów podczas odtwarzania natychmiast wykonaj żądania przy użyciu parametru media_verification_url uzyskanego ze stream punktu końcowego powyżej. Te żądania nie są niezbędne do sygnalizowania po stronie serwera gdzie to serwer rozpoczyna weryfikację multimediów.

Żądania do punktu końcowego media verification są idempotentne.

Żądanie HTTP

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

Treść odpowiedzi

media verification zwraca następujące odpowiedzi:

• HTTP/1.1 204 No Content, jeśli weryfikacja mediów się uda i wysłane zostaną wszystkie pingi.
• HTTP/1.1 404 Not Found, jeśli nie można zweryfikować multimediów z powodu nieprawidłowego formatowania adresu URL lub wygaśnięcia ważności.
• HTTP/1.1 404 Not Found, jeśli wcześniejsza prośba o weryfikację została zrealizowana.
• HTTP/1.1 409 Conflict, jeśli inne żądanie wysyła w tej chwili pingi.

Identyfikatory mediów reklamowych (HLS)

Identyfikatory mediów reklam będą kodowane w metadanych czasowych HLS za pomocą klucza TXXX, zarezerwowany na potrzeby zdefiniowanych przez użytkownika informacji tekstowych ramki. zawartość ramki nie będzie zaszyfrowana i zawsze będzie zaczynać się od tekstu "google_"

Cały tekst ramki powinien być dołączony do kodu weryfikacyjnego reklamy adres URL przed wysłaniem każdego żądania weryfikacji reklamy.

Metoda: metadane

Punkt końcowy metadanych w domenie metadata_url zwraca informacje użyte do utworzenia reklamy Interfejs. Punkt końcowy metadanych jest niedostępny w przypadku strumieni beaconing po stronie serwera. na której serwer jest odpowiedzialny za zainicjowanie weryfikacji mediów reklamowych.

Żądanie HTTP

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

GET https://{metadata_url}

Treść odpowiedzi

Jeśli operacja się uda, odpowiedź zwróci wystąpienie PodMetadata

Praca z metadanymi

Metadane składają się z 3 oddzielnych sekcji: tags, ads i reklamy breaks. Wpis do danych jest sekcja tags. Następnie przejrzyj tagi, i znajdź pierwszy wpis, którego nazwa jest prefiksem ad media ID znaleziony w strumieniu wideo. Na przykład: może mieć identyfikator multimediów reklamy, który wygląda tak:

google_1234567890

Następnie znajdziesz obiekt tagu o nazwie google_12345. W tym przypadku jest ona zgodna z identyfikator multimediów reklamy. Po znalezieniu właściwego obiektu prefiksu mediów reklamowych możesz wyszukać identyfikatory reklam, identyfikatory przerw na reklamę i typ zdarzenia. Identyfikatory reklam są następnie używane do indeksowania Obiekty ads i identyfikatory przerwy na reklamę są używane do indeksowania obiektów breaks.

Dane odpowiedzi

Strumień

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

Reklama

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

Ikona

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

Weryfikacja

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

Reklama towarzysząca

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