LiveBroadcasts: control

توجه: روش liveBroadcasts.control منسوخ شده است و در تاریخ 1 اکتبر 2020 یا بعد از آن دیگر کار نخواهد کرد. پس از آن تاریخ، همه تماس‌های این روش یک خطای ممنوعه (403) را برمی‌گرداند و این روش بعداً به طور کامل حذف خواهد شد.

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

تنظیمات صفحه ای را که می تواند در جریان پخش نمایش داده شود، کنترل می کند.

موارد استفاده رایج

درخواست

درخواست HTTP

POST https://www.googleapis.com/youtube/v3/liveBroadcasts/control

مجوز

این درخواست به مجوز حداقل با یکی از حوزه های زیر نیاز دارد ( در مورد احراز هویت و مجوز بیشتر بخوانید ).

محدوده
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

مولفه های

جدول زیر پارامترهایی را که این کوئری پشتیبانی می کند فهرست می کند. تمام پارامترهای لیست شده پارامترهای پرس و جو هستند.

مولفه های
پارامترهای مورد نیاز
id string
پارامتر id شناسه پخش زنده YouTube را مشخص می کند که به طور منحصر به فرد پخشی را که در آن صفحه در حال به روز رسانی است، مشخص می کند.
part string
پارامتر part یک لیست جدا شده با کاما از یک یا چند ویژگی منبع liveBroadcast را مشخص می کند که پاسخ API شامل می شود. نام part که می توانید در مقدار پارامتر وارد کنید عبارتند از id , snippet , contentDetails و status .
پارامترهای اختیاری
displaySlate boolean
پارامتر displaySlate مشخص می کند که صفحه در حال فعال یا غیرفعال شدن است.
offsetTimeMs unsigned long
پارامتر offsetTimeMs یک آفست زمانی مثبت را مشخص می کند که تغییر صفحه مشخص شده رخ می دهد. این مقدار از ابتدای پخش جریان مانیتور پخش بر حسب میلی ثانیه اندازه گیری می شود، یعنی زمانی که مرحله آزمایش برای پخش آغاز شد. حتی اگر بر حسب میلی ثانیه مشخص شده باشد، مقدار در واقع یک تقریبی است و YouTube اقدام درخواستی را تا حد امکان به آن زمان انجام می دهد.

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

مهم: فقط در صورتی باید مقداری برای این پارامتر مشخص کنید که پخش جریانی شما با تأخیر مواجه شود.
onBehalfOfContentOwner string
این پارامتر فقط در یک درخواست مجاز به درستی قابل استفاده است. توجه: این پارامتر منحصراً برای شرکای محتوای YouTube در نظر گرفته شده است.

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

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

این پارامتر برای شرکای محتوای YouTube در نظر گرفته شده است که کانال‌های مختلف YouTube را مالک و مدیریت می‌کنند. این به صاحبان محتوا اجازه می‌دهد تا یک بار احراز هویت کنند و اقداماتی را از طرف کانال مشخص‌شده در مقدار پارامتر انجام دهند، بدون اینکه نیازی به ارائه اعتبارنامه احراز هویت برای هر کانال جداگانه باشد.
walltime datetime
پارامتر walltime زمان ساعت دیواری را مشخص می کند که در آن تغییر تخته سنگ مشخص شده رخ می دهد. مقدار در قالب ISO 8601 ( YYYY-MM-DDThh:mm:ss.sZ ) مشخص شده است.

درخواست بدن

هنگام فراخوانی این روش، بدنه درخواست ارائه نکنید.

واکنش

در صورت موفقیت آمیز بودن، این روش یک منبع پخش زنده را در بدنه پاسخ برمی گرداند.

خطاها

جدول زیر پیام های خطایی را مشخص می کند که API می تواند در پاسخ به تماس با این روش بازگرداند. لطفاً برای جزئیات بیشتر به مستندات پیام خطا مراجعه کنید.

نوع خطا جزئیات خطا شرح
backendError errorDisplaySlate هنگام اجرای عمل درخواستی خطایی روی داد.
forbidden (403) liveBroadcastControlNotAllowed اقدام درخواستی فقط در صورتی مجاز است که وضعیت پخش live باشد.
insufficientPermissions insufficientLivePermissions کاربر مجاز به انجام عملیات درخواستی نیست، احتمالاً به این دلیل که کاربر مجوز پخش زنده را ندارد.
insufficientPermissions liveStreamingNotEnabled کاربری که درخواست را مجاز کرده است، قادر به پخش جریانی ویدیوی زنده در YouTube نیست. کاربر می تواند اطلاعات بیشتر را در https://www.youtube.com/features بیابد.
invalidValue (400) conflictingTimeFields فقط یکی از offsetTimeMs و walltime ممکن است مشخص شود.
invalidValue (400) invalidOffsetTimeMs مقدار پارامتر offsetTimeMs نامعتبر است. مقدار پارامتر باید مثبت باشد، اما پارامتر را تنها در صورتی می توان مشخص کرد که جریان مانیتور پخش فعال باشد.
invalidValue (400) invalidWalltime مقدار پارامتر walltime نامعتبر است.
notFound (404) liveBroadcastNotFound پخش مشخص شده توسط پارامتر id وجود ندارد.
required (400) actionRequired درخواست API باید حداقل یک عمل را مشخص کند. در این زمان، تنها اقدام پشتیبانی شده، امکان فعال یا غیرفعال کردن اسلاید است.
required (400) idRequired پارامتر id مورد نیاز باید پخشی را که به روز می شود مشخص کند.

آن را امتحان کنید!

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