ChannelSections: update

بخش کانال را به‌روز می‌کند.

تأثیر سهمیه: فراخوانی این روش هزینه سهمیه ۵۰ واحدی دارد.

موارد استفاده رایج

درخواست

درخواست HTTP

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

صدور مجوز

این درخواست به مجوز با حداقل یکی از دامنه‌های زیر نیاز دارد (درباره اصالت‌سنجی و مجوز بیشتر بخوانید).

حوزه
https://www.googleapis.com/auth/youtubepartner
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

پارامترها

جدول زیر پارامترهایی را که این پُرسمان پشتیبانی می‌کند فهرست می‌کند. همه پارامترهای فهرست‌شده پارامترهای پُرسمان هستند.

پارامترها
پارامترهای الزامی
part string
پارامتر part در این عملیات دو هدف دارد. این پارامتر ویژگی‌هایی را که عملیات نوشتن تنظیم می‌کند و همچنین ویژگی‌هایی را که پاسخ میانای برنامه‌سازی کاربردی دربرخواهد داشت شناسایی می‌کند.

فهرست زیر حاوی نام‌های part است که می‌توانید در مقدار پارامتر بگنجانید:
  • contentDetails
  • id
  • snippet
پارامترهای اختیاری
onBehalfOfContentOwner string
این پارامتر فقط در درخواست‌های مجاز قابل‌استفاده است. توجه: این پارامتر منحصراً برای شرکای محتوای YouTube درنظر گرفته شده است.

پارامتر onBehalfOfContentOwner نشان می‌دهد که اطلاعات کاربری مجوز درخواست، کاربر CMS YouTube را شناسایی می‌کند که از طرف مالک محتوای مشخص‌شده در مقدار پارامتر عمل می‌کند. این پارامتر برای شرکای محتوای YouTube که مالک و مدیر بسیاری از کانال‌های مختلف YouTube هستند درنظر گرفته شده است. این ویژگی به مالکان محتوا امکان می‌دهد یک‌بار اصالت‌سنجی کنند و به تمام داده‌های ویدیو و کانال خود دسترسی پیدا کنند، بدون اینکه نیاز باشد برای هر کانال جداگانه اطلاعات اصالت‌سنجی ارائه دهند. حساب CMS که کاربر با آن اصالت‌سنجی می‌کند باید به مالک محتوای YouTube مشخص‌شده پیوند داده شود.

متن درخواست

یک منبع بخش کانال در متن درخواست ارائه دهید. برای آن منبع:

  • باید مقداری برای این ویژگی‌ها مشخص کنید:

    • snippet.type

  • می‌توانید مقادیر این دارایی‌ها را تنظیم کنید:

    • snippet.type
    • snippet.title
    • snippet.position
    • contentDetails.playlists[]
    • contentDetails.channels[]

    اگر درخواست به‌روزرسانی ارسال می‌کنید و درخواستتان مقدار دارایی‌ای را که ازقبل مقدار دارد مشخص نمی‌کند، مقدار موجود دارایی حذف خواهد شد.

پاسخ

اگر موفقیت‌آمیز باشد، این روش یک منبع channelSection را در بدنه پاسخ برمی‌گرداند.

خطاها

جدول زیر پیام‌های خطایی را که ممکن است API در پاسخ به فراخوانی این روش برگرداند، مشخص می‌کند. لطفاً برای جزئیات بیشتر به سند پیام خطا مراجعه کنید.

نوع خطا جزئیات خطا شرح
badRequest (400) notEditable این بخش کانال قابل ویرایش نیست.
badRequest (400) typeRequired منبع channelSection باید مقداری برای فیلد snippet.type مشخص کند.
forbidden (403) channelSectionForbidden درخواست به‌درستی اصالت‌سنجی نشده است یا برای این کانال پشتیبانی نمی‌شود.
invalidValue (400) channelNotActive حداقل یکی از کانال‌های مشخص‌شده فعال نیست.
invalidValue (400) channelsDuplicated درخواست ناموفق بود زیرا کانال‌های تکراری را مشخص کرده بود.
invalidValue (400) channelsNeeded اگر دارایی snippet.type مقدار multipleChannels داشته باشد، دارایی contentDetails.channels[] باید مشخص شود و حداقل یک کانال را مشخص کند.
invalidValue (400) channelsNotExpected منبع ارائه‌شده با درخواست، مقداری را برای ویژگی contentDetails.channels[] مشخص کرده است، اما کانال‌ها برای این نوع بخش کانال مورد انتظار نیستند.
invalidValue (400) contentDetailsNeeded منبعی که به‌روزرسانی می‌کنید باید حاوی شیء contentDetails برای این نوع بخش کانال باشد.
invalidValue (400) idInvalid ویژگی id شناسه بخش کانال نامعتبری را مشخص می‌کند.
invalidValue (400) idRequired ویژگی id باید مقداری را مشخص کند که بخش کانال درحال به‌روزرسانی را شناسایی کند.
invalidValue (400) inValidPosition ویژگی snippet.position حاوی مقدار نامعتبر است.
invalidValue (400) maxChannelsExceeded درخواست ناموفق بود زیرا تلاش کرد کانال‌های زیادی را در بخش کانال اضافه کند.
invalidValue (400) maxPlaylistExceeded درخواست ناموفق بود زیرا تلاش کرد فهرست‌های پخش بسیار زیادی را در بخش کانال قرار دهد.
invalidValue (400) onePlaylistNeeded اگر خصوصیت snippet.type دارای مقدار singlePlaylist باشد، خصوصیت contentDetails.playlists[] باید دقیقاً یک فهرست پخش را مشخص کند.
invalidValue (400) ownChannelInChannels نمی‌توانید کانال خودتان را در بخش کانالی که در آن کانال ظاهر می‌شود اضافه کنید.
invalidValue (400) playlistIsPrivate یک یا چند فهرست پخش مشخص‌شده خصوصی هستند و بنابراین نمی‌توانند در بخش کانال قرار بگیرند.
invalidValue (400) playlistsDuplicated درخواست ناموفق بود زیرا فهرست‌های پخش تکراری را مشخص کرده است.
invalidValue (400) playlistsNeeded اگر ویژگی snippet.type دارای مقدار singlePlaylist یا multiplePlaylists باشد، ویژگی contentDetails.playlists[] باید مشخص شود.
invalidValue (400) playlistsNotExpected منبع ارائه‌شده با درخواست، مقداری را برای دارایی contentDetails.playlists[] مشخص کرده است، اما فهرست‌های پخش برای این نوع بخش کانال موردانتظار نیستند.
invalidValue (400) snippetNeeded برای به‌روزرسانی بخش کانال باید snippet را مشخص کنید.
invalidValue (400) titleLengthExceeded مقدار خصوصیت snippet.title خیلی طولانی است.
invalidValue (400) titleRequired اگر مقدار دارایی snippet.type برابر با multiplePlaylists یا multipleChannels باشد، باید عنوان بخش را با مشخص کردن مقدار دارایی snippet.title تنظیم کنید.
notFound (404) channelNotFound یک یا چند کانال مشخص‌شده پیدا نشد.
notFound (404) channelSectionNotFound بخش کانالی که می‌خواهید به‌روز کنید پیدا نشد.
notFound (404) playlistNotFound یک یا چند فهرست پخش مشخص‌شده پیدا نشد.

امتحان کنید!

از APIs Explorer برای فراخوانی این API و دیدن درخواست و پاسخ API استفاده کنید.