Skema dan properti pelacakan iklan sisi klien - AWS Elemental MediaTailor

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Skema dan properti pelacakan iklan sisi klien

Dengan fitur pelacakan iklan MediaTailor sisi klien, Anda dapat mengintegrasikan data pelacakan iklan sisi klien yang mendetail ke dalam lingkungan pemutar Anda. Bagian berikut mencakup skema pelacakan iklan secara keseluruhan, serta properti dan nilai spesifik yang membentuk skema.

Skema

Struktur JSON berikut menunjukkan skema pelacakan iklan MediaTailor sisi klien. Representasi ini menggambarkan struktur bersarang skema untuk membantu Anda memahami hubungan antara bagian yang berbeda.

Untuk informasi rinci tentang setiap properti, lihatProperti.

{ "avails": [ { "ads": [ { "adID": "string", "adParameters": "string", "adSystem": "string", "adTitle": "string", "adVerifications": [ { "executableResource": [ { "apiFramework": "string", "type": "string", "uri": "string", "language": "string" } ], "javaScriptResource": [ { "apiFramework": "string", "browserOptional": "string", "uri": "string" } ], "trackingEvents": [ { "event": "string", "uri": "string" } ], "vendor": "string", "verificationParameters": "string" } ], "companionAds": [ { "adParameters": "string", "altText": "string", "attributes": { "adSlotId": "string", "apiFramework": "string", "assetHeight": "string", "assetWidth": "string", "expandedHeight": "string", "expandedWidth": "string", "height": "string", "id": "string", "pxratio": "string", "renderingMode": "string", "width": "string" }, "companionClickThrough": "string", "companionClickTracking": "string", "htmlResource": "string", "iFrameResource": "string", "sequence": "string", "staticResource": "string", "trackingEvents": [ { "event": "string", "uri": "string" } ] } ], "creativeId": "string", "creativeSequence": "string", "duration": "string", "durationInSeconds": number, "extensions": [ { "type": "string", "content": "string" } ], "icons": [ { "attributes": { "apiFramework": "string", "duration": "string", "height": "string", "offset": "string", "program": "string", "pxratio": "string", "width": "string", "xPosition": "string", "yPosition": "string" }, "htmlResource": "string", "iconClicks": { "iconClickThrough": "string", "iconClickTracking": { "id": "string" }, "iconClickFallbackImages": [ { "altText": "string", "height": "string", "width": "string", "staticResource": { "creativeType": "string", "uri": "string" } } ] }, "iconViewTracking": "string", "iFrameResource": "string", "staticResource": { "creativeType": "string", "uri": "string" } } ], "mediaFiles": { "adParameters": "string", "duration": "string", "durationInSeconds": number, "mediaFilesList": [ { "apiFramework": "string", "delivery": "string", "height": "string", "maintainAspectRatio": "string", "mediaFileUri": "string", "mediaType": "string", "scalable": "string", "width": "string", "bitrate": "string" } ], "mezzanine": "string", "startTime": "string", "startTimeInSeconds": number, "trackingEvents": [ { "beaconUrls": ["string"], "duration": "string", "durationInSeconds": number, "dateTime": "string", "eventId": "string", "eventType": "string", "startTime": "string", "startTimeInSeconds": number } ] }, "startTime": "string", "startTimeInSeconds": number, "dateTime": "string", "adBreakTrackingEvents": [...], "vastAdId": "string" } ], "adType": "string", "availID": "string", "duration": "string", "durationInSeconds": number, "startTime": "string", "startTimeInSeconds": number, "dateTime": "string", "adMarkerDuration": "string", "adProgramDateTime": "string", "dashAvailabilityStartTime": "string", "hlsAnchorMediaSequenceNumber": "string" } ], "nonLinearAvails": [ { "nonLinearAds": [...], "nonLinearAdsList": [...] } ], "nextToken": "string", "meta": {} }

Properti

Tabel berikut mencantumkan properti di API pelacakan sisi klien, definisi, jenis nilai, dan contohnya.

