Blok reklamowy dynamicznego wstawiania reklam wyświetlający aktywny interfejs API

Interfejs Dynamic Ad Insertion API umożliwia wysyłanie żądań dotyczących transmisji na żywo DAI i śledzenie ich.

Usługa: dai.google.com

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

Metoda: stream

Metody
stream POST /ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

Rejestruje sesję transmisji na żywo z wyświetlaniem bloków reklamowych w ramach dynamicznego wstawiania reklam.

Żądanie HTTP

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

Parametry ścieżki

Parametry
network_code string

Kod sieci Google Ad Managera wydawcy.

custom_asset_key string

Identyfikator niestandardowy powiązany z tym zdarzeniem w usłudze Google Ad Manager.

Treść żądania

Treść żądania jest typu application/x-www-form-urlencoded i zawiera te parametry:

Parametry
Parametry kierowania DFP Opcjonalny Dodatkowe parametry kierowania.
Zastępowanie parametrów strumienia Opcjonalny Zastąp domyślne wartości parametru tworzenia strumienia.
Uwierzytelnianie HMAC Opcjonalny Uwierzytelnianie za pomocą tokena opartego na HMAC.

Treść odpowiedzi

Jeśli operacja się uda, treść odpowiedzi będzie zawierała nowy obiekt Stream.

Open Measurement

Interfejs DAI API zawiera informacje do weryfikacji Open Measurement w polu Verifications. To pole zawiera co najmniej 1 element Verification, który zawiera listę zasobów i metadanych wymaganych do wykonania kodu pomiarowego zewnętrznych usług pomiarowych w celu weryfikacji odtwarzania kreacji. Obsługiwany jest tylko format JavaScriptResource. Więcej informacji znajdziesz na stronie IAB Tech Lab i w specyfikacji VAST 4.1.

Metoda: segment bloku reklamowego

Metody
pod segment GET /linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

Tworzy strumień DAI dla podanego identyfikatora wydarzenia.

Żądanie HTTP

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}

Parametry ścieżki

Parametry
network_code string

Kod sieci Google Ad Managera wydawcy.

custom_asset_key string

Identyfikator niestandardowy powiązany z tym zdarzeniem w usłudze Google Ad Manager.

pod_identifier

Obsługiwane są te formaty:

pod/{integer}

Identyfikator numeryczny bieżącej przerwy na reklamę. Identyfikatory bloków reklamowych są przypisywane kolejno do każdego zdarzenia przerwy na reklamę, zaczynając od 1.

ad_break_id/{string}

Ciąg znaków identyfikatora bieżącej przerwy na reklamę. Każdy nieznany identyfikator przerwy na reklamę przesłany do tego punktu końcowego powoduje utworzenie nowej przerwy na reklamę w przypadku transmisji na żywo.

W przypadku niestandardowych identyfikatorów przerw na reklamy obowiązują te ograniczenia:

  • Musi mieć od 1 do 63 znaków
  • Może zawierać jedynie małe litery, cyfry i łączniki.
profile_name string

Nazwa żądanego profilu kodującego DAI w usłudze Google Ad Manager. Profil kodowania musi być jednym ze skonfigurowanych profili kodowania dla wybranego wydarzenia.

segment_number integer

Indeks żądanego segmentu w bieżącym bloku reklamowym, zaczynający się od zera.
segment_format string

Rozszerzenie pliku powiązane z formatem segmentu, o który prosisz. Akceptowane rozszerzenia to: ts, mp4,vtt, aac, ac3 lub eac3.

Parametry zapytania

Parametry
stream_id wymagane string

Identyfikator transmisji w bieżącej sesji użytkownika. Ta wartość jest zwracana przez udane żądanie do punktu końcowego stream.
sd required1 integer

Czas trwania żądanego segmentu w milisekundach.
so opcjonalnie

Przesunięcie żądanego segmentu w bloku reklamowym w milisekundach. Jeśli pominiesz parametr so, zostanie on obliczony przez pomnożenie czasu trwania segmentu przez numer segmentu.
pd required2 integer

Czas trwania bloku reklamowego w milisekundach.
auth-token wymagane string

auth-token składa się z zakodowanego tokena HMAC zawierającego te dane:

  • pod_id lub ad_break_id
  • network_code
  • custom_asset_key
  • cust_params
  • pd
  • scte35
  • exp
last opcjonalnie boolean

Wskazuje ostatni segment w przerwie na reklamę. W przypadku wszystkich pozostałych segmentów pomiń ten parametr.
scte35 opcjonalnie string

