Playlists: update

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

تاثیر سهمیه ای: فراخوانی به این روش هزینه سهمیه ای 50 واحدی دارد.

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

درخواست کنید

درخواست 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 نشان می دهد که اعتبارنامه مجوز درخواست، کاربر YouTube CMS را شناسایی می کند که از طرف مالک محتوا مشخص شده در مقدار پارامتر عمل می کند. این پارامتر برای شرکای محتوای 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 را در بدنه پاسخ برمی گرداند.

خطاها

جدول زیر پیام های خطایی را مشخص می کند که API می تواند در پاسخ به تماس با این روش بازگرداند. برای جزئیات بیشتر، 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 استفاده کنید.

،

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

تاثیر سهمیه ای: فراخوانی به این روش هزینه سهمیه ای 50 واحدی دارد.

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

درخواست کنید

درخواست 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 نشان می دهد که اعتبارنامه مجوز درخواست، کاربر YouTube CMS را شناسایی می کند که از طرف مالک محتوا مشخص شده در مقدار پارامتر عمل می کند. این پارامتر برای شرکای محتوای 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 را در بدنه پاسخ برمی گرداند.

خطاها

جدول زیر پیام های خطایی را مشخص می کند که API می تواند در پاسخ به تماس با این روش بازگرداند. برای جزئیات بیشتر، 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 استفاده کنید.