Layanan YouTube API - Fungsi Minimum yang Diperlukan

Catatan: Mematuhi Kebijakan Developer YouTube memberikan panduan dan contoh untuk membantu Anda memastikan bahwa klien API Anda mengikuti bagian tertentu Persyaratan dan Kebijakan Layanan YouTube API (TOS API). Panduan ini menawarkan insight tentang cara YouTube menerapkan aspek-aspek tertentu dari TOS API, tetapi tidak menggantikan dokumen yang sudah ada.

Dokumen ini menentukan persyaratan fungsional minimum untuk klien API yang mengimplementasikan atau memberikan akses ke fitur tertentu dari layanan YouTube API ("Klien API").

Persyaratan dan pedoman ini memastikan bahwa klien API memberikan pengalaman pengguna yang konsisten dan melindungi kepentingan pengguna, pemilik konten, dan pengiklan YouTube. Aturan ini merupakan bagian integral dari Persyaratan Layanan YouTube API dan harus diikuti dalam pengembangan dan implementasi Klien API.

Persyaratan dalam dokumen ini akan berubah sehingga kami dapat memastikan pengalaman pengguna yang lebih baik dengan fitur YouTube yang ada. Setelan ini juga akan berubah sebagai respons terhadap fitur YouTube baru dan yang diupdate. Terkadang, perubahan tersebut mungkin mengharuskan Anda memperbarui Klien API Anda untuk memenuhi persyaratan baru. Histori revisi Persyaratan Layanan akan mendokumentasikan perubahan apa pun, jadi periksa dokumen tersebut secara berkala, atau berlangganan feed RSS, untuk memastikan bahwa Anda dapat dengan cepat mempelajari perubahan yang dapat memengaruhi Klien API Anda.

Selain persyaratan dalam dokumen ini, sebaiknya Anda mengikuti praktik terbaik yang dijelaskan dalam Kebijakan Layanan YouTube API dan dibahas di bagian lain dalam dokumentasi layanan YouTube API. Meskipun tidak diwajibkan, praktik ini membantu Klien API Anda memulihkan lebih cepat dari error dan mengoptimalkan penggunaan kuota jika mereka menggunakan layanan YouTube API yang mengalokasikan kuota. Pada saat yang sama, praktik ini membantu memastikan kesehatan ekosistem YouTube dan, terutama, memberikan pengalaman terbaik kepada pengguna Klien API dan Aplikasi YouTube.

Pemutar dan pemutaran video tersemat YouTube

Persyaratan di bagian ini berkaitan secara khusus dengan pemutar YouTube tersemat. Kebijakan Layanan YouTube API juga menyertakan beberapa kebijakan yang relevan dengan Klien API yang memutar konten audiovisual YouTube.

Ukuran Pemutar YouTube Tersemat

Pemutar tersemat harus memiliki area pandang yang berukuran minimal 200 x 200 piksel. Jika pemutar menampilkan kontrol, maka harus cukup besar untuk menampilkan kontrol sepenuhnya tanpa mengecilkan area pandang di bawah ukuran minimum. Sebaiknya pemutar video berukuran 16:9 berukuran minimal lebar 480 piksel dan tinggi minimal 270 piksel.

Pemutaran putar otomatis dan dengan skrip

Bagian ini membahas pemutaran otomatis. Hal ini berlaku untuk pemutar sematan YouTube yang menggunakan parameter pemutar autoplay atau memulai pemutaran otomatis secara terprogram menggunakan layanan YouTube IFrame Player API, layanan YouTube Android Player API, atau layanan YouTube API lainnya.

  • Pemutar tersemat yang otomatis memutar video harus segera memulai pemutaran saat halaman dimuat atau segera setelah pemutar tersemat terlihat sepenuhnya. Namun, Klien API tidak boleh memulai pemutaran otomatis hingga pemutar terlihat dan lebih dari separuh pemutar terlihat di halaman atau layar.

  • Halaman atau layar tidak boleh memiliki lebih dari satu pemutar YouTube yang otomatis memutar konten secara bersamaan.

  • Thumbnail YouTube apa pun yang memulai pemutaran harus berukuran setidaknya 120x70 piksel.