Properti Definisi Tipe nilai Contoh
adID
  • HLS - nomor urut yang terkait dengan awal iklan

  • DASH - ID periode iklan

Jalan: /avails/ads/adId

Pemetaan VAST: Tidak ada

String 10
adBreakTrackingEvents

Array yang membawa peristiwa pelacakan VMAP dari respons VAST. Untuk informasi lebih lanjut, lihat bagian 2.3.3 dari spesifikasi VMAP 1.0.

Jalan: /avails/ads/adBreakTrackingEvents

Array []
adMarkerDuration

Durasi avail yang diamati dari penanda iklan dalam manifes.

String 30
adParameters

Serangkaian parameter iklan, dari VAST VPAID, yang MediaTailor lolos ke pemain.

Jalan: /avails/ads/adParameters

Pemetaan VAST: VAST/Ad/InLine/Creatives/Creative/Linear/AdParameters

String
adProgramDateTime
  • HLS - tanggal, dalam format ISO/IEC 8601:2004, yang mewakili urutan media pertama iklan.

  • DASH - [Tidak ditentukan]

String
ads

Array yang berisi objek iklan yang membentuk avail. Iklan tercantum dalam urutan mereka muncul dalam manifes.

Jalan: /avails/ads

Array []
adSystem

Nama sistem yang melayani iklan.

penting

Pastikan untuk memberikan nilai. Jika Anda tidak memberikan nilai, masalah dapat muncul.

String myADS
adTitle

Judul iklan.

String ad1
adVerifications

Berisi sumber daya dan metadata yang diperlukan untuk mengeksekusi kode pengukuran pihak ketiga untuk memverifikasi pemutaran kreatif. Untuk informasi lebih lanjut tentang properti ini, lihat bagian 3.16 dari spesifikasi VAST 4.2.

MediaTailor mendukung adVerifications sebagai VAST 3 node ekstensi.

Jalan: /avails/ads/adVerifications

Pemetaan VAST: VAST/Ad/InLine/AdVerifications

Array []
altText

Teks alternatif untuk gambar iklan pendamping. Teks ini memungkinkan pemain dengan dukungan deskriptif-audio untuk tunanetra untuk membaca kembali deskripsi gambar.

Jalan: /avails/ads/companionAds/altText

String video sequence advertising sneakers
apiFramework

Setel VPAID untuk memberi tahu pemain bahwa iklan ini adalah iklan VPAID.

Dapat muncul di beberapa lokasi dalam skema.

String VPAID
availID
  • HLS - nomor urut yang terkait dengan awal iklan yang tersedia.

  • DASH - ID periode iklan yang tersedia, yang biasanya merupakan ID periode konten yang akan diganti dengan iklan.

Jalan: /avails/availID

String
  • 34

  • PT34S_1

avails

Array yang berisi objek pemecah iklan, atau avails, yang disajikan di jendela manifes aktif. Keuntungannya tercantum dalam urutan yang muncul dalam manifes.

Jalan: /avails

Array []
adType

Jenis iklan.

Jalan: /avails/adType dan /avails/ads/adType

String
dateTime

Waktu tanggal program, dalam format ISO 8601 detik, untuk memulai iklan atau iklan.

Jalan: /avails/dateTime dan /avails/ads/dateTime

String
duration

Panjangnya, dalam format ISO 8601 detik. Respons mencakup durasi untuk seluruh iklan yang tersedia dan untuk setiap iklan dan suar, meskipun durasi suar selalu nol.

Jalan: /avails/duration dan /avails/ads/duration

String 15.015
durationInSeconds

Panjangnya, dalam format detik.

Jalan: /avails/durationInSeconds dan /avails/ads/durationInSeconds

Bilangan
extensions

Ekstensi khusus VAST yang digunakan server iklan. Untuk informasi selengkapnya tentang ekstensi, lihat bagian 3.18 dari spesifikasi VAST 4.2.

