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 是一个常量字符串:

  • 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

更改某个部分的排序顺序。