Channels: update

API ini kini mendukung kemampuan untuk menandai channel atau video Anda sebagai "Dibuat untuk Anak-Anak". Selain itu, resource channel dan video kini juga berisi properti yang mengidentifikasi status "Dibuat untuk Anak-Anak" dari channel atau video tersebut. Persyaratan Layanan dan Kebijakan Developer YouTube API juga diperbarui pada 10 Januari 2020. Untuk mengetahui informasi lebih lanjut, lihat histori revisi untuk Layanan Data API YouTube dan Persyaratan Layanan Layanan YouTube API.

Memperbarui metadata channel. Perhatikan bahwa metode ini saat ini hanya mendukung pembaruan untuk objek brandingSettings, invideoPromotion, dan localizations resource channel serta properti turunannya.

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

Kasus penggunaan umum

Permintaan

Permintaan HTTP

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

Otorisasi

Permintaan ini memerlukan otorisasi dengan setidaknya 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. API ini mengidentifikasi properti yang akan ditetapkan oleh operasi tulis serta properti yang akan disertakan dalam respons API.

Saat ini, API hanya mengizinkan nilai parameter untuk disetel ke brandingSettings, invideoPromotion, atau localizations. (Anda hanya dapat memperbarui salah satu bagian tersebut dengan satu permintaan.)

Perhatikan bahwa metode ini mengganti nilai yang ada untuk semua properti yang dapat diubah yang terdapat dalam bagian yang ditentukan nilai parameter.
Parameter opsional
onBehalfOfContentOwner string
Parameter ini hanya dapat digunakan dalam permintaan yang diizinkan dengan benar. Parameter onBehalfOfContentOwner menunjukkan bahwa pengguna yang diautentikasi bertindak atas nama pemilik konten yang ditentukan dalam nilai parameter. Parameter ini ditujukan untuk partner konten YouTube yang memiliki dan mengelola berbagai channel YouTube. Dengan kebijakan ini, pemilik konten dapat mengautentikasi sekali serta mendapatkan akses ke semua data video dan channel mereka, tanpa harus memberikan kredensial autentikasi untuk setiap channel. Akun CMS aktual yang diautentikasi pengguna harus ditautkan dengan pemilik konten YouTube yang ditentukan.

Isi permintaan

Berikan resource channel dalam isi permintaan. Untuk resource tersebut:

  • Anda harus menentukan nilai untuk properti ini:

    • id

  • Anda dapat menetapkan nilai untuk properti ini:

    • brandingSettings.channel.country
    • brandingSettings.channel.description
    • brandingSettings.channel.defaultLanguage
    • brandingSettings.channel.keywords
    • brandingSettings.channel.moderateComments
    • brandingSettings.channel.trackingAnalyticsAccountId
    • brandingSettings.channel.unsubscribedTrailer
    • localizations.(key)
    • localizations.(key).title
    • localizations.(key).description
    • status.selfDeclaredMadeForKids

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

Tanggapan

