API Linear Penyisipan Iklan Dinamis

Dynamic Ad Insertion API memungkinkan Anda meminta dan melacak streaming linear (LIVE) DAI.

Layanan: dai.google.com

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

Metode: stream

Permintaan HTTP

POST https://dai.google.com/linear/v1/hls/event/{assetKey}/stream

Header permintaan

Authorization: DCLKDAI key="<api-key>"

Parameter jalur

Isi permintaan

Isi permintaan berjenis application/x-www-form-urlencoded dan berisi parameter berikut:

Isi respons

Jika berhasil, isi respons akan memuat Stream baru. Untuk streaming beacon 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 mengetahui 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. Permintaan ini tidak diperlukan untuk streaming beacon sisi server, tempat server memulai verifikasi media.

Permintaan ke endpoint media verification bersifat idempoten.

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 masa berlaku yang sudah habis.
• 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 dicadangkan untuk frame "informasi teks yang ditentukan pengguna". Isi frame akan didekripsi dan akan selalu dimulai dengan teks "google_".

Seluruh konten teks 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 beacon sisi server, dengan server bertanggung jawab untuk memulai verifikasi media iklan.

Permintaan HTTP

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

GET https://{metadata_url}

Parameter kueri

Isi respons

Jika berhasil, respons akan menampilkan instance PodMetadata.

Bekerja dengan Metadata

Metadata memiliki tiga bagian terpisah: tags, ads, dan breaks iklan. Titik masuk ke data adalah bagian tags. Dari sana, lakukan iterasi pada tag dan temukan entri pertama yang namanya merupakan awalan untuk ID media iklan yang ditemukan di streaming video. Misalnya, Anda mungkin memiliki ID media iklan yang terlihat seperti:

google_1234567890

Kemudian, Anda akan menemukan objek tag bernama google_12345. Dalam hal ini, ID tersebut cocok dengan ID media iklan Anda. Setelah menemukan objek awalan media iklan yang benar, 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

{
  "stream_id": string,
  "stream_manifest": string,
  "hls_master_playlist": string,
  "media_verification_url": string,
  "metadata_url": string,
  "session_update_url": string,
  "polling_frequency": number,
}

PodMetadata

{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
  "next_delta_token": string,
  "obsolete_ad_break_ids": [],
}

TagSegment

{
  "ad": string,
  "ad_break_id": string,
  "type": string,
}

AdBreak

{
  "type": string,
  "duration": number,
  "expected_duration": number,
  "ads": number,
}

Iklan

{
  "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),
}

Ikon

{
  "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

{
  "url": string,
}

FallbackImage

{
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "alt_text": string,
}

Wrapper

{
  "system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
}

Verifikasi

{
  "vendor": string,
  "java_script_resources": [object(JavaScriptResource)],
  "tracking_events": [object(TrackingEvent)],
  "parameters": string,
}

JavaScriptResource

{
  "script_url": string,
  "api_framework": string,
  "browser_optional": boolean,
}

TrackingEvent

{
  "event": string,
  "uri": string,
}

UniversalAdID

{
  "id_value": string,
  "id_registry": string,
}

Pengiring

{
  "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)],
}

InteractiveFile

{
  "resource": string,
  "type": string,
  "variable_duration": boolean,
  "ad_parameters": string,
}