یک تصویر کوچک ویدیوی سفارشی را در YouTube آپلود می کند و آن را برای یک ویدیو تنظیم می کند.
این روش از آپلود رسانه پشتیبانی می کند. فایل های آپلود شده باید با این محدودیت ها مطابقت داشته باشند:
- حداکثر حجم فایل: 2 مگابایت
- انواع MIME رسانه پذیرفته شده:
image/jpeg
،image/png
،application/octet-stream
تاثیر سهمیه ای: فراخوانی به این روش هزینه سهمیه ای تقریباً 50 واحدی دارد.
موارد استفاده رایج
درخواست
درخواست 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 نشان می دهد که اعتبارنامه مجوز درخواست، کاربر YouTube CMS را شناسایی می کند که از طرف مالک محتوا مشخص شده در مقدار پارامتر عمل می کند. این پارامتر برای شرکای محتوای YouTube در نظر گرفته شده است که کانالهای مختلف YouTube را مالک و مدیریت میکنند. این به صاحبان محتوا امکان میدهد یک بار احراز هویت کنند و به تمام دادههای ویدیویی و کانال خود دسترسی داشته باشند، بدون اینکه نیازی به ارائه اعتبارنامه احراز هویت برای هر کانال جداگانه داشته باشند. حساب CMS واقعی که کاربر با آن احراز هویت میکند باید به مالک محتوای YouTube مشخصشده پیوند داده شود. |
درخواست بدن
بدنه درخواست حاوی تصویر کوچکی است که در حال آپلود آن هستید. بدنه درخواست حاوی منبع thumbnail
نیست.
واکنش
در صورت موفقیت آمیز بودن، این روش یک بدنه پاسخ با ساختار زیر را برمی گرداند:
{ "kind": "youtube#thumbnailSetResponse", "etag": etag, "items": [ thumbnail resource ] }
خواص
جدول زیر ویژگی های ظاهر شده در این منبع را تعریف می کند:
خواص | |
---|---|
kind | string نوع منبع API را مشخص می کند. مقدار youtube#thumbnailSetResponse خواهد بود. |
etag | etag Etag این منبع |
items[] | list لیستی از ریز عکسها |
خطاها
جدول زیر پیام های خطایی را مشخص می کند که API می تواند در پاسخ به تماس با این روش بازگرداند. لطفاً برای جزئیات بیشتر به مستندات پیام خطا مراجعه کنید.
نوع خطا | جزئیات خطا | شرح |
---|---|---|
badRequest (400) | invalidImage | محتوای تصویر ارائه شده نامعتبر است. |
badRequest (400) | mediaBodyRequired | درخواست شامل محتوای تصویر نمی شود. |
forbidden (403) | forbidden | تصویر کوچک را نمی توان برای ویدیوی مشخص شده تنظیم کرد. ممکن است درخواست به درستی مجاز نباشد. |
forbidden (403) | forbidden | کاربر احراز هویت شده مجوز آپلود و تنظیم تصاویر کوچک ویدیوی سفارشی را ندارد. |
notFound (404) | videoNotFound | ویدیویی که میخواهید یک تصویر کوچک برای آن درج کنید پیدا نمیشود. مقدار پارامتر videoId درخواست را بررسی کنید تا مطمئن شوید که درست است. |
tooManyRequests (429) | uploadRateLimitExceeded | این کانال اخیراً تصاویر کوچک زیادی را بارگذاری کرده است. لطفاً بعداً دوباره درخواست را امتحان کنید. |
آن را امتحان کنید!
از APIs Explorer برای فراخوانی این API و مشاهده درخواست و پاسخ API استفاده کنید.