REST Resource: users.sections

資源：Section

代表 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

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 預設區段，包含兩位使用者之間的 DIRECT_MESSAGE 或不屬於任何自訂區段的 GROUP_CHAT 聊天室。
DEFAULT_SPACES 不屬於任何自訂專區的預設空間。
DEFAULT_APPS 預設部分，內含使用者安裝的應用程式。

方法

create

 在 Google Chat 中建立專區。

delete

 刪除 CUSTOM_SECTION 類型的章節。

list

 列出 Chat 使用者可用的區段。

patch

 更新區段。

position

 變更區段的排序順序。