Method: users.sections.items.list

רשימת הפריטים באוסף.

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

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

  • https://www.googleapis.com/auth/chat.users.sections
  • https://www.googleapis.com/auth/chat.users.sections.readonly

בקשת HTTP

GET https://chat.googleapis.com/v1/{parent=users/*/sections/*}/items

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

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

פרמטרים
parent

string

חובה. המאפיין parent (הורה) הוא שם משאב הקטע שמכיל את אוסף פריטי הקטע הזה. האפשרות הזו תומכת רק בפריטים של קטע כרטיס המוצר עבור המשתמש שמבצע את השיחה.

פורמט: users/{user}/sections/{section}

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

פרמטרים
pageSize

integer

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

אם לא מציינים ערך, יוחזרו לכל היותר 10 פריטים של קטע.

הערך המקסימלי הוא 100. אם משתמשים בערך גבוה מ-100, הוא משתנה אוטומטית ל-100.

ערכים שליליים מחזירים שגיאה מסוג INVALID_ARGUMENT.
pageToken

string

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

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

string

אופציונלי. מסנן שאילתות.

בשלב הזה, אפשר לסנן רק לפי מרחב.

לדוגמה, space = spaces/{space}.

שאילתות לא תקינות נדחות עם השגיאה INVALID_ARGUMENT.

גוף הבקשה

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

גוף התשובה

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

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

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

object (SectionItem)

הפריטים בקטע מהקטע שצוין.
nextPageToken

string

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

היקפי הרשאה

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

  • https://www.googleapis.com/auth/chat.users.sections
  • https://www.googleapis.com/auth/chat.users.sections.readonly

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