Playlists: insert

فهرست پخش ایجاد می‌کند.

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

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

درخواست

درخواست HTTP

POST 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 در این عملیات دو هدف دارد. این پارامتر ویژگی‌هایی را که عملیات نوشتن تنظیم می‌کند و همچنین ویژگی‌هایی را که پاسخ میانای برنامه‌سازی کاربردی دربرخواهد داشت شناسایی می‌کند.

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

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


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

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


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

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

متن درخواست

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

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

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

    • snippet.title
    • snippet.description
    • status.privacyStatus
    • 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 برای بازیابی مقادیر معتبر استفاده کنید و حتماً آن‌ها را طبق دستورالعمل‌های موجود در اسناد منبع فهرست‌های پخش به‌روز کنید.
badRequest (400) maxPlaylistExceeded فهرست پخش ایجاد نشد چون کانال ازقبل حداکثر تعداد فهرست‌های پخش مجاز را دارد.
forbidden (403) playlistForbidden این عملیات ممنوع است یا درخواست به‌درستی مجاز نشده است.
invalidValue (400) invalidPlaylistSnippet درخواست یک تکه‌کد فهرست پخش نامعتبر ارائه می‌دهد.
required (400) playlistTitleRequired درخواست باید عنوان فهرست پخش را مشخص کند.

امتحان کنید!

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