Playlists: update

فهرست پخش را اصلاح می‌کند. برای مثال، می‌توانید عنوان، شرح، یا وضعیت حریم خصوصی فهرست پخش را تغییر دهید.

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

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

درخواست

درخواست HTTP

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

صدور مجوز

این درخواست به مجوز با حداقل یکی از دامنه‌های زیر نیاز دارد. برای کسب اطلاعات بیشتر درباره اصالت‌سنجی و صدور مجوز، به پیاده‌سازی مجوز OAuth 2.0 مراجعه کنید.

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

پارامترها

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

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

توجه داشته باشید که این روش مقادیر موجود برای دارایی‌های تغییرپذیر را که در هر بخشی که بدنه درخواست مشخص می‌کند وجود دارد ملغی می‌کند. برای مثال، شرح فهرست پخش در بخش snippet قرار دارد که باید در بدنه درخواست گنجانده شود. اگر درخواست مقداری برای ویژگی snippet.description مشخص نکند، شرح موجود فهرست پخش حذف خواهد شد.

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

توجه: این پارامتر منحصراً برای شرکای محتوای YouTube درنظر گرفته شده است.

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

متن درخواست

منبع playlist را در بدنه درخواست ارائه دهید.

برای آن منبع:

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

    • id
    • snippet.title

  • می‌توانید برای این مشخصات مقدار تنظیم کنید:

    • snippet.title
    • snippet.description
    • status.privacyStatus
    • status.podcastStatus
    • snippet.defaultLanguage
    • localizations.(key)
    • localizations.(key).title
    • localizations.(key).description

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

پاسخ

درصورت موفقیت، این روش منبع playlist را در بدنه پاسخ برمی‌گرداند.

خطاها

جدول زیر پیام‌های خطایی را که ممکن است «میانای برنامه‌سازی کاربردی» در پاسخ به فراخوانی این روش برگرداند مشخص می‌کند. برای جزئیات بیشتر، YouTube Data API - Errors را ببینید.

نوع خطا جزئیات خطا شرح
badRequest (400) defaultLanguageNotSetError ‫defaultLanguage باید روی به‌روزرسانی localizations تنظیم شود.
badRequest (400) localizationValidationError یکی از مقادیر موجود در شیء بومی‌سازی‌ها اعتبارسنجی نشد. از روش playlists.list برای بازیابی مقادیر معتبر استفاده کنید و مطمئن شوید که آن‌ها را طبق دستورالعمل‌های موجود در سند منبع فهرست‌های پخش به‌روزرسانی می‌کنید.
forbidden (403) playlistForbidden این عملیات ممنوع است یا درخواست به‌درستی مجاز نشده است.
invalidValue (400) invalidPlaylistSnippet درخواست، قطعه کد فهرست پخش نامعتبری ارائه می‌دهد.
notFound (404) playlistNotFound فهرست پخش شناسایی‌شده با پارامتر id درخواست پیدا نشد.
required (400) playlistTitleRequired درخواست باید عنوان فهرست پخش را مشخص کند.
invalidValue (400) playlistOperationUnsupported این API از قابلیت به‌روزرسانی فهرست پخش مشخص‌شده پشتیبانی نمی‌کند. برای مثال، نمی‌توانید ویژگی‌های فهرست پخش ویدیوهای بارگذاری‌شده‌تان را به‌روز کنید.

امتحان کنید!

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