דף זה תורגם על ידי Cloud Translation API.

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` ה-e של המשאב הזה.
`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.