Dynamic Ad Insertion pod serving VOD API

Dynamic Ad Insertion API memungkinkan Anda meminta dan melacak streaming on-demand DAI.

Layanan: dai.google.com

Semua URI relatif terhadap https://dai.google.com.

Metode: buat aliran data

Metode ini membuat streaming langsung dari perangkat, yang menampilkan semua resource yang diperlukan aplikasi klien untuk memutar dan melacak iklan, serta menampilkan elemen UI.

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

Buat sesi VOD penayangan pod DAI.

Permintaan HTTP

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

Parameter jalur

Parameter
network_code string

Kode jaringan Google Ad Manager penayang.

Isi permintaan

Isi permintaan berjenis application/json dan harus berisi objek CreateStreamRequest.

Isi respons

Jika berhasil, isi respons akan memuat objek CreateStreamResponse baru.

Metode: mendaftarkan aliran

Metode ini mendaftarkan streaming di backend Google DAI dari perangkat, menampilkan semua resource yang diperlukan agar aplikasi klien dapat melacak iklan dan menampilkan elemen UI. Tidak seperti metode create stream, metode ini tidak menampilkan manifes iklan yang dapat dimainkan. Sebagai gantinya, tindakan ini dicapai dalam panggilan server terpisah: decision ad pods.

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

Mendaftarkan sesi VOD penayangan pod DAI.

Permintaan HTTP

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

Parameter jalur

Parameter
network_code string

Kode jaringan Google Ad Manager penayang.

Isi permintaan

Isi permintaan berjenis application/json dan harus berisi objek StreamRegistrationRequest.

Isi respons

Jika berhasil, isi respons akan memuat objek StreamRegistrationResponse baru.

Metode: mengambil pod iklan

Metode ini mengikuti panggilan register stream dari perangkat dan diperlukan untuk mengambil manifes iklan yang dapat dimainkan untuk menggabungkan manifes konten.

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

Pod iklan keputusan untuk sesi VOD penayangan pod DAI.

Permintaan HTTP

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

Parameter jalur

Parameter
network_code string

Kode jaringan Google Ad Manager penayang.

stream_id string

stream_id yang diterima dari panggilan stream_registration.

Isi permintaan

Isi permintaan berjenis application/json dan harus berisi objek AdPodDecisionRequest.

Isi respons

Jika berhasil, isi respons akan memuat objek AdPodDecisionResponse baru.

Metode: metadata pod iklan

Metode ini menampilkan semua informasi yang diperlukan agar aplikasi klien dapat melacak iklan dan merender elemen UI yang sesuai secara akurat.

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

Mengambil metadata pod iklan untuk sesi tertentu. URL ini ditampilkan dalam atribut metadata_url StreamRegistrationResponse.

Permintaan HTTP

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

Isi respons

Jika berhasil, isi respons akan berisi objek Ad pods metadata.

Objek API

PodMetadata

PodMetadata berisi informasi metadata tentang iklan, jeda iklan, dan tag ID media.
Representasi JSON
{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
  "polling_frequency": number,
}
Kolom
tags map[string, object(TagSegment)]

Peta segmen tag yang diindeks berdasarkan awalan tag.
ads map[string, object(Ad)]

Peta iklan yang diindeks menurut ID iklan.
ad_breaks map[string, object(AdBreak)]

Peta jeda iklan yang diindeks menurut ID jeda iklan.
polling_frequency number

Frekuensi polling URL metadata yang direkomendasikan, dalam detik. Diisi untuk streaming VOD menggunakan pengambilan keputusan Sesuai Permintaan.

TagSegment

TagSegment berisi referensi ke iklan, jeda iklan, dan jenis peristiwanya. TagSegment dengan type="progress" tidak boleh di-ping ke endpoint verifikasi media iklan.
Representasi JSON
{
  "ad": string,
  "ad_break_id": string,
  "type": string,
}
Kolom
ad string

ID iklan tag ini.
ad_break_id string

ID jeda iklan tag ini.
type string

Jenis peristiwa tag ini.

