REST Resource: adBreak.networks.assets.adBreaks

Resource: AdBreak

Metadata jeda iklan yang digunakan untuk memutuskan iklan untuk jeda iklan dalam acara video live.

Representasi JSON 
{
  "name": string,
  "createTime": string,
  "expectedDuration": string,
  "customParams": string,
  "scte35CueOut": string,
  "podTemplateName": string,
  "breakState": enum (BreakState),
  "expectedStartTime": string,
  "expireDuration": string,
  "breakSequence": string,
  "breakParams": {
    object (BreakParams)
  },
  "matchParams": {
    object (MatchParams)
  },
  "servedBreak": {
    object (ServedBreak)
  }
}
Kolom
name

string

Hanya output. Nama resource Jeda Iklan. Kolom ini akan memiliki format "networks//assets//adBreaks/".

network_code adalah kode jaringan di Google Ad Manager yang memiliki konten ini.

asset_key adalah kunci Acara Live Stream di Google Ad Manager yang digunakan untuk membuat Jeda Iklan.

adBreakId adalah kunci Jeda Iklan. HANYA OUTPUT.
createTime

string (Timestamp format)

Hanya output. Waktu pembuatan Jeda Iklan.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
expectedDuration

string (Duration format)

Wajib. Perkiraan durasi istirahat.

Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's'. Contoh: "3.5s".
customParams
(deprecated)

string

Opsional. Pasangan nilai kunci yang akan disertakan dalam permintaan iklan untuk jeda ini bagi penargetan kriteria kustom di Ad Manager. Contoh: 'key1=value&key2=value2,value22' Tidak digunakan lagi: Tetapkan cust_params di breakParams.ad_tag_params menggunakan kunci "cust_params".
scte35CueOut

string

Opsional. Data berenkode Base 64 dari cue out scte35. Dapat menyertakan perintah splice_insert() atau time_signal(). Contoh: - dengan time_signal(): “/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==” - dengan splice_insert(): "/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo="
podTemplateName
(deprecated)

string

Opsional. Nama template pod Google Ad Manager. Tidak digunakan lagi: Tetapkan cust_params di breakParams.ad_tag_params menggunakan kunci "ptpln".
breakState

enum (BreakState)

Hanya output. Status Jeda Iklan saat ini.
expectedStartTime

string (Timestamp format)

Opsional. Perkiraan waktu mulai Jeda Iklan.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
expireDuration

string (Duration format)

Opsional. Mengakhiri Jeda Iklan pada expectedStartTime + expireDuration. Jika expectedStartTime tidak disetel, Jeda Iklan akan berakhir expireDuration setelah pengambilan keputusan dimulai. Default: 30 menit Minimum: 5 menit Maksimum: 6 jam

Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's'. Contoh: "3.5s".
breakSequence

string (int64 format)

Hanya output. ID urutan mid-roll Jeda Iklan. Beberapa jeda iklan dapat memiliki breakSequence yang sama jika ditentukan secara eksplisit melalui breakParams.ad_tag_params dengan kunci mridx. Hal ini secara efektif menautkan dua jeda iklan GAM.
breakParams

object (BreakParams)

Opsional. Parameter jeda yang akan disertakan dalam permintaan iklan untuk jeda ini.
matchParams

object (MatchParams)

Opsional. Digunakan untuk DAI yang Digabungkan untuk menentukan cara Jeda Iklan yang dibuat melalui API dicocokkan dengan jeda iklan dalam manifes. Saat jeda baru terdeteksi, fungsi pencocokan akan dijalankan terhadap semua jeda iklan dari peristiwa yang memiliki breakState SCHEDULED atau DECISIONED untuk memeriksa apakah semua parameter yang ditetapkan di matchParams Jeda Iklan cocok dengan jeda yang terdeteksi. Kecocokan terjadi jika salah satu kondisi berikut terpenuhi: 1. Istirahat Iklan memiliki kolom matchParams, dan semua parameter yang ditetapkan di dalamnya cocok dengan jeda baru. 2. Jeda Iklan adalah DECISIONED dan tidak memiliki kolom matchParams.

Untuk mencegah perilaku "mencocokkan semua" yang tidak disengaja (yang akan terjadi dengan matchParams yang kosong tetapi ada), matchParams tidak boleh kosong jika disetel. Jika kolom ada dalam permintaan, setidaknya salah satu kolomnya sendiri harus ditetapkan.

Jeda Iklan diperiksa dalam urutan ini: 1. dengan matchParams, diurutkan berdasarkan expectedStartTime menaik, createTime menaik, dengan Jeda Iklan tanpa expectedStartTime diprioritaskan saat diurutkan 2. tanpa matchParams, diurutkan berdasarkan expectedStartTime menaik, createTime menaik, dengan Jeda Iklan tanpa expectedStartTime diprioritaskan saat diurutkan

Jika semua EABN yang tertunda tidak cocok, DAI akan kembali ke perilaku pengambilan keputusan JIT menggunakan indeks midroll berikutnya yang tersedia
servedBreak

object (ServedBreak)

Hanya output. Hal ini mencerminkan informasi sebenarnya dari jeda iklan yang ditayangkan. Hanya ditetapkan untuk jeda iklan dengan COMPLETE breakState.

BreakState

Status Jeda Iklan.