Sygnał SCTE-35 zakodowany w formacie base64 dla tej przerwy na reklamę.
cust_params opcjonalnie string

Zestaw par klucz-wartość używany do kierowania kampanii w usłudze Ad Manager. Te pary muszą być reprezentowane jako zakodowany ciąg zapytania.

Przykład:
Parametry
  • section = sports
  • page = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

Przypisy

  1. sd nie jest wymagany w przypadku segmentów inicjujących. ↩
  2. pd nie jest wymagany w przypadku zdarzeń z włączonymi przerwami na reklamy bez czasu trwania. ↩

Przykład

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

Treść odpowiedzi

Jeśli operacja się uda, treść odpowiedzi będzie odtwarzalnym segmentem strumienia zgodnym z formatem i parametrami określonymi w żądaniu.

Metoda: plik manifestu bloku reklamowego HLS

Pobiera plik manifestu bloku reklamowego HLS transmisji na żywo, który jest gotowy do załadowania i odtwarzania przez odtwarzacz wideo klienta.

Metody
GET GET /linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset}/{pod_identifier}.m3u8;

Interfejs API do pobierania playlisty HLS z wieloma wariantami dla bloku reklamowego.

Żądanie HTTP

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

Parametry ścieżki

Parametry
network_code string

Kod sieci Google Ad Managera wydawcy.
custom_asset_key string

Identyfikator niestandardowy powiązany z tym zdarzeniem w usłudze Google Ad Manager.
pod_identifier

Obsługiwane są te formaty:

pod/{integer}

Identyfikator numeryczny bieżącej przerwy na reklamę. Identyfikatory bloków reklamowych są przypisywane kolejno do każdego zdarzenia przerwy na reklamę, zaczynając od 1.

ad_break_id/{string}

Ciąg znaków identyfikatora bieżącej przerwy na reklamę. Każdy nieznany identyfikator przerwy na reklamę przesłany do tego punktu końcowego powoduje utworzenie nowej przerwy na reklamę w przypadku transmisji na żywo.

W przypadku niestandardowych identyfikatorów przerw na reklamy obowiązują te ograniczenia:

  • Musi mieć od 1 do 63 znaków
  • Może zawierać jedynie małe litery, cyfry i łączniki.

Parametry zapytania

Parametry
stream_id Wymagany string

Identyfikator transmisji w bieżącej sesji użytkownika. Ta wartość jest zwracana w odpowiedzi na udane żądanie wysłane do punktu końcowego stream.
pd Wymagany integer

Czas trwania bloku reklamowego w milisekundach.
scte35 opcjonalnie string

Sygnał SCTE-35 zakodowany w formacie base64 dla tej przerwy na reklamę.
cust_params opcjonalnie string

Zestaw par klucz-wartość używany do kierowania kampanii w usłudze Ad Manager. Te pary muszą być reprezentowane jako zakodowany ciąg zapytania.

Przykład:
Parametry
  • section = sports
  • strona = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...
auth-token wymagane string

auth-token składa się z zakodowanego tokena HMAC zawierającego te dane:

  • pod_id lub ad_break_id
  • network_code
  • custom_asset_key
  • cust_params
  • pd
  • scte35
  • exp

Treść odpowiedzi

Jeśli operacja się uda, treść odpowiedzi będzie zawierała playlistę HLS z wieloma wariantami.

Metoda: blok reklamowy z plikiem manifestu DASH

Pobiera plik manifestu bloku reklamowego MPEG-DASH transmisji na żywo, który jest gotowy do wczytania i odtwarzania przez odtwarzacz wideo klienta.

Metody
GET GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset}/stream/{stream_id}/{pod_identifier}/manifest.mpd

Interfejs API do pobierania playlisty MPEG-DASH mpd dla bloku reklamowego.

Żądanie HTTP

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}

Parametry ścieżki

Parametry
network_code string

Kod sieci Google Ad Managera wydawcy.
custom_asset_key string

Identyfikator niestandardowy powiązany z tym zdarzeniem w usłudze Google Ad Manager.
stream_id string

Identyfikator transmisji w bieżącej sesji użytkownika. Ta wartość jest zwracana w odpowiedzi na udane żądanie wysłane do punktu końcowego stream.
pod_identifier

Obsługiwane są te formaty:

pod/{integer}

Identyfikator numeryczny bieżącej przerwy na reklamę. Identyfikatory bloków reklamowych są przypisywane kolejno do każdego zdarzenia przerwy na reklamę, zaczynając od 1.

ad_break_id/{string}

