خدمات YouTube API - حداقل عملکرد مورد نیاز

توجه: پیروی از خط‌مشی‌های برنامه‌نویس YouTube راهنمایی‌ها و مثال‌هایی را ارائه می‌دهد تا به شما کمک کند مطمئن شوید که مشتریان API شما از بخش‌های خاصی از شرایط و خط‌مشی‌های خدمات YouTube API (API TOS) پیروی می‌کنند. این راهنما بینشی را در مورد نحوه اجرای برخی جنبه‌های API TOS توسط YouTube ارائه می‌کند، اما جایگزین هیچ سند موجود نمی‌شود.

این سند حداقل الزامات عملکردی را برای کلاینت‌های API تعریف می‌کند که ویژگی‌های خاص سرویس‌های YouTube API ("مشتریان API") را اجرا می‌کنند یا به آنها دسترسی می‌دهند.

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

باید انتظار داشته باشید که الزامات این سند تغییر کند تا بتوانیم از تجربیات کاربر بهتر با ویژگی‌های موجود YouTube اطمینان حاصل کنیم. آنها همچنین در پاسخ به ویژگی های جدید و به روز شده YouTube تغییر خواهند کرد. گاهی اوقات، چنین تغییراتی ممکن است از شما بخواهد که API Client های خود را برای رفع نیازهای جدید به روز کنید. تاریخچه بازنگری شرایط خدمات هرگونه تغییر را مستند می کند، بنابراین لطفاً آن سند را مرتباً بررسی کنید یا در فید RSS آن مشترک شوید تا مطمئن شوید که می توانید به سرعت از تغییراتی که ممکن است بر مشتریان API خود تأثیر بگذارد مطلع شوید.

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

پخش کننده جاسازی شده یوتیوب و پخش ویدیو

الزامات این بخش به طور خاص به پخش کننده های یوتیوب تعبیه شده مربوط می شود. خط‌مشی‌های خدمات YouTube API همچنین شامل چندین خط‌مشی مرتبط با مشتریان API است که محتوای سمعی و بصری YouTube را پخش می‌کنند.

اندازه پخش کننده یوتیوب جاسازی شده

پخش‌کننده‌های جاسازی‌شده باید دیدی با ابعاد حداقل 200 پیکسل در 200 پیکسل داشته باشند. اگر پخش‌کننده کنترل‌ها را نمایش می‌دهد، باید به اندازه‌ای بزرگ باشد که کنترل‌ها را به‌طور کامل نمایش دهد، بدون اینکه درگاه دید کمتر از حداقل اندازه باشد. ما توصیه می کنیم پخش کننده های 16:9 حداقل 480 پیکسل عرض و 270 پیکسل قد داشته باشند.

پخش خودکار و پخش اسکریپت

این بخش پخش خودکار را پوشش می دهد. این برنامه برای پخش‌کننده‌های تعبیه‌شده YouTube که یا از پارامتر پخش autoplay استفاده می‌کنند یا با استفاده از سرویس YouTube IFrame Player API، سرویس YouTube Android Player API یا یکی دیگر از سرویس‌های YouTube API، پخش خودکار را به صورت برنامه‌ریزی شروع می‌کنند، اعمال می‌شود.

  • پخش‌کننده‌های جاسازی‌شده که به‌طور خودکار یک ویدیو را پخش می‌کنند، باید بلافاصله پس از بارگیری صفحه یا به محض اینکه پخش‌کننده جاسازی‌شده کاملاً قابل مشاهده است، بازپخش را آغاز کنند. با این حال، یک سرویس گیرنده API نباید پخش خودکار را شروع کند تا زمانی که پخش کننده قابل مشاهده باشد و بیش از نیمی از پخش کننده در صفحه یا صفحه قابل مشاهده باشد.

  • یک صفحه یا صفحه نباید بیش از یک پخش کننده YouTube داشته باشد که به طور خودکار محتوا را به طور همزمان پخش کند.

  • هر تصویر کوچک YouTube که بازپخش را آغاز می کند باید حداقل 120 پیکسل عرض و 70 پیکسل ارتفاع داشته باشد.

ویژگی های YouTube Player

