Interfejs API VOD do dynamicznego wstawiania reklam

Interfejs Dynamic Ad Insertion API umożliwia zgłaszanie żądań związanych z DAI i ich śledzenie strumieni wideo na żądanie (VOD). Obsługiwane są strumienie HLS i DASH.

Usługa: dai.google.com

Ścieżka metody stream jest podawana w kierunku https://dai.google.com

Metoda: strumień

Żądanie HTTP

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

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

Pole Verifications zawiera informacje o polu Otwórz Weryfikacja pomiarów w przypadku strumieni z sygnalizowaniem innym niż po stronie serwera. Verifications zawiera co najmniej 1 element Verification z listą zasobów i metadanych, które są potrzebne do zweryfikowania odtwarzania kreacji za pomocą kodu pomiarowego firmy zewnętrznej. Obsługiwana jest tylko wartość JavaScriptResource. Aby dowiedzieć się więcej, odwiedź IAB Tech Lab i specyfikacja VAST 4.1.

Metoda: weryfikacja multimediów

Gdy natrafisz na identyfikator multimediów podczas odtwarzania, od razu wykonaj za pomocą żądania media_verification_url z stream punktu końcowego. media_verification_url jest ścieżką bezwzględną. W przypadku strumieni beaconing po stronie serwera żądania weryfikacji mediów nie są konieczne. gdy serwer rozpoczyna weryfikację multimediów.

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

Żądanie HTTP

GET {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 reklamowych będą kodowane w metadanych czasowych HLS za pomocą klucza TXXX, zarezerwowane na „informacje tekstowe zdefiniowane przez użytkownika” ramki. Zawartość ramki nie będą zaszyfrowane i zawsze będą się zaczynać od tekstu "google_".

Cała zawartość tekstowa ramki powinna być dodana do sekcji media_verification_url do każdego żądania weryfikacji reklam.

Identyfikatory mediów reklamowych (DASH)

Identyfikatory mediów reklam będą wstawiane do pliku manifestu za pomocą polecenia Element EventStream na stronie DASH.

Każdy element EventStream będzie miał identyfikator URI identyfikatora schematu o wartości urn:google:dai:2018. Będą one zawierać zdarzenia z atrybutem messageData zawierającym identyfikator multimediów reklamy zaczynający się od “google_”. Cała treść pliku messageData należy dołączyć atrybut media_verification_url do każdej reklamy o weryfikację.

Dane odpowiedzi

Strumień

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

Reklama

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

Zdarzenie

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

Podtytuł

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

SkipMetadata

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

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