Ciąg znaków identyfikatora bieżącej przerwy na reklamę. Każdy nieznany identyfikator przerwy na reklamę przesłany do tego punktu końcowego powoduje utworzenie nowej przerwy na reklamę w przypadku transmisji na żywo.

W przypadku niestandardowych identyfikatorów przerw na reklamy obowiązują te ograniczenia:

  • Musi mieć od 1 do 63 znaków
  • Może zawierać jedynie małe litery, cyfry i łączniki.

Parametry zapytania

Parametry
pd Wymagany integer

Czas trwania bloku reklamowego w milisekundach.
scte35 opcjonalnie string

Sygnał SCTE-35 zakodowany w formacie base64 dla tej przerwy na reklamę.
cust_params opcjonalnie string

Zestaw par klucz-wartość używany do kierowania kampanii w usłudze Ad Manager. Te pary muszą być reprezentowane jako zakodowany ciąg zapytania.

Przykład:
Parametry
  • section = sports
  • strona = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...
auth-token wymagane string

auth-token składa się z zakodowanego tokena HMAC z tymi danymi:

  • pod_id lub ad_break_id
  • network_code
  • custom_asset_key
  • cust_params
  • pd
  • scte35
  • exp

Treść odpowiedzi

Jeśli operacja się uda, treść odpowiedzi będzie zawierała listę odtwarzania MPEG-DASH mpd.

Metoda: szablon okresu DASH pod

Metody
pods GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

Wysyła do Google Ad Managera żądanie szablonu okresu DASH. Ten szablon zawiera makra, które musisz wypełnić parametrami strumienia. Gdy te makra zostaną wypełnione, szablon stanie się okresem przerwy na reklamę i będzie można go wstawić do manifestu DASH.

Żądanie HTTP

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

Parametry ścieżki

Parametry
network_code string

Kod sieci Google Ad Managera wydawcy.

custom_asset_key string

Identyfikator niestandardowy powiązany z tym zdarzeniem w usłudze Google Ad Manager.

Parametry zapytania

Parametry
stream_id wymagane string

Identyfikator transmisji w bieżącej sesji użytkownika. Ta wartość jest zwracana przez udane żądanie do punktu końcowego stream.
tv opcjonalnie integer

Wersja szablonu. Domyślna wartość to 0. Określa wersję szablonu poda do zwrócenia.

  • 0: żąda szablonu, który używa identyfikatora sekwencji bloków reklamowych.
  • 1: żąda szablonu, który obsługuje zarówno identyfikatory sekwencji bloków reklamowych, jak i przerw na reklamę.

Treść odpowiedzi

Jeśli operacja się uda, treść odpowiedzi będzie zawierała nowy obiekt PodTemplateResponse.

Metoda: metadane dotyczące czasu trwania bloku reklamowego

Metody
ad pod timing metadata GET /linear/pods/v1/adv/network/{network_code}/custom_asset/{custom_asset_key}/pod.json

Pobiera metadane dotyczące czasu trwania bloku reklam.

Żądanie HTTP

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

Parametry ścieżki

Parametry
network_code string

Kod sieci Google Ad Managera wydawcy.

custom_asset_key string

Identyfikator niestandardowy powiązany z tą transmisją na żywo w usłudze Google Ad Manager.

Parametry zapytania

Parametry
stream_id Wymagany string

Identyfikator strumienia Ad Managera z aplikacji odtwarzacza wideo klienta.
ad_break_id wymagane string

Identyfikator następnej przerwy na reklamę.

Identyfikatory przerw na reklamę są podawane przez serwer łączenia lub VTP i muszą być zgodne w przypadku wczesnych powiadomień o przerwie na reklamę, żądań metadanych dotyczących czasu trwania bloku reklamowego i żądań przekierowania segmentu w odniesieniu do tej samej przerwy na reklamę.

W przypadku niestandardowych identyfikatorów przerw na reklamy obowiązują te ograniczenia:

  • Musi mieć od 1 do 63 znaków
  • Może zawierać jedynie małe litery, cyfry i łączniki.
  • Identyfikator przerwy na reklamę preroll jest zarezerwowany do pobierania bloku reklamowego przed filmem. Nie można go używać do identyfikowania innych bloków reklamowych.
auth-token wymagane string

auth-token składa się z zakodowanego tokena HMAC zawierającego te dane:

  • ad_break_id
  • network_code
  • custom_asset_key
  • cust_params
  • pd
  • scte35
  • exp
timeout opcjonalnie integer

Liczba milisekund, przez które DAI może blokować to żądanie, aby poczekać na podjęcie decyzji o reklamie. Używaj tego parametru w przypadku żądań, które muszą zwracać wypełnione reklamy w pierwszym żądaniu, np. w przypadku przerw na reklamy przed filmem.