AdBreak

AdBreak menjelaskan satu jeda iklan dalam streaming. Objek ini berisi durasi, jenis (tengah/awal/akhir), dan jumlah iklan.
Representasi JSON
{
  "type": string,
  "duration": number,
  "expected_duration": number,
  "ads": number,
}
Kolom
type string

Jenis jeda yang valid adalah: pre, mid, dan post.
duration number

Total durasi iklan untuk jeda iklan ini, dalam detik.
expected_duration number

Perkiraan durasi jeda iklan (dalam detik), termasuk semua iklan dan slate.
ads number

Jumlah iklan dalam jeda iklan.
Iklan menjelaskan iklan dalam aliran.
Representasi 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),
}
Kolom
ad_break_id string

ID jeda iklan iklan ini.
position number

Posisi iklan ini di jeda iklan, dimulai dari 1.
duration number

Durasi iklan, dalam detik.
title string

Judul iklan opsional.
description string

Deskripsi iklan opsional.
advertiser string

ID pengiklan opsional.
ad_system string

Sistem iklan opsional.
ad_id string

ID iklan opsional.
creative_id string

ID materi iklan opsional.
creative_ad_id string

ID iklan materi iklan opsional.
deal_id string

ID transaksi opsional.
clickthrough_url string

URL klik-tayang opsional.
click_tracking_urls string

URL pelacakan klik opsional.
verifications [object(Verification)]

Entri verifikasi Pengukuran Terbuka opsional yang mencantumkan resource dan metadata yang diperlukan untuk menjalankan kode pengukuran pihak ketiga guna memverifikasi pemutaran materi iklan.
slate boolean

Bool opsional yang menunjukkan bahwa entri saat ini adalah slate.
icons [object(Icon)]

Daftar ikon, dihilangkan jika kosong.
wrappers [object(Wrapper)]

Daftar Wrapper, dihilangkan jika kosong.
universal_ad_id object(UniversalAdID)

ID iklan universal opsional.
extensions string

Daftar opsional semua node <Extension> di VAST.
companions [object(Companion)]

Materi iklan pengiring opsional yang dapat ditampilkan bersama iklan ini.
interactive_file object(InteractiveFile)

Materi iklan interaktif opsional (SIMID) yang harus ditampilkan selama pemutaran iklan.

MatchOpts

MatchOpts menentukan persyaratan pencocokan media yang ketat untuk streaming.
Representasi JSON
{
  "audio_channels": boolean,
  "audio_sample_rate": boolean,
}
Kolom
audio_channels boolean

Cocokkan saluran audio antara konten dan iklan.
audio_sample_rate boolean

Cocokkan frekuensi sampel audio antara konten dan iklan.

CreateStreamRequest

CreateStreamRequest menjelaskan informasi yang ditemukan dalam permintaan HTTP ke VOD pod serving API. Pembuatan streaming dimulai oleh partner teknologi video (VTP), atas nama SDK dan penayang, untuk setiap pengguna. Streaming yang dibuat menghasilkan pod iklan yang telah diputuskan untuk disambungkan VTP. Hal ini berbeda dengan alur StreamRegistrationRequest+AdPodDecisionRequest yang mendaftarkan streaming dan memutuskan adpod dalam beberapa permintaan.
Representasi 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),
}
Kolom
encoding_profiles [object(EncodingProfile)]

Daftar profil encoding. Wajib diisi.
ad_tag string

Tag iklan dasar untuk pengambilan keputusan. Wajib diisi.
cuepoints number

Daftar titik cuplikan, dalam detik. Wajib diisi jika respons tag iklan menggunakan selisih waktu posisional.
manifest_type string

Jenis manifes yang valid adalah: hls dan dash. Default: hls. Opsional.
enable_hls_asset_list boolean

Menunjukkan apakah interstisial daftar aset HLS diaktifkan. Jika diaktifkan, DAI akan menampilkan URL daftar aset untuk setiap jeda iklan, yang dapat digunakan untuk iklan interstisial HLS.
targeting_parameters string

