VOD API Penyisipan Iklan Dinamis

Dynamic Ad Insertion API memungkinkan Anda meminta dan melacak streaming video on demand (VOD) DAI. Streaming HLS dan DASH didukung.

Layanan: dai.google.com

Jalur metode stream bersifat relatif terhadap https://dai.google.com

Metode: stream

Permintaan HTTP

POST https://dai.google.com/ondemand/v1/hls/content/{content-source}/vid/{video-id}/stream

POST https://dai.google.com/ondemand/v1/dash/content/{content-source}/vid/{video-id}/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 berisi Stream baru. Untuk streaming beacon sisi server, Stream ini hanya berisi kolom stream_id dan stream_manifest.

Pengukuran Terbuka

Kolom Verifications berisi informasi untuk verifikasi Pengukuran Terbuka untuk streaming beaconing non-sisi server. Verifications berisi satu atau beberapa elemen Verification yang mencantumkan resource dan metadata yang Anda perlukan untuk memverifikasi pemutaran materi iklan dengan kode pengukuran pihak ketiga. Hanya JavaScriptResource yang didukung. Untuk informasi selengkapnya, lihat IAB Tech Lab dan spesifikasi VAST 4.1.

Metode: verifikasi media

Setelah Anda menemukan ID media iklan selama pemutaran, segera buat permintaan menggunakan media_verification_url dari endpoint stream. media_verification_url adalah jalur absolut. Permintaan verifikasi media tidak diperlukan untuk streaming beacon sisi server, tempat server memulai verifikasi media.

Permintaan ke endpoint media verification bersifat idempoten.

Permintaan HTTP

GET {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 atau masa berlakunya salah.
• HTTP/1.1 404 Not Found jika permintaan verifikasi sebelumnya untuk ID ini berhasil.
• HTTP/1.1 409 Conflict jika permintaan lain sudah mengirim ping pada 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". Konten frame tidak akan dienkripsi dan akan selalu dimulai dengan teks "google_".

Seluruh konten teks frame harus ditambahkan ke media_verification_url untuk setiap permintaan verifikasi iklan.

ID media iklan (DASH)

ID media iklan akan disisipkan ke dalam manifes melalui penggunaan elemen EventStream DASH.

Setiap EventStream akan memiliki URI ID Skema urn:google:dai:2018. Peristiwa ini akan berisi peristiwa dengan atribut messageData yang berisi ID media iklan yang diawali dengan “google_”. Seluruh konten atribut messageData harus ditambahkan ke media_verification_url untuk setiap permintaan verifikasi iklan.

Data respons

Streaming

{
  "stream_id": string,
  "total_duration": number,
  "content_duration": number,
  "valid_for": string,
  "valid_until": string,
  "subtitles": [object(Subtitle)],
  "hls_master_playlist": string,
  "stream_manifest": string,
  "media_verification_url": string,
  "apple_tv": object(AppleTV),
  "ad_breaks": [object(AdBreak)],
}

AppleTV

{
  "interstitials_url": string,
}

AdBreak

{
  "type": string,
  "start": number,
  "duration": number,
  "ads": [object(Ad)],
}

Iklan

{
  "seq": number,
  "start": 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,
  "icons": [object(Icon)],
  "wrappers": [object(Wrapper)],
  "events": [object(Event)],
  "verifications": [object(Verification)],
  "universal_ad_id": object(UniversalAdID),
  "companions": [object(Companion)],
  "interactive_file": object(InteractiveFile),
  "skip_metadata": object(SkipMetadata),
  "extensions": [],
}

Acara

{
  "time": number,
  "type": string,
}

Subjudul

{
  "language": string,
  "language_name": string,
  "ttml": string,
  "webvtt": string,
}

SkipMetadata

{
  "offset": number,
  "tracking_url": string,
}

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