Jeśli limit czasu zostanie przekroczony, żądanie zwróci stan oczekiwania.

Jeśli jest uwzględniona, wartość czasu oczekiwania musi mieścić się w przedziale od 1000 do 15 000 milisekund. Jeśli ten parametr zostanie pominięty, odpowiedzi nie będą opóźniane w celu oczekiwania na decyzję dotyczącą reklamy.
final opcjonalnie boolean

Ustaw wartość true, aby poinformować DAI, że jest to ostatnie żądanie, jakie VTP może wysłać w przypadku tego bloku reklamowego. Jeśli decyzja o reklamie nie jest jeszcze dostępna (w opcjonalnym czasie oczekiwania), DAI zwróci w przypadku tej prośby stałą tablicę.

Domyślna wartość to false.

Parametry procesu wyboru reklamy
pd opcjonalnie integer

Czas trwania przerwy na reklamę (w milisekundach). Nazywany też czasem trwania bloku reklamowego.

Jeśli używasz EABN, wartość pd musi być zgodna z czasem trwania podanym w powiadomieniu o przerwie na reklamę. Jeśli czas trwania nie pasuje, priorytet będzie miała wartość EABN.

cust_params opcjonalnie string

niestandardowe parametry kierowania na przerwę na reklamę, zgodnie z opisem w Centrum pomocy Ad Managera;
scte35 opcjonalnie string

Sygnał SCTE-35 zakodowany w formacie base64.

Jeśli sygnał jest nieprawidłowy, w nagłówku HTTP X-Ad-Manager-Dai-Warning odpowiedzi zostanie wysłana wiadomość, a żądanie zostanie wysłane bez nieprawidłowej wartości scte35.

Treść odpowiedzi

Jeśli operacja się uda, treść odpowiedzi będzie zawierała nowy obiekt AdPodTimingMetadataResponse.

Metoda: weryfikacja mediów

Po napotkaniu identyfikatora multimediów reklamy podczas odtwarzania natychmiast wyślij żądanie za pomocą parametru media_verification_url uzyskanego z punktu końcowego stream podanego powyżej. Te żądania nie są potrzebne w przypadku strumieni sygnalizacji po stronie serwera, w których serwer inicjuje weryfikację multimediów.

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

Metody
media verification GET /{media_verification_url}/{ad_media_id}

Powiadamia interfejs API o zdarzeniu weryfikacji multimediów.

Żądanie HTTP

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

Treść odpowiedzi

media verificationzwraca te odpowiedzi:

  • HTTP/1.1 204 No Content – jeśli weryfikacja multimediów się powiedzie i wszystkie pingi zostaną wysłane.
  • 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.
  • HTTP/1.1 404 Not Found – jeśli poprzednia prośba o weryfikację tego dokumentu tożsamości została rozpatrzona pozytywnie.
  • HTTP/1.1 409 Conflict jeśli w tym czasie inna prośba już wysyła pingi.

Identyfikatory zasobów multimedialnych reklamy

Identyfikatory multimediów reklamowych będą kodowane w osobnej ścieżce metadanych – metadanych z określonym czasem dla strumienia transportowego HLS lub w przypadku plików mp4 w elemencie emsg. Identyfikatory multimediów reklamowych zawsze zaczynają się od ciągu znaków google_.

Cała treść tekstowa wpisu metadanych powinna zostać dołączona do adresu URL weryfikacji reklamy przed wysłaniem każdego żądania weryfikacji reklamy.

Metoda: metadane

Punkt końcowy metadanych pod adresem metadata_url zwraca informacje używane do tworzenia interfejsu reklamy. Punkt końcowy metadanych nie jest dostępny w przypadku strumieni wysyłających sygnały po stronie serwera, w których serwer jest odpowiedzialny za inicjowanie weryfikacji multimediów reklamowych.

Metody
metadata GET /{metadata_url}/{ad-media-id}

GET /{metadata_url}

Pobiera informacje o metadanych reklamy.

Żądanie HTTP

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

GET https://{metadata_url}

Parametry zapytania

Parametry
delta_token opcjonalnie string

Nieprzezroczysty token reprezentujący bieżący stan synchronizacji klienta. Jeśli zostanie podany, serwer zwraca w odpowiedzi tylko metadane, które uległy zmianie od czasu wygenerowania tokena, oraz nowy token next_delta_token. Jeśli zostanie pominięty, serwer zwróci pełne metadane dla całego okna DVR.

Treść odpowiedzi

