REST Resource: users.sections

Ressource: Abschnitt

Stellt einen Abschnitt in Google Chat dar. Abschnitte helfen Nutzern, ihre Bereiche zu organisieren. Es gibt zwei Arten von Abschnitten:

  1. Systemabschnitte:Das sind vordefinierte Abschnitte, die von Google Chat verwaltet werden. Ihre Ressourcennamen sind festgelegt und sie können nicht erstellt oder gelöscht werden. Außerdem kann ihr displayName nicht geändert werden. Beispiele:

    • users/{user}/sections/default-direct-messages
    • users/{user}/sections/default-spaces
    • users/{user}/sections/default-apps
  2. Benutzerdefinierte Abschnitte:Das sind Abschnitte, die vom Nutzer erstellt und verwaltet werden. Zum Erstellen eines benutzerdefinierten Abschnitts mit sections.create ist ein displayName erforderlich. Benutzerdefinierte Abschnitte können mit sections.patch aktualisiert und mit sections.delete gelöscht werden.

JSON-Darstellung
{
  "name": string,
  "displayName": string,
  "sortOrder": integer,
  "type": enum (SectionType)
}
Felder
name

string

ID. Ressourcenname des Abschnitts.

Bei Systemabschnitten ist die Abschnitts-ID ein konstanter String:

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

Format: users/{user}/sections/{section}

displayName

string

Optional. Anzeigename des Abschnitts. Wird nur für Abschnitte vom Typ CUSTOM_SECTION ausgefüllt. Unterstützt bis zu 80 Zeichen. Erforderlich beim Erstellen eines CUSTOM_SECTION.

sortOrder

integer

Nur Ausgabe. Die Reihenfolge des Abschnitts im Verhältnis zu anderen Abschnitten. Abschnitte mit einem niedrigeren sortOrder-Wert werden vor Abschnitten mit einem höheren Wert angezeigt.

type

enum (SectionType)

Erforderlich. Der Typ des Abschnitts.

SectionType

Abschnittstypen.

Enums
SECTION_TYPE_UNSPECIFIED Nicht angegebener Abschnittstyp.
CUSTOM_SECTION Benutzerdefinierter Abschnitt.
DEFAULT_DIRECT_MESSAGES Standardabschnitt mit DIRECT_MESSAGE zwischen zwei menschlichen Nutzern oder GROUP_CHAT-Bereichen, die zu keinem benutzerdefinierten Abschnitt gehören.
DEFAULT_SPACES Standardbereiche, die zu keinem benutzerdefinierten Abschnitt gehören.
DEFAULT_APPS Standardabschnitt mit den installierten Apps eines Nutzers.

Methoden

create

Erstellt einen Abschnitt in Google Chat.

delete

Löscht einen Abschnitt vom Typ CUSTOM_SECTION.

list

Listet die für den Chat-Nutzer verfügbaren Abschnitte auf.

patch

Aktualisiert einen Abschnitt.

position

Ändert die Sortierreihenfolge eines Abschnitts.