Interfejs API dynamicznego wstawiania reklam w przypadku wyświetlania bloków reklamowych w treściach VOD

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

Usługa: dai.google.com

Wszystkie identyfikatory URI są ustawiane względem adresu https://dai.google.com.

Metoda: create stream

Ta metoda tworzy strumień bezpośrednio z urządzenia, zwracając wszystkie zasoby potrzebne aplikacji klienckiej do odtwarzania i śledzenia reklam oraz wyświetlania elementów interfejsu.

Metody
create stream POST: /ondemand/pods/api/v1/network/{network_code}/stream

Utwórz sesję VOD wyświetlania bloków reklamowych w ramach DAI.

Żądanie HTTP

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

Parametry ścieżki

Parametry
network_code string

Kod sieci Google Ad Managera wydawcy.

Treść żądania

Treść żądania jest typu application/json i musi zawierać obiekt CreateStreamRequest.

Treść odpowiedzi

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

Metoda: rejestracja strumienia

Ta metoda rejestruje strumień na backendzie Google DAI z urządzenia, zwracając wszystkie zasoby potrzebne aplikacji klienckiej do śledzenia reklam i wyświetlania elementów interfejsu. W odróżnieniu od metody create stream ta metoda nie zwraca manifestu reklam, które można odtworzyć. Zamiast tego to działanie jest realizowane w osobnym wywołaniu serwera: decision ad pods.

Metody
register stream POST: /ondemand/pods/api/v1/network/{network_code}/stream_registration

Rejestruje sesję VOD wyświetlaną w ramach bloków reklamowych w dynamicznym wstawianiu reklam.

Żądanie HTTP

POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/stream_registration

Parametry ścieżki

Parametry
network_code string

Kod sieci Google Ad Managera wydawcy.

Treść żądania

Treść żądania jest typu application/json i musi zawierać obiekt StreamRegistrationRequest.

Treść odpowiedzi

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

Metoda: pobieranie bloków reklamowych

Ta metoda jest wywoływana przez register stream urządzenie i jest niezbędna do pobierania plików manifestu reklamy, które można odtworzyć, w celu połączenia ich z plikami manifestu treści.

Metody
decision ad pods POST: /ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods

Bloki reklamowe z decyzjami w przypadku sesji VOD z wyświetlaniem bloków reklamowych w ramach dynamicznego wstawiania reklam.

Żądanie HTTP

POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods

Parametry ścieżki

Parametry
network_code string

Kod sieci Google Ad Managera wydawcy.

stream_id string

Identyfikator stream_id otrzymany z wywołania stream_registration.

Treść żądania

Treść żądania jest typu application/json i musi zawierać obiekt AdPodDecisionRequest.

Treść odpowiedzi

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

Metoda: metadane bloków reklamowych

Ta metoda zwraca wszystkie informacje potrzebne aplikacji klienckiej do śledzenia reklam i dokładnego renderowania odpowiednich elementów interfejsu.

Metody
ad pods metadata GET: /ondemand/pods/api/v1/network/.../metadata

Pobieranie metadanych bloków reklamowych w przypadku konkretnej sesji. Ten adres URL jest zwracany w atrybucie StreamRegistrationResponse metadata_url.

Żądanie HTTP

GET: /ondemand/pods/api/v1/network/.../metadata

Treść odpowiedzi

Jeśli operacja się uda, treść odpowiedzi będzie zawierała obiekt Ad pods metadata.

Obiekty API

PodMetadata

PodMetadata zawiera informacje o metadanych 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)],
  "polling_frequency": number,
}
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ę.
polling_frequency number

Zalecana częstotliwość odpytywania adresu URL metadanych w sekundach. Wypełniane w przypadku strumieni VOD korzystających z decyzji na żądanie.

TagSegment

TagSegment zawiera odniesienie do reklamy, jej przerwy reklamowej i typu zdarzenia. Do punktu końcowego weryfikacji multimediów reklamowych 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

Oczekiwany czas trwania przerwy na reklamę (w sekundach), w tym wszystkich reklam i planszy.
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 listą.
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ą się wyświetlać razem z tą reklamą.
interactive_file object(InteractiveFile)

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

MatchOpts

