Method: spaces.messagePins.list

רשימה של הודעות מוצמדות במרחב. המשתמשים יכולים להצמיד הודעות חשובות במרחבים כדי לגשת אליהן בקלות. מידע נוסף זמין במאמר בנושא הצמדה של שיחות ב-Google Chat וביטול ההצמדה שלהן.

נדרש אימות משתמש עם אחת מהרשאות הגישה הבאות:

  • https://www.googleapis.com/auth/chat.spaces.pins.readonly
  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

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

פרמטרים
parent

string

חובה. המרחב הראשי שאליו שייך אוסף הפריטים המוצמדים. הפורמט: spaces/{space}

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

פרמטרים
pageSize

integer

אופציונלי. המספר המקסימלי של הודעות מוצמדות שיוחזרו. יכול להיות שהשירות יחזיר פחות הודעות מהערך הזה. הערך המקסימלי הוא 100. אם משתמשים בערך גבוה מ-100, הוא משתנה אוטומטית ל-100. אם לא מציינים ערך, יוחזרו לכל היותר 100 הודעות מוצמדות. ערכים שליליים מחזירים שגיאה מסוג INVALID_ARGUMENT.
pageToken

string

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

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

גוף הבקשה

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

גוף התשובה

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

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

ייצוג ב-JSON 
{
  "messagePins": [
    {
      object (MessagePin)
    }
  ],
  "nextPageToken": string
}
שדות
messagePins[]

object (MessagePin)

ההודעות המוצמדות מהמרחב שצוין.
nextPageToken

string

אפשר לשלוח טוקן כ-pageToken כדי לאחזר את דף התוצאות הבא. אם השדה ריק, לא יופיעו דפים נוספים.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces.pins.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly

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