Parameter penargetan Ad Manager tambahan. Opsional.
content_duration_seconds number

ContentDurationSeconds adalah durasi konten dalam detik. Wajib diisi jika respons tag iklan menggunakan offset waktu persentase.
decision_timing_options object(DecisionTimingOptions)

Menunjukkan kapan adpod harus diputuskan.
enable_inline_manifests boolean

Menunjukkan apakah manifes jeda harus disisipkan dalam respons JSON.
dai_options object(CreateStreamOptions)

DAIOptions untuk pembuatan aliran.

CreateStreamOptions

CreateStreamOptions mewakili opsi yang tersedia di alur kerja pembuatan streaming satu langkah.
Representasi 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,
}
Kolom
dash_profile string

Profil MPEG-DASH yang akan digunakan, 'live' atau 'on-demand'.
match_options object(MatchOpts)

data_sharing_policy_code string

Mengizinkan penayang mengganti kebijakan berbagi data default jaringan.
sam_id string

sam_id adalah kunci debug SAM untuk sesi, bersifat opsional.
session_title string

session_title adalah judul sesi SAM untuk streaming, bersifat opsional.
dash_inband_event_stream boolean

dash_inband_event_stream menunjukkan bahwa DAI menyisipkan pesan ID3 sebagai peristiwa dalam band (dalam media) menggunakan elemen InbandEventStream, bukan sebagai elemen EventStream (dalam manifes).
distinct_ad_profiles boolean

Jika ditetapkan ke benar (true), menunjukkan bahwa server akan menggunakan profil iklan yang tersedia paling banyak satu kali saat mencocokkan profil encoding yang diminta.
tracking_mode string

tracking_mode adalah jenis pelacakan iklan yang akan digunakan untuk streaming, bersifat opsional. Nilai yang valid adalah: 'ad_media', 'server', 'client'.
emsg_version uint32

emsg_version memaksa penggunaan versi emsg tertentu untuk ID3 dalam media. Hanya didukung jika dash_inband_event_stream benar.

StreamRegistrationRequest

StreamRegistrationRequest mendaftarkan aliran dari perangkat untuk pengambilan keputusan pod iklan di masa mendatang. Hal ini berbeda dengan CreateStreamRequest yang membuat streaming dan memutuskan pod iklan dalam satu permintaan.
Representasi JSON
{
  "targeting_parameters": map[string, string],
  "dai_options": object(StreamRegistrationOptions),
}
Kolom
targeting_parameters string

Parameter penargetan Ad Manager tambahan. Opsional.
dai_options object(StreamRegistrationOptions)

DAIOptions untuk pendaftaran streaming.

StreamRegistrationOptions

StreamRegistrationOptions mencantumkan opsi yang tersedia untuk pembuatan streaming
Representasi JSON
{
  "sam_id": string,
  "tracking_mode": string,
  "emsg_version": uint32,
  "skippable_ads_supported": boolean,
}
Kolom
sam_id string

sam_id adalah kunci debug SAM untuk sesi, bersifat opsional.
tracking_mode string

tracking_mode adalah jenis pelacakan iklan yang akan digunakan untuk streaming, bersifat opsional. Nilai yang valid adalah: 'ad_media', 'server', 'client'.
emsg_version uint32

emsg_version memaksa penggunaan versi emsg tertentu untuk ID3 dalam media. Hanya didukung jika dash_inband_event_stream benar.
skippable_ads_supported boolean

Menunjukkan apakah iklan yang dapat dilewati didukung.

StreamRegistrationResponse

StreamRegistrationResponse merepresentasikan respons JSON yang dikirim kembali ke klien sebagai respons terhadap StreamRegistrationRequest. File ini mencakup ID streaming dan semua URL yang akan dibutuhkan perangkat. ID streaming dapat dirujuk dalam permintaan keputusan adpod berikutnya. Hal ini berbeda dengan CreateStreamResponse yang merepresentasikan respons untuk membuat aliran dan membuat keputusan adpod secara bersamaan.
Representasi JSON
{
  "stream_id": string,
  "media_verification_url": string,
  "valid_for": string,
  "valid_until": string,
  "metadata_url": string,
}
Kolom
stream_id string

