Method: spaces.messages.list

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

בקשת 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

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