Method: spaces.messages.list

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

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

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

פרמטרים
parent

string

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

פורמט: spaces/{space}

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

פרמטרים
pageSize

integer

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

אם לא צוין, יוחזרו 25 לכל היותר.

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

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

string

אופציונלי, אם ממשיכים משאילתה קודמת.

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

במהלך החלוקה לדפים, כל הפרמטרים האחרים שצוינו צריכים להתאים לקריאה שסיפקה את אסימון הדף. העברה של ערכים שונים לפרמטרים האחרים עלולה להוביל לתוצאות בלתי צפויות.
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

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