LiveChatMessages: list

הצגת רשימה של הודעות צ'אט בשידור חי בצ'אט ספציפי.

כששולחים את הבקשה הראשונה לאחזור הודעות צ'אט, ה-API מחזיר חלק מהיסטוריית הצ'אט או את כולה, בהתאם לאורך ההיסטוריה. ההודעות בתשובה מסודרות מהישן לחדש ביותר.
  • השדה nextPageToken בתגובה מספק אסימון שיזהה את קבוצת התוצאות הבאה שלקוח ה-API שלכם צריך לאחזר בבקשה הבאה.
  • המאפיין pollingIntervalMillis מציין כמה זמן לקוח ה-API צריך להמתין לפני שמבקשים תוצאות נוספות.
כשמבקשים תוצאות נוספות, מגדירים את הפרמטר pageToken לערך nextPageToken ושרת ה-API יחזיר הודעות צ'אט נוספות, אם יש כאלה. שוב, במסגרת קבוצת התוצאות הזו, ההודעות מסודרות מהישן לחדש.

תרחישים נפוצים לדוגמה

בקשה

בקשת HTTP

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

פרמטרים

בטבלה הבאה מפורטים הפרמטרים שנתמכים בשאילתה הזו. כל הפרמטרים הרשומים הם פרמטרים של שאילתות.

פרמטרים
פרמטרים נדרשים
liveChatId string
הפרמטר liveChatId מציין את המזהה של הצ'אט שההודעות שלו יוחזרו. מזהה הצ'אט בשידור חי שמשויך לשידור מוחזר בנכס snippet.liveChatId של המשאב liveBroadcast.
part string
הפרמטר part מציין את חלקי המשאב liveChatMessage שתגובת ה-API תכלול. הערכים הנתמכים הם id, snippet ו-authorDetails.
פרמטרים אופציונליים
hl string
הפרמטר hl מורה ל-API לאחזר מחרוזת תצוגה של מטבע שמותאמת לשוק המקומי לשפת אפליקציה ספציפית שנתמכת באתר YouTube. לדוגמה, באנגלית, המטבע יוצג כ-$1.50, אבל בצרפתית הוא יוצג כ-1,50$.

ערך הפרמטר חייב להיות קוד שפה שנכלל ברשימה שמוחזרת על ידי השיטה i18nLanguages.list.
maxResults unsigned integer
הפרמטר maxResults מציין את מספר ההודעות המקסימלי שצריך להחזיר בקבוצת התוצאות. הערכים הקבילים הם 200 עד 2000, כולל. ערך ברירת המחדל הוא 500.
pageToken string
הפרמטר pageToken מזהה דף ספציפי בקבוצת התוצאות שצריך להחזיר. בתגובה מ-API, המאפיין nextPageToken מזהה דפים אחרים שאפשר לאחזר.
profileImageSize unsigned integer
הפרמטר profileImageSize מציין את הגודל של תמונות הפרופיל של המשתמש שצריך להחזיר בקבוצת התוצאות. התמונות ריבועיות. ערך ברירת המחדל הוא 88. כלומר, התמונות יהיו בגודל 88x88 פיקסלים. הערכים הקבילים הם בטווח של 16 עד 720, כולל.

גוף הבקשה

אין לספק גוף בקשה כשמבצעים קריאה ל-method הזה.

תשובה

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

{
  "kind": "youtube#liveChatMessageListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pollingIntervalMillis": unsigned integer,
  "offlineAt": datetime,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveChatMessage Resource
  ],
  "activePollItem": liveChatMessage Resource
}

מאפיינים

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

מאפיינים
kind string
מזהה את הסוג של משאב ה-API. הערך יהיה youtube#liveChatMessageListResponse.
etag etag
ה-Etag של משאב זה.
nextPageToken string
האסימון שיכול לשמש כערך של הפרמטר pageToken כדי לאחזר את הדף הבא בקבוצת התוצאות.
pollingIntervalMillis unsigned integer
משך הזמן (באלפיות שנייה) שהלקוח צריך להמתין לפני שהוא בודק שוב אם יש הודעות חדשות בצ'אט בשידור חי.
offlineAt datetime
התאריך והשעה שבהם השידור החי המקורי עבר למצב אופליין. הנכס הזה מוצג רק אם מקור הנתונים כבר במצב אופליין. הערך מצוין בפורמט ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
pageInfo object
האובייקט pageInfo כולל פרטי חלוקה לדפים של קבוצת התוצאות.
pageInfo.totalResults integer
המספר הכולל של התוצאות בקבוצת התוצאות.
pageInfo.resultsPerPage integer
מספר התוצאות שכלולות בתגובת ה-API.
items[] list
רשימת הודעות. כל פריט ברשימה הוא משאב liveChatMessage.
activePollItem object
נתוני הסקר בהודעה. כל סקר הוא משאב מסוג liveChatMessage מסוג pollEvent, שמייצג סקר פעיל. לכל צ'אט יכול להיות רק סקר אחד.

שגיאות

הטבלה הבאה מזהה את הודעות השגיאה שה-API יכול להחזיר בתגובה לקריאה ל-method הזה. פרטים נוספים זמינים במסמכים בנושא הודעות שגיאה.

סוג השגיאה פרטי השגיאה תיאור
forbidden (403) forbidden אין לך את ההרשאות הנדרשות כדי לאחזר הודעות בצ'אט בשידור חי שצוין.
forbidden (403) liveChatDisabled צ'אט בשידור חי לא מופעל בשידור שצוין.
forbidden (403) liveChatEnded הצ'אט בשידור חי שצוין כבר לא פעיל.
notFound (404) liveChatNotFound הצ'אט בשידור חי שניסית לאחזר לא נמצא. בודקים את ערך הפרמטר liveChatId של הבקשה כדי לוודא שהוא נכון.
rateLimitExceeded rateLimitExceeded הבקשה נשלחה זמן קצר מדי אחרי הבקשה הקודמת. השגיאה הזו מתקבלת כשבקשות API לאחזור הודעות נשלחות בתדירות גבוהה יותר מקצב הרענון של YouTube, שמבזבז שלא לצורך את רוחב הפס.

נסה בעצמך!

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