REST Resource: users.sections

Zasób: Section

Reprezentuje sekcję w Google Chat. Sekcje pomagają użytkownikom organizować pokoje. Istnieją 2 rodzaje sekcji:

  1. Sekcje systemowe: są to wstępnie zdefiniowane sekcje zarządzane przez Google Chat. Ich nazwy zasobów są stałe i nie można ich tworzyć, usuwać ani modyfikować displayName. Przykłady:

    • users/{user}/sections/default-direct-messages
    • users/{user}/sections/default-spaces
    • users/{user}/sections/default-apps
  2. Sekcje niestandardowe: sekcje tworzone i zarządzane przez użytkownika. Tworzenie sekcji niestandardowej za pomocą sections.create wymaga displayName. Sekcje niestandardowe można aktualizować za pomocą metody sections.patch i usuwać za pomocą metody sections.delete.

Zapis JSON
{
  "name": string,
  "displayName": string,
  "sortOrder": integer,
  "type": enum (SectionType)
}
Pola
name

string

Identyfikator. Nazwa zasobu sekcji.

W przypadku sekcji systemowych identyfikator sekcji jest stałym ciągiem znaków:

  • 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

Wymagane. Wyświetlana nazwa sekcji. Wartość podawana tylko w przypadku sekcji typu CUSTOM_SECTION. Może zawierać maksymalnie 80 znaków. Wymagane podczas tworzenia CUSTOM_SECTION.

sortOrder

integer

Tylko dane wyjściowe. Kolejność sekcji w stosunku do innych sekcji. Sekcje o niższej wartości sortOrder są wyświetlane przed sekcjami o wyższej wartości.

type

enum (SectionType)

Wymagane. Typ sekcji.

SectionType

Typy sekcji.

Wartości w polu enum
SECTION_TYPE_UNSPECIFIED Nieokreślony typ sekcji.
CUSTOM_SECTION Sekcja niestandardowa.
DEFAULT_DIRECT_MESSAGES Sekcja domyślna zawierająca DIRECT_MESSAGE między 2 użytkownikami lub pokoje GROUP_CHAT, które nie należą do żadnej sekcji niestandardowej.
DEFAULT_SPACES Domyślne miejsca, które nie należą do żadnej sekcji niestandardowej.
DEFAULT_APPS Sekcja domyślna zawierająca zainstalowane aplikacje użytkownika.

Metody

create

Tworzy sekcję w Google Chat.

delete

Usuwa sekcję typu CUSTOM_SECTION.

list

Wyświetla sekcje dostępne dla użytkownika Chatu.

patch

Aktualizuje sekcję.

position

Zmienia kolejność sortowania sekcji.