LiveBroadcasts: cuepoint

Menyisipkan titik tanda ke dalam live streaming. Titik tanda mungkin memicu jeda iklan.

Catatan: Metode ini menggantikan metode liveCuepoints.insert, yang mewajibkan permintaan untuk diotorisasi oleh akun yang terkait dengan Pemilik Konten YouTube. Metode ini tidak memiliki persyaratan otorisasi yang sama.

Permintaan

Permintaan HTTP

POST https://www.googleapis.com/youtube/v3/liveBroadcasts/cuepoint

Otorisasi

Permintaan ini memerlukan otorisasi dengan setidaknya salah satu cakupan berikut. Untuk membaca selengkapnya tentang autentikasi dan otorisasi, lihat Menerapkan autentikasi OAuth 2.0.

Cakupan
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtubepartner

Parameter

Tabel berikut mencantumkan parameter yang didukung kueri ini. Semua parameter yang tercantum adalah parameter kueri.

Parameter
Parameter yang diperlukan
id string
Parameter id mengidentifikasi siaran tempat titik tanda disisipkan. Siaran harus aktif di-streaming saat menyisipkan titik tanda.
Parameter opsional
onBehalfOfContentOwner string
Parameter ini hanya dapat digunakan dalam permintaan yang diotorisasi dengan benar.
Catatan: Parameter ini ditujukan secara eksklusif untuk partner konten YouTube yang memiliki dan mengelola banyak channel YouTube yang berbeda. Hal ini memungkinkan pemilik konten melakukan autentikasi satu kali dan melakukan tindakan atas nama saluran yang ditentukan dalam nilai parameter, tanpa harus memberikan kredensial autentikasi yang berbeda untuk setiap saluran terpisah. Akun yang digunakan pengguna untuk melakukan autentikasi harus ditautkan ke pemilik konten YouTube yang ditentukan.
Parameter onBehalfOfContentOwner menunjukkan bahwa kredensial otorisasi permintaan tersebut mengidentifikasi pengguna YouTube yang bertindak atas nama Pemilik Konten YouTube yang ditentukan dalam nilai parameter. Parameter ini ditujukan untuk partner konten YouTube yang memiliki dan mengelola banyak channel YouTube yang berbeda.
onBehalfOfContentOwnerChannel string
Parameter ini hanya dapat digunakan dalam permintaan yang diotorisasi dengan benar.
Catatan: Parameter ini ditujukan secara eksklusif untuk partner konten YouTube yang memiliki dan mengelola banyak channel YouTube yang berbeda. Hal ini memungkinkan pemilik konten melakukan autentikasi satu kali dan melakukan tindakan atas nama saluran yang ditentukan dalam nilai parameter, tanpa harus memberikan kredensial autentikasi untuk setiap saluran terpisah.
Parameter onBehalfOfContentOwnerChannel menentukan ID channel YouTube channel yang terkait dengan siaran tempat titik tanda disisipkan. Parameter ini diperlukan saat permintaan menentukan nilai untuk parameter onBehalfOfContentOwner, dan hanya dapat digunakan bersama dengan parameter tersebut. Persyaratan berikut juga berlaku:
  • Permintaan harus diotorisasi dengan akun pengguna yang ditautkan ke pemilik konten yang ditentukan oleh parameter onBehalfOfContentOwner.
  • Channel yang ditentukan oleh nilai parameter onBehalfOfContentOwnerChannel harus ditautkan ke pemilik konten yang ditentukan oleh parameter onBehalfOfContentOwner.

Isi permintaan

Berikan resource cuepoint dalam isi permintaan. Struktur JSON berikut menunjukkan format resource cuepoint:

{
    "id": string,
    "insertionOffsetTimeMs": long,
    "walltimeMs": datetime,
    "durationSecs": unsigned integer,
    "cueType": string
  }
 Dalam isi permintaan, kolom cueType wajib diisi dan harus ditetapkan ke cueTypeAd. Anda juga dapat menetapkan nilai untuk properti ini:
  • durationSecs
  • insertionOffsetTimeMs (tidak boleh ditetapkan jika walltimeMs ditetapkan)
  • walltimeMs (tidak boleh ditetapkan jika insertionOffsetTimeMs ditetapkan)

Properti

Tabel berikut menentukan properti yang muncul dalam resource ini:

Properti
id string
Nilai yang ditetapkan YouTube untuk mengidentifikasi titik tanda secara unik. Perhatikan bahwa nilai ini berbeda dengan parameter id yang diperlukan, yang mengidentifikasi siaran. Nilai ini dapat dihilangkan saat mengirim permintaan untuk menyisipkan titik tanda. Nilai akan diisi dalam respons API.
insertionOffsetTimeMs long
Nilai properti mengidentifikasi offset waktu, dalam milidetik, saat titik tanda harus disisipkan. Nilai diukur dari awal aliran monitor, dan nilai defaultnya adalah 0, yang menunjukkan bahwa titik tanda harus disisipkan sesegera mungkin. Anda tidak boleh menentukan nilai untuk parameter ini jika siaran Anda tidak memiliki streaming monitor.

Meskipun diukur dalam milidetik, nilai ini sebenarnya merupakan perkiraan, dan YouTube akan menyisipkan titik tanda sebisa mungkin mendekati waktu tersebut.

Nilai non-nol untuk kolom ini hanya didukung jika streaming siaran tertunda. Jika streaming siaran Anda tidak tertunda, 0 adalah satu-satunya nilai yang valid. Untuk mengetahui detail selengkapnya, lihat Memulai.

Catatan: Jika siaran Anda memiliki fase pengujian, offset diukur dari waktu dimulainya fase pengujian.

API akan menampilkan error jika permintaan mencoba menyisipkan titik tanda yang menentukan nilai untuk properti ini dan untuk properti walltimeMs.
walltimeMs integer
Nilai properti menentukan waktu jam dinding saat titik tanda harus disisipkan. Nilainya adalah bilangan bulat yang mewakili stempel waktu epoch (dalam milidetik).

API akan menampilkan error jika permintaan mencoba menyisipkan titik tanda yang menentukan nilai untuk properti ini dan untuk properti insertionOffsetTimeMs.
durationSecs unsigned integer
Durasi titik tanda, dalam detik. Nilai harus berupa bilangan bulat positif. Nilai defaultnya adalah 30.
cueType string
Jenis titik tanda. Nilai properti harus ditetapkan ke cueTypeAd.

Respons

Jika berhasil, metode ini akan menampilkan resource cuepoint yang disisipkan dalam isi respons.

Error

Tabel berikut mengidentifikasi pesan error yang dapat ditampilkan API sebagai respons terhadap panggilan ke metode ini. Untuk mengetahui detail selengkapnya, lihat YouTube Live Streaming API - Error.

Jenis error Detail error Deskripsi
insufficientPermissions (403) insufficientLivePermissions Permintaan tidak diberi otorisasi untuk menyisipkan titik tanda dalam siaran langsung.
insufficientPermissions (403) liveStreamingNotEnabled Pengguna yang mengizinkan permintaan tidak diizinkan untuk melakukan live stream video di YouTube. Pengguna dapat menemukan informasi selengkapnya di Memulai live streaming dan Kelayakan fitur.
rateLimitExceeded (403) userRequestsExceedRateLimit Pengguna telah mengirim terlalu banyak permintaan dalam jangka waktu tertentu.
required (400) idRequired Parameter id yang diperlukan harus mengidentifikasi siaran tempat Anda ingin menyisipkan titik tanda.
required (400) cueTypeRequired Kolom cueType yang diperlukan harus ditentukan dalam isi permintaan API.
notFound (404) liveBroadcastNotFound Siaran yang ditentukan oleh parameter id tidak ada.
invalidValue (400) conflictingTimeFields Hanya salah satu dari insertionOffsetTimeMs dan walltimeMs yang dapat ditentukan. Menetapkan kedua nilai akan menyebabkan error. Jika Anda tidak menetapkan salah satu nilai, YouTube akan menggunakan waktu insertionOffsetTimeMs default (0), yang berarti titik tanda akan disisipkan sesegera mungkin.
invalidValue (400) invalidInsertionOffsetTimeMs Resource cuepoint menentukan nilai yang tidak valid untuk properti insertionOffsetTimeMs. Nilainya harus berupa 0 atau bilangan bulat positif.
invalidValue (400) invalidWalltimeMs Resource cuepoint menentukan nilai yang tidak valid untuk properti walltimeMs. Nilainya harus berupa bilangan bulat yang mewakili stempel waktu epoch (dalam milidetik).
backendError (5xx) serviceUnavailable Layanan tidak tersedia. Coba lagi permintaan Anda setelah beberapa menit.

Cobalah!

Gunakan APIs Explorer untuk memanggil API ini dan melihat permintaan serta respons API.