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, כלומר התמונות יהיו בגודל 88 פיקסלים על 88 פיקסלים. הערכים הקבילים הם בטווח 16 עד 720, כולל.

גוף הבקשה

אין להזין גוף בקשה בעת הפעלת שיטה זו.

תשובה

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

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

נכסים

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

נכסים
kind string
מזהה את סוג המשאב של ה-API. הערך יהיה youtube#liveChatMessageListResponse.
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.

שגיאות

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

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

רוצה לנסות?

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