הצגת רשימה של הודעות במרחב המשותף שבו המתקשר חבר, כולל הודעות ממשתמשים שחסמתם וממרחבים משותפים. דוגמה לכך נמצאת במאמר רשימת הודעות. נדרש אימות משתמש.
בקשת HTTP
GET https://chat.googleapis.com/v1/{parent=spaces/*}/messages
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
parent |
חובה. שם המשאב של המרחב המשותף שממנו רוצים להציג את ההודעות. פורמט: |
פרמטרים של שאילתה
פרמטרים | |
---|---|
pageSize |
המספר המקסימלי של הודעות שהוחזרו. השירות עשוי להחזיר פחות הודעות מהערך הזה. אם לא צוין, מוחזרים 25 לכל היותר. הערך המקסימלי הוא 1,000. אם מזינים ערך גדול מ-1,000, הוא משתנה באופן אוטומטי ל-1,000. ערכים שליליים מחזירים שגיאה מסוג |
pageToken |
אופציונלי, אם ממשיכים משאילתה קודמת. אסימון דף שהתקבל מקריאה קודמת של רשימת הודעות. מספקים את הפרמטר הזה כדי לאחזר את הדף הבא. במהלך העימוד, כל הפרמטרים האחרים שצוינו צריכים להתאים לקריאה שסיפקה את אסימון הדף. העברה של ערכים שונים לפרמטרים האחרים עלולה להוביל לתוצאות בלתי צפויות. |
filter |
מסנן שאילתות. אפשר לסנן הודעות לפי תאריך ( כדי לסנן הודעות לפי התאריך שבו הן נוצרו, צריך לציין את כדי לסנן לפי שרשור, צריך לציין את כדי לסנן לפי שרשור וגם לפי תאריך, משתמשים באופרטור לדוגמה, השאילתות הבאות תקינות:
שאילתות לא חוקיות נדחות על ידי השרת עם השגיאה |
orderBy |
אופציונלי, אם ממשיכים משאילתה קודמת. איך מסודרת רשימת ההודעות. ציין ערך להזמנה לפי פעולת הזמנה. אלה הערכים החוקיים של פעולת הזמנה:
סדר ברירת המחדל הוא |
showDeleted |
האם לכלול הודעות שנמחקו. הודעות שנמחקו כוללות את שעת המחיקה ואת המטא-נתונים של המחיקה, אבל תוכן ההודעה לא זמין. |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
הודעת תשובה להודעות רישום.
אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"messages": [
{
object ( |
שדות | |
---|---|
messages[] |
רשימת ההודעות. |
nextPageToken |
ניתן לשלוח אסימון בתור |
היקפי הרשאות
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/chat.import
https://www.googleapis.com/auth/chat.messages
https://www.googleapis.com/auth/chat.messages.readonly
למידע נוסף, עיינו במדריך ההרשאות.