StreamID adalah ID unik untuk streaming saat ini dari penonton ini.
media_verification_url string

MediaVerificationURL adalah awalan URL yang akan digunakan dalam permintaan verifikasi media iklan yang dijelaskan di bawah. Tidak ada untuk streaming beaconing sisi klien.
valid_for string

ValidFor adalah durasi validitas streaming ini, dalam format "00h00m00s".
valid_until string

ValidUntil adalah tanggal dan waktu hingga streaming ini valid.
metadata_url string

MetadataURL adalah URL metadata yang akan digunakan untuk meminta metadata pod iklan.

DecisionTimingOptions

DecisionTimingOptions menjelaskan opsi pengaturan waktu untuk memutuskan jeda iklan untuk streaming.
Representasi JSON
{
  "type": string,
  "on_create_breaks": [],
}
Kolom
type string

Type menjelaskan kapan adpod diputuskan untuk streaming. Jenis yang valid adalah: on_create (default), on_demand. Jika jenisnya on_demand, iklan akan diputuskan secara lambat saat manifes diminta untuk jeda tertentu. Jika jenisnya adalah on_create, semua iklan diputuskan saat streaming dibuat.
on_create_breaks string

OnCreateBreaks adalah daftar breakID VMAP peka huruf besar/kecil yang harus diputuskan saat pembuatan streaming. Kolom ini hanya diizinkan jika jenisnya adalah on_demand. ID jeda iklan khusus "preroll" dan "postroll" dapat digunakan untuk menunjukkan bahwa jeda preroll atau postroll harus diputuskan pada waktu pembuatan streaming.

EncodingProfile

EncodingProfile menjelaskan encoding dari satu varian konten. Setelan ini dapat berisi setelan video saja, setelan audio saja (dalam kasus jenis media), setelan video dan audio, atau tidak keduanya dalam kasus subtitel.
Representasi JSON
{
  "profile_name": string,
  "type": string,
  "container_type": string,
  "video_settings": object(VideoSettings),
  "audio_settings": object(AudioSettings),
  "subtitle_settings": object(SubtitleSettings),
}
Kolom
profile_name string

Nama yang diberikan penayang untuk profil. Unik per streaming. Wajib diisi.
type string

Jenis yang valid adalah: media, iframe, subtitel. Wajib diisi.
container_type string

Jenis yang valid adalah: mpeg2ts, fmp4cmaf, dan hls_packed_audio. Wajib untuk Jenis media dan iframe.
video_settings object(VideoSettings)

Setelan video diperlukan jika jenis penampung adalah iframe. Jika tidak, tombol tersebut hanya ada jika profil berisi video.
audio_settings object(AudioSettings)

Setelan audio ada jika profil berisi audio. Setelan audio hanya diizinkan jika jenis penampungnya adalah media.
subtitle_settings object(SubtitleSettings)

Setelan subtitel diperlukan untuk mengetik subtitel.

VideoSettings

VideoSettings menjelaskan video profil encoding. Jika satu setelan video ada, semua setelan harus ada.
Representasi JSON
{
  "codec": string,
  "bitrate": int32,
  "frames_per_second": number,
  "resolution": object(Resolution),
}
Kolom
codec string

String codec RFC6381 video.
bitrate int32

Kecepatan bit video maksimum profil encoding.
frames_per_second number

Frame per detik video.
resolution object(Resolution)

Resolusi lebar x tinggi video.

AudioSettings

AudioSettings menjelaskan audio profil encoding. Jika ada satu setelan audio, semua setelan audio harus ada.
Representasi JSON
{
  "codec": string,
  "bitrate": int32,
  "channels": int32,
  "sample_rate": int64,
}
Kolom
codec string

String codec RFC6381 dari audio.
bitrate int32

Kecepatan bit audio maksimum profil encoding.
channels int32

