PlaylistItems: update

Mengubah item playlist. Misalnya, Anda dapat memperbarui posisi item dalam playlist.

Dampak kuota: Panggilan ke metode ini memiliki biaya kuota sebesar 50 unit.

Kasus penggunaan umum

Permintaan

Permintaan HTTP

PUT https://www.googleapis.com/youtube/v3/playlistItems

Otorisasi

Permintaan ini memerlukan otorisasi dengan setidaknya salah satu cakupan berikut (baca selengkapnya tentang autentikasi dan otorisasi).

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

Parameter

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

Parameter
Parameter yang diperlukan
part string
Parameter part memiliki dua tujuan dalam operasi ini. Parameter ini mengidentifikasi properti yang akan ditetapkan oleh operasi tulis serta properti yang akan disertakan dalam respons API.

Perhatikan bahwa metode ini akan mengganti nilai yang ada untuk semua properti yang dapat diubah yang terdapat di bagian mana pun yang ditentukan oleh nilai parameter. Misalnya, item playlist dapat menentukan waktu mulai dan waktu berakhir, yang mengidentifikasi bagian waktu video yang akan diputar saat pengguna menonton video dalam playlist. Jika permintaan Anda memperbarui item playlist yang menetapkan nilai ini, dan nilai parameter part permintaan menyertakan bagian contentDetails, waktu mulai dan berakhir item playlist akan diperbarui ke nilai apa pun yang ditentukan oleh isi permintaan. Jika isi permintaan tidak menentukan nilai, waktu mulai dan berakhir yang ada akan dihapus dan diganti dengan setelan default.

Daftar berikut berisi nama part yang dapat Anda sertakan dalam nilai parameter:
  • contentDetails
  • id
  • snippet
  • status
Parameter opsional
onBehalfOfContentOwner string
Catatan: Parameter onBehalfOfContentOwner ditujukan secara eksklusif untuk partner konten YouTube dan hanya dapat digunakan dalam permintaan yang diotorisasi dengan benar.

Parameter ini dirancang untuk partner konten YouTube yang memiliki dan mengelola banyak channel YouTube yang berbeda. Parameter ini memungkinkan pengguna yang berafiliasi dengan pemilik konten melakukan autentikasi satu kali, lalu dapat mengakses dan mengelola semua data video dan channel pemilik konten, tanpa harus memberikan kredensial autentikasi untuk setiap channel.

Jika parameter ada, nilainya akan mengidentifikasi pemilik konten, dan kredensial otorisasi permintaan akan mengidentifikasi pengguna YouTube yang diizinkan untuk bertindak atas nama pemilik konten tersebut. Akun yang digunakan pengguna untuk melakukan autentikasi harus ditautkan ke pemilik konten yang ditentukan di setelan YouTube Creator Studio.

Isi permintaan

Berikan resource playlistItem dalam isi permintaan. Untuk resource tersebut:

  • Anda harus menentukan nilai untuk properti ini:

    • id
    • snippet.playlistId
    • snippet.resourceId

  • Anda dapat menetapkan nilai untuk properti ini:

    • snippet.position
    • contentDetails.note
    • contentDetails.startAt
    • contentDetails.endAt

    Jika Anda mengirimkan permintaan pembaruan, dan permintaan Anda tidak menentukan nilai untuk properti yang sudah memiliki nilai, nilai properti yang ada akan dihapus.

Respons

Jika berhasil, metode ini akan menampilkan resource playlistItem dalam isi respons.

Error

Tabel berikut mengidentifikasi pesan error yang dapat ditampilkan API sebagai respons terhadap panggilan ke metode ini. Lihat dokumentasi pesan error untuk mengetahui detail selengkapnya.

Jenis error Detail error Deskripsi
forbidden (403) playlistItemsNotAccessible Permintaan tidak diotorisasi dengan benar untuk memperbarui item playlist yang ditentukan.
invalidValue (400) invalidPlaylistItemPosition Permintaan mencoba menetapkan posisi item playlist ke nilai yang tidak valid atau tidak didukung. Periksa nilai properti position di snippet resource.
invalidValue (400) invalidResourceType type yang ditentukan untuk ID resource tidak didukung untuk operasi ini. ID resource mengidentifikasi item yang ditambahkan ke playlist, misalnya youtube#video.
invalidValue (400) invalidSnippet Permintaan tidak menentukan properti snippet yang valid.
invalidValue (400) manualSortRequired Permintaan mencoba menetapkan posisi item playlist, tetapi playlist tidak menggunakan pengurutan manual. (Misalnya, item playlist dapat diurutkan berdasarkan tanggal atau popularitas.) Anda dapat mengatasi error ini dengan menghapus elemen snippet.position dari resource yang disisipkan oleh permintaan. Jika Anda ingin item playlist memiliki posisi tertentu dalam daftar, Anda harus memperbarui opsi Pengurutan playlist ke Manual di setelan playlist terlebih dahulu. Setelan ini dapat disesuaikan di Pengelola Video YouTube.
notFound (404) playlistItemNotFound Item playlist yang diidentifikasi dengan properti id permintaan tidak dapat ditemukan.
notFound (404) playlistNotFound Playlist yang diidentifikasi dengan parameter playlistId permintaan tidak dapat ditemukan.
required (400) channelIdRequired Permintaan tidak menentukan nilai untuk properti channelId yang diperlukan.
required (400) playlistIdRequired Permintaan tidak menentukan nilai untuk properti playlistId yang diperlukan.
required (400) playlistItemIdRequired Resource item playlist yang ditentukan dalam permintaan harus menggunakan properti id untuk mengidentifikasi item playlist yang sedang diperbarui.
invalidValue (400) playlistOperationUnsupported API tidak mendukung kemampuan untuk memperbarui video dalam playlist yang ditentukan. Misalnya, Anda tidak dapat memperbarui video di playlist video yang diupload.

Cobalah!

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