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 را مشخص می‌کند که با کاما از هم جدا شده‌اند و پاسخ «میانای برنامه‌سازی کاربردی» شامل آن‌ها خواهد بود. نام‌های part که می‌توانید در مقدار پارامتر اضافه کنید عبارت‌اند از id، snippet، contentDetails، monetizationDetails، و status.
فیلترها (دقیقاً یکی از پارامترهای زیر را مشخص کنید)
broadcastStatus string
پارامتر broadcastStatus پاسخ میانای برنامه‌سازی کاربردی را فیلتر می‌کند تا فقط شامل همه‌فرستی‌هایی با وضعیت مشخص‌شده باشد.

مقادیر قابل‌قبول عبارتند از:
  • 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
نوع منبع میانای برنامه‌سازی کاربردی را مشخص می‌کند. مقدار youtube#liveBroadcastListResponse خواهد بود.
etag etag
Etag این منبع.
nextPageToken string
رمزی که می‌تواند به‌عنوان مقدار پارامتر pageToken برای بازیابی صفحه بعدی در مجموعه نتایج استفاده شود.
prevPageToken string
نشانه‌ای که می‌تواند به‌عنوان مقدار پارامتر pageToken برای بازیابی صفحه قبلی در مجموعه نتایج استفاده شود.
pageInfo object
شیء pageInfo اطلاعات صفحه‌بندی را برای مجموعه نتایج کپسوله می‌کند.
pageInfo.totalResults integer
تعداد کل نتایج در مجموعه نتایج.
pageInfo.resultsPerPage integer
تعداد نتایج گنجانده‌شده در پاسخ «میانای برنامه کاربردی».
items[] list
فهرستی از همه‌فرستی‌هایی که با معیارهای درخواست مطابقت دارند.

خطاها

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

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

امتحان کنید!

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