Jumlah saluran audio (termasuk saluran frekuensi rendah).
sample_rate int64

Frekuensi sampel audio, dalam hertz.

SubtitleSettings

SubtitleSettings menjelaskan subtitel profil encoding.
Representasi JSON
{
  "format": string,
  "language": string,
}
Kolom
format string

Format subtitel: webvtt untuk hls, webvtt atau ttml untuk dash.
language string

Bahasa yang akan disisipkan dalam manifes.

Resolusi

Resolusi menjelaskan lebar x tinggi video.
Representasi JSON
{
  "width": int32,
  "height": int32,
}
Kolom
width int32

Lebar video, dalam piksel. Wajib diisi.
height int32

Tinggi video, dalam piksel. Wajib diisi.

AdPodDecisionRequest

AdPodDecisionRequest mewakili permintaan untuk memutuskan pod iklan untuk streaming yang sebelumnya terdaftar.
Representasi 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),
}
Kolom
encoding_profiles [object(EncodingProfile)]

Daftar profil encoding. Wajib diisi.
ad_tag string

Tag iklan dasar untuk pengambilan keputusan. Wajib diisi.
cuepoints number

Daftar titik cuplikan, dalam detik. Wajib diisi jika respons tag iklan menggunakan selisih waktu posisional.
manifest_type string

Jenis manifes yang valid adalah: hls dan dash. Default: hls. Opsional.
enable_hls_asset_list boolean

Menunjukkan apakah interstisial daftar aset HLS diaktifkan. Jika diaktifkan, DAI akan menampilkan URL daftar aset untuk setiap jeda iklan, yang dapat digunakan untuk iklan interstisial HLS.
targeting_parameters string

Parameter penargetan Ad Manager tambahan. Opsional.
content_duration_seconds number

ContentDurationSeconds adalah durasi konten dalam detik. Wajib diisi jika respons tag iklan menggunakan offset waktu persentase.
decision_timing_options object(DecisionTimingOptions)

Menunjukkan kapan adpod harus diputuskan.
enable_inline_manifests boolean

Menunjukkan apakah manifes jeda harus disisipkan dalam respons JSON.
dai_options object(AdPodDecisionOptions)

DAIOptions untuk keputusan pod iklan.

AdPodDecisionResponse

AdPodDecisionResponse merepresentasikan respons terhadap pengambilan keputusan pod iklan untuk streaming yang terdaftar sebelumnya. Berisi daftar pod iklan yang diputuskan untuk streaming tersebut.
Representasi JSON
{
  "valid_for": string,
  "valid_until": string,
  "ad_pods": [object(AdPod)],
}
Kolom
valid_for string

ValidFor adalah durasi validitas streaming ini, dalam format "00h00m00s".
valid_until string

ValidUntil adalah tanggal dan waktu hingga streaming ini valid.
ad_pods [object(AdPod)]

Daftar pod iklan yang diurutkan berdasarkan urutan penyisipan.

CreateStreamResponse

CreateStreamResponse merepresentasikan respons JSON yang dikirim kembali ke klien sebagai respons terhadap CreateStreamRequest.
Representasi 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,
}
Kolom
valid_for string

ValidFor adalah durasi validitas streaming ini, dalam format "00h00m00s".
valid_until string

ValidUntil adalah tanggal dan waktu hingga streaming ini valid.
ad_pods [object(AdPod)]

Daftar pod iklan yang diurutkan berdasarkan urutan penyisipan.
stream_id string

StreamID adalah ID unik untuk streaming saat ini dari penonton ini.
media_verification_url string

MediaVerificationURL adalah awalan URL yang akan digunakan dalam permintaan verifikasi media iklan yang dijelaskan di bawah. Tidak ada untuk streaming beaconing sisi klien.
pod_metadata object(PodMetadata)

PodMetadata berisi informasi tambahan yang diperlukan untuk merender pod di perangkat dan memicu verifikasi. Seperti yang dijelaskan dalam dokumen Dynamic Ad Insertion Linear API. Hanya disertakan untuk streaming beaconing sisi klien.
metadata_url string