MatchOpts określają rygorystyczne wymagania dotyczące dopasowywania multimediów w przypadku strumienia.
Zapis JSON
{
  "audio_channels": boolean,
  "audio_sample_rate": boolean,
}
Pola
audio_channels boolean

Dopasowywanie kanałów audio między treściami a reklamami.
audio_sample_rate boolean

Dopasuj częstotliwość próbkowania audio w treściach i reklamach.

CreateStreamRequest

CreateStreamRequest opisuje informacje zawarte w żądaniach HTTP do interfejsu VOD pod serving API. Proces tworzenia strumienia jest inicjowany przez partnera technologicznego wideo w imieniu pakietu SDK i wydawcy dla każdego użytkownika. Strumień utworzony w wyniku tego działania zawiera wybrane bloki reklamowe, które VTP może połączyć. W przeciwieństwie do przepływu StreamRegistrationRequest+AdPodDecisionRequest, który rejestruje strumień i podejmuje decyzje dotyczące bloków reklamowych w wielu żądaniach.
Zapis JSON
{
  "encoding_profiles": [object(EncodingProfile)],
  "ad_tag": string,
  "cuepoints": [],
  "manifest_type": string,
  "enable_hls_asset_list": boolean,
  "targeting_parameters": map[string, string],
  "content_duration_seconds": number,
  "decision_timing_options": object(DecisionTimingOptions),
  "enable_inline_manifests": boolean,
  "dai_options": object(CreateStreamOptions),
}
Pola
encoding_profiles [object(EncodingProfile)]

Lista profili kodowania. Wymagane.
ad_tag string

Podstawowy tag reklamy na potrzeby podejmowania decyzji. Wymagane.
cuepoints number

Lista punktów wskazujących w sekundach. Wymagany, gdy odpowiedź tagu reklamy używa przesunięć czasowych pozycji.
manifest_type string

Prawidłowe typy plików manifestu to: hls i dash. Domyślnie: hls. Opcjonalne.
enable_hls_asset_list boolean

Wskazuje, czy w przypadku listy zasobów HLS włączone są reklamy pełnoekranowe. Gdy ta opcja jest włączona, DAI zwraca adresy URL list zasobów dla każdego bloku reklamowego, które można wykorzystać w przypadku reklam pełnoekranowych HLS.
targeting_parameters string

Dodatkowe parametry kierowania w usłudze Ad Manager. Opcjonalne.
content_duration_seconds number

ContentDurationSeconds to czas trwania treści w sekundach. Wymagane, gdy odpowiedź tagu reklamy używa przesunięć czasowych w procentach.
decision_timing_options object(DecisionTimingOptions)

Określa, kiedy należy podejmować decyzje dotyczące bloków reklamowych.
enable_inline_manifests boolean

Określa, czy manifesty przerw mają być wstawiane w odpowiedzi JSON.
dai_options object(CreateStreamOptions)

Opcje DAI dotyczące tworzenia strumienia.

CreateStreamOptions

CreateStreamOptions reprezentuje opcje dostępne w jednokrokowym przepływie pracy tworzenia strumienia.
Zapis JSON
{
  "dash_profile": string,
  "match_options": object(MatchOpts),
  "data_sharing_policy_code": string,
  "sam_id": string,
  "session_title": string,
  "dash_inband_event_stream": boolean,
  "distinct_ad_profiles": boolean,
  "tracking_mode": string,
  "emsg_version": uint32,
}
Pola
dash_profile string

Profil MPEG-DASH do użycia: „na żywo” lub „na żądanie”.
match_options object(MatchOpts)

data_sharing_policy_code string

Umożliwia wydawcom zastąpienie domyślnej zasady udostępniania danych w sieci.
sam_id string

sam_id to opcjonalny klucz debugowania SAM dla sesji.
session_title string

session_title to tytuł sesji SAM dla strumienia (opcjonalny).
dash_inband_event_stream boolean

dash_inband_event_stream oznacza, że DAI wstawia komunikaty ID3 jako zdarzenia w strumieniu (w multimediach) za pomocą elementu InbandEventStream, a nie jako elementy EventStream (w pliku manifestu).
distinct_ad_profiles boolean

Jeśli ta wartość jest ustawiona na „true”, serwer użyje dowolnego dostępnego profilu reklamy co najwyżej raz podczas dopasowywania żądanych profili kodowania.
tracking_mode string

