LiveBroadcasts: list

فهرستی از پخش‌های YouTube را برمی‌گرداند که با پارامترهای درخواست API مطابقت دارند.

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

درخواست

درخواست HTTP

GET https://www.googleapis.com/youtube/v3/liveBroadcasts

مجوز

این درخواست نیاز به مجوز با حداقل یکی از حوزه های زیر دارد. برای مطالعه بیشتر درباره احراز هویت و مجوز، به اجرای احراز هویت OAuth 2.0 مراجعه کنید.

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

مولفه های

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

مولفه های
پارامترهای مورد نیاز
part string
پارامتر part یک لیست جدا شده با کاما از یک یا چند ویژگی منبع liveBroadcast را مشخص می کند که پاسخ API شامل می شود. نام part که می توانید در مقدار پارامتر وارد کنید عبارتند از id , snippet , contentDetails , monetizationDetails و status .
فیلترها (دقیقا یکی از پارامترهای زیر را مشخص کنید)
broadcastStatus string
پارامتر broadcastStatus پاسخ API را فیلتر می کند تا فقط پخش هایی با وضعیت مشخص شده را شامل شود.

مقادیر قابل قبول عبارتند از:
  • active - پخش زنده جاری را برگردانید.
  • all - همه پخش ها را برگردانید.
  • completed - پخش پخش هایی که قبلاً به پایان رسیده است را بازگردانید.
  • upcoming - پخش پخش‌هایی که هنوز شروع نشده‌اند را بازگردانید.
id string
پارامتر id فهرستی از شناسه‌های پخش YouTube جدا شده با کاما را مشخص می‌کند که پخش‌های در حال بازیابی را مشخص می‌کند. در یک منبع liveBroadcast ، ویژگی id شناسه پخش را مشخص می کند.
mine boolean
پارامتر mine را می توان برای دستور دادن به API استفاده کرد که فقط پخش های متعلق به کاربر تأیید شده را برگرداند. مقدار پارامتر را روی true تنظیم کنید تا فقط پخش های خود را بازیابی کنید.
پارامترهای اختیاری
broadcastType string
پارامتر broadcastType پاسخ API را فیلتر می کند تا فقط پخش هایی با نوع مشخص شده را شامل شود. این پارامتر باید در درخواست هایی استفاده شود که پارامتر mine را روی true تنظیم می کنند یا از پارامتر broadcastStatus استفاده می کنند. مقدار پیش فرض event است.

مقادیر قابل قبول عبارتند از:
  • all - همه پخش ها را برگردانید.
  • event - فقط پخش رویدادهای برنامه ریزی شده را برگردانید.
  • persistent - فقط پخش مداوم را برگردانید.
maxResults unsigned integer
پارامتر maxResults حداکثر تعداد مواردی را که باید در مجموعه نتایج برگردانده شوند را مشخص می کند. مقادیر قابل قبول شامل 0 تا 50 است. مقدار پیش فرض 5 است.
onBehalfOfContentOwner string
این پارامتر فقط در یک درخواست مجاز به درستی قابل استفاده است.
توجه: این پارامتر منحصراً برای شرکای محتوای YouTube در نظر گرفته شده است.

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

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

این پارامتر برای شرکای محتوای YouTube در نظر گرفته شده است که کانال‌های مختلف YouTube را مالک و مدیریت می‌کنند. این به صاحبان محتوا اجازه می‌دهد تا یک بار احراز هویت کنند و اقداماتی را از طرف کانال مشخص‌شده در مقدار پارامتر انجام دهند، بدون اینکه نیازی به ارائه اعتبارنامه احراز هویت برای هر کانال جداگانه باشد.
pageToken string
پارامتر pageToken صفحه خاصی را در مجموعه نتایج مشخص می کند که باید برگردانده شود. در یک پاسخ API، ویژگی های nextPageToken و prevPageToken صفحات دیگری را شناسایی می کنند که می توانند بازیابی شوند.

درخواست بدن

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

واکنش

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

{
  "kind": "youtube#liveBroadcastListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveBroadcast Resource
  ]
}

خواص

جدول زیر ویژگی های ظاهر شده در این منبع را تعریف می کند:

خواص
kind string
نوع منبع API را مشخص می کند. مقدار youtube#liveBroadcastListResponse خواهد بود.
etag etag
Etag این منبع
nextPageToken string
نشانه ای که می تواند به عنوان مقدار پارامتر pageToken برای بازیابی صفحه بعدی در مجموعه نتایج استفاده شود.
prevPageToken string
نشانه ای که می تواند به عنوان مقدار پارامتر pageToken برای بازیابی صفحه قبلی در مجموعه نتایج استفاده شود.
pageInfo object
شی pageInfo اطلاعات صفحه‌بندی را برای مجموعه نتایج کپسوله می‌کند.
pageInfo. totalResults integer
تعداد کل نتایج در مجموعه نتایج.
pageInfo. resultsPerPage integer
تعداد نتایج موجود در پاسخ API.
items[] list
فهرستی از پخش هایی که با معیارهای درخواست مطابقت دارند.

خطاها

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

نوع خطا جزئیات خطا شرح
insufficientPermissions insufficientLivePermissions درخواست برای بازیابی پخش زنده مجاز نیست.
insufficientPermissions liveStreamingNotEnabled کاربری که درخواست را مجاز کرده است، قادر به پخش جریانی ویدیوی زنده در YouTube نیست. برای اطلاعات بیشتر، واجد شرایط بودن ویژگی را ببینید.

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

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