MetadataURL adalah URL metadata yang akan digunakan untuk meminta metadata pod iklan.

AdPod

AdPod merepresentasikan jeda iklan yang telah diputuskan dan siap untuk diputar.
Representasi 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,
}
Kolom
manifest_uris string

ManifestURIs adalah peta nama profil encoding ke manifest_uris varian HLS untuk konten HLS.
multivariant_uri string

MultivariantURI adalah URI untuk manifes multivarian untuk konten HLS.
mpd_uri string

MPDURI adalah URI untuk MPD untuk konten DASH.
manifests Manifests adalah peta nama profil encoding ke manifes varian HLS.string

Diisi hanya jika stream memiliki enable_inline_manifests yang disetel ke benar (true).
multivariant_manifest string

MultivariantManifest adalah manifes multivarian untuk konten HLS. Diisi hanya jika stream memiliki enable_inline_manifests yang disetel ke benar (true).
mpd_manifest string

MPDManifest adalah manifes MPD untuk konten DASH. Diisi hanya jika stream memiliki enable_inline_manifests yang disetel ke benar (true).
asset_list_uri string

AssetListURI adalah URI untuk daftar aset iklan HLS untuk konten HLS. Diisi hanya jika iklan interstisial daftar aset HLS diaktifkan untuk streaming.
start number

Waktu mulai pod iklan dalam linimasa aset (tanpa menyertakan pod iklan sebelumnya) dalam detik floating point.
duration number

Durasi pod iklan dalam detik floating point.
type string

Jenis jeda iklan.
midroll_index number

Indeks mid-roll berbasis 1 dalam streaming, berdasarkan ID jeda VMAP. Dihilangkan untuk pre-roll dan post-roll.

AdPodDecisionOptions

AdPodDecisionOptions merepresentasikan opsi tambahan untuk streaming.
Representasi 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,
}
Kolom
dash_profile string

Profil MPEG-DASH yang akan digunakan, 'live' atau 'on-demand'.
match_options object(MatchOpts)

data_sharing_policy_code string

Mengizinkan penayang mengganti kebijakan berbagi data default jaringan.
sam_id string

sam_id adalah kunci debug SAM untuk sesi, bersifat opsional.
session_title string

session_title adalah judul sesi SAM untuk streaming, bersifat opsional.
dash_inband_event_stream boolean

dash_inband_event_stream menunjukkan bahwa DAI menyisipkan pesan ID3 sebagai peristiwa dalam band (dalam media) menggunakan elemen InbandEventStream, bukan sebagai elemen EventStream (dalam manifes).
distinct_ad_profiles boolean

Jika ditetapkan ke benar (true), menunjukkan bahwa server akan menggunakan profil iklan yang tersedia paling banyak satu kali saat mencocokkan profil encoding yang diminta.

Streaming

Stream digunakan untuk merender daftar semua resource untuk stream yang baru dibuat dalam format JSON .
Representasi JSON
{
  "stream_id": string,
  "valid_for": string,
  "valid_until": string,
  "media_verification_url": string,
}
Kolom
stream_id string

ID streaming.
valid_for string

Aliran durasi berlaku untuk, dalam format "00h00m00s".
valid_until string

Tanggal validnya streaming, dalam format RFC 3339.
media_verification_url string

URL verifikasi media.

Ikon

Ikon berisi informasi tentang Ikon VAST.
Representasi 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,
}
Kolom
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 berisi informasi tentang rasio klik-tayang ikon.
Representasi JSON
{
  "url": string,
}
Kolom
url string

FallbackImage

FallbackImage berisi informasi tentang gambar penggantian VAST.
Representasi JSON
{
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "alt_text": string,
}
Kolom
creative_type string

height int32

width int32

resource string

alt_text string

Wrapper

Wrapper berisi informasi tentang iklan wrapper. Tidak menyertakan ID Kesepakatan jika tidak ada.
Representasi JSON
{
  "system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
}
Kolom
system string