tracking_mode to typ śledzenia reklam, który ma być używany w przypadku strumienia. Jest to parametr opcjonalny. Prawidłowe wartości to: „ad_media”, „server”, „client”.
emsg_version uint32

emsg_version wymusza użycie określonej wersji emsg w przypadku identyfikatorów ID3 w treści. Obsługiwane tylko wtedy, gdy dash_inband_event_stream ma wartość true.

StreamRegistrationRequest

StreamRegistrationRequest rejestruje strumień z urządzenia na potrzeby przyszłego podejmowania decyzji dotyczących zasobów reklamowych. W przeciwieństwie do CreateStreamRequest, który tworzy strumień i podejmuje decyzje dotyczące bloków reklamowych w ramach jednego żądania.
Zapis JSON
{
  "targeting_parameters": map[string, string],
  "dai_options": object(StreamRegistrationOptions),
}
Pola
targeting_parameters string

Dodatkowe parametry kierowania w usłudze Ad Manager. Opcjonalne.
dai_options object(StreamRegistrationOptions)

DAIOptions do rejestracji strumienia.

StreamRegistrationOptions

StreamRegistrationOptions zawiera listę opcji dostępnych podczas tworzenia strumienia.
Zapis JSON
{
  "sam_id": string,
  "tracking_mode": string,
  "emsg_version": uint32,
  "skippable_ads_supported": boolean,
}
Pola
sam_id string

sam_id to opcjonalny klucz debugowania SAM dla sesji.
tracking_mode string

tracking_mode to typ śledzenia reklam, który ma być używany w przypadku strumienia. Jest to parametr opcjonalny. Prawidłowe wartości to: „ad_media”, „server”, „client”.
emsg_version uint32

emsg_version wymusza użycie określonej wersji emsg w przypadku identyfikatorów ID3 w treści. Obsługiwane tylko wtedy, gdy dash_inband_event_stream ma wartość true.
skippable_ads_supported boolean

Wskazuje, czy reklamy możliwe do pominięcia są obsługiwane.

StreamRegistrationResponse

StreamRegistrationResponse to odpowiedź w formacie JSON odsyłana do klienta w odpowiedzi na StreamRegistrationRequest. Zawiera identyfikator strumienia i wszystkie adresy URL, których urządzenie będzie potrzebować. Identyfikator strumienia może być używany w kolejnym żądaniu decyzji dotyczącej bloku reklamowego. Różni się to od odpowiedzi CreateStreamResponse, która reprezentuje odpowiedź na utworzenie strumienia i podjęcie decyzji dotyczącej zasobów reklamowych w tym samym czasie.
Zapis JSON
{
  "stream_id": string,
  "media_verification_url": string,
  "valid_for": string,
  "valid_until": string,
  "metadata_url": string,
}
Pola
stream_id string

StreamID to unikalny identyfikator bieżącego strumienia tego widza.
media_verification_url string

MediaVerificationURL to prefiks adresu URL, którego należy używać w opisanych poniżej żądaniach weryfikacji multimediów w reklamie. Brak w przypadku strumieni z sygnalizowaniem po stronie klienta.
valid_for string

ValidFor to czas ważności tego strumienia w formacie „00h00m00s”.
valid_until string

ValidUntil to data i godzina, do której ta transmisja jest ważna.
metadata_url string

MetadataURL to adres URL metadanych, który będzie używany do wysyłania żądań metadanych grupy reklam.

DecisionTimingOptions

DecisionTimingOptions opisuje opcje czasowe dotyczące podejmowania decyzji o przerwach na reklamy w strumieniu.
Zapis JSON
{
  "type": string,
  "on_create_breaks": [],
}
Pola
type string

Typ określa, kiedy podejmowane są decyzje dotyczące bloków reklamowych w strumieniu. Prawidłowe typy to: on_create (domyślny), on_demand. Jeśli typ to on_demand, reklamy są wybierane z opóźnieniem, gdy żądany jest plik manifestu dla konkretnej przerwy. Jeśli typ to on_create, decyzje dotyczące wszystkich reklam są podejmowane podczas tworzenia transmisji.
on_create_breaks string

