liveBroadcast
اکنون دارای خاصیتی است که وضعیت «ساخته شده برای بچهها» آن پخش زنده را مشخص میکند. شرایط خدمات YouTube API و خطمشیهای برنامهنویس نیز در 10 ژانویه 2020 بهروزرسانی شد. برای اطلاعات بیشتر، لطفاً به تاریخچه بازبینی سرویس YouTube Live Streaming API و شرایط خدمات YouTube API Services مراجعه کنید.پخش ایجاد می کند.
موارد استفاده رایج
درخواست
درخواست HTTP
POST https://www.googleapis.com/youtube/v3/liveBroadcasts
مجوز
این درخواست به مجوز حداقل با یکی از حوزه های زیر نیاز دارد ( در مورد احراز هویت و مجوز بیشتر بخوانید ).
محدوده |
---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
مولفه های
جدول زیر پارامترهایی را که این کوئری پشتیبانی می کند فهرست می کند. تمام پارامترهای لیست شده پارامترهای پرس و جو هستند.
مولفه های | ||
---|---|---|
پارامترهای مورد نیاز | ||
part | string پارامتر part در این عملیات دو هدف را دنبال می کند. ویژگی هایی را که عملیات نوشتن تنظیم می کند و همچنین ویژگی هایی را که پاسخ API شامل می شود شناسایی می کند.ویژگی های part که می توانید در مقدار پارامتر بگنجانید عبارتند از id , snippet , contentDetails و status . | |
پارامترهای اختیاری | ||
onBehalfOfContentOwner | string این پارامتر فقط در یک درخواست مجاز به درستی قابل استفاده است. توجه: این پارامتر منحصراً برای شرکای محتوای YouTube در نظر گرفته شده است. پارامتر onBehalfOfContentOwner نشان می دهد که اعتبارنامه مجوز درخواست، کاربر YouTube CMS را شناسایی می کند که از طرف مالک محتوا مشخص شده در مقدار پارامتر عمل می کند. این پارامتر برای شرکای محتوای YouTube در نظر گرفته شده است که کانالهای مختلف YouTube را مالک و مدیریت میکنند. این به صاحبان محتوا امکان میدهد یک بار احراز هویت کنند و به تمام دادههای ویدیویی و کانال خود دسترسی داشته باشند، بدون اینکه نیازی به ارائه اعتبارنامه احراز هویت برای هر کانال جداگانه داشته باشند. حساب CMS که کاربر با آن احراز هویت میکند باید به مالک محتوای YouTube مشخص شده مرتبط باشد. | |
onBehalfOfContentOwnerChannel | string این پارامتر فقط در یک درخواست مجاز به درستی قابل استفاده است. این پارامتر فقط در یک درخواست مجاز به درستی قابل استفاده است. توجه: این پارامتر منحصراً برای شرکای محتوای YouTube در نظر گرفته شده است. پارامتر onBehalfOfContentOwnerChannel شناسه کانال YouTube کانالی را که ویدیویی به آن اضافه می شود مشخص می کند. این پارامتر زمانی مورد نیاز است که یک درخواست مقداری را برای پارامتر onBehalfOfContentOwner مشخص می کند و فقط می تواند در ارتباط با آن پارامتر استفاده شود. علاوه بر این، درخواست باید با استفاده از یک حساب CMS که به مالک محتوایی که پارامتر onBehalfOfContentOwner مشخص میکند مرتبط است، مجاز باشد. در نهایت، کانالی که مقدار پارامتر onBehalfOfContentOwnerChannel مشخص می کند باید به مالک محتوایی که پارامتر onBehalfOfContentOwner مشخص می کند پیوند داده شود.این پارامتر برای شرکای محتوای YouTube در نظر گرفته شده است که کانالهای مختلف YouTube را مالک و مدیریت میکنند. این به صاحبان محتوا اجازه میدهد تا یک بار احراز هویت کنند و اقداماتی را از طرف کانال مشخصشده در مقدار پارامتر انجام دهند، بدون اینکه نیازی به ارائه اعتبارنامه احراز هویت برای هر کانال جداگانه باشد. |
درخواست بدن
یک منبع پخش زنده در بدنه درخواست ارائه دهید. برای آن منبع:
شما باید یک مقدار برای این ویژگی ها مشخص کنید:
-
snippet.title
-
snippet.scheduledStartTime
-
status.privacyStatus
-
شما می توانید مقادیری را برای این ویژگی ها تنظیم کنید:
-
snippet.title
-
snippet.description
-
snippet.scheduledStartTime
-
snippet.scheduledEndTime
-
status.privacyStatus
-
status.selfDeclaredMadeForKids
-
contentDetails.monitorStream.enableMonitorStream
-
contentDetails.monitorStream.broadcastStreamDelayMs
-
contentDetails.enableAutoStart
-
contentDetails.enableAutoStop
-
contentDetails.enableClosedCaptions
-
contentDetails.enableDvr
-
contentDetails.enableEmbed
-
contentDetails.recordFromStart
توجه: جدول ویژگی ، مقادیر پیش فرضی را که برای ویژگی های فهرست شده در بالا تنظیم شده است، مستند می کند. مقادیر پیش فرض در هر یک از موارد زیر اختصاص داده می شود:- شما مقادیری را برای آن ویژگی ها مشخص نمی کنید.
- مقدار پارامتر
part
در درخواست شما بخشی را که حاوی این ویژگی ها است مشخص نمی کند.
-
واکنش
در صورت موفقیت آمیز بودن، این روش یک منبع پخش زنده را در بدنه پاسخ برمی گرداند.
خطاها
جدول زیر پیام های خطایی را مشخص می کند که API می تواند در پاسخ به تماس با این روش بازگرداند. لطفاً برای جزئیات بیشتر به مستندات پیام خطا مراجعه کنید.
نوع خطا | جزئیات خطا | شرح |
---|---|---|
insufficientPermissions | insufficientLivePermissions | درخواست مجاز به ایجاد پخش زنده نیست. |
insufficientPermissions | livePermissionBlocked | کاربری که این درخواست را مجاز کرده است در حال حاضر نمی تواند ویدیوی زنده را در YouTube پخش کند. جزئیاتی که توضیح می دهد چرا کاربر نمی تواند ویدیوی زنده را پخش کند ممکن است در تنظیمات کانال کاربر در https://www.youtube.com/features موجود باشد. |
insufficientPermissions | liveStreamingNotEnabled | کاربری که درخواست را مجاز کرده است، قادر به پخش جریانی ویدیوی زنده در YouTube نیست. کاربر می تواند اطلاعات بیشتر را در https://www.youtube.com/features بیابد. |
invalidValue (400) | invalidAutoStart | منبع liveBroadcast حاوی یک مقدار نامعتبر برای ویژگی contentDetails.enableAutoStart است. همه پخش ها از این تنظیم پشتیبانی نمی کنند. |
invalidValue (400) | invalidAutoStop | منبع liveBroadcast حاوی یک مقدار نامعتبر برای ویژگی contentDetails.enableAutoStop است. شما نمی توانید تنظیمات enableAutoStop را برای پخش مداوم تغییر دهید. |
invalidValue (400) | invalidDescription | منبع liveBroadcast مقدار معتبری برای ویژگی snippet.description مشخص نکرده است. مقدار دارایی می تواند حداکثر 5000 کاراکتر داشته باشد. |
invalidValue (400) | invalidEmbedSetting | منبع liveBroadcast حاوی یک مقدار نامعتبر برای ویژگی contentDetails.enable_embed است. شما نمی توانید این پخش را جاسازی کنید. |
invalidValue (400) | invalidLatencyPreferenceOptions | منبع liveBroadcast حاوی یک مقدار نامعتبر برای ویژگی contentDetails.latencyPreference است. همه تنظیمات با این اولویت تأخیر پشتیبانی نمیشوند. |
invalidValue (400) | invalidPrivacyStatus | منبع liveBroadcast حاوی یک مقدار نامعتبر برای ویژگی status.privacy_status است. |
invalidValue (400) | invalidProjection | منبع liveBroadcast حاوی یک مقدار نامعتبر برای ویژگی contentDetails.projection است. پخش پیش فرض پخش را نمی توان روی 360 تنظیم کرد. |
invalidValue (400) | invalidScheduledEndTime | منبع liveBroadcast حاوی یک مقدار نامعتبر برای ویژگی snippet.scheduledEndTime است. زمان پایان برنامه ریزی شده باید از زمان شروع برنامه ریزی شده پیروی کند. |
invalidValue (400) | invalidScheduledStartTime | منبع liveBroadcast حاوی یک مقدار نامعتبر برای ویژگی snippet.scheduledStartTime است. زمان شروع برنامه ریزی شده باید در آینده باشد و به اندازه کافی به تاریخ فعلی نزدیک باشد که بتوان در آن زمان پخش را به طور قابل اعتماد برنامه ریزی کرد. |
invalidValue (400) | invalidTitle | منبع liveBroadcast مقدار معتبری برای ویژگی snippet.title مشخص نکرده است. مقدار دارایی باید بین 1 تا 100 کاراکتر باشد. |
limitExceeded | userBroadcastsExceedLimit | کاربر پخش زنده یا برنامه ریزی شده زیادی ایجاد کرده است و باید برخی از آنها را متوقف یا حذف کند. |
rateLimitExceeded | userRequestsExceedRateLimit | کاربر در یک بازه زمانی معین درخواست های زیادی ارسال کرده است. |
required (400) | privacyStatusRequired | منبع پخش زنده باید وضعیت حریم خصوصی را مشخص کند. مقادیر معتبر privacyStatus را ببینید. |
required (400) | scheduledEndTimeRequired | منبع liveBroadcast باید ویژگی snippet.scheduledEndTime مشخص کند. |
required (400) | scheduledStartTimeRequired | منبع liveBroadcast باید ویژگی snippet.scheduledStartTime مشخص کند. |
required (400) | titleRequired | منبع liveBroadcast باید ویژگی snippet.title را مشخص کند. |
آن را امتحان کنید!
از APIs Explorer برای فراخوانی این API و مشاهده درخواست و پاسخ API استفاده کنید.