ID sistem iklan.
ad_id string

ID Iklan yang digunakan untuk iklan wrapper.
creative_id string

ID materi iklan yang digunakan untuk iklan wrapper.
creative_ad_id string

ID Iklan Materi Iklan yang digunakan untuk iklan wrapper.
deal_id string

ID transaksi opsional untuk iklan wrapper.

Verifikasi

Verifikasi berisi informasi untuk Pengukuran Terbuka, yang memfasilitasi pengukuran visibilitas dan verifikasi pihak ketiga. Saat ini, hanya resource JavaScript yang didukung. Lihat https://iabtechlab.com/standards/open-measurement-sdk/
Representasi JSON
{
  "vendor": string,
  "java_script_resources": [object(JavaScriptResource)],
  "tracking_events": [object(TrackingEvent)],
  "parameters": string,
}
Kolom
vendor string

Vendor verifikasi.
java_script_resources [object(JavaScriptResource)]

Daftar resource JavaScript untuk verifikasi.
tracking_events [object(TrackingEvent)]

Daftar peristiwa pelacakan untuk verifikasi.
parameters string

String opaque yang diteruskan ke kode verifikasi bootstrap.

JavaScriptResource

JavaScriptResource berisi informasi untuk verifikasi melalui JavaScript.
Representasi JSON
{
  "script_url": string,
  "api_framework": string,
  "browser_optional": boolean,
}
Kolom
script_url string

URI ke payload JavaScript.
api_framework string

APIFramework adalah nama framework video yang menjalankan kode verifikasi.
browser_optional boolean

Apakah skrip ini dapat dijalankan di luar browser.

TrackingEvent

TrackingEvent berisi URL yang harus di-ping oleh klien dalam situasi tertentu.
Representasi JSON
{
  "event": string,
  "uri": string,
}
Kolom
event string

Jenis peristiwa pelacakan.
uri string

Peristiwa pelacakan yang akan di-ping.

UniversalAdID

UniversalAdID digunakan untuk memberikan ID materi iklan unik yang dipertahankan di seluruh sistem iklan.
Representasi JSON
{
  "id_value": string,
  "id_registry": string,
}
Kolom
id_value string

ID Iklan Universal dari materi iklan yang dipilih untuk iklan.
id_registry string

String yang digunakan untuk mengidentifikasi URL situs pendaftaran tempat ID Iklan Universal materi iklan yang dipilih dikatalogkan.

Pengiring

Pengiring berisi informasi untuk iklan pengiring yang dapat ditampilkan bersama dengan iklan.
Representasi 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)],
}
Kolom
click_data object(ClickData)

Data klik untuk pengiring ini.
creative_type string

Atribut CreativeType pada node <StaticResource> di VAST jika ini adalah pengiring jenis statis.
height int32

Tinggi pengiring ini dalam piksel.
width int32

Lebar pengiring ini dalam piksel.
resource string

Untuk pendamping statis dan iframe, ini akan menjadi URL yang akan dimuat dan ditampilkan. Untuk pengiring HTML, ini akan menjadi cuplikan HTML yang harus ditampilkan sebagai pengiring.
type string

Jenis pengiring ini. Dapat berupa statis, iframe, atau HTML.
ad_slot_id string

ID slot untuk pendamping ini.
api_framework string

Framework API untuk pendamping ini.
tracking_events [object(TrackingEvent)]

Daftar peristiwa pelacakan untuk pendamping ini.

InteractiveFile

InteractiveFile berisi informasi untuk materi iklan interaktif (yaitu SIMID) yang harus ditampilkan selama pemutaran iklan.
Representasi JSON
{
  "resource": string,
  "type": string,
  "variable_duration": boolean,
  "ad_parameters": string,
}
Kolom
resource string

URL ke materi iklan interaktif.
type string

Jenis MIME file yang disediakan sebagai resource.
variable_duration boolean

Apakah materi iklan ini dapat meminta perpanjangan durasi.
ad_parameters string

Nilai node <AdParameters> di VAST.