ویژگی ها و پارامترهای پخش کننده YouTube - از جمله، به عنوان مثال، ظاهر نام تجاری YouTube در پخش کننده - در اسناد و مشخصات YouTube API (https://developers.google.com/youtube) مشخص شده است. شما نباید تغییراتی در پخش کننده YouTube ایجاد کنید که به صراحت در اسناد API توضیح داده نشده است.

روکش ها و قاب ها

شما نباید پوشش‌ها، فریم‌ها یا سایر عناصر بصری را در مقابل هیچ بخشی از پخش‌کننده تعبیه‌شده YouTube، از جمله کنترل‌های پخش‌کننده، نمایش دهید. به طور مشابه، نباید از پوشش‌ها، فریم‌ها یا سایر عناصر بصری برای مبهم کردن بخشی از پخش‌کننده تعبیه‌شده، از جمله کنترل‌های پخش‌کننده، استفاده کنید.

Mouseovers

برای شروع هر اقدامی از طرف کاربر، مانند باز کردن یک پنجره یا اشتراک در یک کانال، نباید از ماوس یا رویدادهای لمسی در پخش کننده YouTube استفاده کنید.

در حال آپلود ویدیوها

اگر مشتریان API به کاربران اجازه می‌دهند محتوا را در چندین پلتفرم آپلود کنند، کاربران باید بتوانند پلتفرم‌هایی را که می‌خواهند ویدیوهای خود را در آن آپلود کنند، انتخاب کرده و از حالت انتخاب خارج کنند.

الزامات داده

کلاینت‌های API که به کاربران امکان می‌دهند ویدیوها را در YouTube آپلود کنند، باید کاربران را قادر به تنظیم مقادیر در لیست زیر کنند. هر ویژگی که در لیست نیست اختیاری است.

نام شرح
خواص منابع
snippet.title ضروری . عنوان ویدیو اگر مقدار از 100 کاراکتر بیشتر شود، یوتیوب خطایی را برمی‌گرداند. YouTube از همه کاراکترهای معتبر UTF-8 به جز < و > پشتیبانی می کند.

snippet.description ضروری . توضیحات ویدیو اگر مقدار از 5000 بایت بیشتر شود، یوتیوب خطایی را برمی‌گرداند. YouTube از همه کاراکترهای معتبر UTF-8 به جز < و > پشتیبانی می کند.
status.privacyStatus ضروری . تنظیمات حریم خصوصی ویدیو . کاربران باید بتوانند انتخاب کنند که ویدیوی آپلود شده عمومی، خصوصی یا فهرست نشده باشد.
درخواست پارامترها
onBehalfOfContentOwnerChannel مشروط مورد نیاز است . اگر اعتبارنامه مجوز درخواست، مالک محتوا را شناسایی کند و پارامتر onBehalfOfContentOwner تنظیم شده باشد، کاربر API باید بتواند کانال YouTube را که ویدیو در آن آپلود می‌شود نیز مشخص کند.

نمایش نظرات

نام شرح
خواص منابع
snippet.textDisplay ضروری . متن کامنت مشتری API باید (الف) متن کامل یک نظر یا پاسخ نظر را نمایش دهد، یا (ب) متن را کوتاه کند و راهی برای بیننده فراهم کند تا به راحتی به متن کامل از نسخه کوتاه شده دسترسی پیدا کند.

این الزام برای همه نظرات و پاسخ‌های نظر اعمال می‌شود، صرف‌نظر از اینکه نظرات با کدام منبع مرتبط هستند (ویدئوها، کانال‌ها و غیره).

توجه داشته باشید که مقدار ویژگی snippet.topLevelComment منبع commentThread یک منبع comment است و ویژگی replies.comments[] فهرستی از منابع comment است. به این ترتیب، این الزام برای ویژگی های snippet.topLevelComment.snippet.textDisplay و replies.comments[].snippet.textDisplay نیز اعمال می شود.
snippet.title
( channel )
مورد نیاز (پیشنهاد) . عنوان کانال
  • اگر نظر مربوط به یک کانال باشد، مشتری API باید نام کانال را نمایش دهد.
  • اگر نظر مربوط به یک ویدیو باشد، مشتری API باید نام کانالی را که ویدیو را آپلود کرده است نمایش دهد.
snippet.title
( video )
مشروط مورد نیاز (پیشنهاد) . عنوان ویدیو اگر نظر مربوط به یک ویدیو باشد، این مقدار باید نمایش داده شود.
snippet.moderationStatus مشروط مورد نیاز است . اگر مقدار پارامتر moderationStatus در درخواست API heldForReview شودForReview یا likelySpam ، نمایشگر باید به وضوح آن وضعیت را با استفاده از مقدار ویژگی، زبان مشابه (مثلاً "این نظر برای بررسی نگهداری می شود")، یک سرصفحه (مثلا "برای بررسی نگه داشته شود" شناسایی کند. ) یا زبان بدون ابهام دیگر. روش commentThreads.list از قابلیت بازیابی نظرات بر اساس وضعیت تعدیل آنها پشتیبانی می کند.

افزودن نظرات

نام شرح
خواص منابع
snippet.title
( channel )
ضروری . عنوان کانال
  • اگر کاربر نظری درباره یک کانال اضافه می کند، مشتری API باید نام کانال را نمایش دهد.
  • اگر کاربر در مورد یک ویدیو نظر اضافه می کند، مشتری API باید نام کانالی را که ویدیو را آپلود کرده است نمایش دهد.
snippet.title
( video )
ضروری . اگر کاربر در مورد یک ویدیو نظر اضافه می کند، مشتری API باید عنوان ویدیو را نمایش دهد.
ملزومات دیگر
Comment author's channel name ضروری . مشتری API باید حساب کاربری یوتیوب را که نظر به آن نسبت داده می شود، به وضوح شناسایی کند. اگر اعتبارنامه درخواست، مالک محتوا را شناسایی کند و پارامتر onBehalfOfContentOwner تنظیم شده باشد، کاربر API باید بتواند کانال YouTube را که نظر به آن نسبت داده می‌شود را نیز مشخص کند.

افزودن پاسخ های نظر

نام شرح
خواص منابع
snippet.textDisplay ضروری . متن کامنت سرویس گیرنده API باید متن نظری را که کاربر به آن پاسخ می دهد مطابق با قوانین تعریف شده در بخش نمایش نظرات این سند نمایش دهد.
snippet.title
( channel )
ضروری . عنوان کانال
  • اگر کاربر به نظری درباره یک کانال پاسخ می دهد، مشتری API باید نام کانال را نمایش دهد.
  • اگر کاربر به نظری درباره یک ویدیو پاسخ می‌دهد، مشتری API باید نام کانالی را که ویدیو را آپلود کرده است نمایش دهد.
snippet.title
( video )
ضروری . اگر کاربر به نظری درباره یک ویدیو پاسخ می‌دهد، مشتری API باید عنوان ویدیو را نمایش دهد.
ملزومات دیگر
Comment author's channel name ضروری . مشتری API باید حساب کاربری YouTube را که پاسخ نظر به آن نسبت داده می‌شود، به وضوح شناسایی کند. اگر اعتبارنامه درخواست، مالک محتوا را شناسایی کند و پارامتر onBehalfOfContentOwner تنظیم شده باشد، کاربر API نیز باید بتواند کانال YouTube را که پاسخ نظر به آن نسبت داده می‌شود، مشخص کند.

ویرایش یا حذف پاسخ های نظرات

نام شرح
خواص منابع
snippet.textDisplay ضروری . متن کامنت مشتری API باید متن نظری را که کاربر در حال ویرایش یا حذف آن است مطابق با قوانین تعریف شده در بخش نمایش نظرات این سند نمایش دهد.
snippet.title
( channel )
ضروری . عنوان کانال
  • اگر کاربر در حال ویرایش یا حذف نظری درباره یک کانال است، مشتری API باید نام کانال را نمایش دهد.
  • اگر کاربر در حال ویرایش یا حذف نظری درباره یک ویدیو است، مشتری API باید نام کانالی را که ویدیو را آپلود کرده است نمایش دهد.
snippet.title
( video )
ضروری . اگر کاربر در حال ویرایش یا حذف نظری درباره یک ویدیو است، مشتری API باید عنوان ویدیو را نمایش دهد.
ملزومات دیگر
Comment author's channel name ضروری . مشتری API باید حساب کاربری یوتیوب را که نظر به آن نسبت داده شده است، به وضوح شناسایی کند.

ممنوع کردن کاربر از چت زنده (یا حذف ممنوعیت)

نام شرح
خواص منابع
snippet.title
( channel )
ضروری . نام کانال یوتیوب که در حال ممنوعیت یا لغو ممنوعیت است. علاوه بر این، نام باید به کانال پیوند داده شود یا آدرس کانال نیز باید نمایش داده شود.
ملزومات دیگر
نام کانال نویسنده کامنت ضروری . سرویس گیرنده API باید حساب کاربری YouTube را که برای افزودن یا حذف ممنوعیت استفاده می‌شود، به وضوح شناسایی کند.