OnCreateBreaks to lista identyfikatorów przerw VMAP, w których wielkość liter jest rozróżniana i które powinny być uwzględniane podczas podejmowania decyzji o utworzeniu strumienia. To pole jest dozwolone tylko wtedy, gdy typ to on_demand. Specjalne identyfikatory przerw na reklamy „preroll” i „postroll” mogą służyć do wskazywania, że decyzja o przerwach na reklamy przed filmem lub po filmie powinna być podejmowana w momencie tworzenia strumienia.

EncodingProfile

EncodingProfile opisuje kodowanie pojedynczej wersji treści. Może zawierać tylko ustawienia wideo, tylko ustawienia audio (w przypadku typu multimediów), zarówno ustawienia wideo, jak i audio, lub żadne z nich w przypadku napisów.
Zapis JSON
{
  "profile_name": string,
  "type": string,
  "container_type": string,
  "video_settings": object(VideoSettings),
  "audio_settings": object(AudioSettings),
  "subtitle_settings": object(SubtitleSettings),
}
Pola
profile_name string

Nazwa profilu podana przez wydawcę. Unikalny dla każdego strumienia. Wymagane.
type string

Prawidłowe typy to: media, iframe, subtitles. Wymagane.
container_type string

Prawidłowe typy to: mpeg2ts, fmp4cmaf i hls_packed_audio. Wymagane w przypadku typów multimediów i iframe.
video_settings object(VideoSettings)

Ustawienia wideo są wymagane, jeśli typem kontenera jest element iframe. W przeciwnym razie są one widoczne tylko wtedy, gdy profil zawiera film.
audio_settings object(AudioSettings)

Ustawienia audio są dostępne, jeśli profil zawiera dźwięk. Ustawienia audio są dozwolone tylko wtedy, gdy typ kontenera to multimedia.
subtitle_settings object(SubtitleSettings)

W przypadku napisów wpisywanych wymagane są ustawienia napisów.

VideoSettings

VideoSettings opisuje film w profilu kodowania. Jeśli występuje jedno ustawienie filmu, muszą występować wszystkie.
Zapis JSON
{
  "codec": string,
  "bitrate": int32,
  "frames_per_second": number,
  "resolution": object(Resolution),
}
Pola
codec string

Ciąg kodeka wideo zgodny z RFC6381.
bitrate int32

Maksymalna szybkość transmisji bitów wideo w profilu kodowania.
frames_per_second number

Liczba klatek na sekundę w filmie.
resolution object(Resolution)

Rozdzielczość filmu (szerokość x wysokość).

AudioSettings

AudioSettings opisuje dźwięk w profilu kodowania. Jeśli jest obecne jedno ustawienie audio, wszystkie muszą być obecne.
Zapis JSON
{
  "codec": string,
  "bitrate": int32,
  "channels": int32,
  "sample_rate": int64,
}
Pola
codec string

Ciąg kodeka audio zgodny ze specyfikacją RFC6381.
bitrate int32

Maksymalna szybkość transmisji bitów audio w profilu kodowania.
channels int32

Liczba kanałów audio (w tym kanałów niskich częstotliwości).
sample_rate int64

Częstotliwość próbkowania dźwięku w hercach.

SubtitleSettings

SubtitleSettings opisuje napisy w profilach kodowania.
Zapis JSON
{
  "format": string,
  "language": string,
}
Pola
format string

Format napisów: webvtt dla hls, webvtt lub ttml dla dash.
language string

Język do wstawienia w manifeście.

Rozdzielczość

Rozdzielczość to szerokość x wysokość filmu.
Zapis JSON
{
  "width": int32,
  "height": int32,
}
Pola
width int32

Szerokość filmu w pikselach. Wymagane.
height int32

Wysokość filmu w pikselach. Wymagane.

AdPodDecisionRequest

AdPodDecisionRequest reprezentuje żądanie podjęcia decyzji dotyczącej bloków reklamowych w przypadku wcześniej zarejestrowanego strumienia.
Zapis JSON
{
  "encoding_profiles": [object(EncodingProfile)],
  "ad_tag": string,
  "cuepoints": [],
  "manifest_type": string,
  "enable_hls_asset_list": boolean,
  "targeting_parameters": map[string, string],
  "content_duration_seconds": number,
  "decision_timing_options": object(DecisionTimingOptions),
  "enable_inline_manifests": boolean,
  "dai_options": object(AdPodDecisionOptions),
}
Pola
encoding_profiles [object(EncodingProfile)]

