API Linear Penyisipan Iklan Dinamis

API Penyisipan Iklan Dinamis memungkinkan Anda meminta dan melacak DAI streaming linear (LIVE).

Layanan: dai.google.com

Semua URI di bawah ini 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 berisi Stream Untuk streaming sisi server, Stream ini hanya berisi kolom stream_id dan stream_manifest.

Pengukuran Terbuka

DAI API berisi informasi untuk verifikasi Pengukuran Terbuka dalam Kolom Verifications. Kolom ini berisi satu atau beberapa Elemen Verification yang mencantumkan resource dan metadata yang diperlukan untuk mengeksekusi kode pengukuran pihak ketiga untuk memverifikasi pemutaran materi iklan. Hanya JavaScriptResource didukung. Untuk informasi selengkapnya, lihat IAB Tech Lab dan Spesifikasi VAST 4.1.

Metode: verifikasi media

Setelah menemukan pengenal media iklan selama pemutaran, segera buat permintaan menggunakan media_verification_url yang diperoleh dari stream endpoint, di atas. Permintaan ini tidak diperlukan untuk beaconing sisi server streaming, 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 akan 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 tersebut TXXX, dicadangkan untuk "informasi teks yang ditentukan pengguna" {i>frame<i}. Tujuan dalam {i>frame<i} tersebut tidak akan dienkripsi dan akan selalu dimulai dengan teks "google_".

Seluruh konten teks dalam bingkai harus ditambahkan ke verifikasi iklan URL sebelum membuat setiap permintaan verifikasi iklan.

Metode: metadata

Endpoint metadata di metadata_url menampilkan informasi yang digunakan untuk membuat iklan UI. Endpoint metadata tidak tersedia untuk aliran data di sisi server, di mana server bertanggung jawab untuk memulai verifikasi media iklan.

Permintaan HTTP

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

GET https://{metadata_url}

Isi respons

Jika berhasil, respons menampilkan instance PodMetadata

Bekerja dengan Metadata

Metadata memiliki tiga bagian yang berbeda: tags, ads, dan breaks iklan. Entri mengarah ke data adalah bagian tags. Kemudian, lakukan iterasi tag dan temukan entri pertama yang namanya merupakan awalan untuk ID media iklan yang ditemukan dalam streaming video. Sebagai contoh, Anda mungkin memiliki ID media iklan yang terlihat seperti:

google_1234567890

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

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

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,
}