Jeśli operacja się uda, odpowiedź będzie zawierała instancję obiektu PodMetadata.

Analizowanie metadanych

Metadane składają się z 3 osobnych sekcji: tags, ads i breaks. Punktem wejścia do danych jest sekcja tags. Następnie przejrzyj tagi i znajdź pierwszy wpis, którego nazwa jest prefiksem identyfikatora multimediów reklamy znalezionego w strumieniu wideo. Możesz na przykład mieć identyfikator multimediów reklamy, który wygląda tak:

google_1234567890

Następnie znajdź obiekt tagu o nazwie google_12345. W tym przypadku jest on zgodny z identyfikatorem multimediów reklamy. Gdy znajdziesz odpowiedni obiekt z prefiksem multimediów reklamy, możesz wyszukać identyfikatory reklam, identyfikatory przerw na reklamę i typ zdarzenia. Identyfikatory reklam są następnie używane do indeksowania obiektów ads, a identyfikatory przerw na reklamy – do indeksowania obiektów breaks.

Obiekty interfejsu API

Strumień

Strumień służy do renderowania listy zasobów dla nowo utworzonego strumienia w formacie JSON.
Zapis JSON
{
  "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,
}
Pola
stream_id string

Identyfikator strumienia GAM.
media_verification_url string

URL do weryfikacji multimediów używany jako podstawowy punkt końcowy do śledzenia zdarzeń odtwarzania.
metadata_url string

Adres URL metadanych używany do okresowego sprawdzania informacji o nadchodzących zdarzeniach reklam w strumieniu.
session_update_url string

Adres URL aktualizacji sesji używany do aktualizowania parametrów kierowania w przypadku tej transmisji. Oryginalne wartości parametrów kierowania są rejestrowane podczas początkowego żądania utworzenia strumienia.
heartbeat_url string

Adres URL sygnału „heartbeat”, który służy do utrzymywania aktywności strumienia obrazów typu beacon po stronie serwera. Musi być pingowany co {PollingFrequency} sekund. Wypełniane w przypadku strumieni sygnalizowania po stronie serwera.
polling_frequency number

Częstotliwość odpytywania w sekundach podczas wysyłania żądania metadata_url lub heartbeat_url.
pod_manifest_url string

Szablon URL pliku manifestu bloku reklamowego służy do generowania adresu URL, z którego można pobrać plik manifestu bloku reklamowego transmisji, odpowiadający adresowi URL listy odtwarzania z wieloma wariantami w HLS lub MPD w DASH. Wypełniane w przypadku wydarzeń transmisji na żywo typu dynamicznego wstawiania reklam POD_SERVING_MANIFEST. https://developers.google.com/ad-manager/api/reference/v202305/LiveStreamEventService.DynamicAdInsertionType
manifest_format string

Format manifestu to format manifestu pobranego z pod_manifest_url, dash lub hls.

PodMetadata

PodMetadata zawiera informacje o metadanych reklam, przerw reklamowych i tagów identyfikatorów multimediów.
Zapis JSON
{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
  "next_delta_token": string,
  "obsolete_ad_break_ids": [],
}
Pola
tags map[string, object(TagSegment)]

Mapa segmentów tagów indeksowanych według prefiksu tagu.
ads map[string, object(Ad)]

Mapa reklam indeksowanych według identyfikatora reklamy.
ad_breaks map[string, object(AdBreak)]

Mapa przerw na reklamy indeksowanych według identyfikatora przerwy na reklamę.
next_delta_token string

Nieprzejrzysty token, którego klient może użyć podczas następnego sondowania.
obsolete_ad_break_ids string

Lista identyfikatorów przerw na reklamy, które są przestarzałe i powinny zostać usunięte z pamięci podręcznej klienta.

TagSegment

TagSegment zawiera odniesienie do reklamy, przerwy na reklamę i typu zdarzenia. Do punktu końcowego weryfikacji multimediów reklamy nie należy wysyłać pingów do elementu TagSegment z atrybutem type="progress".
Zapis JSON
{
  "ad": string,
  "ad_break_id": string,
  "type": string,
}
Pola
ad string

Identyfikator reklamy tego tagu.
ad_break_id string

Identyfikator przerwy na reklamę w tym tagu.
type string

Typ zdarzenia tego tagu.

AdBreak

AdBreak opisuje pojedynczą przerwę na reklamę w strumieniu. Zawiera czas trwania, typ (w trakcie, przed lub po) i liczbę reklam.
Zapis JSON
{
  "type": string,
  "duration": number,
  "expected_duration": number,
  "ads": number,
}
Pola
type string