Jika berhasil, metode ini menampilkan resource saluran di 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
badRequest (400) brandingValidationError Salah satu nilai dalam objek brandingSettings gagal divalidasi. Gunakan metode channels.list untuk mengambil setelan yang ada untuk saluran, dan perbarui nilai properti dengan mengikuti panduan dalam dokumentasi resource channels.
badRequest (400) channelTitleUpdateForbidden Saat memperbarui brandingSettings part saluran, Anda harus menetapkan nilai properti brandingSettings.channel.title ke judul saluran saat ini atau menghapus properti. API akan menampilkan error jika Anda mengubah nilai properti.
badRequest (400) defaultLanguageNotSetError defaultLanguage harus disetel untuk mengupdate localizations.
badRequest (400) invalidBrandingOption Salah satu setelan branding yang Anda tentukan tidak ada. Gunakan metode channels.list untuk mengambil nilai yang valid dan pastikan untuk memperbaruinya sesuai dengan pedoman dalam dokumentasi resource channels.
badRequest (400) invalidCustomMessage Metadata permintaan menentukan pesan khusus yang tidak valid. Periksa nilai properti invideoPromotion.items[].customMessage di resource yang dikirim oleh permintaan.
badRequest (400) invalidDuration Metadata permintaan menentukan durasi yang tidak valid di bagian invideoPromotion.
badRequest (400) invalidDuration Metadata permintaan menentukan jenis posisi yang tidak valid untuk menentukan cara item yang dipromosikan diposisikan di pemutar video. Periksa nilai properti invideoPromotion.position.type di resource yang dikirim oleh permintaan.
badRequest (400) invalidRecentlyUploadedBy Metadata permintaan menetapkan ID saluran yang tidak valid. Periksa nilai properti invideoPromotion.items[].id.recentlyUploadedBy di resource yang dikirim oleh permintaan.
badRequest (400) invalidTimingOffset Metadata permintaan menentukan selisih waktu yang tidak valid di bagian invideoPromotion.
badRequest (400) invalidTimingOffset Metadata permintaan menentukan offset pengaturan waktu yang tidak valid untuk menentukan kapan item yang dipromosikan harus ditampilkan di pemutar video. Periksa nilai properti invideoPromotion.timing.offsetMs di resource yang dikirim oleh permintaan.
badRequest (400) invalidTimingType Metadata permintaan menentukan metode pengaturan waktu yang tidak valid untuk menentukan kapan item yang dipromosikan harus ditampilkan di pemutar video. Periksa nilai properti invideoPromotion.timing.type di resource yang dikirim oleh permintaan.
badRequest (400) localizationValidationError Salah satu nilai dalam objek pelokalan gagal divalidasi. Gunakan metode channels.list untuk mengambil nilai yang valid dan pastikan untuk memperbaruinya dengan mengikuti panduan di dokumentasi referensi saluran.
badRequest (400) tooManyPromotedItems Jumlah item yang dipromosikan yang diizinkan terlampaui di bagian invideoPromotion.
forbidden (403) channelForbidden Saluran yang ditentukan di parameter id tidak mendukung permintaan atau permintaan tidak diotorisasi dengan benar.
forbidden (403) promotedVideoNotAllowed Saluran yang dicoba diperbarui oleh permintaan API tidak dapat ditemukan. Periksa nilai properti id di resource channel yang dikirim permintaan untuk memastikan bahwa ID saluran sudah benar.
forbidden (403) websiteLinkNotAllowed URL situs yang ditentukan tidak diizinkan.
notFound (404) channelNotFound Saluran yang ditentukan dalam parameter id tidak dapat ditemukan.
notFound (404) channelNotFound Saluran yang ditentukan oleh parameter id tidak dapat ditemukan atau tidak memiliki opsi branding.
notFound (404) unknownChannelId ID channel yang ditentukan tidak ditemukan.
notFound (404) unknownChannelId ID channel yang baru saja diupload oleh Tidak ditemukan.
notFound (404) unknownVideoId ID video yang ditentukan sebagai item yang dipromosikan tidak dapat ditemukan.
required (400) requiredItemIdType Metadata permintaan harus menentukan jenis item di bagian invideoPromotion.
required (400) requiredItemId Metadata permintaan harus menentukan ID item di bagian invideoPromotion.
required (400) requiredTimingOffset Metadata permintaan harus menentukan selisih waktu default sehingga YouTube dapat menentukan kapan harus menampilkan item yang dipromosikan. Tetapkan nilai properti invideoPromotion.defaultTiming.offsetMs dalam resource yang dikirim permintaan.
required (400) requiredTimingOffset Metadata permintaan harus menentukan selisih waktu sehingga YouTube dapat menentukan kapan harus menampilkan item yang dipromosikan. Tetapkan nilai properti invideoPromotion.timing.offsetMs dalam resource yang dikirim permintaan.
required (400) requiredTimingType Metadata permintaan harus menentukan metode pengaturan waktu sehingga YouTube dapat menentukan kapan harus menampilkan item yang dipromosikan. Tetapkan nilai properti invideoPromotion.defaultTiming.type dalam resource yang dikirim permintaan.
required (400) requiredTimingType Metadata permintaan harus menentukan metode pengaturan waktu sehingga YouTube dapat menentukan kapan harus menampilkan item yang dipromosikan. Tetapkan nilai properti invideoPromotion.timing.type dalam resource yang dikirim permintaan.
required (400) requiredTiming Metadata permintaan harus menentukan pengaturan waktu untuk setiap item di bagian invideoPromotion.
required (400) requiredVideoId Metadata permintaan harus menentukan ID video untuk mengidentifikasi item yang dipromosikan.
required (400) requiredWebsiteUrl Metadata permintaan harus menentukan URL situs di bagian invideoPromotion. Tetapkan nilai properti invideoPromotion.items[].id.websiteUrl dalam resource yang dikirim permintaan.

Cobalah!

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