Method: spaces.messages.list

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

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

  • אימות אפליקציות עם אישור אדמין עם היקף ההרשאה:

    • ‫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

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

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

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

enum (MarkupSyntax)

אופציונלי. מציין את תחביר הפלט הרצוי בשדה formattedText של הודעת צ'אט.

גוף הבקשה

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

גוף התשובה

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

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

ייצוג 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

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