Method: spaces.messages.list

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

נדרש אימות משתמש.

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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

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