Lista profili kodowania. Wymagane.
ad_tag string

Podstawowy tag reklamy na potrzeby podejmowania decyzji. Wymagane.
cuepoints number

Lista punktów wskazujących w sekundach. Wymagany, gdy odpowiedź tagu reklamy używa przesunięć czasowych pozycji.
manifest_type string

Prawidłowe typy plików manifestu to: hls i dash. Domyślnie: hls. Opcjonalne.
enable_hls_asset_list boolean

Wskazuje, czy w przypadku listy zasobów HLS włączone są reklamy pełnoekranowe. Gdy ta opcja jest włączona, DAI zwraca adresy URL list zasobów dla każdego bloku reklamowego, które można wykorzystać w przypadku reklam pełnoekranowych HLS.
targeting_parameters string

Dodatkowe parametry kierowania w usłudze Ad Manager. Opcjonalne.
content_duration_seconds number

ContentDurationSeconds to czas trwania treści w sekundach. Wymagane, gdy odpowiedź tagu reklamy używa przesunięć czasowych w procentach.
decision_timing_options object(DecisionTimingOptions)

Określa, kiedy należy podejmować decyzje dotyczące bloków reklamowych.
enable_inline_manifests boolean

Określa, czy manifesty przerw mają być wstawiane w odpowiedzi JSON.
dai_options object(AdPodDecisionOptions)

Opcje dynamicznego wstawiania reklam w przypadku decyzji dotyczących bloku reklamowego.

AdPodDecisionResponse

AdPodDecisionResponse reprezentuje odpowiedź na decyzję dotyczącą bloków reklamowych w przypadku wcześniej zarejestrowanego strumienia. Zawiera listę bloków reklamowych, dla których podjęto decyzję w przypadku tego strumienia.
Zapis JSON
{
  "valid_for": string,
  "valid_until": string,
  "ad_pods": [object(AdPod)],
}
Pola
valid_for string

ValidFor to czas ważności tego strumienia w formacie „00h00m00s”.
valid_until string

ValidUntil to data i godzina, do której ta transmisja jest ważna.
ad_pods [object(AdPod)]

Lista bloków reklamowych uporządkowana według kolejności wstawiania.

CreateStreamResponse

CreateStreamResponse reprezentuje odpowiedź w formacie JSON wysyłaną z powrotem do klienta w odpowiedzi na CreateStreamRequest.
Zapis JSON
{
  "valid_for": string,
  "valid_until": string,
  "ad_pods": [object(AdPod)],
  "stream_id": string,
  "media_verification_url": string,
  "pod_metadata": object(PodMetadata),
  "metadata_url": string,
}
Pola
valid_for string

ValidFor to czas ważności tego strumienia w formacie „00h00m00s”.
valid_until string

ValidUntil to data i godzina, do której ta transmisja jest ważna.
ad_pods [object(AdPod)]

Lista bloków reklamowych uporządkowana według kolejności wstawiania.
stream_id string

StreamID to unikalny identyfikator bieżącego strumienia tego widza.
media_verification_url string

MediaVerificationURL to prefiks adresu URL, którego należy używać w opisanych poniżej żądaniach weryfikacji multimediów w reklamie. Brak w przypadku strumieni z sygnalizowaniem po stronie klienta.
pod_metadata object(PodMetadata)

PodMetadata zawiera dodatkowe informacje wymagane do renderowania zasobnika na urządzeniu i wywoływania weryfikacji. Zgodnie z opisem w dokumentacji interfejsu Linear API do dynamicznego wstawiania reklam. Dotyczy tylko strumieni z sygnalizowaniem po stronie klienta.
metadata_url string

MetadataURL to adres URL metadanych, który będzie używany do wysyłania żądań metadanych grupy reklam.

AdPod

AdPod reprezentuje wybraną przerwę na reklamę gotową do odtworzenia.
Zapis JSON
{
  "manifest_uris": map[string, string],
  "multivariant_uri": string,
  "mpd_uri": string,
  "manifests": map[string, string],
  "multivariant_manifest": string,
  "mpd_manifest": string,
  "asset_list_uri": string,
  "start": number,
  "duration": number,
  "type": string,
  "midroll_index": number,
}
Pola
manifest_uris string

