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 )

Обязательно. Тип раздела.

Тип раздела

Типы разделов.

Перечисления
SECTION_TYPE_UNSPECIFIED Тип раздела не указан.
CUSTOM_SECTION Пользовательский раздел.
DEFAULT_DIRECT_MESSAGES Раздел по умолчанию, содержащий сообщения DIRECT_MESSAGE между двумя пользователями или групповые чаты GROUP_CHAT , не относящиеся ни к одному из пользовательских разделов.
DEFAULT_SPACES Пространства по умолчанию, не относящиеся ни к одному пользовательскому разделу.
DEFAULT_APPS Раздел по умолчанию, содержащий установленные пользователем приложения.

Методы

create

Создает раздел в Google Чате.

delete

Удаляет раздел типа CUSTOM_SECTION .

list

Отображает разделы, доступные пользователю чата.

patch

Обновляет раздел.

position

Изменяет порядок сортировки раздела.