Thumbnails: set

یک ریزعکس سفارشی ویدیو را در YouTube بارگذاری می‌کند و آن را برای یک ویدیو تنظیم می‌کند.

این روش از بارگذاری رسانه پشتیبانی می‌کند. فایل‌های بارگذاری‌شده باید با این محدودیت‌ها مطابقت داشته باشند:

  • حداکثر اندازه فایل: ۵۰ مگابایت
  • انواع MIME رسانه پذیرفته‌شده: image/jpeg، image/png، application/octet-stream

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

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

درخواست

درخواست HTTP

POST https://www.googleapis.com/upload/youtube/v3/thumbnails/set

صدور مجوز

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

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

پارامترها

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

پارامترها
پارامترهای الزامی
videoId string
پارامتر videoId شناسه ویدیو YouTube را که ریزعکس سفارشی ویدیو برای آن ارائه می‌شود مشخص می‌کند.
پارامترهای اختیاری
onBehalfOfContentOwner string
توجه: این پارامتر منحصراً برای شرکای محتوای YouTube درنظر گرفته شده است.

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

متن درخواست

بدنه درخواست حاوی تصویر ریزعکسی است که درحال بارگذاری آن هستید. بدنه درخواست حاوی منبع thumbnail نیست.

پاسخ

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

{
  "kind": "youtube#thumbnailSetResponse",
  "etag": etag,
  "items": [
    thumbnail resource
  ]
}

مشخصات

جدول زیر ویژگی‌هایی را که در این منبع ظاهر می‌شوند تعریف می‌کند:

مشخصات
kind string
نوع منبع میانای برنامه‌سازی کاربردی را مشخص می‌کند. مقدار youtube#thumbnailSetResponse خواهد بود.
etag etag
Etag این منبع.
items[] list
فهرست ریزعکس‌ها.

خطاها

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

نوع خطا جزئیات خطا شرح
badRequest (400) invalidImage محتوای تصویر ارائه‌شده نامعتبر است.
badRequest (400) mediaBodyRequired درخواست شامل محتوای تصویر نیست.
forbidden (403) forbidden تصویر کوچک را نمی‌توان برای ویدیو مشخص‌شده تنظیم کرد. ممکن است درخواست به‌درستی مجاز نشده باشد.
forbidden (403) forbidden کاربر اصالت‌سنجی‌شده اجازه بارگذاری و تنظیم ریزعکس‌های ویدیو سفارشی را ندارد.
notFound (404) videoNotFound ویدیویی که تلاش می‌کنید تصویر ریزعکس برای آن درج کنید، یافت نشد. مقدار پارامتر videoId درخواست را بررسی کنید تا مطمئن شوید درست است.
tooManyRequests (429) uploadRateLimitExceeded این کانال اخیراً تصاویر کوچک زیادی بارگذاری کرده است. لطفاً بعداً درخواست را دوباره امتحان کنید.

امتحان کنید!

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