Atribut Pemutar YouTube

Atribut dan parameter pemutar YouTube – termasuk, misalnya, tampilan branding YouTube pada pemutar – ditentukan dalam dokumentasi dan spesifikasi YouTube API (https://developers.google.com/youtube). Anda tidak boleh melakukan perubahan pada pemutar YouTube yang tidak dijelaskan secara eksplisit dalam dokumentasi API.

Overlay dan bingkai

Anda tidak boleh menampilkan overlay, bingkai, atau elemen visual lainnya di depan bagian mana pun dari pemutar sematan YouTube, termasuk kontrol pemutar. Demikian juga, Anda tidak boleh menggunakan overlay, bingkai, atau elemen visual lainnya untuk mengaburkan bagian mana pun dari pemutar yang disematkan, termasuk kontrol pemutar.

Arahan kursor

Anda tidak boleh menggunakan pengarahan mouse atau peristiwa sentuh pada pemutar YouTube untuk memulai tindakan apa pun atas nama pengguna, seperti membuka jendela atau berlangganan saluran.

Mengupload video

Jika Klien API mengizinkan pengguna untuk mengupload konten ke beberapa platform, pengguna harus dapat memilih dan membatalkan pilihan platform tempat mereka ingin mengupload video.

Persyaratan data

Klien API yang memungkinkan pengguna mengupload video ke YouTube harus mengaktifkan pengguna untuk menetapkan nilai dalam daftar berikut. Setiap properti yang tidak tercantum bersifat opsional.

  Nama Deskripsi
Properti resource
snippet.title Wajib diisi. Judul video. YouTube akan menampilkan error jika nilai melebihi 100 karakter. YouTube mendukung semua karakter UTF-8 yang valid kecuali < dan >.

snippet.description Wajib diisi. Deskripsi video. YouTube akan menampilkan error jika nilainya melebihi 5.000 byte. YouTube mendukung semua karakter UTF-8 yang valid kecuali < dan >.
status.privacyStatus Wajib diisi. Setelan privasi video. Pengguna harus dapat memilih apakah video yang diupload akan bersifat publik, pribadi, atau tidak publik.
Parameter permintaan
onBehalfOfContentOwnerChannel Wajib bersyarat. Jika kredensial otorisasi permintaan mengidentifikasi pemilik konten dan parameter onBehalfOfContentOwner disetel, pengguna API juga harus dapat menentukan channel YouTube tempat video diupload.

Menampilkan komentar

  Nama Deskripsi
Properti resource
snippet.textDisplay Wajib diisi. Teks komentar. Klien API harus (a) menampilkan teks lengkap balasan komentar atau komentar, atau (b) memotong teks dan menyediakan cara bagi pelihat untuk dengan mudah mengakses teks lengkap dari versi yang terpotong.

Persyaratan ini berlaku untuk semua komentar dan balasan komentar, terlepas dari jenis resource yang terkait dengan komentar tersebut (video, saluran, dll.).

Perhatikan bahwa daftar properti snippet.topLevelComment resource commentThread adalah resource comment dan resource replies.comments[].comment Oleh karena itu, persyaratan ini juga berlaku untuk properti snippet.topLevelComment.snippet.textDisplay dan replies.comments[].snippet.textDisplay.
snippet.title
(channel)
Wajib (saran). Judul saluran.
  • Jika komentar tersebut berkaitan dengan channel, klien API harus menampilkan nama channel.
  • Jika komentar tersebut berkaitan dengan video, klien API harus menampilkan nama channel yang mengupload video tersebut.
snippet.title
(video)
Wajib bersyarat (saran). Judul video. Nilai ini harus ditampilkan jika komentar berkaitan dengan video.
snippet.moderationStatus Wajib bersyarat. Jika nilai parameter moderationStatus dalam permintaan API adalah heldForReview atau likelySpam, tampilan harus secara jelas mengidentifikasi status tersebut menggunakan nilai properti, kata-kata yang mirip (mis. "Komentar ini ditahan untuk ditinjau"), header (misalnya "Ditahan untuk ditinjau"), atau kata-kata yang tidak ambigu lainnya. Metode commentThreads.list mendukung kemampuan untuk mengambil komentar berdasarkan status moderasinya.

Menambahkan komentar

  Nama Deskripsi
Properti resource
snippet.title
(channel)
Wajib diisi. Judul saluran.
  • Jika pengguna menambahkan komentar tentang saluran, klien API harus menampilkan nama saluran.
  • Jika pengguna menambahkan komentar tentang video, klien API harus menampilkan nama channel yang mengupload video tersebut.
snippet.title
(video)
Wajib diisi. Jika pengguna menambahkan komentar tentang video, klien API harus menampilkan judul video.
Persyaratan lainnya
Comment author's channel name Wajib diisi. Klien API harus mengidentifikasi dengan jelas akun pengguna YouTube yang akan memberikan atribut komentar. Jika kredensial otorisasi permintaan mengidentifikasi pemilik konten dan parameter onBehalfOfContentOwner disetel, pengguna API juga harus dapat menentukan channel YouTube tempat komentar akan diatribusikan.

Menambahkan balasan komentar

  Nama Deskripsi
Properti resource
snippet.textDisplay Wajib diisi. Teks komentar. Klien API harus menampilkan teks komentar yang dibalas pengguna sesuai dengan aturan yang ditetapkan di bagian Menampilkan komentar dokumen ini.
snippet.title
(channel)
Wajib diisi. Judul saluran.
  • Jika pengguna membalas komentar tentang saluran, klien API harus menampilkan nama saluran.
  • Jika pengguna membalas komentar tentang video, klien API harus menampilkan nama channel yang mengupload video tersebut.
snippet.title
(video)
Wajib diisi. Jika pengguna membalas komentar tentang video, klien API harus menampilkan judul video.
Persyaratan lainnya
Comment author's channel name Wajib diisi. Klien API harus mengidentifikasi dengan jelas akun pengguna YouTube yang akan menerima atribusi balasan komentar. Jika kredensial otorisasi permintaan mengidentifikasi pemilik konten dan parameter onBehalfOfContentOwner disetel, pengguna API juga harus dapat menentukan channel YouTube yang akan menerima atribusi balasan komentar.

Mengedit atau menghapus balasan komentar

  Nama Deskripsi
Properti resource
snippet.textDisplay Wajib diisi. Teks komentar. Klien API harus menampilkan teks komentar yang sedang diedit atau dihapus pengguna sesuai dengan aturan yang ditetapkan di bagian Menampilkan komentar dalam dokumen ini.
snippet.title
(channel)
Wajib diisi. Judul saluran.
  • Jika pengguna mengedit atau menghapus komentar tentang saluran, klien API harus menampilkan nama saluran.
  • Jika pengguna mengedit atau menghapus komentar tentang video, klien API harus menampilkan nama channel yang mengupload video tersebut.
snippet.title
(video)
Wajib diisi. Jika pengguna mengedit atau menghapus komentar tentang video, klien API harus menampilkan judul video.
Persyaratan lainnya
Comment author's channel name Wajib diisi. Klien API harus mengidentifikasi dengan jelas akun pengguna YouTube yang terkait dengan komentar.

Memblokir pengguna dari live chat (atau menghapus pemblokiran)

  Nama Deskripsi
Properti resource
snippet.title
(channel)
Wajib diisi. Nama channel YouTube yang diblokir atau dibatalkan pemblokirannya. Selain itu, nama harus tertaut ke channel atau URL channel juga harus ditampilkan.
Persyaratan lainnya
Nama channel penulis komentar Wajib diisi. Klien API harus mengidentifikasi dengan jelas akun pengguna YouTube yang digunakan untuk menambahkan atau menghapus pemblokiran.