Prawidłowe typy przerw to: pre, mid i post.
duration number

Łączny czas trwania reklam w tej przerwie na reklamę (w sekundach).
expected_duration number

Przewidywany czas trwania przerwy na reklamę (w sekundach), obejmujący wszystkie reklamy i plansze.
ads number

Liczba reklam w przerwie na reklamę.
Reklama opisuje reklamę w strumieniu.
Zapis JSON
{
  "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),
}
Pola
ad_break_id string

Identyfikator przerwy na reklamę tej reklamy.
position number

Pozycja tej reklamy w przerwie na reklamę, zaczynając od 1.
duration number

Czas trwania reklamy w sekundach.
title string

Opcjonalny tytuł reklamy.
description string

Opcjonalny opis reklamy.
advertiser string

Opcjonalny identyfikator reklamodawcy.
ad_system string

Opcjonalny system reklamowy.
ad_id string

Opcjonalny identyfikator reklamy.
creative_id string

Opcjonalny identyfikator kreacji.
creative_ad_id string

Opcjonalny identyfikator reklamy powiązanej z kreacją.
deal_id string

Opcjonalny identyfikator umowy.
clickthrough_url string

Opcjonalny docelowy URL.
click_tracking_urls string

Opcjonalne linki monitorujące kliknięcia.
verifications [object(Verification)]

Opcjonalne wpisy weryfikacji Open Measurement, które zawierają listę zasobów i metadanych wymaganych do wykonania kodu pomiarowego firmy zewnętrznej w celu weryfikacji odtwarzania kreacji.
slate boolean

Opcjonalna wartość logiczna wskazująca, że bieżący wpis jest tablicą.
icons [object(Icon)]

Lista ikon, pominięta, jeśli jest pusta.
wrappers [object(Wrapper)]

Lista elementów opakowujących, pominięta, jeśli jest pusta.
universal_ad_id object(UniversalAdID)

Opcjonalny uniwersalny identyfikator reklamy.
extensions string

Opcjonalna lista wszystkich węzłów <Extension> w VAST.
companions [object(Companion)]

Opcjonalne elementy towarzyszące, które mogą być wyświetlane razem z tą reklamą.
interactive_file object(InteractiveFile)

Opcjonalna interaktywna kreacja (SIMID), która powinna być wyświetlana podczas odtwarzania reklamy.

PodTemplateResponse

PodTemplateResponse reprezentuje ładunek JSON zwracany do VTP na potrzeby łączenia zasobników.
Zapis JSON
{
  "dash_period_template": string,
  "segment_duration_ms": int64,
}
Pola
dash_period_template string

DashPeriodTemplate to szablon XML okresu, który przed połączeniem należy wypełnić odpowiednimi danymi.
segment_duration_ms int64

SegmentDurationMS to czas trwania segmentów okresu w milisekundach.

AdpodTimingMetadataResponse

AdpodTimingMetadataResponse zawiera informacje o bloku reklamowym i sposobie tworzenia adresów URL segmentów dla tego bloku.
Zapis JSON
{
  "status": string,
  "ads": [object(AdRendering)],
  "slate": object(SlateRendering),
  "dash_representations": map[string, object(DASHRepresentation)],
  "dash_adaptation_sets": map[string, object(DASHAdaptationSet)],
}
Pola
status string

Stan decyzji dotyczący bloku reklamowego.
ads [object(AdRendering)]

Tablica obiektów Ad opisujących sposób renderowania adresów URL segmentów reklam, indeksowana od 0.
slate object(SlateRendering)

Slate opisujący sposób renderowania adresów URL segmentów slate.
dash_representations map[string, object(DASHRepresentation)]

Lista reprezentacji DASH dla tego bloku reklamowego, które mają być renderowane w plikach manifestu DASH.
dash_adaptation_sets map[string, object(DASHAdaptationSet)]

Lista zestawów adaptacyjnych DASH dla tego bloku reklamowego, które mają być renderowane w plikach manifestu DASH.

AdRendering

AdRendering opisuje, jak renderować reklamę, w przypadku której podjęto decyzję.
Zapis JSON
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
Pola
duration_ms number

Czas trwania reklamy w milisekundach (liczba całkowita).
variants map[string, object(VariantRendering)]

Słownik obiektów Variant (patrz poniżej) indeksowany według identyfikatora wariantu lub profilu skonfigurowanego w interfejsie.

SlateRendering

SlateRendering opisuje sposób renderowania treści w formacie Slate.
Zapis JSON
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
Pola
duration_ms number

Czas trwania slajdu w milisekundach (liczba całkowita).
variants map[string, object(VariantRendering)]

