Method: users.sections.list

רשימה של החלקים שזמינים למשתמש ב-Chat. הקטעים עוזרים למשתמשים לקבץ את השיחות שלהם ולהתאים אישית את רשימת המרחבים שמוצגת בחלונית הניווט ב-Chat. פרטים נוספים זמינים במאמר איך יוצרים חלקים ועושים סדר ב-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

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

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

פרמטרים
parent

string

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

  • הכינוי me. לדוגמה, users/me.

  • כתובת האימייל שלהם ב-Workspace. לדוגמה, users/user@example.com.

  • מזהה המשתמש שלהם. לדוגמה, users/123456789.

פורמט: users/{user}

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

פרמטרים
pageSize

integer

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

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

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

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

string

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

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

גוף הבקשה

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

גוף התשובה

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

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

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

object (Section)

הקטעים מהמשתמש שצוין.
nextPageToken

string

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

היקפי הרשאה

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

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

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