مرجع API

این مرجع API توضیح می‌دهد که چگونه بااستفاده از «API جاری‌سازی زنده YouTube» پخش‌های زنده و جاری‌سازی‌های ویدیویی را در YouTube زمان‌بندی کنید.

انواع منبع

LiveBroadcasts

منبع liveBroadcast نشان‌دهنده رویدادی است که ازطریق ویدیو زنده در YouTube جاری‌سازی خواهد شد.

برای کسب اطلاعات بیشتر درباره این منبع، نمایش منبع و فهرست دارایی‌ها آن را ببینید.

روش درخواست HTTP شرح
نشانی‌های وب نسبی به https://www.googleapis.com/youtube/v3
bind POST /liveBroadcasts/bind پخش YouTube را به یک جاری‌سازی متصل می‌کند یا اتصال موجود بین یک پخش و یک جاری‌سازی را حذف می‌کند. یک همه‌فرستی فقط می‌تواند به یک جاری‌سازی ویدیویی متصل شود، اگرچه یک جاری‌سازی ویدیویی می‌تواند به بیش از یک همه‌فرستی متصل شود.
delete DELETE /liveBroadcasts همه‌فرستی را حذف می‌کند.
insert POST /liveBroadcasts همه‌فرستی ایجاد می‌کند.
list GET /liveBroadcasts فهرستی از پخش‌های YouTube را که با پارامترهای درخواست API مطابقت دارند برمی‌گرداند.
transition POST /liveBroadcasts/transition وضعیت یک همه‌فرستی زنده YouTube را تغییر می‌دهد و هر فرایندی را که با وضعیت جدید مرتبط است آغاز می‌کند. برای مثال، وقتی وضعیت همه‌فرستی را به testing تغییر می‌دهید، YouTube شروع به انتقال ویدیو به جاری‌سازی مانیتور آن همه‌فرستی می‌کند. قبل‌از فراخوانی این روش، باید تأیید کنید که مقدار ویژگی status.streamStatus برای جاری‌سازی محدود به همه‌فرستی شما active است.
update PUT /liveBroadcasts یک همه‌فرستی را به‌روزرسانی می‌کند. برای مثال، می‌توانید تنظیمات همه‌فرستی تعریف‌شده در شیء contentDetails منبع liveBroadcast را اصلاح کنید.
cuepoint POST /liveBroadcasts/cuepoint یک نقطه نشان در یک همه‌فرستی زنده درج می‌کند. نقطه نشانه ممکن است وقفه آگهی را راه‌اندازی کند.

LiveChatBans

منبع liveChatBan کاربر YouTube و گپ مستقیم YouTube را که کاربر از شرکت در آن منع شده است شناسایی می‌کند.

برای اطلاعات بیشتر درباره این منبع، نمایش منبع و فهرست مشخصه‌ها را ببینید.

روش درخواست HTTP شرح
نشانی‌های وب نسبی به https://www.googleapis.com/youtube/v3
delete DELETE /liveChat/bans ممنوعیتی را که مانع از مشارکت کاربر خاصی در گپ مستقیم می‌شود برمی‌دارد و درنتیجه کاربر می‌تواند دوباره به گپ بپیوندد. درخواست میانای برنامه‌سازی کاربردی باید توسط مالک کانال یا گرداننده گپ مستقیم مرتبط با ممنوعیت مجاز شود.
insert POST /liveChat/bans کاربر خاصی را از شرکت در گپ مستقیم منع می‌کند. درخواست API باید توسط مالک کانال یا یک مدیر گپ زنده مرتبط با ممنوعیت مجاز شود.

LiveChatMessages

منبع liveChatMessage نشان‌دهنده پیام گپ در گپ مستقیم YouTube است. این منبع می‌تواند حاوی جزئیاتی درباره انواع مختلف پیام‌ها باشد، ازجمله پیام متنی جدیداً پست‌شده یا رویداد تأمین بودجه طرفداران.

ویژگی گپ مستقیم به‌طور پیش‌فرض برای پخش‌های زنده فعال است و درحین فعال بودن رویداد زنده دردسترس است. (پس‌از پایان رویداد، گپ مستقیم دیگر برای آن رویداد دردسترس نیست.)

برای کسب اطلاعات بیشتر درباره این منبع، نمایش منبع و فهرست دارایی‌ها آن را ببینید.

