LiveChatModerators: list

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

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

درخواست

درخواست HTTP

GET https://www.googleapis.com/youtube/v3/liveChat/moderators

پارامترها

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

پارامترها
پارامترهای الزامی
liveChatId	string پارامتر liveChatId گپ مستقیم YouTube را مشخص می‌کند که API باید گردانندگان را برای آن برگرداند. شناسه گپ مستقیم مرتبط با پخش در ویژگی snippet.liveChatId منبع liveBroadcast برگردانده می‌شود.
part	string پارامتر part بخش‌های منبع liveChatModerator را که پاسخ API شامل آن خواهد بود مشخص می‌کند. مقادیر پشتیبانی‌شده id و snippet است.
پارامترهای اختیاری
maxResults	unsigned integer پارامتر maxResults حداکثر تعداد مواردی را که باید در مجموعه نتایج برگردانده شود مشخص می‌کند. مقادیر پذیرفتنی از 0 تا 50 (شامل این دو عدد) است. مقدار پیش‌فرض 5 است.
pageToken	string پارامتر pageToken صفحه خاصی را در مجموعه نتایج که باید برگردانده شود شناسایی می‌کند. در پاسخ میانای برنامه‌سازی کاربردی، ویژگی‌های nextPageToken و prevPageToken صفحه‌های دیگری را که می‌توان بازیابی کرد شناسایی می‌کنند.

متن درخواست

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

پاسخ

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

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

مشخصات

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

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

خطاها

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

امتحان کنید!

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