Jalan: /avails/ads/extensions

Pemetaan VAST: VAST/Ad/InLine/Extensions

Array []
icons

Elemen ikon untuk iklan.

Jalan: /avails/ads/icons

Pemetaan VAST: VAST/Ad/InLine/Creatives/Creative/Linear/Icons

Array
mediaFiles

Video dan aset lain yang dibutuhkan pemain untuk iklan.

Jalan: /avails/ads/mediaFiles

Objek
nonLinearAvails

Array objek yang memanfaatkan iklan non-linier.

Jalan: /nonLinearAvails

Array
executableResource

Sumber daya yang dapat dieksekusi untuk verifikasi.

Jalan: /avails/ads/adVerifications/executableResource

Pemetaan VAST: VAST/Ad/InLine/AdVerifications/Verification/ExecutableResource

Array
javaScriptResource

JavaScript sumber daya untuk verifikasi.

Jalan: /avails/ads/adVerifications/javaScriptResource

Pemetaan VAST: VAST/Ad/InLine/AdVerifications/Verification/JavaScriptResource

Array
trackingEvents

Melacak acara untuk verifikasi atau iklan pendamping.

Jalur: /avails/ads/adVerifications/trackingEvents atau /avails/ads/companionAds/trackingEvents

Array
vendor

Vendor verifikasi.

Jalan: /avails/ads/adVerifications/vendor

Pemetaan VAST: VAST/Ad/InLine/AdVerifications/Verification/@vendor

String
uri

URI yang menunjuk ke aset yang dapat dieksekusi, aset video, atau titik akhir pelacakan.

Path: Berbagai lokasi dalam skema

Pemetaan VAST: Berbagai elemen CDATA di VAST

String https://tracking.example.com/impression
verificationParameters

Parameter verifikasi.

Jalan: /avails/ads/adVerifications/verificationParameters

Pemetaan VAST: VAST/Ad/InLine/AdVerifications/Verification/VerificationParameters

String
attributes

Atribut iklan pendamping seperti dimensi dan mode rendering.

Jalan: /avails/ads/companionAds/attributes

Objek
companionClickThrough

URL ke halaman pengiklan yang dibuka pemutar media saat pemirsa mengklik iklan pendamping.

Jalan: /avails/ads/companionAds/companionClickThrough

Pemetaan VAST: VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/CompanionClickThrough

String https://aws.amazon.com/
companionClickTracking

URL pelacakan untuk companionClickThrough properti.

Jalan: /avails/ads/companionAds/companionClickTracking

Pemetaan VAST: VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/CompanionClickTracking

String https://myads.com/beaconing/event=clicktracking
htmlResource

HTML yang dikodekan CData yang dimasukkan langsung ke dalam halaman HTML penyedia streaming.

Jalan: /avails/ads/companionAds/htmlResource

Pemetaan VAST: VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/HTMLResource