Słownik obiektów wariantów indeksowany według identyfikatora wariantu lub profilu. Czas trwania slajdów musi być powtarzany w pętli, aż do osiągnięcia wymaganej długości slajdu, z wstawianiem przerw HLS między iteracjami lub powtarzaniem nowych okresów w przypadku MPEG-DASH.

VariantRendering

VariantRendering opisuje 1 wariant lub profil w reklamie lub slajdzie.
Zapis JSON
{
  "segment_extension": string,
  "segment_durations": object(SegmentDurations),
}
Pola
segment_extension string

Ciąg znaków, jedna z wartości: ts, mp4, aac, ac3, ec3, m4a, m4v. Rozszerzenie nazwy pliku jest częścią adresów URL segmentów.
segment_durations object(SegmentDurations)

Obiekty SegmentDurations. Czas trwania każdego segmentu można przekształcić w adres URL segmentu.

SegmentDurations

SegmentDurations opisuje czas trwania sekwencji segmentów w określonej jednostce czasu.
Zapis JSON
{
  "timescale": number,
  "values": [],
}
Pola
timescale number

Timescale to liczba jednostek na sekundę (int) Oczekiwane wartości: 1000 w przypadku HLS (milisekundy) 90000 w przypadku wideo DASH (PTS) Częstotliwość próbkowania dźwięku w przypadku dźwięku DASH.
values number

Tablica czasów trwania segmentów w jednostkach skali czasu.

DASHRepresentation

DASHRepresentation opisuje węzły Representation, które mają być renderowane w plikach manifestu DASH.
Zapis JSON
{
  "codecs": string,
  "bandwidth": number,
  "width": number,
  "height": number,
  "frame_rate": string,
  "audio_sampling_rate": number,
  "audio_channel_config": object(SchemeIDURIAndValue),
}
Pola
codecs string

Kodeki reprezentacji.
bandwidth number

Przepustowość reprezentacji.
width number

Szerokość reprezentacji.
height number

Wysokość reprezentacji.
frame_rate string

Liczba klatek reprezentacji.
audio_sampling_rate number

Częstotliwość próbkowania audio w reprezentacji.
audio_channel_config object(SchemeIDURIAndValue)

Konfiguracja kanału audio reprezentacji.

DASHAdaptationSet

DASHAdaptationSet opisuje węzły AdaptationSet, które mają być renderowane w plikach manifestu DASH.
Zapis JSON
{
  "content_type": string,
  "mime_type": string,
  "role": object(SchemeIDURIAndValue),
  "inband_event_stream": object(SchemeIDURIAndValue),
  "min_frame_rate": string,
  "max_frame_rate": string,
  "scan_type": string,
  "start_with_sap": string,
  "segment_alignment": boolean,
  "representations": [],
}
Pola
content_type string

Typ treści w zestawie adaptacyjnym.
mime_type string

Typ MIME zestawu adaptacyjnego.
role object(SchemeIDURIAndValue)

Rola zestawu adaptacyjnego.
inband_event_stream object(SchemeIDURIAndValue)

Strumień zdarzeń w pasmie zestawu adaptacyjnego.
min_frame_rate string

Minimalna liczba klatek na sekundę w zestawie adaptacyjnym.
max_frame_rate string

Maksymalna liczba klatek w zestawie adaptacyjnym.
scan_type string

Typ skanowania zestawu adaptacyjnego.
start_with_sap string

Zacznij od SAP w zestawie adaptacyjnym.
segment_alignment boolean

Wyrównanie segmentów w zestawie adaptacyjnym.
representations string

Reprezentacje zestawu adaptacyjnego.

SchemeIDURIAndValue

SchemeIDURIAndValue to para identyfikatora schematu i jego wartości.
Zapis JSON
{
  "scheme_id_uri": string,
  "value": string,
}
Pola
scheme_id_uri string

Identyfikator URI schematu wartości.
value string

Wartość identyfikatora schematu URI.

Ikona

Element Icon zawiera informacje o ikonie VAST.
Zapis JSON
{
  "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,
}
Pola
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

ClickData zawiera informacje o kliknięciu ikony.
Zapis JSON
{
  "url": string,
}
Pola
url string

FallbackImage

FallbackImage zawiera informacje o zastępczym obrazie VAST.
Zapis JSON
{
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "alt_text": string,
}
Pola
creative_type string

height int32

width int32

resource string

alt_text string

Wrapper

Element opakowujący zawiera informacje o reklamie opakowującej. Nie zawiera identyfikatora umowy, jeśli nie istnieje.
Zapis JSON
{
  "system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
}
Pola
system string

