REST Resource: users.sections

משאב: קטע

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

  1. קטעי מערכת: אלה קטעים מוגדרים מראש שמנוהלים על ידי Google Chat. שמות המשאבים שלהם קבועים, ואי אפשר ליצור, למחוק או לשנות את displayName שלהם. דוגמאות:

    • users/{user}/sections/default-direct-messages
    • users/{user}/sections/default-spaces
    • users/{user}/sections/default-apps

  2. קטעים בהתאמה אישית: אלה קטעים שהמשתמש יצר ומנהל. כדי ליצור מדור בהתאמה אישית באמצעות sections.create צריך displayName. אפשר לעדכן קטעים בהתאמה אישית באמצעות sections.patch ולמחוק אותם באמצעות sections.delete.

ייצוג ב-JSON 
{
  "name": string,
  "displayName": string,
  "sortOrder": integer,
  "type": enum (SectionType)
}
שדות
name

string

מזהה. שם המשאב של הקטע.

בקטעי מערכת, מזהה הקטע הוא מחרוזת קבועה:

  • DEFAULT_DIRECT_MESSAGES: users/{user}/sections/default-direct-messages
  • DEFAULT_SPACES: users/{user}/sections/default-spaces
  • DEFAULT_APPS: users/{user}/sections/default-apps

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

string

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

integer

פלט בלבד. הסדר של הקטע ביחס לקטעים אחרים. קטעים עם ערך sortOrder נמוך יותר מופיעים לפני קטעים עם ערך גבוה יותר.
type

enum (SectionType)

חובה. סוג האוסף.

SectionType

סוגי אוספים.

טיפוסים בני מנייה (enum)
SECTION_TYPE_UNSPECIFIED סוג הקטע לא צוין.
CUSTOM_SECTION מדור מותאם אישית.
DEFAULT_DIRECT_MESSAGES הקטע שמוגדר כברירת מחדל מכיל DIRECT_MESSAGE בין שני משתמשים אנושיים או חללים של GROUP_CHAT שלא שייכים לאף קטע מותאם אישית.
DEFAULT_SPACES רווחים שמוגדרים כברירת מחדל ולא שייכים לאף קטע בהתאמה אישית.
DEFAULT_APPS הקטע שמוגדר כברירת מחדל ומכיל את האפליקציות המותקנות של המשתמש.

Methods

create

 יצירת קטע ב-Google Chat.

delete

 מוחק קטע מסוג CUSTOM_SECTION.

list

 רשימה של החלקים שזמינים למשתמש ב-Chat.

patch

 עדכון של קטע.

position

 שינוי סדר המיון של קטע.