String <![CDATA[<!doctype html><html><head><meta name=\"viewport\" content=\"width=1, initial-scale=1.0, minimum-scale=1.0,...]]>
iFrameResource

URL ke file sumber daya HTML yang dimuat penyedia streaming ke dalam iframe.

Jalan: /avails/ads/companionAds/iFrameResource

Pemetaan VAST: VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/iFrameResource

String
sequence

Nilai urutan yang ditentukan untuk kreatif dalam respons VAST.

Jalan: /avails/ads/companionAds/sequence

String 1
startTime

Posisi waktu, dalam format ISO 8601 detik. Untuk HLS, ini relatif terhadap awal sesi pemutaran. Untuk DASH, ini relatif terhadap AST manifes (Waktu Mulai Ketersediaan). Responsnya mencakup waktu mulai untuk seluruh iklan yang tersedia dan untuk setiap iklan dan suar.

Jalan: /avails/startTime dan /avails/ads/startTime

String PT18.581355S
startTimeInSeconds

Posisi waktu, dalam format detik. Untuk HLS, ini relatif terhadap awal sesi pemutaran. Untuk DASH, ini relatif terhadap AST manifes (Waktu Mulai Ketersediaan). Responsnya mencakup waktu mulai untuk seluruh iklan yang tersedia dan untuk setiap iklan dan suar.

Jalan: /avails/startTimeInSeconds dan /avails/ads/startTimeInSeconds

Bilangan 18.581
eventId
  • HLS - nomor urut yang terkait dengan suar.

  • DASH - awal iklan. ptsTime

String
event

Nama acara pelacakan.

Jalur: /avails/ads/adVerifications/trackingEvents/event atau /avails/ads/companionAds/trackingEvents/event

String impression, start, firstQuartile, midpoint, thirdQuartile, complete
beaconUrls

URL tempat MediaTailor mengirim suar iklan.

Jalan: /avails/ads/mediaFiles/trackingEvents/beaconUrls

Array
bitrate

Bitrate dari aset video. Properti ini biasanya tidak termasuk untuk aset yang dapat dieksekusi.

String 2048
companionAds

Satu atau beberapa spesifikasi konten iklan pendamping, yang masing-masing menentukan file sumber daya yang akan digunakan. Iklan pendamping menyertai iklan yang tersedia dan menyediakan konten, seperti bingkai di sekitar iklan atau spanduk, untuk ditampilkan di dekat video.

Jalan: /avails/ads/companionAds

Array []
creativeId

Nilai Id atribut Creative tag untuk iklan.

String creative-1
creativeSequence

Urutan di mana iklan harus diputar, sesuai dengan Ad@id nilai dalam respons VAST.

String 1
dashAvailabilityStartTime

Untuk live/dynamic DASH, manifes asal. MPD@availabilityStartTime

String 2022-10-05T19:38:39.263Z
delivery

Menunjukkan apakah streaming protokol progressive atau sedang digunakan.

String progressive
eventType

Jenis suar.

Jalan: /avails/ads/mediaFiles/trackingEvents/eventType

String impression
height

Ketinggian, dalam piksel, dari aset video.

String 360
hlsAnchorMediaSequenceNumber

Nomor urutan media dari urutan first/oldest media yang terlihat dalam manifes asal HLS.

String 77
maintainAspectRatio

Menunjukkan apakah akan mempertahankan rasio aspek video saat melakukan penskalaan.

Boolean true
mediaFilesList

Menentukan video dan aset lain yang dibutuhkan pemain untuk iklan yang tersedia.

Jalan: /avails/ads/mediaFiles/mediaFilesList

Array []
mediaFileUri

URI yang menunjuk ke aset yang dapat dieksekusi atau aset video.

String https://myad.com/ad/ad134/vpaid.js
mediaType

Jenis MIME dari aset kreatif atau pendamping.

String video/mp4
meta

Metadata tambahan untuk iklan.

Objek
mezzanine

URL MP4 aset mezzanine, ditentukan jika iklan VPAID menyertakan satu.

Jalan: /avails/ads/mediaFiles/mezzanine

String https://gcdn.2mdn.net/videoplayback/id/itag/ck2/file/file.mp4
nextToken

Nilai token yang menunjuk ke halaman hasil berikutnya, ketika nilai seperti itu ada.

String UFQzOS44NzNTXzIwMjMtMDctMzFUMTY6NTA6MDYuMzUwNjI2ODQ1Wl8x
nonLinearAds

Iklan non-linear yang muncul di samping konten video.

Array []
nonLinearAdsList

Daftar iklan non-linier.

Array []
scalable

Menunjukkan apakah akan menskalakan video ke dimensi lain.

Boolean true
skipOffset

Nilai waktu yang mengidentifikasi kapan pemain membuat kontrol lewati tersedia bagi pengguna.

String 00:00:05
staticResource

URL ke file kreatif statis yang digunakan untuk komponen iklan.

Jalan: /avails/ads/companionAds/staticResource

String https://very-interactive-ads.com/campaign1/file.json?c=1019113602
vastAdId

Nilai Id atribut Ad tag.

String ad1
width

Lebar, dalam piksel, dari aset video.

String 640
xPosition

Posisi horizontal ikon dalam pemutar video. Bisa berupa nilai piksel tertentu atau posisi seperti “kiri” atau “kanan”.

Jalan: /avails/ads/icons/attributes/xPosition

String left atau 10
yPosition

Posisi vertikal ikon dalam pemutar video. Dapat berupa nilai piksel tertentu atau posisi seperti “atas” atau “bawah”.

Jalan: /avails/ads/icons/attributes/yPosition

String top atau 10
iconClicks

Berisi informasi klik-tayang dan pelacakan untuk sebuah ikon.

Jalan: /avails/ads/icons/iconClicks

Objek
iconClickThrough

URL ke halaman pengiklan yang dibuka pemutar media saat pemirsa mengklik ikon.

Jalan: /avails/ads/icons/iconClicks/iconClickThrough

String https://advertiser.com/landing-page
iconClickTracking

URL pelacakan untuk iconClickThrough properti.

Jalan: /avails/ads/icons/iconClicks/iconClickTracking

Objek
iconClickFallbackImages

Array gambar fallback untuk ditampilkan jika ikon tidak dapat ditampilkan.

Jalan: /avails/ads/icons/iconClicks/iconClickFallbackImages

Array
iconViewTracking

URL untuk melacak saat ikon dilihat.

Jalan: /avails/ads/icons/iconViewTracking

String https://tracking.example.com/icon-view
offset

Waktu mengimbangi kapan ikon akan muncul selama pemutaran iklan.

Jalan: /avails/ads/icons/attributes/offset

String 00:00:05
program

Program atau inisiatif yang terkait dengan ikon, seperti "AdChoices”.

Jalan: /avails/ads/icons/attributes/program

String AdChoices
pxratio

Rasio piksel untuk ikon atau iklan pendamping, digunakan untuk tampilan DPI tinggi.

Jalur: /avails/ads/icons/attributes/pxratio atau /avails/ads/companionAds/attributes/pxratio

String 1 atau 2
type

Jenis sumber daya atau ekstensi.

Jalur: /avails/ads/extensions/type atau /avails/ads/adVerifications/executableResource/type

String text/javascript
content

Isi ekstensi.

Jalan: /avails/ads/extensions/content

String
language

Bahasa pemrograman dari sumber daya yang dapat dieksekusi.

Jalan: /avails/ads/adVerifications/executableResource/language

String javascript
browserOptional

Menunjukkan apakah dukungan browser diperlukan untuk JavaScript sumber daya.

Jalan: /avails/ads/adVerifications/javaScriptResource/browserOptional

String true atau false
id

Pengidentifikasi untuk berbagai elemen dalam skema.

Jalur: /avails/ads/companionAds/attributes/id atau /avails/ads/icons/iconClicks/iconClickTracking/id

String companion-1
assetHeight

Ketinggian aset iklan pendamping.

Jalan: /avails/ads/companionAds/attributes/assetHeight

String 250
assetWidth

Lebar aset iklan pendamping.

Jalan: /avails/ads/companionAds/attributes/assetWidth

String 300
expandedHeight

Ketinggian iklan pendamping saat diperluas.

Jalan: /avails/ads/companionAds/attributes/expandedHeight

String 600
expandedWidth

Lebar iklan pendamping saat diperluas.

Jalan: /avails/ads/companionAds/attributes/expandedWidth

String 600
renderingMode

Mode rendering untuk iklan pendamping.

Jalan: /avails/ads/companionAds/attributes/renderingMode

String default atau transparent
adSlotId

ID slot iklan tempat iklan pendamping harus ditampilkan.

Jalan: /avails/ads/companionAds/attributes/adSlotId

String banner-1
creativeType

Jenis MIME dari aset kreatif.

Jalan: /avails/ads/icons/staticResource/creativeType

String image/png