Enum
BREAK_STATE_UNSPECIFIED Status Jeda Iklan tidak diketahui.
BREAK_STATE_DECISIONED Pengambilan keputusan jeda iklan dimulai, tetapi belum ditayangkan kepada pengguna.
BREAK_STATE_COMPLETE Istirahat Iklan ditayangkan kepada pengguna.
BREAK_STATE_SCHEDULED Jeda Iklan dijadwalkan untuk pengambilan keputusan.
BREAK_STATE_EXPIRED Jeda Iklan telah kedaluwarsa dan tidak dapat digunakan. Secara default, Jeda Iklan akan berakhir 30 menit setelah expectedStartTime, atau 30 menit setelah keputusan memulai Jeda Iklan jika expectedStartTime tidak ditetapkan. Masa berlaku dapat ditetapkan secara eksplisit menggunakan kolom expireDuration.

BreakParams

Parameter yang terkait dengan jeda iklan.

Representasi JSON 
{
  "macros": [
    {
      object (KeyValue)
    }
  ],
  "adTagParams": [
    {
      object (KeyValue)
    }
  ]
}
Kolom
macros[]

object (KeyValue)

Opsional. Nilai makro kustom yang menggantikan placeholder arbitrer dalam tag iklan. Pada waktu permintaan iklan, DAI akan memperluas makro tag iklan dalam bentuk %%DAI_PATTERN:[MACRO_KEY]%%, dengan MACRO_KEY adalah kuncinya.

Jika ditetapkan, makro ini akan lebih diutamakan daripada makro yang ditetapkan pada permintaan Penayangan Pod.
adTagParams[]

object (KeyValue)

Opsional. Mengganti parameter tag iklan pada permintaan iklan utama.

Ini digunakan untuk pengambilan keputusan jika dipicu sebelum permintaan Penayangan Pod dengan setelan cust_params.

Umumnya, parameter menggantikan parameter string kueri pada permintaan iklan utama untuk jeda. Untuk beberapa server iklan dengan format URL kustom, parameter dapat menggantikan tempat tertentu dalam tag iklan agar sesuai dengan persyaratan server iklan. Menetapkan nilai "mridx" pada AdBreak akan menggantikan kolom breakSequence dengan nilai yang diberikan, jika berupa bilangan bulat positif yang valid. Hal ini berlaku bahkan untuk server iklan non-GAM.

Jika disetel, parameter ini akan diprioritaskan daripada parameter yang disetel pada permintaan Penayangan Pod.

KeyValue

Mewakili pasangan nilai kunci.

Representasi JSON 
{
  "key": string,
  "value": string
}
Kolom
key

string

Wajib. Kunci dari pasangan nilai kunci ini.
value

string

Wajib. Nilai pasangan nilai kunci ini.

MatchParams

Parameter untuk mencocokkan dengan jeda iklan DAI yang digabungkan yang terdeteksi.

Representasi JSON 
{
  "scte35Binary": string,
  "scte35Upid": string,
  "scte35EventId": integer,
  "breakDuration": boolean
}
Kolom
scte35Binary

string

Opsional. Biner SCTE-35. Agar cocok dengan kolom ini, jeda iklan dalam manifes harus memiliki string biner SCTE-35 yang sama (dienkode base64). Jika kosong, kolom ini akan dilewati.
scte35Upid

string

Opsional. UPID (ID Program Unik) SCTE-35. Agar cocok dengan kolom ini, jeda iklan dalam manifes harus memiliki UPID SCTE-35 yang sama. UPID adalah nilai yang diuraikan dari biner SCTE-35. Jika kosong, kolom ini akan dilewati.
scte35EventId

integer (uint32 format)

Opsional. ID peristiwa SCTE-35. Agar cocok dengan kolom ini, jeda iklan dalam manifes harus memiliki ID peristiwa yang sama (ID peristiwa penggabungan/ID peristiwa segmentasi). ID peristiwa adalah nilai yang diuraikan dari biner SCTE-35. Jika kosong, kolom ini akan dilewati.
breakDuration

boolean

Opsional. Durasi jeda. Agar cocok dengan kolom ini, jeda iklan dalam manifes harus memiliki durasi jeda yang sama dengan expectedDuration Jeda Iklan, dengan toleransi 1 md. Jika salah (false), hal ini akan dilewati.

ServedBreak

Menampilkan informasi sebenarnya dari Jeda Iklan yang ditayangkan.

Representasi JSON 
{
  "breakDetectTime": string,
  "detectedDuration": string,
  "scte35CueOut": string
}
Kolom
breakDetectTime

string (Timestamp format)

Hanya output. Waktu jeda iklan yang cocok terdeteksi. Untuk Penayangan Pod, ini adalah waktu saat segmen/manifes pertama pod iklan diminta. Untuk DAI yang Digabungkan, ini adalah saat jeda iklan pertama kali terdeteksi di manifes.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
detectedDuration

string (Duration format)

Hanya output. Durasi yang terdeteksi diteruskan pada jeda iklan yang cocok.

Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's'. Contoh: "3.5s".
scte35CueOut

string

Hanya output. Pesan SCTE-35 berenkode base64 yang terdeteksi diteruskan ke jeda iklan yang cocok.

Metode

create

 API untuk membuat Jeda Iklan dalam live stream.

delete

 API untuk menghapus Jeda Iklan dalam live stream.

get

 API untuk mendapatkan Jeda Iklan dalam live stream.

list

 API untuk mencantumkan Jeda Iklan dalam live stream.

patch

 API untuk memperbarui Jeda Iklan dalam live stream.