Dynamic AdPenyisipan API memungkinkan Anda meminta dan melacak streaming DAI linear (LIVE).
Layanan: dai.google.com
Semua URI di bawah ini relatif terhadap https://dai.google.com
Metode: stream
Metode | |
---|---|
stream |
POST /linear/v1/hls/event/{assetKey}/stream
Membuat streaming DAI untuk ID peristiwa yang diberikan. |
Permintaan HTTP
POST https://dai.google.com/linear/v1/hls/event/{assetKey}/stream
Header permintaan
Parameter | |
---|---|
api‑key |
string Kunci API yang diberikan saat membuat streaming harus valid untuk jaringan penayang. Daripada menyediakannya dalam isi permintaan, kunci API dapat diteruskan di header Otorisasi HTTP dengan format berikut: Authorization: DCLKDAI key="<api-key>" |
Parameter jalur
Parameter | |
---|---|
assetKey |
string ID peristiwa streaming. |
Isi permintaan
Isi permintaan berjenis application/x-www-form-urlencoded
dan berisi
parameter berikut:
Parameter | ||
---|---|---|
dai-ssb |
Opsional | Tetapkan ke |
Parameter Penargetan DFP | Opsional | Parameter penargetan tambahan. |
Mengganti Parameter Aliran Data | Opsional | Mengganti nilai default parameter pembuatan streaming. |
Autentikasi HMAC | Opsional | Autentikasi menggunakan token berbasis HMAC. |
Isi respons
Jika berhasil, isi respons akan berisi
Stream
baru. Untuk streaming beaconing sisi server, Stream
ini
hanya berisi kolom stream_id
dan stream_manifest
.
Pengukuran Terbuka
DAI API berisi informasi untuk verifikasi Pengukuran Terbuka di kolom
Verifications
. Kolom ini berisi satu atau beberapa
elemen Verification
yang mencantumkan resource dan metadata yang diperlukan untuk mengeksekusi
kode pengukuran pihak ketiga guna memverifikasi pemutaran materi iklan. Hanya
JavaScriptResource
yang didukung. Untuk informasi selengkapnya, lihat
IAB Tech Lab dan
spesifikasi VAST 4.1.
Metode: verifikasi media
Setelah menemukan ID media iklan selama pemutaran, segera buat permintaan menggunakan media_verification_url yang diperoleh dari endpoint stream di atas. Permintaan ini tidak diperlukan untuk streaming beaconing sisi server, tempat server memulai verifikasi media.
Permintaan ke endpoint media verification
bersifat idempoten.
Metode | |
---|---|
media verification |
GET /{media_verification_url}/{ad_media_id}
Memberi tahu API peristiwa verifikasi media. |
Permintaan HTTP
GET https://{media-verification-url}/{ad-media-id}
Isi respons
media verification
menampilkan respons berikut:
HTTP/1.1 204 No Content
jika verifikasi media berhasil dan semua ping dikirim.HTTP/1.1 404 Not Found
jika permintaan tidak dapat memverifikasi media karena format URL yang salah atau habis masa berlakunya.HTTP/1.1 404 Not Found
jika permintaan verifikasi sebelumnya untuk tanda pengenal ini berhasil.HTTP/1.1 409 Conflict
jika permintaan lain sudah mengirimkan ping saat ini.
ID media iklan (HLS)
ID media iklan akan dienkode dalam Metadata Berwaktu HLS menggunakan kunci
TXXX
, yang disimpan untuk frame "informasi teks yang ditentukan pengguna". Konten
frame akan tidak dienkripsi dan akan selalu dimulai dengan teks
"google_"
.
Seluruh konten teks dalam frame harus ditambahkan ke URL verifikasi iklan sebelum membuat setiap permintaan verifikasi iklan.
Metode: metadata
Endpoint metadata di metadata_url
menampilkan informasi yang digunakan untuk membuat UI
iklan. Endpoint metadata tidak tersedia untuk streaming sumber sisi server,
dengan server yang bertanggung jawab untuk memulai verifikasi media iklan.
Metode | |
---|---|
metadata |
GET /{metadata_url}/{ad-media-id} GET /{metadata_url}
Mengambil informasi metadata iklan. |
Permintaan HTTP
GET https://{metadata_url}/{ad-media-id}
GET https://{metadata_url}
Isi respons
Jika berhasil, respons akan menampilkan instance
PodMetadata
.
Bekerja dengan Metadata
Metadata memiliki tiga bagian yang berbeda: tags
, ads
, dan breaks
iklan. Titik
entri ke dalam data adalah bagian tags
. Dari sana, ulangi tag
dan temukan entri pertama yang namanya adalah awalan
ID media iklan yang ditemukan dalam streaming video. Misalnya, Anda
mungkin memiliki ID media iklan yang terlihat seperti:
google_1234567890
Kemudian, Anda menemukan objek tag bernama google_12345
. Dalam hal ini, ID tersebut cocok dengan
ID media iklan Anda. Setelah menemukan objek awalan media iklan yang tepat, Anda dapat mencari
ID iklan, ID jeda iklan, dan jenis peristiwa. ID iklan kemudian digunakan untuk mengindeks
objek ads
dan ID jeda iklan digunakan untuk mengindeks objek breaks
.
Data respons
Streaming
Streaming digunakan untuk merender daftar resource untuk streaming yang baru dibuat dalam format JSON.Representasi JSON |
---|
{ "stream_id": string, "stream_manifest": string, "hls_master_playlist": string, "media_verification_url": string, "metadata_url": string, "session_update_url": string, "polling_frequency": number, } |
Kolom | |
---|---|
stream_id |
string ID streaming GAM. |
stream_manifest |
string URL manifes streaming, yang digunakan untuk mengambil playlist multi-varian di HLS atau MPD di DASH. |
hls_master_playlist |
string (TIDAK DIGUNAKAN LAGI) URL playlist multi-varian HLS. Sebagai gantinya, gunakan "stream_manifes". |
media_verification_url |
string URL verifikasi media yang digunakan sebagai endpoint dasar untuk melacak peristiwa pemutaran. |
metadata_url |
string URL metadata yang digunakan untuk melakukan polling informasi berkala tentang acara iklan streaming mendatang. |
session_update_url |
string URL update sesi yang digunakan untuk memperbarui parameter penargetan untuk streaming ini. Nilai asli untuk parameter penargetan akan diambil selama permintaan pembuatan streaming awal. |
polling_frequency |
number Frekuensi polling, dalam detik, saat meminta metadata_url dari ataubeat_url. |
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)], } |
Kolom | |
---|---|
tags |
map[string, object(TagSegment)] Peta segmen tag yang diindeks oleh 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 oleh ID jeda iklan. |
TagSegment
TagSegment berisi referensi ke iklan, jeda iklannya, dan jenis peristiwa. 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
Jeda Iklan mendeskripsikan satu jeda iklan dalam streaming. Tab ini berisi durasi, jenis (pertengahan/pra/pasca), dan jumlah iklan.Representasi JSON |
---|
{ "type": string, "duration": number, "expected_duration": number, "ads": number, } |
Kolom | |
---|---|
type |
string Jenis jeda yang valid adalah: sebelum, pertengahan, dan setelah. |
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 (layar pemblokir) apa pun. |
ads |
number Jumlah iklan dalam jeda iklan. |
Iklan
Iklan mendeskripsikan iklan dalam streaming.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 untuk iklan ini. |
position |
number Posisi iklan ini dalam jeda iklan, mulai dari 1. |
duration |
number Durasi iklan, dalam detik. |
title |
string Judul opsional iklan. |
description |
string Deskripsi opsional iklan. |
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 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 <Ekstensi> di VAST. |
companions |
[object(Companion)] Pengiring opsional yang mungkin ditampilkan bersama iklan ini. |
interactive_file |
object(InteractiveFile) Materi iklan interaktif opsional (SIMID) yang harus ditampilkan selama pemutaran iklan. |
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 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. ID ini tidak menyertakan ID Transaksi 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 Open Measurement, yang memfasilitasi pengukuran verifikasi dan visibilitas 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 referensi JavaScript untuk verifikasi. |
tracking_events |
[object(TrackingEvent)] Daftar peristiwa pelacakan untuk verifikasi. |
parameters |
string String buram 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 untuk situs registry tempat ID Iklan Universal materi iklan yang dipilih dicantumkan dalam katalog. |
Pengiring
Pengiring berisi informasi untuk iklan pengiring yang dapat ditampilkan bersama 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 merupakan pengiring jenis statis. |
height |
int32 Tinggi dalam piksel pendamping ini. |
width |
int32 Lebar dalam piksel pengiring ini. |
resource |
string Untuk pengiring statis dan iframe, alamat ini akan menjadi URL yang akan dimuat dan ditampilkan. Untuk pengiring HTML, kode ini akan menjadi cuplikan HTML yang harus ditampilkan sebagai pengiring. |
type |
string Jenis pendamping ini. URL dapat berupa statis, iframe, atau HTML. |
ad_slot_id |
string ID slot untuk pengiring 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> dalam VAST. |