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 מזהה דף ספציפי בקבוצת התוצאות שצריך להחזיר. בתגובת ה-API, המאפיינים nextPageToken ו-prevPageToken מזהים דפים אחרים שניתן לאחזר.

גוף הבקשה

אין לציין את גוף הבקשה בקריאה לשיטה הזו.

תשובה

אם הפעולה בוצעה בהצלחה, השיטה הזו מחזירה גוף תגובה עם המבנה הבא:

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

תכונות

הטבלה הבאה מגדירה את המאפיינים שיופיעו במשאב הזה:

תכונות
kind string
מזהה את הסוג של משאב ה-API. הערך יהיה youtube#liveChatModeratorListResponse.
etag etag
ה-e של המשאב הזה.
prevPageToken string
האסימון שיכול לשמש כערך הפרמטר pageToken כדי לאחזר את הדף הקודם בקבוצת התוצאות.
nextPageToken string
האסימון שיכול לשמש כערך של הפרמטר pageToken כדי לאחזר את הדף הבא בקבוצת התוצאות.
pageInfo object
האובייקט pageInfo כולל את פרטי החלוקה לדפים של קבוצת התוצאות.
pageInfo.totalResults integer
המספר הכולל של התוצאות בקבוצת התוצאות.
pageInfo.resultsPerPage integer
מספר התוצאות שכלולות בתגובת ה-API.
items[] list
רשימה של מנהלי תגובות שתואמים לקריטריונים של הבקשה.

שגיאות

ה-API לא מגדיר הודעות שגיאה ייחודיות לשיטת ה-API הזו. עם זאת, השיטה הזו עדיין יכולה להחזיר שגיאות כלליות של ה-API שמפורטות בתיעוד של הודעת השגיאה.

רוצה לנסות?

משתמשים ב-APIs Explorer כדי לקרוא ל-API הזה ולראות את הבקשה והתגובה של ה-API.