Interfejs Dynamic Ad Insertion API umożliwia żądanie transmisji na żywo z dynamicznym wstawianiem reklam i ich śledzenie.
Usługa: dai.google.com
Wszystkie identyfikatory URI są względne względem adresu https://dai.google.com
.
Metoda: strumień
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 Google Ad Manager. |
Treść żądania
Treść żądania ma typ application/x-www-form-urlencoded
i zawiera te parametry:
Parametry | ||
---|---|---|
Parametry kierowania DFP | Opcjonalny | Dodatkowe parametry kierowania. |
Zastępowanie parametrów strumienia | Opcjonalny | Zastępowanie domyślnych wartości parametru tworzenia strumienia. |
Uwierzytelnianie HMAC | Opcjonalny | Uwierzytelnianie za pomocą tokena opartego na HMAC. |
Treść odpowiedzi
Jeśli operacja się powiedzie, treść odpowiedzi będzie zawierać 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 firmy zewnętrznej w celu weryfikacji odtwarzania kreacji. Obsługiwana jest tylko wartość JavaScriptResource
. Więcej informacji znajdziesz w specyfikacji IAB Tech Lab i specyfikacji VAST 4.1.
Metoda: pod segment
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 zdarzenia. |
Żą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 Google Ad Manager. |
pod_identifier |
Obsługiwane są te formaty: pod/{integer}
Identyfikator numeryczny bieżącej przerwy na reklamę. Identyfikatory podsegmentów reklamy są przypisywane stopniowo do każdego zdarzenia przerwy na reklamę, zaczynając od ad_break_id/{string}
Identyfikator ciągu znaków bieżącej przerwy na reklamę. Identyfikator przerwy na reklamę podany przez wydawcę nie jest ograniczony w taki sam sposób jak identyfikator bloku reklamowego. Każdy nieznany identyfikator przerwy na reklamę przesłany do tego punktu końcowego tworzy nową przerwę na reklamę dla transmisji na żywo. |
profile_name |
string
Nazwaprofilu kodującego DAI Google Ad Managera, którego dotyczy żądanie. Profil kodowania musi być jednym ze skonfigurowanych profili kodowania dla wybranego zdarzenia. |
segment_number |
integer
Indeks żądanego segmentu w bieżącym podzbiorze reklam, zaczynając od zera. |
segment_format |
string
Rozszerzenie pliku powiązane z żądanym formatem segmentu.
Akceptowane rozszerzenia to: |
Parametry zapytania
Parametry | ||||||
---|---|---|---|---|---|---|
stream_id |
wymagany |
string
Identyfikator strumienia dla bieżącej sesji użytkownika. Ta wartość jest zwracana przez |
||||
sd |
required1
|
integer
Czas trwania żądanego segmentu (w milisekundach). |
||||
so |
opcjonalnie |
Odsunięcie żądanego segmentu w bloku reklamowym w milisekundach.
Jeśli pominiesz parametr |
||||
pd |
wymagany2 |
integer
Czas trwania bloku reklamowego w milisekundach. |
||||
auth-token |
wymagany |
string
Podpisany, zakodowany w formacie URL token HMAC bieżącego podzbioru reklam. |
||||
last |
opcjonalnie |
boolean
Wskazuje ostatni segment w przerwie na reklamę. Pomiń ten parametr we wszystkich pozostałych segmentach. |
||||
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 Ad Managera. Te pary muszą być reprezentowane jako ciąg znaków zapytań zakodowany w adresie URL. Przykład:
|
Przypisy
-
sd
nie jest wymagany w przypadku segmentów inicjalizacji. ↩ -
W przypadku zdarzeń z włączonymi przerwami reklamowymi bez czasu trwania tag
pd
nie jest wymagany. ↩
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
W przypadku powodzenia treść odpowiedzi będzie zawierać odtwarzalny segment strumienia odpowiadający formatowi i parametrom określonym w żądaniu.
Metoda: blok reklamowy z plikiem manifestu HLS
Pobiera manifest podreklamy HLS transmisji na żywo, który jest gotowy do załadowania i odtworzenia przez klienta odtwarzacza wideo.
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 na potrzeby 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 podsegmentów reklamy są przypisywane stopniowo do każdego zdarzenia przerwy na reklamę, zaczynając od ad_break_id/{string}
Identyfikator ciągu znaków bieżącej przerwy na reklamę. Identyfikator przerwy na reklamę podany przez wydawcę nie jest ograniczony w taki sam sposób jak identyfikator bloku reklamowego. Każdy nieznany identyfikator przerwy na reklamę przesłany do tego punktu końcowego tworzy nową przerwę na reklamę dla transmisji na żywo. |
Parametry zapytania
Parametry | ||||||
---|---|---|---|---|---|---|
stream_id |
Wymagany |
string
Identyfikator strumienia dla bieżącej sesji użytkownika. Ta wartość jest zwracana przez zakończone pomyślnie żądanie do punktu końcowego |
||||
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 Ad Managera. Te pary muszą być reprezentowane jako ciąg znaków zapytań zakodowany w adresie URL. Przykład:
|
Treść odpowiedzi
W przypadku powodzenia treść odpowiedzi to playlista HLS z wieloma wariantami.
Metoda: manifest DASH pod blokiem reklamowym
Pobiera plik manifestu bloku reklamowego MPEG-DASH transmisji na żywo, który jest gotowy do załadowania i odtworzenia przez odtwarzacz wideo klienta.
Metody | |
---|---|
GET |
GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset}/stream/{stream_id}/pod/{pod_id}/manifest.mpd
Interfejs API do pobierania playlisty mpd MPEG-DASH 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 strumienia dla bieżącej sesji użytkownika. Ta wartość jest zwracana przez zakończone pomyślnie żądanie do punktu końcowego |
pod_id |
integer
Identyfikator numeryczny bieżącej przerwy na reklamę. Identyfikatory podsegmentów reklamy są przypisywane stopniowo do każdego zdarzenia przerwy na reklamę, zaczynając od |
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 Ad Managera. Te pary muszą być reprezentowane jako ciąg znaków zapytań zakodowany w adresie URL. Przykład:
|
Treść odpowiedzi
W przypadku powodzenia treść odpowiedzi to playlista mpd MPEG-DASH.
Metoda: szablon okresu w DASH
Metody | |
---|---|
pods |
GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json
Wymaga od Google Ad Managera przesłania szablonu okresu DASH. Ten szablon zawiera makr, które musisz wypełnić parametrami strumienia. Po wypełnieniu tych makro szablon staje się okresem przerwy na reklamę i może zostać zszyty do pliku 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 Google Ad Manager. |
Parametry zapytania
Parametry | ||
---|---|---|
stream_id |
wymagany |
string
Identyfikator strumienia dla bieżącej sesji użytkownika. Ta wartość jest zwracana przez |
Treść odpowiedzi
Jeśli operacja się powiedzie, treść odpowiedzi będzie zawierać 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 boksu reklamowego. |
Żą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
Niestandardowy identyfikator powiązany z tą transmisją na żywo w Google Ad Manager. |
Parametry zapytania
Parametry | ||
---|---|---|
stream_id |
Wymagany |
string
Identyfikator strumienia Ad Managera z aplikacji klienta odtwarzacza wideo. |
ad_break_id |
wymagany |
string
Identyfikator następnej nadchodzącej przerwy na reklamę. Identyfikatory przerw na reklamę są dostarczane przez serwer łączenia lub VTP i muszą być zgodne z powiadomieniami o wczesnej przerwie na reklamę, żądaniami metadanych dotyczących czasu trwania bloku reklamowego oraz żądaniami przekierowania do segmentu dotyczącymi tej samej przerwy na reklamę. W przypadku niestandardowych identyfikatorów przerw na reklamę obowiązują te ograniczenia:
|
auth-token |
wymagany |
string
|
timeout |
opcjonalnie |
integer
Liczba milisekund, przez które DAI może zablokować to żądanie, aby oczekiwać na podjęcie decyzji dotyczącej reklamy. Używaj tego parametru w przypadku żądań, które muszą zwracać wypełnione reklamy przy pierwszym żądaniu, np. w przypadku przerw na reklamę przed filmem. Jeśli przekroczysz limit czasu, prośba zostanie oznaczona jako oczekująca. Jeśli jest podany, musi on wynosić od 1000 do 15 tys. milisekund. Jeśli nie zostanie podany, odpowiedzi nie będą opóźniane, aby czekać na podjęcie decyzji dotyczącej reklamy. |
final |
opcjonalnie |
boolean
Ustaw jako Domyślna wartość to |
Parametry wyboru reklamy |
||
pd |
opcjonalnie |
integer
Czas trwania przerwy na reklamę (w milisekundach). Inna nazwa to czas trwania bloku reklamowego. Jeśli używasz EABN, wartość pd musi być zgodna z czasem podanym w powiadomieniu o przerwie na reklamę. Jeśli czas trwania nie jest taki sam, pierwszeństwo ma wartość EABN. |
cust_params |
opcjonalnie |
string
Parametry niestandardowe do kierowania na przerwę na reklamę, opisane w Centrum pomocy Ad Managera. |
scte35 |
opcjonalnie |
string
Sygnał SCTE-35 zakodowany w standardzie base64.
Jeśli sygnał jest nieprawidłowy, w nagłówku HTTP |
Treść odpowiedzi
Jeśli operacja się powiedzie, treść odpowiedzi będzie zawierać nowy obiekt AdPodTimingMetadataResponse
.
Metoda: weryfikacja mediów
Po napotkaniu identyfikatora multimediów reklamy podczas odtwarzania natychmiast prześlij żądanie, używając parametru media_verification_url uzyskanego z punktu końcowego stream. Te żądania nie są potrzebne w przypadku strumieniowania z beaconami po stronie serwera, gdzie weryfikację multimediów inicjuje serwer.
Żądania wysyłane do punktu końcowego media verification
są idempotentne.
Metody | |
---|---|
media verification |
GET /{media_verification_url}/{ad_media_id}
powiadamia interfejs API o zdarzeniu weryfikacji mediów; |
Żądanie HTTP
GET https://{media-verification-url}/{ad-media-id}
Treść odpowiedzi
media verification
zwraca te odpowiedzi:
HTTP/1.1 204 No Content
, jeśli weryfikacja mediów się powiedzie i wszystkie pingi zostaną wysłane.HTTP/1.1 404 Not Found
, jeśli żądanie nie może zweryfikować multimediów z powodu nieprawidłowego formatowania adresu URL lub jego 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 samym czasie wysyłana jest inna prośba.
Identyfikatory mediów reklamy
Identyfikatory multimediów reklamowych będą kodowane w osobnej ścieżce metadanych – metadanych zsynchronizowanych w przypadku strumienia transportowego HLS lub emsg w przypadku plików mp4. Identyfikatory multimediów reklamy zawsze zaczynają się od ciągu znaków google_
.
Przed wysłaniem żądania weryfikacji reklamy do adresu URL weryfikacji reklamy należy dołączyć cały tekst zawarty w pliku z metadanymi.
Metoda: metadane
Punkt końcowy metadanych pod adresem metadata_url
zwraca informacje używane do tworzenia interfejsu użytkownika reklamy. Punkt końcowy metadanych jest niedostępny w przypadku strumieniowania za pomocą sygnałów na serwerze, w którym to serwer jest odpowiedzialny za inicjowanie weryfikacji medió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}
Treść odpowiedzi
Jeśli operacja się powiedzie, odpowiedź zwróci instancję PodMetadata
.
Analizowanie metadanych
Metadane są podzielone na 3 sekcje: tags
, ads
i reklama breaks
. Punkt wejścia do danych to sekcja tags
. Następnie przejrzyj tagi i znajdź pierwszy wpis, którego nazwa jest prefiksem identyfikatora danych reklamy znalezionego w strumieniu wideo. Identyfikator multimediów reklamy może na przykład wyglądać tak:
google_1234567890
Następnie znajdź obiekt tagu o nazwie google_12345
. W tym przypadku jest to identyfikator multimediów w Google Ads. Gdy znajdziesz odpowiedni obiekt prefiksu multimediów reklamowych, możesz sprawdzić identyfikatory reklam, identyfikatory przerw na reklamę i typ zdarzenia. Identyfikatory reklam są następnie używane do indeksowania obiektów ads
, a identyfikatory przerw reklamowych do indeksowania obiektów breaks
.
Dane odpowiedzi
Strumień
Strumień służy do renderowania listy zasobów 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 Adres URL weryfikacji multimediów używany jako podstawowy punkt końcowy do śledzenia zdarzeń odtwarzania. |
metadata_url |
string URL metadanych używany do okresowego pobierania informacji o nadchodzących zdarzeniach reklamowych w strumieniu. |
session_update_url |
string Adres URL aktualizacji sesji służący do aktualizowania parametrów kierowania dla tego strumienia. Pierwotne wartości parametrów kierowania są rejestrowane podczas początkowego żądania utworzenia strumienia. |
heartbeat_url |
string Adres URL heartbeat, który służy do utrzymywania aktywności strumienia beaconów po stronie serwera. Musi być pingowany co {PollingFrequency} sekund. Wypełnione w przypadku strumieni sygnalizowania po stronie serwera. |
polling_frequency |
number Częstotliwość odpytywania (w sekundach) podczas wysyłania żądania do adresu URL metadanych lub heartbeat_url. |
pod_manifest_url |
string Szablon adresu URL pliku manifestu pod służy do generowania adresu URL służącego do pobrania pliku manifestu pod transmisji, który odpowiada adresowi URL playlisty wielowariantowej w HLS lub pliku MPD w DASH. Wypełniane w przypadku wydarzeń strumieniowego przesyłania danych o typie dynamicznego wstawiania reklam POD_SERVING_MANIFEST. https://developers.google.com/ad-manager/api/reference/v202305/LiveStreamEventService.DynamicAdInsertionType |
manifest_format |
string Format pliku manifestu to format pliku manifestu pobranego z pod_manifest_url, czyli dash lub hls. |
PodMetadata
PodMetadata zawiera metadane dotyczące 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)], } |
Pola | |
---|---|
tags |
map[string, object(TagSegment)] Mapa segmentów tagów posortowanych według prefiksu tagu. |
ads |
map[string, object(Ad)] Mapa reklam posortowanych według identyfikatora reklamy |
ad_breaks |
map[string, object(AdBreak)] Mapa przerw na reklamy posortowanych według identyfikatora przerwy na reklamę. |
TagSegment
TagSegment zawiera odwołanie do reklamy, jej przerwy reklamowej i typu zdarzenia. TagSegment o typie „progress” nie powinien być pingowany do punktu weryfikacji mediów reklamowych.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ę tego tagu. |
type |
string Typ zdarzenia tego tagu. |
AdBreak
AdBreak opisuje pojedynczą przerwę na reklamę w strumieniu. Zawiera czas trwania, typ (pomiędzy, przed lub po) oraz liczbę reklam.Zapis JSON |
---|
{ "type": string, "duration": number, "expected_duration": number, "ads": number, } |
Pola | |
---|---|
type |
string Prawidłowe typy przerw to: przed, w środku i po. |
duration |
number Łączny czas trwania reklam w tej przerwie na reklamę (w sekundach). |
expected_duration |
number Przewidywany czas trwania przerwy na reklamę (w sekundach), w tym czas trwania wszystkich reklam i plansz. |
ads |
number Liczba reklam w przerwie na reklamę. |
Reklama
Reklama – opis reklamy 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ę w tej reklamie. |
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 Identyfikator kreacji (opcjonalnie). |
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, czy bieżący wpis jest slajdem. |
icons |
[object(Icon)] Lista ikon, pomijana, jeśli jest pusta. |
wrappers |
[object(Wrapper)] Lista obudów, 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 pliku VAST. |
companions |
[object(Companion)] Opcjonalne kreacje 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 podów.Zapis JSON |
---|
{ "dash_period_template": string, "segment_duration_ms": int64, } |
Pola | |
---|---|
dash_period_template |
string DashPeriodTemplate to szablon XML okresu, który należy wypełnić odpowiednimi danymi przed zszyciem. |
segment_duration_ms |
int64 SegmentDurationMS to czas trwania segmentów okresu w milisekundach. |
AdpodTimingMetadataResponse
Odpowiedź z danymi metadanych dotyczącymi czasu trwania bloku reklamowego zawiera informacje o bloku reklamowym i sposobie tworzenia adresów URL segmentów.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ącej bloku reklamowego. |
ads |
[object(AdRendering)] Tablica obiektów Ad, która opisuje sposób renderowania adresów URL segmentów reklam. Indeksowanie zaczyna się od 0. |
slate |
object(SlateRendering) Opis 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 adaptacji DASH dla tego bloku reklamowego, które mają być renderowane w plikach manifestu DASH. |
AdRendering
AdRendering zawiera opis renderowania reklamy, która została już zweryfikowana.Zapis JSON |
---|
{ "duration_ms": number, "variants": map[string, object(VariantRendering)], } |
Pola | |
---|---|
duration_ms |
number Czas trwania reklamy w milisekundach (int). |
variants |
map[string, object(VariantRendering)] Przechowuje słownik obiektów wariantu (patrz poniżej), posortowany według identyfikatora wariantu lub profilu zgodnie z konfiguracją w interfejsie użytkownika. |
SlateRendering
SlateRendering zawiera opis renderowania treści w ramach slajdu.Zapis JSON |
---|
{ "duration_ms": number, "variants": map[string, object(VariantRendering)], } |
Pola | |
---|---|
duration_ms |
number Czas trwania planszy w milisekundach (int). |
variants |
map[string, object(VariantRendering)] Przewodnik po obiektach wariantów, posortowany według identyfikatora wariantu lub profilu. Czas trwania osi czasu musi być odtwarzany w pętli, aż do osiągnięcia wymaganej długości osi czasu, wstawiając przerwy w HLS między iteracjami lub pętlą nowe okresy w przypadku MPEG-DASH. |
VariantRendering
VariantRendering opisuje jeden wariant lub profil w reklamie/slate.Zapis JSON |
---|
{ "segment_extension": string, "segment_durations": object(SegmentDurations), } |
Pola | |
---|---|
segment_extension |
string Ciąg znaków, jeden z: ts, mp4, aac, ac3, ec3, m4a, m4v. Rozszerzenie pliku w adresach URL segmentów. |
segment_durations |
object(SegmentDurations) Obiekty SegmentDurations. Czas trwania każdego segmentu można przekształcić w adres URL segmentu. |
SegmentDurations
SegmentDurations określa czas trwania sekwencji segmentów w określonej jednostce czasu.Zapis JSON |
---|
{ "timescale": number, "values": [], } |
Pola | |
---|---|
timescale |
number Układ czasu to liczba jednostek na sekundę (int) Przewidywane wartości: 1000 w przypadku HLS (milisekundy) 90000 w przypadku filmu DASH (PTS) Częstotliwość próbkowania dźwięku w przypadku dźwięku DASH. |
values |
number Tablica z czasem trwania segmentów w jednostkach czasu |
DASHRepresentation
DASHRepresentation opisuje węzły Representation, które mają zostać wyrenderowane 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 na sekundę w reprezentacji. |
audio_sampling_rate |
number Częstotliwość próbkowania audio 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 zestawu adaptacji. |
mime_type |
string Typ MIME zestawu adaptacji. |
role |
object(SchemeIDURIAndValue) Rola zestawu adaptacyjnego. |
inband_event_stream |
object(SchemeIDURIAndValue) Strumień zdarzeń w paśmie sygnału w zestawie adaptacji. |
min_frame_rate |
string Minimalna liczba klatek w zestawie adaptacji. |
max_frame_rate |
string Maksymalna liczba klatek na sekundę w zestawie adaptacji. |
scan_type |
string Typ skanowania zestawu adaptacji. |
start_with_sap |
string Zacznij od SAP w zestawie adaptacji. |
segment_alignment |
boolean Wyrównanie segmentu w zestawie adaptacyjnym. |
representations |
string Reprezentacje zestawu adaptacyjnego. |
SchemeIDURIAndValue
Parametr SchemeIDURIAndValue to para: identyfikator schematu i jego wartość.Zapis JSON |
---|
{ "scheme_id_uri": string, "value": string, } |
Pola | |
---|---|
scheme_id_uri |
string Identyfikator URI schematu wartości. |
value |
string Wartość identyfikatora URI schematu. |
Ikona
Ikona 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 wrapper zawiera informacje o reklamie typu wrapper. Nie zawiera identyfikatora oferty, 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żyty w reklamie opakowującej. |
creative_id |
string Identyfikator kreacji użytej w reklamie w ramce. |
creative_ad_id |
string Identyfikator reklamy kreacji użytej w reklamie z kodem towarzyszącym |
deal_id |
string Opcjonalny identyfikator umowy dla reklamy opakowującej. |
Weryfikacja
Weryfikacja zawiera informacje dotyczące Open Measurement, które ułatwiają pomiar widoczności i weryfikację przez zewnętrznych dostawców. Obecnie obsługiwane są tylko zasoby JavaScript. Informacje 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 służących do weryfikacji |
parameters |
string Nieprzezroczysty ciąg znaków przekazany do kodu weryfikacyjnego bootstrapa. |
JavaScriptResource
JavaScriptResource zawiera informacje do weryfikacji za pomocą kodu JavaScript.Zapis JSON |
---|
{ "script_url": string, "api_framework": string, "browser_optional": boolean, } |
Pola | |
---|---|
script_url |
string Identyfikator URI ładunku JavaScript. |
api_framework |
string APIFramework to nazwa platformy wideo, która wykonuje kod weryfikacyjny. |
browser_optional |
boolean Czy skrypt można uruchomić poza przeglądarką. |
TrackingEvent
TrackingEvent zawiera adresy URL, które w określonych sytuacjach powinny być pingowane przez klienta.Zapis JSON |
---|
{ "event": string, "uri": string, } |
Pola | |
---|---|
event |
string Typ zdarzenia śledzenia. |
uri |
string Zdarzenie śledzenia, które ma być pingowane. |
UniversalAdID
UniversalAdID służy do podawania unikalnego identyfikatora kreacji, który jest utrzymywany w różnych systemach reklamowych.Zapis JSON |
---|
{ "id_value": string, "id_registry": string, } |
Pola | |
---|---|
id_value |
string Uniwersalny identyfikator reklamy wybranej kreacji. |
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ą być wyświetlane razem z reklamą.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 pliku VAST, jeśli jest to kreacja towarzysząca typu static. |
height |
int32 Wysokość tego elementu w pikselach. |
width |
int32 Szerokość tego elementu w pikselach. |
resource |
string W przypadku elementów towarzyszących statycznych i iframe będzie to adres URL, który ma być wczytywany i wyświetlany. W przypadku elementów towarzyszących w formacie HTML będzie to fragment kodu HTML, który powinien być wyświetlany jako element towarzyszący. |
type |
string Typ tego elementu towarzyszącego. Może być statyczny, iframe lub HTML. |
ad_slot_id |
string Identyfikator slotu dla tego urządzenia towarzyszącego. |
api_framework |
string Platforma interfejsu API dla tego urządzenia. |
tracking_events |
[object(TrackingEvent)] Lista zdarzeń śledzenia dla tego urządzenia towarzyszącego. |
InteractiveFile
Plik InteractiveFile zawiera informacje o interaktywnych kreacjach (np. identyfikator SIMID), które powinny być wyświetlane 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 podawanego jako zasób. |
variable_duration |
boolean Czy ta kreacja może prosić o przedłużenie czasu trwania. |
ad_parameters |
string Wartość węzła <AdParameters> w pliku VAST. |