Identyfikator systemu reklamowego.
ad_id string

Identyfikator reklamy używany w reklamie opakowującej.
creative_id string

Identyfikator kreacji użyty w reklamie z kodem towarzyszącym.
creative_ad_id string

Identyfikator reklamy powiązanej z kreacją używany w reklamie w kodzie towarzyszącym.
deal_id string

Opcjonalny identyfikator umowy dotyczący reklamy opakowującej.

Weryfikacja

Weryfikacja zawiera informacje o Open Measurement, które ułatwiają pomiar widoczności i weryfikacji przez podmioty zewnętrzne. Obecnie obsługiwane są tylko zasoby JavaScript. Więcej informacji znajdziesz na stronie https://iabtechlab.com/standards/open-measurement-sdk/
Zapis JSON
{
  "vendor": string,
  "java_script_resources": [object(JavaScriptResource)],
  "tracking_events": [object(TrackingEvent)],
  "parameters": string,
}
Pola
vendor string

Dostawca systemu weryfikacji.
java_script_resources [object(JavaScriptResource)]

Lista zasobów JavaScript do weryfikacji.
tracking_events [object(TrackingEvent)]

Lista zdarzeń śledzenia weryfikacji.
parameters string

Nieprzezroczysty ciąg znaków przekazywany do kodu weryfikacyjnego rozruchu.

JavaScriptResource

JavaScriptResource zawiera informacje do weryfikacji za pomocą JavaScriptu.
Zapis JSON
{
  "script_url": string,
  "api_framework": string,
  "browser_optional": boolean,
}
Pola
script_url string

Identyfikator URI do ładunku JavaScript.
api_framework string

APIFramework to nazwa platformy wideo, która używa kodu weryfikacyjnego.
browser_optional boolean

Określa, czy ten skrypt można uruchomić poza przeglądarką.

TrackingEvent

TrackingEvent zawiera adresy URL, do których klient powinien wysyłać pingi w określonych sytuacjach.
Zapis JSON
{
  "event": string,
  "uri": string,
}
Pola
event string

Typ zdarzenia śledzenia.
uri string

Zdarzenie śledzenia, które ma zostać wysłane.

UniversalAdID

Identyfikator UniversalAdID służy do podawania unikalnego identyfikatora kreacji, który jest zachowywany w różnych systemach reklamowych.
Zapis JSON
{
  "id_value": string,
  "id_registry": string,
}
Pola
id_value string

Uniwersalny identyfikator reklamy wybranej kreacji reklamy.
id_registry string

Ciąg znaków służący do identyfikacji adresu URL witryny rejestru, w której katalogowany jest uniwersalny identyfikator reklamy wybranej kreacji.

Reklama towarzysząca

Element towarzyszący zawiera informacje o reklamach towarzyszących, które mogą się wyświetlać obok reklamy.
Zapis JSON
{
  "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)],
}
Pola
click_data object(ClickData)

Dane o kliknięciach tej kreacji towarzyszącej.
creative_type string

Atrybut CreativeType w węźle <StaticResource> w tagu VAST, jeśli jest to reklama towarzysząca typu statycznego.
height int32

Wysokość tego elementu towarzyszącego w pikselach.
width int32

Szerokość tego elementu towarzyszącego w pikselach.
resource string

W przypadku statycznych i iframe’owych reklam towarzyszących będzie to adres URL, który ma zostać wczytany i wyświetlony. W przypadku reklam towarzyszących w formacie HTML będzie to fragment kodu HTML, który powinien być wyświetlany jako reklama towarzysząca.
type string

Typ tego urządzenia towarzyszącego. Może to być statyczny, iframe lub HTML.
ad_slot_id string

Identyfikator miejsca na reklamy towarzyszące.
api_framework string

Platforma interfejsu API tego komponentu.
tracking_events [object(TrackingEvent)]

Lista zdarzeń śledzenia w przypadku tego komponentu towarzyszącego.

InteractiveFile

InteractiveFile zawiera informacje o interaktywnej kreacji (np. SIMID), która powinna być wyświetlana podczas odtwarzania reklamy.
Zapis JSON
{
  "resource": string,
  "type": string,
  "variable_duration": boolean,
  "ad_parameters": string,
}
Pola
resource string

Adres URL interaktywnej kreacji.
type string

Typ MIME pliku podanego jako zasób.
variable_duration boolean

Czy w przypadku tej kreacji można poprosić o przedłużenie czasu trwania.
ad_parameters string

Wartość węzła <AdParameters> w VAST.