LiveStreams: list

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

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

درخواست

درخواست HTTP

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

صدور مجوز

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

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

پارامترها

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

پارامترها
پارامترهای الزامی
part string
پارامتر part فهرستی از یک یا چند دارایی منبع liveStream را مشخص می‌کند که با کاما از هم جدا شده‌اند و پاسخ «میانای برنامه‌سازی کاربردی» شامل آن‌ها خواهد بود. نام‌های part که می‌توانید در مقدار پارامتر بگنجانید عبارت‌اند از id، snippet، cdn، و status.
فیلترها (دقیقاً یکی از پارامترهای زیر را مشخص کنید)
id string
پارامتر id فهرستی از شناسه‌های جاری‌سازی YouTube را که با کاما از هم جدا شده‌اند و جاری‌سازی‌های درحال بازیابی را مشخص می‌کنند تعیین می‌کند. در منبع liveStream، ویژگی id شناسه جاری‌سازی را مشخص می‌کند.
mine boolean
این پارامتر فقط در درخواست‌های مجاز قابل‌استفاده است. از پارامتر mine می‌توان برای دستور دادن به API برای برگرداندن فقط جاری‌سازی‌های متعلق به کاربر اصالت‌سنجی‌شده استفاده کرد. مقدار پارامتر را روی true تنظیم کنید تا فقط جاری‌سازی‌های خودتان را بازیابی کنید.
پارامترهای اختیاری
maxResults unsigned integer
پارامتر maxResults حداکثر تعداد مواردی را که باید در مجموعه نتایج برگردانده شود مشخص می‌کند. مقادیر پذیرفتنی از 0 تا 50 است. مقدار پیش‌فرض 5 است.
onBehalfOfContentOwner string
از این پارامتر فقط می‌توان در درخواست مجاز مناسب استفاده کرد. توجه: این پارامتر منحصراً برای شرکای محتوای YouTube درنظر گرفته شده است.

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

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

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

متن درخواست

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

پاسخ

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

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

مشخصات

جدول زیر خصوصیات نشان‌داده‌شده در این منبع را تعریف می‌کند:

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

خطاها

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

نوع خطا جزئیات خطا شرح
insufficientPermissions insufficientLivePermissions درخواست برای بازیابی جاری‌سازی زنده مشخص‌شده مجاز نیست.
insufficientPermissions liveStreamingNotEnabled کاربری که درخواست را مجاز کرده است، برای جاری‌سازی ویدیو زنده در YouTube فعال نیست. کاربر می‌تواند اطلاعات بیشتر را در https://www.youtube.com/features پیدا کند.

امتحان کنید!

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