روش درخواست HTTP شرح
شناسه‌های منبع یکسان مربوط به https://www.googleapis.com/youtube/v3
delete DELETE /liveChat/messages پیام گپ را حذف می‌کند. درخواست API باید توسط مالک کانال یا یک مدیر گپ زنده مرتبط با ممنوعیت مجاز شود.
insert POST /liveChat/messages پیامی را به گپ مستقیم اضافه می‌کند.
list GET /liveChat/messages پیام‌های گپ مستقیم را برای گپی خاص فهرست می‌کند.
streamList اتصال جاری‌سازی سرور را برای دریافت پیام‌های گپ مستقیم برای گپ خاصی با تأخیر کم فعال می‌کند.

LiveChatModerators

منبع liveChatModerator نشان‌دهنده گرداننده گپ مستقیم YouTube است. گرداننده گپ این قابلیت را دارد که کاربران را از گپ مسدود یا رفع انسداد کند، پیام‌ها را حذف کند، و اقدامات مدیریتی دیگری برای گپ مستقیم انجام دهد.

برای اطلاعات بیشتر درباره این منبع، نمایش منبع و فهرست مشخصه‌ها را ببینید.

روش درخواست HTTP شرح
نشانی‌های وب نسبی به https://www.googleapis.com/youtube/v3
delete DELETE /liveChat/moderators گرداننده گپ را برمی‌دارد. درخواست باید توسط مالک کانال پخش زنده تأیید شود.
insert POST /liveChat/moderators گرداننده جدیدی برای گپ اضافه می‌کند. درخواست باید توسط مالک کانال پخش زنده تأیید شود.
list GET /liveChat/moderators گردانندگان گپ مستقیم را فهرست می‌کند. درخواست باید توسط مالک کانال پخش زنده مجاز شود.

LiveStreams

منبع liveStream حاوی اطلاعاتی درباره جاری‌سازی ویدیویی است که به YouTube ارسال می‌کنید. جاری‌سازی محتوایی را ارائه می‌دهد که برای کاربران YouTube پخش خواهد شد. پس‌از ایجاد، منبع liveStream می‌تواند به یک یا چند منبع liveBroadcast محدود شود.

برای اطلاعات بیشتر درباره این منبع، نمایش منبع و فهرست مشخصه‌ها را ببینید.

روش درخواست HTTP شرح
شناسه‌های منبع یکسان مربوط به https://www.googleapis.com/youtube/v3
delete DELETE /liveStreams جاری‌سازی ویدیویی را حذف می‌کند.
insert POST /liveStreams جاری‌سازی ویدیو ایجاد می‌کند. جاری‌سازی به شما امکان می‌دهد ویدیو خود را به YouTube ارسال کنید، که سپس می‌تواند ویدیو را برای مخاطبان شما پخش کند.
list GET /liveStreams فهرستی از جاری‌سازی‌های ویدیویی را که با پارامترهای درخواست API مطابقت دارند برمی‌گرداند.
update PUT /liveStreams جاری‌سازی ویدیویی را به‌روز می‌کند. اگر ویژگی‌هایی که می‌خواهید تغییر دهید قابل به‌روزرسانی نیستند، باید جاری‌سازی جدیدی با تنظیمات مناسب ایجاد کنید.

SuperChatEvents

منبع superChatEvent نشان‌دهنده پیام Super Chat خریداری‌شده توسط یک طرفدار درطول یک جاری‌سازی زنده YouTube است. در جاری‌سازی گپ مستقیم YouTube، «اَبَر گپ‌ها» از دو طریق از سایر پیام‌ها متمایز می‌شوند:

  • «اَبَر گپ‌ها» با رنگی برجسته می‌شوند.
  • «اَبَر گپ‌ها» برای مدت زمان مشخصی در نوار خبر سنجاق می‌شوند.

رنگ Super Chat، مدت زمانی که در تیکر سنجاق می‌ماند، و حداکثر طول پیام همگی براساس مبلغ خرید تعیین می‌شوند. برای کسب اطلاعات بیشتر درباره Super Chat، به مرکز راهنمایی YouTube مراجعه کنید.

برای اطلاعات بیشتر درباره این منبع، نمایش منبع و فهرست مشخصه‌ها را ببینید.

روش درخواست HTTP شرح
نشانی‌های وب نسبی به https://www.googleapis.com/youtube/v3
list GET /superChatEvents رویدادهای Super Chat را از جاری‌سازی‌های زنده کانال در ۳۰ روز گذشته فهرست کنید.