Method: spaces.messages.list

הפונקציה מחזירה רשימה של הודעות במרחב שהמתקשר הוא חבר בו, כולל הודעות מחברים וממרחבים חסומים. הודעות מערכת, כמו הודעות על הצטרפות של חברים חדשים למרחב, לא נכללות. אם מנסים להציג הודעות מחלל שאין בו הודעות, התשובה היא אובייקט ריק. כשמשתמשים בממשק REST/HTTP, התגובה מכילה אובייקט JSON ריק, {}. דוגמה מופיעה במאמר רשימת הודעות.

יש תמיכה בסוגי האימות הבאים:

  • אימות אפליקציות עם אישור אדמין בגרסת Developer Preview עם היקף ההרשאה:

    • ‫https://www.googleapis.com/auth/chat.app.messages.readonly. כשמשתמשים בהיקף האימות הזה, השיטה הזו מחזירה רק הודעות ציבוריות במרחב. הוא לא כולל הודעות פרטיות.

  • אימות משתמש עם אחת מהרשאות הגישה הבאות:

    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • ‫https://www.googleapis.com/auth/chat.import (רווחים במצב ייבוא בלבד)

בקשת HTTP

GET https://chat.googleapis.com/v1/{parent=spaces/*}/messages

כתובת ה-URL משתמשת בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
parent

string

חובה. שם המשאב של המרחב שממנו רוצים להציג את רשימת ההודעות.

פורמט: spaces/{space}

פרמטרים של שאילתה

פרמטרים
pageSize

integer

אופציונלי. המספר המקסימלי של ההודעות שמוחזרות. יכול להיות שהשירות יחזיר פחות הודעות מהערך הזה.

אם לא מציינים מספר, מוחזרות לכל היותר 25 תוצאות.

הערך המקסימלי הוא 1,000. אם משתמשים בערך גבוה מ-1,000, הוא משתנה אוטומטית ל-1,000.

ערכים שליליים מחזירים שגיאה מסוג INVALID_ARGUMENT.
pageToken

string

אופציונלי. אסימון דף שהתקבל מקריאה קודמת של list messages. צריך לציין את הפרמטר הזה כדי לאחזר את הדף הבא.

כשמבצעים חלוקה לעמודים, כל שאר הפרמטרים שצוינו צריכים להיות זהים לקריאה שסיפקה את טוקן הדף. העברת ערכים שונים לפרמטרים האחרים עלולה להוביל לתוצאות לא צפויות.
filter

string

אופציונלי. מסנן שאילתות.

אפשר לסנן הודעות לפי תאריך (createTime) ושרשור (thread.name).

כדי לסנן הודעות לפי תאריך היצירה שלהן, מציינים את createTime עם חותמת זמן בפורמט RFC-3339 ומרכאות כפולות. לדוגמה, "2023-04-21T11:30:00-04:00". אפשר להשתמש באופרטור גדול מ- > כדי להציג רשימה של הודעות שנוצרו אחרי חותמת זמן, או באופרטור קטן מ- < כדי להציג רשימה של הודעות שנוצרו לפני חותמת זמן. כדי לסנן הודעות בטווח זמן מסוים, משתמשים באופרטור AND בין שני חותמות זמן.

כדי לסנן לפי שרשור, מציינים את thread.name, בפורמט spaces/{space}/threads/{thread}. אפשר לציין רק thread.name אחד לכל שאילתה.

כדי לסנן לפי שרשור ותאריך, משתמשים באופרטור AND בשאילתה.

לדוגמה, השאילתות הבאות הן חוקיות:

createTime > "2012-04-21T11:30:00-04:00"

createTime > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

createTime > "2012-04-21T11:30:00+00:00" AND

createTime < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

השרת דוחה שאילתות לא חוקיות עם שגיאת INVALID_ARGUMENT.
orderBy

string

אופציונלי. איך מסודרת רשימת ההודעות. מציינים ערך כדי להגדיר סדר באמצעות פעולת הזמנה. הערכים התקינים של פעולת ההזמנה הם:

  • ‫ASC לסדר עולה.

  • ‫DESC לסדר יורד.

סדר ברירת המחדל הוא createTime ASC.
showDeleted

boolean

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

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

הודעת תגובה להודעות של כרטיס מוצר.

אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string
}
שדות
messages[]

object (Message)

רשימת ההודעות.
nextPageToken

string

אפשר לשלוח אסימון בתור pageToken כדי לאחזר את דף התוצאות הבא. אם השדה ריק, אין דפים נוספים.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly

מידע נוסף זמין במדריך ההרשאות.