ManifestURIs to mapa nazw profili kodowania na adresy manifestów wariantów HLS dla treści HLS.
multivariant_uri string

MultivariantURI to identyfikator URI manifestu z wieloma wariantami dla treści HLS.
mpd_uri string

MPDURI to identyfikator URI pliku MPD dla treści DASH.
manifests string

Manifests to mapa nazwy profilu kodowania na plik manifestu wariantu HLS. Wypełniane tylko wtedy, gdy w przypadku strumienia pole enable_inline_manifests ma wartość true.
multivariant_manifest string

MultivariantManifest to plik manifestu z wieloma wariantami dla treści HLS. Wypełniane tylko wtedy, gdy w przypadku strumienia pole enable_inline_manifests ma wartość true.
mpd_manifest string

MPDManifest to plik manifestu MPD dla treści DASH. Wypełniane tylko wtedy, gdy w przypadku strumienia pole enable_inline_manifests ma wartość true.
asset_list_uri string

AssetListURI to identyfikator URI listy plików HLS w przypadku treści HLS. Wypełniane tylko wtedy, gdy w strumieniu są włączone reklamy pełnoekranowe na liście zasobów HLS.
start number

Czas rozpoczęcia bloku reklamowego na osi czasu zasobu (bez uwzględniania poprzednich bloków reklamowych) w sekundach zmiennoprzecinkowych.
duration number

Czas trwania bloku reklamowego w sekundach (liczba zmiennoprzecinkowa).
type string

Typ przerwy na reklamę.
midroll_index number

Indeks reklam w trakcie filmu w strumieniu oparty na identyfikatorze przerwy VMAP (liczony od 1). Pominięte w przypadku reklam przed filmem i po filmie.

AdPodDecisionOptions

AdPodDecisionOptions reprezentuje dodatkowe opcje strumienia.
Zapis JSON
{
  "dash_profile": string,
  "match_options": object(MatchOpts),
  "data_sharing_policy_code": string,
  "sam_id": string,
  "session_title": string,
  "dash_inband_event_stream": boolean,
  "distinct_ad_profiles": boolean,
}
Pola
dash_profile string

Profil MPEG-DASH do użycia: „na żywo” lub „na żądanie”.
match_options object(MatchOpts)

data_sharing_policy_code string

Umożliwia wydawcom zastąpienie domyślnej zasady udostępniania danych w sieci.
sam_id string

sam_id to opcjonalny klucz debugowania SAM dla sesji.
session_title string

session_title to tytuł sesji SAM dla strumienia (opcjonalny).
dash_inband_event_stream boolean

dash_inband_event_stream oznacza, że DAI wstawia komunikaty ID3 jako zdarzenia w strumieniu (w multimediach) za pomocą elementu InbandEventStream, a nie jako elementy EventStream (w pliku manifestu).
distinct_ad_profiles boolean

Jeśli ta wartość jest ustawiona na „true”, serwer użyje dowolnego dostępnego profilu reklamy co najwyżej raz podczas dopasowywania żądanych profili kodowania.

Strumień

Strumień służy do renderowania listy wszystkich zasobów nowo utworzonego strumienia w formacie JSON .
Zapis JSON
{
  "stream_id": string,
  "valid_for": string,
  "valid_until": string,
  "media_verification_url": string,
}
Pola
stream_id string

Identyfikator strumienia.
valid_for string

Okres ważności strumienia w formacie „00h00m00s”.
valid_until string

Data, do której strumień jest ważny, w formacie RFC 3339.
media_verification_url string

Adres URL weryfikacji multimediów.

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 transakcji, 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 w kodzie towarzyszącym.
creative_ad_id string

Identyfikator reklamy powiązanej z kreacją użyty w reklamie z kodem 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 firmy 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

Nieprzejrzysty 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

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 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 w reklamie.
id_registry string

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

Reklama towarzysząca

Element Companion 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 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 reklam towarzyszących i reklam towarzyszących w elemencie iframe 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 elementu towarzyszącego. Może to być statyczny kod HTML, kod iframe lub kod HTML.
ad_slot_id string

Identyfikator miejsca docelowego tego elementu towarzyszącego.
api_framework string

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

Lista zdarzeń śledzenia w przypadku tego elementu 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 ta kreacja może prosić o przedłużenie czasu trwania.
ad_parameters string

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