تصویر ته‌نقشی را در YouTube بارگذاری می‌کند و آن را برای کانالی تنظیم می‌کند.
این روش از بارگذاری رسانه پشتیبانی می‌کند. فایل‌های بارگذاری‌شده باید با این محدودیت‌ها مطابقت داشته باشند:
- حداکثر اندازه فایل: ۱۰ مگابایت
- انواع MIME رسانه پذیرفته‌شده:
image/jpeg،image/png،application/octet-stream
تأثیر سهمیه: فراخوانی این روش هزینه سهمیه ۵۰ واحدی دارد.
درخواست
درخواست HTTP
POST https://www.googleapis.com/upload/youtube/v3/watermarks/set
صدور مجوز
این درخواست به مجوز با حداقل یکی از محدوده‌های زیر نیاز دارد. برای کسب اطلاعات بیشتر درباره اصالت‌سنجی و صدور مجوز، به پیاده‌سازی مجوز OAuth 2.0 مراجعه کنید.
| حوزه |
|---|
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 |
پارامترها
جدول زیر پارامترهایی را که این پُرسمان پشتیبانی می‌کند فهرست می‌کند. همه پارامترهای فهرست‌شده پارامترهای پُرسمان هستند.
| پارامترها | ||
|---|---|---|
| پارامترهای الزامی | ||
channelId |
stringپارامتر channelId شناسه کانال YouTube را که ته‌نقش برای آن ارائه می‌شود مشخص می‌کند. |
|
| پارامترهای اختیاری | ||
onBehalfOfContentOwner |
stringتوجه: این پارامتر منحصراً برای شرکای محتوای YouTube درنظر گرفته شده است. پارامتر onBehalfOfContentOwner نشان می‌دهد که اطلاعات کاربری مجوز درخواست، کاربر CMS YouTube را که ازطرف مالک محتوای مشخص‌شده در مقدار پارامتر اقدام می‌کند شناسایی می‌کند. این پارامتر برای شرکای محتوای YouTube است که مالک و مدیر کانال‌های مختلف YouTube هستند. این ویژگی به مالکان محتوا اجازه می‌دهد یک‌بار اصالت‌سنجی کنند و به همه داده‌های ویدیو و کانال خود دسترسی پیدا کنند، بدون اینکه نیاز باشد برای هر کانال به‌طور جداگانه اعتبارنامه‌های اصالت‌سنجی ارائه دهند. حساب CMS که کاربر با آن اصالت‌سنجی می‌کند باید به مالک محتوای YouTube مشخص‌شده پیوند داده شده باشد. |
|
متن درخواست
منبع watermark را در بدنه درخواست ارائه دهید. منبع حاوی ویژگی‌های زیر است:
-
timing(object، الزامی): زمان‌بندی نمایش ته‌نقش را کپسوله می‌کند.-
timing.type(string، الزامی): رویoffsetFromStartیاoffsetFromEndتنظیم شود. -
timing.offsetMs(unsigned long، الزامی): جبران شروع برحسب میلی‌ثانیه. اگرtypeبرابر باoffsetFromEndباشد، باید حداقل1000میلی‌ثانیه باشد. -
timing.durationMs(unsigned long، اختیاری): مدت زمان رؤیت‌پذیری به میلی‌ثانیه (حداقل1000میلی‌ثانیه). اگرtypeبرابر باoffsetFromEndاست، نباید ازoffsetMsبیشتر باشد.
-
-
targetChannelId(string، اختیاری): شناسه کانال YouTube که ته‌نقش به آن پیوند می‌دهد. اگر حذف شود، به کانال شناسایی‌شده توسطchannelIdپیوند می‌دهد. position(object، منسوخ): توسط YouTube نادیده گرفته می‌شود. همواره در گوشه بالا سمت راست قرار می‌گیرند.
پاسخ
درصورت موفقیت، این روش رمز وضعیت HTTP 204 No Content را برمی‌گرداند.
خطاها
جدول زیر پیام‌های خطایی را که ممکن است «میانای برنامه‌سازی کاربردی» در پاسخ به فراخوانی این روش برگرداند مشخص می‌کند. برای جزئیات بیشتر، YouTube Data API - Errors را ببینید.
| نوع خطا | جزئیات خطا | شرح |
|---|---|---|
badRequest (400) |
imageFormatUnsupported |
تصویری که ارائه کردید قالب پشتیبانی‌نشده دارد. |
badRequest (400) |
imageTooTall |
تصویری که ارائه کردید خیلی بلند است. |
badRequest (400) |
imageTooWide |
تصویری که ارائه کردید خیلی عریض است. |
badRequest (400) |
mediaBodyRequired |
درخواست شامل محتوای تصویر نیست. |
forbidden (403) |
forbidden |
ته‌نقش را نمی‌توان برای کانال مشخص‌شده تنظیم کرد. ممکن است درخواست به‌درستی مجاز نشده باشد یا پارامتر channelId روی مقدار نامعتبر تنظیم شده باشد. |
امتحان کنید!
برای فراخوانی این API و دیدن درخواست و پاسخ API، از APIs Explorer استفاده کنید.