Watermarks: set

یک تصویر واترمارک را در یوتیوب آپلود می‌کند و آن را برای یک کانال تنظیم می‌کند.

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

  • حداکثر حجم فایل: ۱۰ مگابایت
  • انواع 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 شناسه کانال یوتیوبی را که واترمارک برای آن ارائه می‌شود، مشخص می‌کند.
پارامترهای اختیاری
onBehalfOfContentOwner string
توجه: این پارامتر منحصراً برای شرکای محتوای YouTube در نظر گرفته شده است.

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

درخواست بدنه

یک منبع watermark در بدنه درخواست ارائه دهید. این منبع شامل ویژگی‌های زیر است:

  • timing ( object ، الزامی): زمان‌بندی نمایش واترمارک را کپسوله‌سازی می‌کند.
    • timing.type ( string , required): روی offsetFromStart یا offsetFromEnd تنظیم می‌شود.
    • timing.offsetMs ( unsigned long ، الزامی): شروع آفست بر حسب میلی‌ثانیه. اگر type offsetFromEnd باشد، باید حداقل 1000 میلی‌ثانیه باشد.
    • timing.durationMs ( unsigned long ، اختیاری): مدت زمان قابل مشاهده بر حسب میلی ثانیه (حداقل 1000 میلی ثانیه). اگر type offsetFromEnd باشد، نباید از offsetMs بیشتر شود.
  • targetChannelId ( string ، اختیاری): شناسه کانال یوتیوبی که واترمارک به آن لینک می‌دهد. در صورت حذف، به کانالی که توسط channelId مشخص شده است، لینک می‌دهد.
  • position ( object , منسوخ شده): توسط یوتیوب نادیده گرفته می‌شود. واترمارک‌ها همیشه در گوشه بالا سمت راست قرار می‌گیرند.

پاسخ

در صورت موفقیت، این متد کد وضعیت HTTP 204 No Content را برمی‌گرداند.

خطاها

جدول زیر پیام‌های خطایی را که API می‌تواند در پاسخ به فراخوانی این متد برگرداند، مشخص می‌کند. برای جزئیات بیشتر، به YouTube Data API - Errors مراجعه کنید.

نوع خطا جزئیات خطا توضیحات
badRequest (400) imageFormatUnsupported تصویری که ارائه دادید فرمت پشتیبانی نشده‌ای دارد.
badRequest (400) imageTooTall تصویری که گذاشتی خیلی بلنده.
badRequest (400) imageTooWide تصویری که گذاشتید خیلی عریضه.
badRequest (400) mediaBodyRequired درخواست شامل محتوای تصویر نمی‌شود.
forbidden (403) forbidden نمی‌توان واترمارک را برای کانال مشخص شده تنظیم کرد. ممکن است درخواست به درستی تأیید نشده باشد، یا پارامتر channelId روی مقدار نامعتبری تنظیم شده باشد.

امتحانش کن!

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