REST Resource: users.sections

リソース: Section

Google Chat のセクションを表します。セクションを使用すると、スペースを整理できます。セクションには次の 2 種類があります。

  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

ID。セクションのリソース名。

システム セクションの場合、セクション ID は定数文字列です。

  • 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

セクションの種類。

列挙型
SECTION_TYPE_UNSPECIFIED セクション タイプが指定されていません。
CUSTOM_SECTION カスタム セクション。
DEFAULT_DIRECT_MESSAGES 2 人のユーザー間の DIRECT_MESSAGE またはカスタム セクションに属していない GROUP_CHAT スペースを含むデフォルト セクション。
DEFAULT_SPACES カスタム セクションに属していないデフォルトのスペース。
DEFAULT_APPS ユーザーのインストール済みアプリを含むデフォルトのセクション。

メソッド

create

 Google Chat にセクションを作成します。

delete

 CUSTOM_SECTION 型のセクションを削除します。

list

 Chat ユーザーが利用できるセクションを一覧表示します。

patch

 セクションを更新します。

position

 セクションの並べ替え順序を変更します。