Package google.chat.v1

索引

ChatService

让开发者能够在 Google Chat 平台上构建 Chat 应用和集成。

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

完成指定聊天室的导入流程，并使其对用户可见。

需要应用身份验证和全网域授权。如需了解详情，请参阅授权 Google Chat 应用导入数据。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/chat.import

如需了解详情，请参阅授权指南。
CreateCustomEmoji

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

创建自定义表情符号。

需要用户身份验证。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/chat.customemojis

如需了解详情，请参阅授权指南。
CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

为发起通话的 Chat 应用、用户或 Google 群组创建会员资格。不支持为其他 Chat 应用创建会员资格。创建会员资格时，如果指定会员的自动接受政策处于关闭状态，那么在收到邀请后，他们必须先接受聊天室邀请，然后才能加入。否则，创建会员资格会直接将成员添加到指定聊天室。

支持以下类型的身份验证：

如需查看使用示例，请参阅：

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

如需了解详情，请参阅授权指南。
CreateMessage

rpc CreateMessage(CreateMessageRequest) returns (Message)

在 Google Chat 聊天室中创建消息。如需查看示例，请参阅发送消息。

create() 方法需要进行用户身份验证或应用身份验证。Chat 会根据您在请求中使用的身份验证类型，以不同的方式为消息发件人分配属性。

下图展示了 Chat 在您使用应用身份验证时如何为消息添加属性。Chat 会将 Chat 应用显示为消息发件人。消息内容可以包含文本 (text)、卡片 (cardsV2) 和配件微件 (accessoryWidgets)。

使用应用身份验证发送的邮件

下图展示了 Chat 在您使用用户身份验证时如何归因消息。Chat 会将用户显示为消息发送者，并通过显示其名称将 Chat 应用归因于消息。消息内容只能包含文本 (text)。

通过用户身份验证发送的邮件

邮件大小（包括邮件内容）上限为 32,000 字节。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

如需了解详情，请参阅授权指南。
CreateReaction

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

创建回应并将其添加到消息中。仅支持 Unicode 表情符号。如需查看示例，请参阅对消息添加回应。

需要用户身份验证。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.create

如需了解详情，请参阅授权指南。
CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space)

创建聊天室。可用于在 Import mode 中创建命名聊天室或群聊。如需查看示例，请参阅创建聊天室。

支持以下类型的身份验证：

以应用身份进行身份验证时，必须在请求中设置 space.customer 字段。

聊天室在创建时的成员资格取决于聊天室是在 Import mode 中创建的：

  • 导入模式：系统不会创建任何成员。
  • 所有其他模式：系统会将发起通话的用户添加为成员。具体如下：
    • 使用应用身份验证时，应用本身。
    • 使用用户身份验证时的人为用户。

如果您在创建聊天室时收到错误消息 ALREADY_EXISTS，请尝试使用其他 displayName。Google Workspace 组织中现有的聊天室可能已使用此显示名称。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.app.spaces.create
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

如需了解详情，请参阅授权指南。
DeleteCustomEmoji

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty)

删除自定义表情符号。

需要用户身份验证。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/chat.customemojis

如需了解详情，请参阅授权指南。
DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

删除会员资格。如需查看示例，请参阅从聊天室中移除用户或 Google Chat 应用。

支持以下类型的身份验证：

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

如需了解详情，请参阅授权指南。
DeleteMessage

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

删除消息。如需查看示例，请参阅删除消息。

支持以下类型的身份验证：

使用应用身份验证时，请求只能删除发起调用的 Chat 应用创建的消息。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

如需了解详情，请参阅授权指南。
DeleteReaction

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

删除对消息的回应。仅支持 Unicode 表情符号。如需查看示例，请参阅删除回应。

需要用户身份验证。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions

如需了解详情，请参阅授权指南。
DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

删除命名空间。始终执行级联删除，这意味着聊天室的子资源（例如在聊天室中发布的消息和聊天室中的成员资格）也会被删除。有关示例，请参阅删除聊天室。

支持以下类型的身份验证：

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.app.delete
  • https://www.googleapis.com/auth/chat.admin.delete
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.delete

如需了解详情，请参阅授权指南。
FindDirectMessage

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

返回与指定用户的现有私信。如果找不到直接消息空间，则返回 404 NOT_FOUND 错误。如需查看示例，请参阅查找私信。

在进行应用身份验证的情况下，返回指定用户与调用 Chat 应用之间的私信聊天室。

在进行用户身份验证后，返回指定用户与经过身份验证的用户之间的私信空间。

// Supports the following types of authentication:

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

如需了解详情，请参阅授权指南。
GetAttachment

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

获取邮件附件的元数据。系统会使用 media API 提取附件数据。如需查看示例，请参阅获取邮件附件相关元数据。需要应用身份验证。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/chat.bot

如需了解详情，请参阅授权指南。
GetCustomEmoji

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

返回自定义表情符号的详细信息。

需要用户身份验证。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.customemojis
  • https://www.googleapis.com/auth/chat.customemojis.readonly

如需了解详情，请参阅授权指南。
GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership)

返回会员资格的详细信息。如需查看示例，请参阅详细了解用户或 Google Chat 应用的会员资格。

支持以下类型的身份验证：

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

如需了解详情，请参阅授权指南。
GetMessage

rpc GetMessage(GetMessageRequest) returns (Message)

返回消息的详细信息。如需查看示例，请参阅获取消息的详细信息。

支持以下类型的身份验证：

注意：可能会返回来自已屏蔽成员或聊天室的消息。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

如需了解详情，请参阅授权指南。
GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space)

返回聊天室的详细信息。如需示例，请参阅获取聊天室的详细信息。

支持以下类型的身份验证：

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.app.spaces

如需了解详情，请参阅授权指南。
GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

返回 Google Chat 聊天室中的事件。事件载荷包含发生更改的资源的最新版本。例如，如果您请求有关新消息的事件，但该消息后来被更新了，服务器会在事件载荷中返回更新后的 Message 资源。

注意：此请求的聊天室事件数据的聊天室对象中不会返回 permissionSettings 字段。

需要用户身份验证。如需获取事件，经过身份验证的用户必须是聊天室的成员。

如需查看示例，请参阅从 Google Chat 聊天室获取事件的详细信息。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

如需了解详情，请参阅授权指南。
GetSpaceNotificationSetting

rpc GetSpaceNotificationSetting(GetSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

获取聊天室通知状态设置。

需要用户身份验证。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/chat.users.spacesettings

如需了解详情，请参阅授权指南。
GetSpaceReadState

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

返回用户在聊天室中的阅读状态的详细信息，用于识别已读和未读消息。如需查看示例，请参阅获取有关用户聊天室读取状态的详细信息。

需要用户身份验证。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

如需了解详情，请参阅授权指南。
GetThreadReadState

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

返回有关用户在会话中的阅读状态的详细信息，用于识别已读和未读消息。如需查看示例，请参阅详细了解用户的会话读取状态。

需要用户身份验证。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

如需了解详情，请参阅授权指南。
ListCustomEmojis

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse)

列出向已通过身份验证的用户显示的自定义表情符号。

需要用户身份验证。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.customemojis
  • https://www.googleapis.com/auth/chat.customemojis.readonly

如需了解详情，请参阅授权指南。
ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

列出聊天室中的成员资格。如需查看示例，请参阅列出聊天室中的用户和 Google Chat 应用。使用应用身份验证列出成员资格时，系统会列出 Chat 应用有权访问的聊天室中的成员资格，但会排除 Chat 应用的成员资格（包括 Chat 应用自己的成员资格）。使用用户身份验证列出会员资格会列出已通过身份验证的用户有权访问的聊天室中的会员资格。

支持以下类型的身份验证：

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

如需了解详情，请参阅授权指南。
ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

列出调用方所属聊天室中的消息，包括来自已屏蔽成员和聊天室的消息。如果您列出没有消息的聊天室中的消息，则响应为空对象。使用 REST/HTTP 接口时，响应包含一个空 JSON 对象 {}。如需查看示例，请参阅列出消息。

需要用户身份验证。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

如需了解详情，请参阅授权指南。
ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

列出对某条消息的回应。如需查看示例，请参阅列出消息的回应。

需要用户身份验证。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

如需了解详情，请参阅授权指南。
ListSpaceEvents

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

列出 Google Chat 聊天室中的事件。对于每项事件，载荷都包含最新版本的 Chat 资源。例如，如果您列出与新聊天室成员有关的事件，服务器会返回包含最新会员详细信息的 Membership 资源。如果在请求的时间段内移除了新成员，事件载荷将包含一个空的 Membership 资源。

需要用户身份验证。如需列出活动，经过身份验证的用户必须是聊天室的成员。

如需查看示例，请参阅列出 Google Chat 聊天室中的事件。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

如需了解详情，请参阅授权指南。
ListSpaces

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse)

列出调用方所属的聊天室。群聊和私信只有在发送第一条消息后才会列出。如需查看示例，请参阅列出聊天室。

支持以下类型的身份验证：

如需按 Google Workspace 组织列出所有命名聊天室，请改用 Workspace 管理员权限使用 spaces.search() 方法。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

如需了解详情，请参阅授权指南。
SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

根据管理员的搜索返回 Google Workspace 组织中的聊天室列表。

需要具有管理员权限的用户进行身份验证。在请求中，将 use_admin_access 设置为 true。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly

如需了解详情，请参阅授权指南。
SetUpSpace

rpc SetUpSpace(SetUpSpaceRequest) returns (Space)

创建聊天室并向其中添加指定用户。系统会自动将发起调用的用户添加到聊天室，因此不应在请求中将其指定为成员。如需查看示例，请参阅设置包含初始成员的聊天室。

如需指定要添加的真人成员，请使用适当的 membership.member.name 添加成员资格。如需添加真人用户，请使用 users/{user}，其中 {user} 可以是用户的电子邮件地址。对于同一 Workspace 组织中的用户，{user} 还可以是 People API 中人员的 id，或 Directory API 中用户的 id。例如，如果 user@example.com 的 People API 人员个人资料 ID 为 123456789，您可以将 membership.member.name 设置为 users/user@example.com 或 users/123456789，将该用户添加到聊天室。

如需指定要添加的 Google 群组，请使用相应的 membership.group_member.name 添加成员资格。如需添加或邀请 Google 群组，请使用 groups/{group}，其中 {group} 是 Cloud Identity Groups API 中相应群组的 id。例如，您可以使用 Cloud Identity Groups lookup API 检索群组电子邮件地址 group@example.com 的 ID 123456789，然后通过将 membership.group_member.name 设置为 groups/123456789 将群组添加到聊天室。不支持群组电子邮件地址，并且 Google 群组只能作为成员添加到命名聊天室中。

对于命名聊天室或群聊，如果发起者屏蔽了某些成员或被某些成员屏蔽，或者没有权限添加某些成员，则系统不会将这些成员添加到创建的聊天室。

如需在发起通话的用户与另一位真人用户之间创建私信 (DM)，请仅指定一个成员资格来代表真人用户。如果其中一位用户屏蔽了另一位用户，则请求会失败，并且系统不会创建私信。

如需在发起通话的用户和发起通话的应用之间创建私信，请将 Space.singleUserBotDm 设为 true，并勿指定任何成员资格。您只能使用此方法与通话应用设置私信。如需将通话应用添加为聊天室成员或两个真人用户之间的现有私信成员，请参阅邀请或添加用户或应用到聊天室。

如果两位用户之间已存在私信，即使在发出请求时其中一人屏蔽了另一人，系统也会返回现有私信。

不支持包含会话式回复的聊天室。如果您在设置聊天室时收到错误消息 ALREADY_EXISTS，请尝试使用其他 displayName。Google Workspace 组织中现有的聊天室可能已在使用此显示名称。

需要用户身份验证。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

如需了解详情，请参阅授权指南。
UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

更新会员资格。如需查看示例，请参阅更新用户在聊天室中的成员资格。

支持以下类型的身份验证：

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships

如需了解详情，请参阅授权指南。
UpdateMessage

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

更新消息。patch 和 update 方法之间存在差异。patch 方法使用 patch 请求，而 update 方法使用 put 请求。我们建议使用 patch 方法。如需查看示例，请参阅更新消息。

支持以下类型的身份验证：

使用应用身份验证时，请求只能更新发起调用的 Chat 应用创建的消息。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

如需了解详情，请参阅授权指南。
UpdateSpace

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

更新聊天室。如需了解示例，请参阅更新聊天室。

如果您在更新 displayName 字段时收到错误消息 ALREADY_EXISTS，请尝试使用其他显示名称。Google Workspace 组织中的现有聊天室可能已经在使用此显示名称。

支持以下类型的身份验证：

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces

如需了解详情，请参阅授权指南。
UpdateSpaceNotificationSetting

rpc UpdateSpaceNotificationSetting(UpdateSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

更新聊天室通知状态设置。

需要用户身份验证。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/chat.users.spacesettings

如需了解详情，请参阅授权指南。
UpdateSpaceReadState

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

更新聊天室中用户的已读状态，用于标识已读和未读消息。如需查看示例，请参阅更新用户聊天室的读取状态。

需要用户身份验证。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/chat.users.readstate

如需了解详情，请参阅授权指南。

AccessoryWidget

显示在消息底部的一种或多种交互式 widget。如需了解详情，请参阅在消息底部添加互动式微件。

字段
联合字段 action。操作的类型。action 只能是下列其中一项：
button_list

ButtonList

按钮列表。

ActionResponse

Chat 应用可以使用这些参数来配置其响应的发布方式。

字段
type

ResponseType

仅限输入。Chat 应用响应的类型。
url

string

仅限输入。供用户进行身份验证或配置的网址。（仅适用于 REQUEST_CONFIG 响应类型。）
dialog_action

DialogAction

仅限输入。对与对话框相关的互动事件的响应。必须附带 ResponseType.Dialog。
updated_widget

UpdatedWidget

仅限输入。更新后的 widget 的响应。

ResponseType

Chat 应用响应的类型。

枚举
TYPE_UNSPECIFIED 默认类型，以 NEW_MESSAGE 进行处理。
NEW_MESSAGE 在主题中发布新消息。
UPDATE_MESSAGE 更新 Chat 应用的消息。仅当消息发送方类型为 BOT 时，才允许在 CARD_CLICKED 事件中执行此操作。
UPDATE_USER_MESSAGE_CARDS 更新用户邮件中的卡片。仅当响应包含匹配网址的 MESSAGE 事件或消息发件人类型为 HUMAN 的 CARD_CLICKED 事件时，才允许使用此属性。文本会被忽略。
REQUEST_CONFIG 私下要求用户进行额外的身份验证或配置。
DIALOG 显示对话框。
UPDATE_WIDGET 微件文本自动补全选项查询。

SelectionItems

微件自动补全结果列表。

字段
items[]

SelectionItem

SelectionItem 对象的数组。

UpdatedWidget

更新后的 widget 的响应。用于为 widget 提供自动补全选项。

字段
widget

string

更新后的微件的 ID。该 ID 必须与触发更新请求的 widget 的 ID 一致。
联合字段 updated_widget。微件会根据用户操作进行更新。updated_widget 只能是下列其中一项：
suggestions

SelectionItems

微件自动补全结果列表

ActionStatus

表示调用或提交对话框的请求的状态。

字段
status_code

Code

状态代码。
user_facing_message

string

用于向用户发送其请求状态的消息。如果未设置，系统会发送基于 status_code 的通用消息。

注释

仅限输出。与邮件纯文本正文相关的注释。如需为短信添加基本格式，请参阅设置短信格式。

纯文本消息正文示例：

Hello @FooBot how are you!"

相应的注释元数据：

"annotations":[{
  "type":"USER_MENTION",
  "startIndex":6,
  "length":7,
  "userMention": {
    "user": {
      "name":"users/{user}",
      "displayName":"FooBot",
      "avatarUrl":"https://goo.gl/aeDtrS",
      "type":"BOT"
    },
    "type":"MENTION"
   }
}]
字段
type

AnnotationType

此注解的类型。
length

int32

此注释对应的纯文本邮件正文中的子字符串的长度。
start_index

int32

此注释对应的纯文本消息正文中的起始索引（从 0 开始，包括该数值）。
联合字段 metadata。有关注释的其他元数据。metadata 只能是下列其中一项：
user_mention

UserMentionMetadata

用户提及的元数据。
slash_command

SlashCommandMetadata

斜杠命令的元数据。

AnnotationType

注释的类型。

枚举
ANNOTATION_TYPE_UNSPECIFIED 枚举的默认值。请勿使用。
USER_MENTION 提及了用户。
SLASH_COMMAND 调用斜杠命令。

AttachedGif

由网址指定的 GIF 图片。

字段
uri

string

仅限输出。托管 GIF 图片的网址。

附件

Google Chat 中的附件。

字段
name

string

可选。附件的资源名称，格式为 spaces/{space}/messages/{message}/attachments/{attachment}。
content_name

string

仅限输出。内容的原始文件名，而不是完整路径。
content_type

string

仅限输出。文件的内容类型（MIME 类型）。
thumbnail_uri

string

仅限输出。缩略图网址，应用于向人为用户预览附件。聊天应用不应使用此网址下载附件内容。
download_uri

string

仅限输出。下载网址，应用于允许人类用户下载附件。聊天应用不应使用此网址下载附件内容。
source

Source

仅限输出。附件的来源。
联合字段 data_ref。对附件的引用数据。data_ref 只能是下列其中一项：
attachment_data_ref

AttachmentDataRef

可选。对附件数据的引用。此字段用于创建或更新包含附件的邮件，或使用 Media API 下载附件数据。
drive_data_ref

DriveDataRef

仅限输出。对 Google 云端硬盘附件的引用。此字段与 Google Drive API 搭配使用。

来源

附件的来源。

枚举
SOURCE_UNSPECIFIED 已预订。
DRIVE_FILE 文件是 Google 云端硬盘文件。
UPLOADED_CONTENT 文件会上传到 Chat。

AttachmentDataRef

对附件数据的引用。

字段
resource_name

string

可选。附件数据的资源名称。此字段可与 media API 搭配使用，以下载附件数据。
attachment_upload_token

string

可选。包含对上传的附件的引用的不透明令牌。由客户端视为不透明字符串，用于创建或更新包含附件的 Chat 消息。

CardWithId

Google Chat 消息中的卡片。

只有 Chat 应用可以创建卡片。如果您的 Chat 应用以用户身份进行身份验证，则消息中不能包含卡片。

使用卡片制作工具设计和预览卡片。

打开卡片制作工具

字段
card_id

string

如果消息包含多张卡片，则必须填写。消息中卡片的唯一标识符。
card

Card

一张卡片。大小上限为 32 KB。

ChatSpaceLinkData

Chat 聊天室链接的数据。

字段
space

string

关联的 Chat 聊天室资源的聊天室。

格式：spaces/{space}
thread

string

关联的 Chat 聊天室资源的消息串。

格式：spaces/{space}/threads/{thread}
message

string

关联的 Chat 聊天室资源的消息。

格式：spaces/{space}/messages/{message}

CompleteImportSpaceRequest

用于请求完成聊天室导入流程的消息。

字段
name

string

必需。导入模式聊天室的资源名称。

格式：spaces/{space}

CompleteImportSpaceResponse

用于表示已完成聊天室导入流程的响应消息。

字段
space

Space

导入模式聊天室。

ContextualAddOnMarkup

此类型没有字段。

供开发者指定内容相关插件内容的标记。

卡片

卡片是一种界面元素，可以包含文本和图片等界面微件。

字段
header

CardHeader

卡片的标题。标题通常包含标题和图片。
sections[]

Section

各部分之间用线条分隔。
card_actions[]

CardAction

此卡片的操作。
name

string

卡片的名称。

CardAction

卡片操作是指与卡片关联的操作。对于账单卡，典型操作包括：删除账单、通过电子邮件发送账单或在浏览器中打开账单。

Google Chat 应用不支持。

字段
action_label

string

用于在操作菜单项中显示的标签。
on_click

OnClick

此操作项的 onclick 操作。

CardHeader

字段
title

string

必须指定标题。标题的高度是固定的：如果同时指定了标题和副标题，则每个标题占一行。如果仅指定了标题，则标题会占据两行。
subtitle

string

卡片标题的副标题。
image_style

ImageStyle

图片的类型（例如方形边框或圆形边框）。
image_url

string

卡片标题中的图片的网址。

ImageStyle

枚举
IMAGE_STYLE_UNSPECIFIED
IMAGE 方形边框。
AVATAR 圆形边框。

部分

一个版块包含一组按指定顺序呈现（垂直）的 widget。在所有平台上，卡片都采用固定的窄宽度，因此目前不需要布局属性（例如浮动）。

字段
header

string

该部分的标题。支持设置了格式的文本。如需详细了解如何设置文本格式，请参阅在 Google Chat 应用中设置文本格式和在 Google Workspace 插件中设置文本格式。
widgets[]

WidgetMarkup

一个版块必须包含至少一个 widget。

CreateCustomEmojiRequest

创建自定义表情符号的请求。

字段
custom_emoji

CustomEmoji

必需。要创建的自定义表情符号。

CreateMembershipRequest

用于创建会员资格的请求消息。

字段
parent

string

必需。要为其创建成员资格的聊天室的资源名称。

格式：spaces/{space}
membership

Membership

必需。要创建的成员资格关系。

memberType 字段必须包含已填充 user.name 和 user.type 字段的用户。服务器将分配资源名称并覆盖所有指定内容。

当 Chat 应用为真人用户创建会员关系时，必须使用特定的授权范围，并为特定字段设置特定值：

  • 以用户身份进行身份验证时，必须使用 chat.memberships 授权范围。

  • 以应用身份进行身份验证时，必须使用 chat.app.memberships 授权范围。以应用身份进行身份验证功能适用于以下平台：

  • 将 user.type 设置为 HUMAN，并将 user.name 设置为格式为 users/{user} 的值，其中 {user} 可以是用户的电子邮件地址。对于同一 Workspace 组织中的用户，{user} 还可以是 People API 中的人员的 id，或 Directory API 中用户的 id。例如，如果 user@example.com 的 People API 人员个人资料 ID 为 123456789，您可以将 membership.member.name 设置为 users/user@example.com 或 users/123456789，将该用户添加到聊天室。

如需邀请聊天室所属 Workspace 组织之外的用户，您需要进行用户身份验证。

当 Chat 应用为自己创建成员关系时，必须以用户身份进行身份验证并使用 chat.memberships.app 范围，将 user.type 设置为 BOT，并将 user.name 设置为 users/app。
use_admin_access

bool

可选。如果为 true，则该方法会使用用户的 Google Workspace 管理员权限运行。

发起通话的用户必须是拥有管理聊天和聊天室对话权限的 Google Workspace 管理员。

需要 chat.admin.memberships OAuth 2.0 范围。

使用管理员权限创建应用会员资格或为管理员 Google Workspace 组织之外的用户创建会员资格不受支持。

CreateMessageRequest

创建消息。

字段
parent

string

必需。要在其中创建消息的聊天室的资源名称。

格式：spaces/{space}
message

Message

必需。消息正文。
thread_key
(deprecated)

string

可选。已弃用：请改用 thread.thread_key。线程的 ID。最多支持 4,000 个字符。如需发起或添加会话，请创建消息并指定 threadKey 或 thread.name。如需查看用法示例，请参阅发起或回复消息串。
request_id

string

可选。此消息的唯一请求 ID。指定现有请求 ID 会返回使用该 ID 创建的消息，而不是创建新消息。
message_reply_option

MessageReplyOption

可选。指定消息是发起话题还是回复话题。仅在命名空间中受支持。

响应用户互动时，系统会忽略此字段。对于会话中的互动，系统会在同一会话中创建回复。否则，系统会将回复创建为新会话。
message_id

string

可选。消息的自定义 ID。让 Chat 应用能够获取、更新或删除消息，而无需将系统分配的 ID 存储在消息的资源名称（在消息的 name 字段中表示）中。

此字段的值必须满足以下要求：

  • 以 client- 开头。例如，client-custom-name 是有效的自定义 ID，但 custom-name 不是。
  • 最多包含 63 个字符，且只能包含小写字母、数字和连字符。
  • 在聊天室内是唯一的。聊天应用无法为不同的消息使用相同的自定义 ID。

有关详情，请参阅为消息命名。

MessageReplyOption

指定如何回复消息。未来可能会添加更多州。

枚举
MESSAGE_REPLY_OPTION_UNSPECIFIED 默认。启动新线程。使用此选项会忽略包含的任何 thread ID 或 thread_key。
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD 将消息创建为对 thread ID 或 thread_key 指定的会话的回复。如果失败，消息会改为启动新线程。
REPLY_MESSAGE_OR_FAIL 将消息创建为对 thread ID 或 thread_key 指定的会话的回复。如果使用新的 thread_key，系统会创建一个新线程。如果消息创建失败，系统会改为返回 NOT_FOUND 错误。

CreateReactionRequest

对消息创建回应。

字段
parent

string

必需。创建回应的消息。

格式：spaces/{space}/messages/{message}
reaction

Reaction

必需。要创建的回应。

CreateSpaceRequest

请求创建没有成员的命名聊天室。

字段
space

Space

必需。必须填充 displayName 和 spaceType 字段。仅支持 SpaceType.SPACE 和 SpaceType.GROUP_CHAT。仅当 importMode 设为 true 时，才可使用 SpaceType.GROUP_CHAT。

如果您收到错误消息 ALREADY_EXISTS，请尝试使用其他 displayName。Google Workspace 组织中现有的聊天室可能已使用此显示名称。

系统会在服务器上分配聊天室 name，因此此字段中指定的任何内容都将被忽略。
request_id

string

可选。此请求的唯一标识符。建议使用随机 UUID。指定现有请求 ID 会返回使用该 ID 创建的聊天室，而不是创建新的聊天室。使用其他经过身份验证的用户指定同一 Chat 应用中的现有请求 ID 会返回错误。

CustomEmoji

表示自定义表情符号。

字段
name

string

标识符。自定义表情符号的资源名称，由服务器分配。

格式：customEmojis/{customEmoji}
uid

string

仅限输出。自定义表情符号资源的唯一键。
emoji_name

string

可选。不可变。用户为自定义表情符号提供的名称，该名称在组织内必须唯一。

在创建自定义表情符号时为必需字段，否则为输出字段。

表情符号名称必须以英文冒号开头和结尾，必须是小写字母，且只能包含字母数字字符、连字符和下划线。连字符和下划线应用来分隔字词，且不得连续使用。

示例：:valid-emoji-name:
temporary_image_uri

string

仅限输出。自定义表情符号的图片网址，有效期至少为 10 分钟。请注意，在创建自定义表情符号时，系统不会在响应中填充此值。
payload

CustomEmojiPayload

可选。仅限输入。载荷数据。创建自定义表情符号时，此属性是必需的。

CustomEmojiPayload

自定义表情符号的载荷数据。

字段
file_content

bytes

必需。仅限输入。用于自定义表情符号的图片。

载荷不得超过 256 KB，图片的尺寸不得低于 64 像素，也不得高于 500 像素。这些限制可能会发生变化。
filename

string

必需。仅限输入。图片文件名。

支持的文件扩展名：.png、.jpg、.gif。

DeleteCustomEmojiRequest

请求删除自定义表情符号。

字段
name

string

必需。要删除的自定义表情符号的资源名称。

格式：customEmojis/{customEmoji}

您可以将表情符号名称用作 {customEmoji} 的别名。例如，customEmojis/:example-emoji:，其中 :example-emoji: 是自定义表情符号的表情符号名称。

DeleteMembershipRequest

请求删除聊天室中的成员资格。

字段
name

string

必需。要删除的会员资格的资源名称。聊天应用可以删除真人用户或自己的会员资格。Chat 应用无法删除其他应用的会员资格。

删除用户成员资格时，需要使用 chat.memberships 范围和 spaces/{space}/members/{member} 格式。您可以将该电子邮件地址用作 {member} 的别名。例如，spaces/{space}/members/example@gmail.com，其中 example@gmail.com 是 Google Chat 用户的电子邮件地址。

删除应用会员资格时，需要 chat.memberships.app 范围和 spaces/{space}/members/app 格式。

格式：spaces/{space}/members/{member} 或 spaces/{space}/members/app。
use_admin_access

bool

可选。如果为 true，则该方法会使用用户的 Google Workspace 管理员权限运行。

发起通话的用户必须是拥有管理聊天和聊天室对话权限的 Google Workspace 管理员。

需要 chat.admin.memberships OAuth 2.0 范围。

不支持使用管理员访问权限删除聊天室中的应用成员资格。

DeleteMessageRequest

请求删除消息。

字段
name

string

必需。消息的资源名称。

格式：spaces/{space}/messages/{message}

如果您为消息设置了自定义 ID，则可以将 clientAssignedMessageId 字段中的值用作 {message}。有关详情，请参阅为消息命名。
force

bool

可选。当 true 时，删除消息也会删除其会话式回复。当 false 时，如果消息包含会话式回复，则删除会失败。

仅在以用户身份进行身份验证时适用。在以聊天应用身份进行身份验证时，此属性没有任何影响。

DeleteReactionRequest

删除对消息的回应。

字段
name

string

必需。要删除的回应的名称。

格式：spaces/{space}/messages/{message}/reactions/{reaction}

DeleteSpaceRequest

请求删除聊天室。

字段
name

string

必需。要删除的聊天室的资源名称。

格式：spaces/{space}
use_admin_access

bool

可选。如果为 true，则该方法会使用用户的 Google Workspace 管理员权限运行。

发起通话的用户必须是拥有管理聊天和聊天室对话权限的 Google Workspace 管理员。

需要 chat.admin.delete OAuth 2.0 范围。

DeletionMetadata

有关已删除消息的信息。设置 delete_time 后，系统会删除消息。

字段
deletion_type

DeletionType

指明是谁删除了消息。

DeletionType

消息是谁删除的以及删除方式。未来可能会添加更多值。

枚举
DELETION_TYPE_UNSPECIFIED 此值未使用。
CREATOR 用户删除了自己的消息。
SPACE_OWNER 聊天室所有者删除了消息。
ADMIN Google Workspace 管理员已删除该邮件。
APP_MESSAGE_EXPIRY Chat 应用会在消息到期后将其删除。
CREATOR_VIA_APP Chat 应用代表用户删除了消息。
SPACE_OWNER_VIA_APP Chat 应用代表聊天室所有者删除了消息。

对话框

对话框卡片正文的封装容器。

字段
body

Card

仅限输入。对话框正文，以模态方式呈现。Google Chat 应用不支持以下卡片实体：DateTimePicker、OnChangeAction。

DialogAction

包含对话框和请求状态代码。

字段
action_status

ActionStatus

仅限输入。调用或提交对话框的请求的状态。在必要时向用户显示状态和消息。例如，在出现错误或成功时。
联合字段 action。要执行的操作。action 只能是下列其中一项：
dialog

Dialog

仅限输入。请求的对话框。

DriveDataRef

对云端硬盘附件的引用。

字段
drive_file_id

string

云端硬盘文件的 ID。与 Drive API 搭配使用。

DriveLinkData

Google 云端硬盘链接的数据。

字段
drive_data_ref

DriveDataRef

引用 Google 云端硬盘文件的 DriveDataRef。
mime_type

string

关联的 Google 云端硬盘资源的 MIME 类型。

表情符号

用于回应消息的表情符号。

字段
联合字段 content。必需。表情符号的内容。content 只能是下列其中一项：
unicode

string

可选。由 Unicode 字符串表示的基本表情符号。
custom_emoji

CustomEmoji

仅限输出。自定义表情符号。

EmojiReactionSummary

使用特定表情符号回应消息的用户数量。

字段
emoji

Emoji

仅限输出。与回应关联的表情符号。
reaction_count

int32

仅限输出。使用关联表情符号的回应总数。

FindDirectMessageRequest

用于根据用户资源获取私信聊天室的请求。

字段
name

string

必需。要查找私信内容的用户的资源名称。

格式：users/{user}，其中 {user} 是 People API 中的人员的 id，或 Directory API 中的用户的 id。例如，如果 People API 个人资料 ID 为 123456789，您可以使用 users/123456789 作为 name 来查找与该用户的私信。通过用户身份验证后，您可以将电子邮件地址用作 {user} 的别名。例如，users/example@gmail.com，其中 example@gmail.com 是 Google Chat 用户的电子邮件地址。

GetAttachmentRequest

请求获取附件。

字段
name

string

必需。附件的资源名称，格式为 spaces/{space}/messages/{message}/attachments/{attachment}。

GetCustomEmojiRequest

用于返回单个自定义表情符号的请求。

字段
name

string

必需。自定义表情符号的资源名称。

格式：customEmojis/{customEmoji}

您可以将表情符号名称用作 {customEmoji} 的别名。例如，customEmojis/:example-emoji:，其中 :example-emoji: 是自定义表情符号的表情符号名称。

GetMembershipRequest

请求获取聊天室的成员资格。

字段
name

string

必需。要检索的会员资格的资源名称。

如需通过用户身份验证获取应用自己的会员资格，您可以选择使用 spaces/{space}/members/app。

格式：spaces/{space}/members/{member} 或 spaces/{space}/members/app

您可以将用户的电子邮件地址用作 {member} 的别名。例如，spaces/{space}/members/example@gmail.com，其中 example@gmail.com 是 Google Chat 用户的电子邮件地址。
use_admin_access

bool

可选。如果为 true，则该方法会使用用户的 Google Workspace 管理员权限运行。

发起通话的用户必须是拥有管理聊天和聊天室对话权限的 Google Workspace 管理员。

需要 chat.admin.memberships 或 chat.admin.memberships.readonly OAuth 2.0 范围。

使用管理员访问权限时，不支持获取聊天室中的应用会员资格。

GetMessageRequest

请求获取消息。

字段
name

string

必需。消息的资源名称。

格式：spaces/{space}/messages/{message}

如果您为消息设置了自定义 ID，则可以将 clientAssignedMessageId 字段中的值用作 {message}。有关详情，请参阅为消息命名。

GetSpaceEventRequest

用于获取聊天室事件的请求消息。

字段
name

string

必需。聊天室事件的资源名称。

格式：spaces/{space}/spaceEvents/{spaceEvent}

GetSpaceNotificationSettingRequest

用于获取聊天室通知设置的请求消息。仅支持获取发起通话的用户的通知设置。

字段
name

string

必需。格式：users/{user}/spaces/{space}/spaceNotificationSetting

  • users/me/spaces/{space}/spaceNotificationSetting，或
  • users/user@example.com/spaces/{space}/spaceNotificationSetting，或
  • users/123456789/spaces/{space}/spaceNotificationSetting。注意：路径中只能包含调用方的用户 ID 或电子邮件地址。

GetSpaceReadStateRequest

GetSpaceReadState API 的请求消息。

字段
name

string

必需。要检索的聊天室读取状态的资源名称。

仅支持获取调用方用户的读取状态。

如需引用调用方用户，请设置以下任一项：

  • me 别名。例如 users/me/spaces/{space}/spaceReadState。

  • 用户的 Workspace 电子邮件地址。例如 users/user@example.com/spaces/{space}/spaceReadState。

  • 用户 ID。例如 users/123456789/spaces/{space}/spaceReadState。

格式：users/{user}/spaces/{space}/spaceReadState

GetSpaceRequest

请求返回单个空格。

字段
name

string

必需。聊天室的资源名称，格式为 spaces/{space}。

格式：spaces/{space}
use_admin_access

bool

可选。如果为 true，则该方法会使用用户的 Google Workspace 管理员权限运行。

发起通话的用户必须是拥有管理聊天和聊天室对话权限的 Google Workspace 管理员。

需要 chat.admin.spaces 或 chat.admin.spaces.readonly OAuth 2.0 范围。

GetThreadReadStateRequest

GetThreadReadStateRequest API 的请求消息。

字段
name

string

必需。要检索的线程读取状态的资源名称。

仅支持获取调用方用户的读取状态。

如需引用调用方用户，请设置以下任一项：

  • me 别名。例如 users/me/spaces/{space}/threads/{thread}/threadReadState。

  • 用户的 Workspace 电子邮件地址。例如 users/user@example.com/spaces/{space}/threads/{thread}/threadReadState。

  • 其用户 ID。例如 users/123456789/spaces/{space}/threads/{thread}/threadReadState。

格式：users/{user}/spaces/{space}/threads/{thread}/threadReadState

群组

Google Chat 中的 Google 群组。

字段
name

string

Google 群组的资源名称。

表示 Cloud Identity Groups API 中的群组。

格式：groups/{group}

HistoryState

消息和聊天室的聊天记录状态。指定消息和对话会在创建后保留多长时间。

枚举
HISTORY_STATE_UNSPECIFIED 默认值。请勿使用。
HISTORY_OFF 聊天记录功能处于关闭状态。消息和会话会保留 24 小时。
HISTORY_ON 聊天记录功能已开启。组织的 Vault 保留规则会指定邮件和会话保留的时长。

ListCustomEmojisRequest

用于返回自定义表情符号列表的请求。

字段
page_size

int32

可选。返回的自定义表情符号的数量上限。服务返回的自定义表情符号数量可能会少于此值。如果未指定，则默认值为 25。最大值为 200；大于 200 的值会更改为 200。
page_token

string

可选。（如果从上一个查询继续）。

从上一个列出自定义表情符号的调用接收的页面令牌。利用其进行后续页面检索。

进行分页时，过滤条件值应与提供页面令牌的调用相一致。传递其他值可能会导致意外结果。
filter

string

可选。查询过滤条件。

支持按创作者过滤。

如需按创作者过滤，您必须指定有效的值。目前，只有 creator("users/me") 和 NOT creator("users/me") 支持按自定义表情符号是否由发起调用的用户创建进行过滤。

例如，以下查询会返回调用方创建的自定义表情符号：

creator("users/me")

服务器会拒绝无效查询，并返回 INVALID_ARGUMENT 错误。

ListCustomEmojisResponse

对自定义表情符号列表的响应。

字段
custom_emojis[]

CustomEmoji

无序列表。请求的（或第一个）页面中的自定义表情符号列表。
next_page_token

string

可作为 pageToken 发送的令牌可用于检索下一页结果。如果为空，则表示没有后续页面。

ListMembershipsRequest

用于列出会员的请求消息。

字段
parent

string

必需。要获取其成员名单的聊天室的资源名称。

格式：spaces/{space}
page_size

int32

可选。要返回的会员数量上限。服务返回的订阅的数量可能小于此值。

如果未指定，则最多返回 100 项会员资格。

最大值为 1000。如果您使用的值超过 1000，系统会自动将其更改为 1000。

负值会返回 INVALID_ARGUMENT 错误。
page_token

string

可选。从之前的列出会员资格的调用接收的页面令牌。提供此参数以检索后续页面。

进行分页时，提供的所有其他参数都应与提供页面令牌的调用相一致。向其他参数传递不同的值可能会导致意外结果。
filter

string

可选。查询过滤条件。

您可以按成员的角色 (role) 和类型 (member.type) 过滤会员资格。

如需按角色进行过滤，请将 role 设置为 ROLE_MEMBER 或 ROLE_MANAGER。

如需按类型进行过滤，请将 member.type 设置为 HUMAN 或 BOT。您还可以使用 != 运算符过滤出 member.type。

如需同时按角色和类型过滤，请使用 AND 运算符。如需按角色或类型过滤，请使用 OR 运算符。

将 use_admin_access 设置为 true 时，必须提供 member.type = "HUMAN" 或 member.type != "BOT"。其他成员类型过滤条件将被拒绝。

例如，以下查询有效：

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

member.type != "BOT"

以下查询无效：

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

服务器会拒绝无效查询，并返回 INVALID_ARGUMENT 错误。
show_groups

bool

可选。如果为 true，除了其他类型的会员资格外，还会返回与 Google Group 关联的会员资格。如果设置了 filter，系统不会返回与过滤条件不匹配的 Google Group 成员资格。
show_invited

bool

可选。如果为 true，除了其他类型的会员资格外，还会返回与 invited 会员关联的会员资格。如果设置了过滤条件，系统将不会返回与过滤条件不匹配的 invited 成员资格。

目前需要用户身份验证。
use_admin_access

bool

可选。如果为 true，则该方法会使用用户的 Google Workspace 管理员权限运行。

发起通话的用户必须是拥有管理聊天和聊天室对话权限的 Google Workspace 管理员。

需要 chat.admin.memberships.readonly 或 chat.admin.memberships OAuth 2.0 范围。

使用管理员访问权限时，不支持在聊天室中列出应用会员资格。

ListMembershipsResponse

对列出聊天室成员资格的请求做出的响应。

字段
memberships[]

Membership

无序列表。请求的（或第一个）网页中的会员资格列表。
next_page_token

string

可作为 pageToken 发送的令牌可用于检索下一页结果。如果为空，则表示没有后续页面。

ListMessagesRequest

列出用户是成员的指定聊天室中的邮件。

字段
parent

string

必需。要列出消息的聊天室的资源名称。

格式：spaces/{space}
page_size

int32

可选。返回的消息数量上限。服务返回的消息数量可能少于此值。

如果未指定，则最多返回 25 个。

最大值为 1000。如果您使用的值超过 1000，系统会自动将其更改为 1000。

负值会返回 INVALID_ARGUMENT 错误。
page_token

string

可选。从上一个列出消息调用接收的页面令牌。提供此参数以检索后续页面。

进行分页时，提供的所有其他参数都应与提供页面令牌的调用相一致。向其他参数传递不同的值可能会导致意外结果。
filter

string

可选。查询过滤条件。

您可以按日期 (create_time) 和会话 (thread.name) 过滤消息。

如需按消息创建日期过滤消息，请使用 RFC-3339 格式的时间戳和双引号指定 create_time。例如 "2023-04-21T11:30:00-04:00"。您可以使用大于运算符 > 列出在某个时间戳之后创建的消息，也可以使用小于运算符 < 列出在某个时间戳之前创建的消息。如需过滤时间间隔内的邮件，请在两个时间戳之间使用 AND 运算符。

如需按线程过滤，请指定格式为 spaces/{space}/threads/{thread} 的 thread.name。每个查询只能指定一个 thread.name。

如需按会话和日期过滤，请在查询中使用 AND 运算符。

例如，以下查询有效：

create_time > "2012-04-21T11:30:00-04:00"

create_time > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

create_time > "2012-04-21T11:30:00+00:00" AND

create_time < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

服务器会拒绝无效查询，并返回 INVALID_ARGUMENT 错误。
order_by

string

可选。消息列表的排序方式。指定要按排序操作进行排序的值。有效的排序操作值如下所示：

  • ASC 表示升序。

  • DESC 表示降序。

默认排序为 create_time ASC。
show_deleted

bool

可选。是否包含已删除的消息。已删除的邮件包含删除时间和有关其删除的元数据，但邮件内容不可用。

ListMessagesResponse

用于列出消息的响应消息。

字段
messages[]

Message

消息列表。
next_page_token

string

您可以发送 pageToken 令牌来检索下一页结果。如果为空，则表示没有后续页面。

ListReactionsRequest

列出对某条消息的回应。

字段
parent

string

必需。用户回应的消息。

格式：spaces/{space}/messages/{message}
page_size

int32

可选。返回的回应数量上限。服务返回的回应数量可能少于此值。如果未指定，则默认值为 25。最大值为 200；大于 200 的值会更改为 200。
page_token

string

可选。（如果从上一个查询继续）。

从之前的 list reactions 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时，过滤条件值应与提供页面令牌的调用相一致。传递其他值可能会导致意外结果。
filter

string

可选。查询过滤条件。

您可以按表情符号（emoji.unicode 或 emoji.custom_emoji.uid）和用户 (user.name) 过滤回应。

如需过滤多种表情符号或用户的回应，请使用 OR 运算符（例如 emoji.unicode = "🙂" OR emoji.unicode = "👍" 和 user.name = "users/AAAAAA" OR user.name = "users/BBBBBB"）联接类似字段。

如需按表情符号和用户过滤回应，请使用 AND 运算符，例如 emoji.unicode = "🙂" AND user.name = "users/AAAAAA"。

如果您的查询同时使用 AND 和 OR，请使用括号对它们进行分组。

例如，以下查询有效：

user.name = "users/{user}"
emoji.unicode = "🙂"
emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR emoji.unicode = "👍"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" AND user.name = "users/{user}"
(emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}")
AND user.name = "users/{user}"

以下查询无效：

emoji.unicode = "🙂" AND emoji.unicode = "👍"
emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR
user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
AND user.name = "users/{user}"

服务器会拒绝无效查询，并返回 INVALID_ARGUMENT 错误。

ListReactionsResponse

对列出回应的请求的响应。

字段
reactions[]

Reaction

请求的（或第一）页面中的回应列表。
next_page_token

string

用于检索下一页结果的接续令牌。对于结果的最后一页，此值为空。

ListSpaceEventsRequest

用于请求列出聊天室活动的消息。

字段
parent

string

必需。发生事件的 Google Chat 聊天室的资源名称。

格式：spaces/{space}。
page_size

int32

可选。返回的聊天室事件的数量上限。服务返回的订阅的数量可能小于此值。

负值会返回 INVALID_ARGUMENT 错误。
page_token

string

可选。从之前的 list space events 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时，提供给列表空间事件的所有其他参数必须与提供页面令牌的调用相一致。向其他参数传递不同的值可能会导致意外结果。
filter

string

必需。查询过滤条件。

您必须使用“has”:运算符指定至少一种事件类型 (event_type)。如需按多个事件类型进行过滤，请使用 OR 运算符。在过滤条件中省略批量事件类型。该请求会自动返回任何相关的批量事件。例如，如果您按新回应 (google.workspace.chat.reaction.v1.created) 进行过滤，服务器还会返回批量新回应事件 (google.workspace.chat.reaction.v1.batchCreated)。如需查看受支持的事件类型的列表，请参阅 SpaceEvents 参考文档。

（可选）您还可以按开始时间 (start_time) 和结束时间 (end_time) 进行过滤：

  • start_time：用于开始列出聊天室事件的独占时间戳。您最多可以列出 28 天前发生的事件。如果未指定，则列出过去 28 天的聊天室事件。
  • end_time：包含的时间戳，表示列出聊天室事件的截止时间。如果未指定，则列出请求发出前发生的事件。

如需指定开始时间或结束时间，请使用等于 = 运算符和 RFC-3339 格式。如需同时按 start_time 和 end_time 过滤，请使用 AND 运算符。

例如，以下查询有效：

start_time="2023-08-23T19:20:33+00:00" AND
end_time="2023-08-23T19:21:54+00:00"

start_time="2023-08-23T19:20:33+00:00" AND
(event_types:"google.workspace.chat.space.v1.updated" OR
event_types:"google.workspace.chat.message.v1.created")

以下查询无效：

start_time="2023-08-23T19:20:33+00:00" OR
end_time="2023-08-23T19:21:54+00:00"

event_types:"google.workspace.chat.space.v1.updated" AND
event_types:"google.workspace.chat.message.v1.created"

服务器会拒绝无效查询，并返回 INVALID_ARGUMENT 错误。

ListSpaceEventsResponse

用于列出聊天室事件的响应消息。

字段
space_events[]

SpaceEvent

结果会按时间顺序返回（最早的事件排在前面）。注意：对于列表请求，Space 对象中不会返回 permissionSettings 字段。
next_page_token

string

用于提取更多事件的接续令牌。如果省略此字段，则不存在后续页面。

ListSpacesRequest

用于列出调用方所属聊天室的请求。

字段
page_size

int32

可选。要返回的聊天室数量上限。服务返回的订阅的数量可能小于此值。

如果未指定，则最多返回 100 个聊天室。

最大值为 1000。如果您使用的值大于 1000，系统会自动将其更改为 1000。

负值会返回 INVALID_ARGUMENT 错误。
page_token

string

可选。从之前的列出聊天室调用接收的页面令牌。提供此参数以检索后续页面。

进行分页时，过滤条件值应与提供页面令牌的调用相一致。传递其他值可能会导致意外结果。
filter

string

可选。查询过滤条件。

您可以按聊天室类型 (space_type) 过滤聊天室。

如需按聊天室类型过滤，您必须指定有效的枚举值，例如 SPACE 或 GROUP_CHAT（space_type 不能为 SPACE_TYPE_UNSPECIFIED）。如需查询多个聊天室类型，请使用 OR 运算符。

例如，以下查询有效：

space_type = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

服务器会拒绝无效查询，并返回 INVALID_ARGUMENT 错误。

ListSpacesResponse

列出聊天室请求的响应。

字段
spaces[]

Space

请求的（或第一个）页面中的聊天室列表。注意：对于列表请求，Space 对象中不会返回 permissionSettings 字段。
next_page_token

string

您可以发送 pageToken 令牌来检索下一页结果。如果为空，则表示没有后续页面。

MatchedUrl

Chat 消息中匹配的网址。聊天应用可以预览匹配的网址。如需了解详情，请参阅预览链接。

字段
url

string

仅限输出。匹配的网址。

会员资格

表示 Google Chat 中的成员关系，例如用户或 Chat 应用是否受邀加入聊天室、是否是聊天室成员或是否不在聊天室中。

字段
name

string

标识符。成员资格的资源名称，由服务器分配。

格式：spaces/{space}/members/{member}
state

MembershipState

仅限输出。会员资格的状态。
role

MembershipRole

可选。用户在 Chat 聊天室中的角色，该角色决定了用户在聊天室中可以执行的操作。

此字段只能在 UpdateMembership 中用作输入。
create_time

Timestamp

可选。不可变。成员资格的创建时间，例如成员加入或受邀加入聊天室的时间。此字段仅用于输出，但在导入模式聊天室中用于导入历史会员资格时除外。
delete_time

Timestamp

可选。不可变。成员资格的删除时间，例如成员退出或被移除聊天室的时间。此字段仅用于输出，但在导入模式聊天室中用于导入历史会员资格时除外。
联合字段 memberType。与此会员资格关联的成员。我们将来可能会支持其他类型的成员。memberType 只能是下列其中一项：
member

User

可选。相应成员资格对应的 Google Chat 用户或应用。如果您的 Chat 应用以用户身份进行身份验证，输出将填充用户 name 和 type。
group_member

Group

可选。相应成员资格对应的 Google 群组。

如需读取或更改 Google 群组的成员资格，您需要进行用户身份验证。

MembershipRole

表示用户在 Chat 聊天室中被允许执行的操作。未来可能会添加更多枚举值。

枚举
MEMBERSHIP_ROLE_UNSPECIFIED 默认值。对于 users：他们不是聊天室成员，但可以受邀加入。对于 Google Groups：系统始终会为其分配此角色（未来可能会使用其他枚举值）。
ROLE_MEMBER 聊天室的成员。用户拥有基本权限，例如向聊天室发送消息。在 1 对 1 对话和未命名的群组对话中，所有人都有此角色。
ROLE_MANAGER 聊天室管理员。该用户拥有所有基本权限以及管理权限，可以管理聊天室，例如添加或移除成员。仅在 SpaceType.SPACE 中受支持。

MembershipState

指定成员与聊天室的关系。我们将来可能会支持其他会员状态。

枚举
MEMBERSHIP_STATE_UNSPECIFIED 默认值。请勿使用。
JOINED 系统会将用户添加到聊天室，并且用户可以参与聊天室。
INVITED 用户已受邀加入聊天室，但尚未加入。
NOT_A_MEMBER 用户不属于聊天室，也没有待处理的加入聊天室邀请。

MembershipBatchCreatedEventData

多个新会员的事件载荷。

事件类型：google.workspace.chat.membership.v1.batchCreated

字段
memberships[]

MembershipCreatedEventData

新会员的列表。

MembershipBatchDeletedEventData

多个已删除会员的事件载荷。

事件类型：google.workspace.chat.membership.v1.batchDeleted

字段
memberships[]

MembershipDeletedEventData

已删除的会员资格的列表。

MembershipBatchUpdatedEventData

多个更新后的会员资格的事件载荷。

事件类型：google.workspace.chat.membership.v1.batchUpdated

字段
memberships[]

MembershipUpdatedEventData

已更新的会员资格的列表。

MembershipCreatedEventData

新会员的事件载荷。

事件类型：google.workspace.chat.membership.v1.created。

字段
membership

Membership

新会员资格。

MembershipDeletedEventData

已删除会员资格的事件载荷。

事件类型：google.workspace.chat.membership.v1.deleted

字段
membership

Membership

已删除的会员资格。系统只会填充 name 和 state 字段。

MembershipUpdatedEventData

更新后的会员资格的事件载荷。

事件类型：google.workspace.chat.membership.v1.updated

字段
membership

Membership

更新后的会员资格。

消息

Google Chat 聊天室中的消息。

字段
name

string

标识符。消息的资源名称。

格式：spaces/{space}/messages/{message}

其中 {space} 是发布消息的聊天室的 ID，{message} 是系统为消息分配的 ID。例如 spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB。

如果您在创建消息时设置了自定义 ID，则可以使用此 ID 在请求中指定消息，方法是将 {message} 替换为 clientAssignedMessageId 字段中的值。例如 spaces/AAAAAAAAAAA/messages/client-custom-name。有关详情，请参阅为消息命名。
sender

User

仅限输出。消息的创建者。如果您的 Chat 应用以用户身份进行身份验证，输出将填充用户 name 和 type。
create_time

Timestamp

可选。不可变。对于在 Chat 中创建的聊天室，则是消息创建的时间。此字段仅用于输出，但在导入模式聊天室中使用时除外。

对于导入模式聊天室，请将此字段设置为消息在来源中创建的历史时间戳，以保留原始创建时间。
last_update_time

Timestamp

仅限输出。用户上次修改消息的时间。如果消息从未修改过，则此字段为空。
delete_time

Timestamp

仅限输出。消息在 Google Chat 中被删除的时间。如果消息从未被删除，则此字段为空。
text

string

可选。邮件的纯文本正文。指向图片、视频或网页的第一个链接会生成预览条状标签。您还可以@提及 Google Chat 用户或聊天室中的所有人。

如需了解如何创建短信，请参阅发送消息。
formatted_text

string

仅限输出。包含消息 text，其中添加了用于传达格式的标记。此字段可能无法捕获界面中显示的所有格式，但包含以下内容：

  • 粗体、斜体、删除线、monospace、monospace 块和项目符号列表的标记语法。

  • 用户提及，采用 <users/{user}> 格式。

  • 采用 <{url}|{rendered_text}> 格式的自定义超链接，其中第一个字符串是网址，第二个字符串是呈现的文本，例如 <http://example.com|custom text>。

  • 使用格式 :{emoji_name}: 的自定义表情符号，例如 :smile:。这不适用于 Unicode 表情符号，例如 U+1F600（表示笑脸表情符号）。

如需了解详情，请参阅查看消息中发送的文本格式
cards[]
(deprecated)

Card

已弃用：请改用 cards_v2。

富媒体、格式化且交互式的卡片，可用于显示界面元素，例如：格式化文本、按钮和可点击的图片。卡片通常显示在消息的纯文本正文下方。cards 和 cards_v2 的大小上限为 32 KB。
cards_v2[]

CardWithId

可选。卡片的数组。

只有 Chat 应用可以创建卡片。如果您的 Chat 应用以用户身份进行身份验证，则消息中不能包含卡片。

如需了解如何创建包含卡片的消息，请参阅发送消息。

使用卡片制作工具设计和预览卡片。

打开卡片制作工具
annotations[]

Annotation

仅限输出。与此消息中的 text 关联的注解。
thread

Thread

邮件所属的会话。如需查看使用示例，请参阅发起或回复消息串。
space

Space

仅限输出。如果您的 Chat 应用以用户身份进行身份验证，则输出仅填充聊天室 name。
fallback_text

string

可选。消息卡片的纯文本说明，用于在无法显示实际卡片时（例如移动通知）显示。
action_response

ActionResponse

仅限输入。Chat 应用可以使用这些参数来配置其响应的发布方式。
argument_text

string

仅限输出。消息的纯文本正文，其中已移除所有 Chat 应用提及。
slash_command

SlashCommand

仅限输出。斜线命令信息（如果适用）。
attachment[]

Attachment

可选。用户上传的附件。
matched_url

MatchedUrl

仅限输出。spaces.messages.text 中与链接预览模式匹配的网址。如需了解详情，请参阅预览链接。
thread_reply

bool

仅限输出。如果为 true，则表示消息是回复会话中的回复。如果为 false，则消息会显示在聊天室的顶级对话中，作为会话的第一条消息或没有会话回复的消息。

如果聊天室不支持在话题中回复，则此字段始终为 false。
client_assigned_message_id

string

可选。消息的自定义 ID。您可以使用此字段来标识消息，或获取、删除或更新消息。如需设置自定义 ID，请在创建消息时指定 messageId 字段。有关详情，请参阅为消息命名。
emoji_reaction_summaries[]

EmojiReactionSummary

仅限输出。消息的表情符号回应摘要列表。
private_message_viewer

User

可选。不可变。用于创建消息的输入，否则仅输出。可以查看消息的用户。设置此字段后，消息将是私密的，只有指定用户和 Chat 应用可以看到。如需在请求中添加此字段，您必须使用应用身份验证调用 Chat API，并忽略以下内容：

有关详情，请参阅私下发送消息。
deletion_metadata

DeletionMetadata

仅限输出。有关已删除消息的信息。设置 delete_time 后，系统会删除消息。
quoted_message_metadata

QuotedMessageMetadata

仅限输出。与 Google Chat 用户在聊天室中引用的消息相关的信息。Google Chat 用户可以引用消息来回复消息。
attached_gifs[]

AttachedGif

仅限输出。附加到邮件中的 GIF 图片。
accessory_widgets[]

AccessoryWidget

可选。显示在消息底部的一种或多种交互式 widget。您可以为包含文本、卡片或文本和卡片的消息添加配件微件。不支持包含对话框的消息。如需了解详情，请参阅在消息底部添加互动式微件。

若要创建包含配件 widget 的消息，您需要进行应用身份验证。

MessageBatchCreatedEventData

多个新消息的事件载荷。

事件类型：google.workspace.chat.message.v1.batchCreated

字段
messages[]

MessageCreatedEventData

新消息列表。

MessageBatchDeletedEventData

多个已删除邮件的事件载荷。

事件类型：google.workspace.chat.message.v1.batchDeleted

字段
messages[]

MessageDeletedEventData

已删除消息的列表。

MessageBatchUpdatedEventData

多个更新消息的事件载荷。

事件类型：google.workspace.chat.message.v1.batchUpdated

字段
messages[]

MessageUpdatedEventData

更新后的消息列表。

MessageCreatedEventData

新消息的事件载荷。

事件类型：google.workspace.chat.message.v1.created

字段
message

Message

新消息。

MessageDeletedEventData

已删除邮件的事件载荷。

事件类型：google.workspace.chat.message.v1.deleted

字段
message

Message

已删除的消息。系统只会填充 name、createTime、deleteTime 和 deletionMetadata 字段。

MessageUpdatedEventData

更新后的消息的事件载荷。

事件类型：google.workspace.chat.message.v1.updated

字段
message

Message

更新后的消息。

QuotedMessageMetadata

有关引用的邮件的信息。

字段
name

string

仅限输出。被引用消息的资源名称。

格式：spaces/{space}/messages/{message}
last_update_time

Timestamp

仅限输出。引用消息的创建时间或上次更新时间。

回应

对消息的回应。

字段
name

string

标识符。回应的资源名称。

格式：spaces/{space}/messages/{message}/reactions/{reaction}
user

User

仅限输出。创建回应的用户。
emoji

Emoji

必需。回应中使用的表情符号。

ReactionBatchCreatedEventData

多个新回应的事件载荷。

事件类型：google.workspace.chat.reaction.v1.batchCreated

字段
reactions[]

ReactionCreatedEventData

新回应的列表。

ReactionBatchDeletedEventData

多个已删除回应的事件载荷。

事件类型：google.workspace.chat.reaction.v1.batchDeleted

字段
reactions[]

ReactionDeletedEventData

已删除的回应的列表。

ReactionCreatedEventData

新回应的事件载荷。

事件类型：google.workspace.chat.reaction.v1.created

字段
reaction

Reaction

新回应。

ReactionDeletedEventData

已删除回应的事件载荷。

类型：google.workspace.chat.reaction.v1.deleted

字段
reaction

Reaction

已删除的回应。

RichLinkMetadata

指向资源的富媒体链接。

字段
uri

string

此链接的 URI。
联合字段 data。关联资源的数据。data 只能是下列其中一项：

RichLinkType

富媒体链接类型。我们将来可能会添加更多类型。

枚举
DRIVE_FILE Google 云端硬盘富链接类型。
CHAT_SPACE Chat 聊天室富链接类型。例如，聊天室智能条状标签。

SearchSpacesRequest

请求根据查询搜索聊天室列表。

字段
use_admin_access

bool

如果为 true，则该方法会使用用户的 Google Workspace 管理员权限运行。

发起通话的用户必须是拥有管理聊天和聊天室对话权限的 Google Workspace 管理员。

需要 chat.admin.spaces.readonly 或 chat.admin.spaces OAuth 2.0 范围。

此方法目前仅支持管理员访问权限，因此此字段仅接受 true。
page_size

int32

要返回的聊天室数量上限。服务返回的数量可能小于此值。

如果未指定，则最多返回 100 个聊天室。

最大值为 1000。如果您使用的值超过 1000，系统会自动将其更改为 1000。
page_token

string

从上一个搜索空间调用接收的令牌。提供此参数以检索后续页面。

进行分页时，提供的所有其他参数都应与提供页面令牌的调用相一致。向其他参数传递不同的值可能会导致意外结果。
query

string

必需。搜索查询。

您可以使用以下参数进行搜索：

  • create_time
  • customer
  • display_name
  • external_user_allowed
  • last_active_time
  • space_history_state
  • space_type

create_time 和 last_active_time 接受 RFC-3339 格式的时间戳，支持的比较运算符包括：=、<、>、<=、>=。

customer 是必需的，用于指明要从哪个客户提取聊天室。customers/my_customer 是唯一支持的值。

display_name 仅接受 HAS (:) 运算符。要匹配的文本首先会被分解为令牌，然后每个令牌都会作为聊天室 display_name 中的任意子字符串，以不区分大小写的方式独立进行前缀匹配。例如，Fun Eve 与 Fun event 或 The evening was fun 匹配，但不匹配 notFun event 或 even。

external_user_allowed 接受 true 或 false。

space_history_state 仅接受 space 资源的 historyState 字段中的值。

space_type 是必需的，且唯一的有效值是 SPACE。

在不同字段中，仅支持 AND 运算符。有效示例为 space_type = "SPACE" AND display_name:"Hello"，无效示例为 space_type = "SPACE" OR display_name:"Hello"。

在同一字段中，space_type 不支持 AND 或 OR 运算符。display_name、“space_history_state”和“external_user_allowed”仅支持 OR 运算符。last_active_time 和 create_time 同时支持 AND 和 OR 运算符。AND 只能用于表示间隔，例如 last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00"。

以下示例查询有效：

customer = "customers/my_customer" AND space_type = "SPACE"

customer = "customers/my_customer" AND space_type = "SPACE" AND
display_name:"Hello World"

customer = "customers/my_customer" AND space_type = "SPACE" AND
(last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(display_name:"Hello World" OR display_name:"Fun event") AND
(last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(create_time > "2019-01-01T00:00:00+00:00" AND create_time <
"2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND
(space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
order_by

string

可选。聊天室列表的排序方式。

支持按以下属性排序：

  • membership_count.joined_direct_human_user_count - 表示直接加入聊天室的真人用户数。
  • last_active_time - 表示上次将符合条件的项添加到此聊天室的任何主题的时间。
  • create_time - 表示聊天室的创建时间。

有效的排序操作值包括：

  • ASC 表示升序。默认值。

  • DESC 表示降序。

支持的语法如下：

  • membership_count.joined_direct_human_user_count DESC
  • membership_count.joined_direct_human_user_count ASC
  • last_active_time DESC
  • last_active_time ASC
  • create_time DESC
  • create_time ASC

SearchSpacesResponse

包含与搜索聊天室请求对应的聊天室列表的响应。

字段
spaces[]

Space

请求的聊天室的页面。
next_page_token

string

可用于检索下一页的令牌。如果此字段为空，则不存在后续页面。
total_size

int32

所有页面中与查询匹配的聊天室的总数。如果结果超过 10,000 个空格，此值为估算值。

SetUpSpaceRequest

请求创建聊天室并向其中添加指定用户。

字段
space

Space

必需。Space.spaceType 是必填字段。

如需创建聊天室，请将 Space.spaceType 设置为 SPACE，并设置 Space.displayName。如果您在设置聊天室时收到错误消息 ALREADY_EXISTS，请尝试使用其他 displayName。Google Workspace 组织中的现有聊天室可能已使用此显示名称。

如需创建群聊，请将 Space.spaceType 设置为 GROUP_CHAT。请勿设置 Space.displayName。

如需创建人与人之间的 1 对 1 对话，请将 Space.spaceType 设置为 DIRECT_MESSAGE，并将 Space.singleUserBotDm 设置为 false。请勿设置 Space.displayName 或 Space.spaceDetails。

如需在用户与发起通话的 Chat 应用之间创建 1 对 1 对话，请将 Space.spaceType 设置为 DIRECT_MESSAGE，并将 Space.singleUserBotDm 设置为 true。请勿设置 Space.displayName 或 Space.spaceDetails。

如果 DIRECT_MESSAGE 聊天室已存在，系统会返回该聊天室，而不是创建新聊天室。
request_id

string

可选。此请求的唯一标识符。建议使用随机 UUID。指定现有请求 ID 会返回使用该 ID 创建的聊天室，而不是创建新的聊天室。使用其他经过身份验证的用户指定同一 Chat 应用中的现有请求 ID 会返回错误。
memberships[]

Membership

可选。要邀请加入聊天室的 Google Chat 用户或群组。请忽略发起通话的用户，因为系统会自动添加该用户。

该集合目前最多支持 20 个成员（除了调用方之外）。

对于人体成员资格，Membership.member 字段必须包含一个已填充 name 的 user（格式：users/{user}），并将 type 设置为 User.Type.HUMAN。您只能在设置聊天室时添加真人用户（仅支持在通过通话应用设置私信时添加 Chat 扩展应用）。您还可以使用用户的电子邮件地址作为 {user} 的别名来添加成员。例如，user.name 可以是 users/example@gmail.com。如需邀请 Gmail 用户或外部 Google Workspace 网域中的用户，必须使用用户的电子邮件地址作为 {user}。

对于 Google 群组成员资格，Membership.group_member 字段必须包含填充了 name 的 group（格式为 groups/{group}）。只有将 Space.spaceType 设置为 SPACE 时，您才能添加 Google 群组。

将 Space.spaceType 设置为 SPACE 时为可选。

将 Space.spaceType 设置为 GROUP_CHAT 时需要，并且至少需要两个成员资格。

将 Space.spaceType 设置为 DIRECT_MESSAGE 并使用真人用户时，此属性是必需的，并且必须有一个成员资格。

在创建人工与发起 Chat 应用对话的 1 对 1 对话时（将 Space.spaceType 设置为 DIRECT_MESSAGE 并将 Space.singleUserBotDm 设置为 true 时），此值必须为空。

SlashCommand

Google Chat 中的斜杠命令。

字段
command_id

int64

调用的斜杠命令的 ID。

SlashCommandMetadata

斜杠命令 (/) 的注释元数据。

字段
bot

User

调用命令的 Chat 应用。
type

Type

斜杠命令的类型。
command_name

string

调用的斜杠命令的名称。
command_id

int64

调用的斜杠命令的命令 ID。
triggers_dialog

bool

指示斜杠命令是否适用于对话框。

类型

枚举
TYPE_UNSPECIFIED 枚举的默认值。请勿使用。
ADD 将 Chat 应用添加到聊天室。
INVOKE 在聊天室中调用斜杠命令。

空格

Google Chat 中的聊天室。聊天室是指两名或两名以上用户之间的对话，或用户与 Chat 应用之间的一对一消息。

字段
name

string

标识符。聊天室的资源名称。

格式：spaces/{space}

其中 {space} 表示聊天室的系统分配 ID。您可以通过调用 spaces.list() 方法或从聊天室网址中获取聊天室 ID。例如，如果聊天室网址为 https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA，则聊天室 ID 为 AAAAAAAAA。
type
(deprecated)

Type

仅限输出。已弃用：请改用 space_type。聊天室的类型。
space_type

SpaceType

可选。聊天室类型。创建聊天室或更新聊天室类型时，此字段为必需字段。仅用于其他用途的输出。
single_user_bot_dm

bool

可选。聊天室是 Chat 应用与单个用户之间的私信。
threaded
(deprecated)

bool

仅限输出。已弃用：请改用 spaceThreadingState。此聊天室中消息是否会以话题形式显示。
display_name

string

可选。聊天室的显示名称。当 spaceType 为 SPACE 时，创建聊天室时需要此属性。如果您在创建聊天室或更新 displayName 时收到错误消息 ALREADY_EXISTS，请尝试使用其他 displayName。Google Workspace 组织中的现有聊天室可能已经在使用此显示名称。

对于私信，此字段可能为空。

最多支持 128 个字符。
external_user_allowed

bool

可选。不可变。此聊天室是否允许任何 Google Chat 用户成为成员。在 Google Workspace 组织中创建聊天室时输入的信息。在以下情况下创建聊天室时，请省略此字段：

  • 已验证身份的用户使用的是个人账号（不受管理的用户账号）。默认情况下，个人用户账号创建的聊天室会允许任何 Google Chat 用户加入。

对于现有聊天室，此字段仅用于输出。
space_threading_state

SpaceThreadingState

仅限输出。Chat 聊天室中的会话状态。
space_details

SpaceDetails

可选。聊天室的详细信息，包括说明和规则。
space_history_state

HistoryState

可选。此聊天室中消息和会话的消息记录状态。
import_mode

bool

可选。此聊天室是否是在将数据迁移到 Google Workspace 的过程中在 Import Mode 中创建的。在导入聊天室时，用户将看不到这些聊天室，直到导入完成为止。

在 Import Mode 中创建聊天室需要用户身份验证。
create_time

Timestamp

可选。不可变。对于在 Chat 中创建的聊天室，该值为聊天室的创建时间。此字段仅用于输出，但在导入模式聊天室中使用时除外。

对于导入模式聊天室，请将此字段设置为聊天室在来源中创建的历史时间戳，以保留原始创建时间。

仅当 spaceType 为 GROUP_CHAT 或 SPACE 时才会在输出中填充。
last_active_time

Timestamp

仅限输出。聊天室中最后一条消息的时间戳。
admin_installed

bool

仅限输出。对于 Chat 应用中的私信聊天室，聊天室是由 Google Workspace 管理员创建的。管理员可以代表贵组织中的用户安装 Chat 应用并设置私信功能。

如需支持管理员安装，您的 Chat 应用必须支持私信功能。
membership_count

MembershipCount

仅限输出。已加入的会员资格数量（按会员类型分组）。当 space_type 设为 SPACE、DIRECT_MESSAGE 或 GROUP_CHAT 时，此字段会被填充。
access_settings

AccessSettings

可选。指定聊天室的访问权限设置。仅当 space_type 为 SPACE 时填充。
space_uri

string

仅限输出。用户访问聊天室的 URI。
import_mode_expire_time

Timestamp

仅限输出。如果聊天室仍处于导入模式，系统会在该时间自动将其删除。

在导入模式下创建的每个聊天室都必须在到期时间之前使用 spaces.completeImport 退出此模式。

系统仅会为使用导入模式创建的聊天室填充此字段。
customer

string

可选。不可变。聊天室所在网域的客户 ID。仅当使用应用身份验证创建聊天室且 SpaceType 为 SPACE 时才必需，否则不应设置。

格式为 customers/{customer}，其中 customer 是 [Admin SDK 客户资源]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) 中的 id。专用应用还可以使用 customers/my_customer 别名在与应用所在的 Google Workspace 组织相同的组织中创建聊天室。

对于私信，此字段不会填充。

联合字段 space_permission_settings。表示聊天室的权限设置。仅当 space_type 为 SPACE 时填充。

需要用户身份验证。space_permission_settings 只能是下列其中一项：
predefined_permission_settings

PredefinedPermissionSettings

可选。仅限输入。预定义的聊天室权限设置，仅在创建聊天室时输入。如果未设置此字段，则系统会创建协作空间。创建聊天室后，系统会在 PermissionSettings 字段中填充设置。
permission_settings

PermissionSettings

可选。现有聊天室的聊天室权限设置。用于更新确切聊天室权限设置的输入，其中会替换现有权限设置。输出列出了当前权限设置。

AccessSettings

表示聊天室的访问权限设置。

字段
access_state

AccessState

仅限输出。表示聊天室的访问状态。
audience

string

可选。可以发现聊天室、加入聊天室并预览聊天室中消息的目标对象群组的资源名称。如果未设置，则只有被单独邀请或添加到聊天室的用户或 Google 群组才能访问该聊天室。有关详情，请参阅让目标对象群组能够发现聊天室。

格式：audiences/{audience}

如需使用 Google Workspace 组织的默认目标对象群组，请将其设置为 audiences/default。

读取目标对象群组支持：

将 chat.bot 范围与应用身份验证搭配使用时，系统不会填充此字段。

设置目标对象群组需要用户身份验证。

AccessState

表示聊天室的访问状态。

枚举
ACCESS_STATE_UNSPECIFIED 此 API 中的访问权限状态未知或不受支持。
PRIVATE 只有其他用户或 Google Workspace 管理员单独添加或邀请的用户或 Google 群组才能发现和访问聊天室。
DISCOVERABLE

聊天室管理员已向目标对象群组授予对聊天室的访问权限。已单独添加或受邀加入聊天室的用户或 Google 群组也可以发现和访问该聊天室。如需了解详情，请参阅向特定用户公开聊天室。

创建开放型聊天室需要用户身份验证。

MembershipCount

表示聊天室的成员数量，按类别分组。

字段
joined_direct_human_user_count

int32

仅限输出。直接加入聊天室的真人用户数，不包括因加入聊天室所属群组而加入的用户。
joined_group_count

int32

仅限输出。直接加入聊天室的所有群组的数量。

PermissionSetting

表示聊天室权限设置。

字段
managers_allowed

bool

可选。聊天室管理员是否拥有此权限。
members_allowed

bool

可选。非管理员成员是否拥有此权限。

PermissionSettings

您在更新现有命名空间时可以指定的权限设置。

如需在创建聊天室时设置权限设置，请在请求中指定 PredefinedPermissionSettings 字段。

字段
manage_members_and_groups

PermissionSetting

可选。用于管理聊天室中的成员和群组的设置。
modify_space_details

PermissionSetting

可选。用于更新聊天室名称、头像、说明和准则的设置。
toggle_history

PermissionSetting

可选。用于开启或关闭聊天室历史记录的设置。
use_at_mention_all

PermissionSetting

可选。用于在聊天室中使用“@所有人”的设置。
manage_apps

PermissionSetting

可选。用于管理聊天室中应用的设置。
manage_webhooks

PermissionSetting

可选。用于管理聊天室中网络钩子的设置。
post_messages

PermissionSetting

仅限输出。用于在聊天室中发送消息的设置。
reply_messages

PermissionSetting

可选。用于在聊天室中回复消息的设置。

PredefinedPermissionSettings

预定义的权限设置，您只能在创建命名聊天室时指定。我们将来可能会添加更多设置。如需详细了解命名空间的权限设置，请参阅了解聊天室。

枚举
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED 未指定。请勿使用。
COLLABORATION_SPACE 将聊天室设为协作聊天室，以便所有成员都可以发帖。
ANNOUNCEMENT_SPACE 将聊天室设为通知聊天室，这样只有聊天室管理员才能发送消息。

SpaceDetails

聊天室的详细信息，包括说明和规则。

字段
description

string

可选。聊天室的说明。例如，描述聊天室的讨论主题、功能用途或参与者。

最多支持 150 个字符。
guidelines

string

可选。聊天室的规则、期望和礼仪。

最多支持 5,000 个字符。

SpaceThreadingState

指定 Chat 聊天室中的会话状态类型。

枚举
SPACE_THREADING_STATE_UNSPECIFIED 已预订。
THREADED_MESSAGES 支持消息会话的命名聊天室。用户回复消息时，可以回复会话，这样他们的回复就会保留在原始消息的上下文中。
GROUPED_MESSAGES 对话按主题整理的命名聊天室。系统会将主题及其回复分组。
UNTHREADED_MESSAGES 两人之间的私信 (DM) 以及 3 人或更多人之间的群组对话。

SpaceType

聊天室类型。创建或更新聊天室时必须指定此属性。仅用于其他用途的输出。

枚举
SPACE_TYPE_UNSPECIFIED 已预订。
SPACE 用户可在聊天室中发送消息、共享文件和协作。SPACE 可以包含 Chat 应用。
GROUP_CHAT 3 人或更多人之间的群组对话。GROUP_CHAT 可以包含 Chat 应用。
DIRECT_MESSAGE 两人或一人与 Chat 应用之间的 1 对 1 消息。

类型

已弃用：请改用 SpaceType。

枚举
TYPE_UNSPECIFIED 已预订。
ROOM 两人或多人之间的对话。
DM 人与 Chat 应用之间的一对一私信，其中所有消息都是平行的。请注意，这不包括人与人之间的私信。

SpaceBatchUpdatedEventData

用于对聊天室进行多次更新的事件载荷。

事件类型：google.workspace.chat.space.v1.batchUpdated

字段
spaces[]

SpaceUpdatedEventData

已更新聊天室的列表。

SpaceEvent

表示 Google Chat 聊天室中发生的更改或活动的事件。如需了解详情，请参阅处理 Google Chat 中的事件。

字段
name

string

聊天室事件的资源名称。

格式：spaces/{space}/spaceEvents/{spaceEvent}
event_time

Timestamp

事件发生的时间。
event_type

string

聊天室事件的类型。每种事件类型都有一个批处理版本，该版本表示短时间内发生的该事件类型的多个实例。对于 spaceEvents.list() 请求，请在查询过滤条件中省略批量事件类型。默认情况下，服务器会同时返回事件类型及其批处理版本。

消息支持的事件类型：

  • 新消息：google.workspace.chat.message.v1.created
  • 更新后的消息：google.workspace.chat.message.v1.updated
  • 已删除消息：google.workspace.chat.message.v1.deleted
  • 多个新消息：google.workspace.chat.message.v1.batchCreated
  • 更新了多条消息：google.workspace.chat.message.v1.batchUpdated
  • 已删除多条消息：google.workspace.chat.message.v1.batchDeleted

会员资格支持的事件类型：

  • 新会员：google.workspace.chat.membership.v1.created
  • 更新后的会员资格：google.workspace.chat.membership.v1.updated
  • 已删除的会员资格：google.workspace.chat.membership.v1.deleted
  • 多个新会员：google.workspace.chat.membership.v1.batchCreated
  • 更新了多个会员资格：google.workspace.chat.membership.v1.batchUpdated
  • 多个已删除的会员资格：google.workspace.chat.membership.v1.batchDeleted

回应支持的事件类型：

  • 新回应：google.workspace.chat.reaction.v1.created
  • 已删除的回应：google.workspace.chat.reaction.v1.deleted
  • 新增了多种回应：google.workspace.chat.reaction.v1.batchCreated
  • 已删除的回应数量：google.workspace.chat.reaction.v1.batchDeleted

与聊天室相关的支持事件类型：

  • 更新后的聊天室：google.workspace.chat.space.v1.updated
  • 多个聊天室更新：google.workspace.chat.space.v1.batchUpdated

联合字段 payload。

payload 只能是下列其中一项：
message_created_event_data

MessageCreatedEventData

新消息的事件载荷。

事件类型：google.workspace.chat.message.v1.created
message_updated_event_data

MessageUpdatedEventData

更新后的消息的事件载荷。

事件类型：google.workspace.chat.message.v1.updated
message_deleted_event_data

MessageDeletedEventData

已删除邮件的事件载荷。

事件类型：google.workspace.chat.message.v1.deleted
message_batch_created_event_data

MessageBatchCreatedEventData

多个新消息的事件载荷。

事件类型：google.workspace.chat.message.v1.batchCreated
message_batch_updated_event_data

MessageBatchUpdatedEventData

多个更新消息的事件载荷。

事件类型：google.workspace.chat.message.v1.batchUpdated
message_batch_deleted_event_data

MessageBatchDeletedEventData

多个已删除邮件的事件载荷。

事件类型：google.workspace.chat.message.v1.batchDeleted
space_updated_event_data

SpaceUpdatedEventData

聊天室更新的事件载荷。

事件类型：google.workspace.chat.space.v1.updated
space_batch_updated_event_data

SpaceBatchUpdatedEventData

用于对聊天室进行多次更新的事件载荷。

事件类型：google.workspace.chat.space.v1.batchUpdated
membership_created_event_data

MembershipCreatedEventData

新会员的事件载荷。

事件类型：google.workspace.chat.membership.v1.created
membership_updated_event_data

MembershipUpdatedEventData

更新后的会员资格的事件载荷。

事件类型：google.workspace.chat.membership.v1.updated
membership_deleted_event_data

MembershipDeletedEventData

已删除会员资格的事件载荷。

事件类型：google.workspace.chat.membership.v1.deleted
membership_batch_created_event_data

MembershipBatchCreatedEventData

多个新会员的事件载荷。

事件类型：google.workspace.chat.membership.v1.batchCreated
membership_batch_updated_event_data

MembershipBatchUpdatedEventData

多个更新后的会员资格的事件载荷。

事件类型：google.workspace.chat.membership.v1.batchUpdated
membership_batch_deleted_event_data

MembershipBatchDeletedEventData

多个已删除会员的事件载荷。

事件类型：google.workspace.chat.membership.v1.batchDeleted
reaction_created_event_data

ReactionCreatedEventData

新回应的事件载荷。

事件类型：google.workspace.chat.reaction.v1.created
reaction_deleted_event_data

ReactionDeletedEventData

已删除的回应的事件载荷。

事件类型：google.workspace.chat.reaction.v1.deleted
reaction_batch_created_event_data

ReactionBatchCreatedEventData

多个新回应的事件载荷。

事件类型：google.workspace.chat.reaction.v1.batchCreated
reaction_batch_deleted_event_data

ReactionBatchDeletedEventData

多个已删除回应的事件载荷。

事件类型：google.workspace.chat.reaction.v1.batchDeleted

SpaceNotificationSetting

聊天室中用户的通知设置。

字段
name

string

标识符。聊天室通知设置的资源名称。格式：users/{user}/spaces/{space}/spaceNotificationSetting。
notification_setting

NotificationSetting

通知设置。
mute_setting

MuteSetting

聊天室通知静音设置。

MuteSetting

聊天室通知静音设置类型。

枚举
MUTE_SETTING_UNSPECIFIED 已预订。
UNMUTED 用户将根据通知设置收到聊天室通知。
MUTED 无论通知设置如何，用户都不会收到有关该聊天室的任何通知。

NotificationSetting

通知设置类型。

枚举
NOTIFICATION_SETTING_UNSPECIFIED 已预订。
ALL 系统会在有人用“@”提及你、所关注的话题有新消息，或新话题中有首条消息时发出通知。除非用户手动取消关注，否则系统会自动关注所有新会话。
MAIN_CONVERSATIONS 系统会在有人用“@”提及你、关注的话题有新消息，或新话题中有首条消息时触发通知。不适用于一对一私信。
FOR_YOU 系统会在收到用“@”提及的消息、所关注话题的消息时触发通知。不适用于一对一私信。
OFF 通知已关闭。

SpaceReadState

用户在聊天室中的阅读状态，用于标识已读和未读消息。

字段
name

string

聊天室读取状态的资源名称。

格式：users/{user}/spaces/{space}/spaceReadState
last_read_time

Timestamp

可选。用户聊天室读取状态的更新时间。通常，此值与上次读取的消息的时间戳相对应，或者与用户指定的时间戳相对应，用于标记聊天室中上次读取的位置。

SpaceUpdatedEventData

更新后的聊天室的事件载荷。

事件类型：google.workspace.chat.space.v1.updated

字段
space

Space

更新后的聊天室。

会话

Google Chat 聊天室中的会话串。如需查看用法示例，请参阅发起或回复消息串。

如果您在创建消息时指定了会话，则可以设置 messageReplyOption 字段，以确定在找不到匹配的会话时会发生什么情况。

字段
name

string

标识符。线程的资源名称。

示例：spaces/{space}/threads/{thread}
thread_key

string

可选。用于创建或更新会话的输入。否则，仅限输出。线程的 ID。最多支持 4,000 个字符。

此 ID 是设置它的 Chat 应用所特有的。例如，如果多个 Chat 应用使用相同的话题键创建消息，则这些消息会发布在不同的会话中。如需在某人或其他 Chat 应用创建的消息串中回复，请改为指定消息串 name 字段。

ThreadReadState

用户在会话中的读取状态，用于识别已读和未读消息。

字段
name

string

线程读取状态的资源名称。

格式：users/{user}/spaces/{space}/threads/{thread}/threadReadState
last_read_time

Timestamp

用户的线程读取状态更新的时间。通常，这与会话中最后读取的消息的时间戳相对应。

UpdateMembershipRequest

用于更新会员资格的请求消息。

字段
membership

Membership

必需。要更新的会员资格。仅更新 update_mask 指定的字段。
update_mask

FieldMask

必需。要更新的字段路径。使用英文逗号分隔多个值，或使用 * 更新所有字段路径。

目前支持的字段路径：

  • role
use_admin_access

bool

可选。如果为 true，则该方法会使用用户的 Google Workspace 管理员权限运行。

发起通话的用户必须是拥有管理聊天和聊天室对话权限的 Google Workspace 管理员。

需要 chat.admin.memberships OAuth 2.0 范围。

UpdateMessageRequest

请求更新消息。

字段
message

Message

必需。字段已被更新的消息。
update_mask

FieldMask

必需。要更新的字段路径。使用英文逗号分隔多个值，或使用 * 更新所有字段路径。

目前支持的字段路径：
allow_missing

bool

可选。如果找不到 true 和消息，系统会创建新消息并忽略 updateMask。指定的消息 ID 必须由客户端分配，否则请求将会失败。

UpdateSpaceNotificationSettingRequest

请求更新聊天室通知设置。仅支持更新发起通话的用户的通知设置。

字段
space_notification_setting

SpaceNotificationSetting

必需。聊天室通知设置的资源名称必须采用 users/{user}/spaces/{space}/spaceNotificationSetting 格式填充。仅更新 update_mask 指定的字段。
update_mask

FieldMask

必需。支持的字段路径：- notification_setting - mute_setting

UpdateSpaceReadStateRequest

UpdateSpaceReadState API 的请求消息。

字段
space_read_state

SpaceReadState

必需。聊天室读取状态和要更新的字段。

仅支持更新调用方用户的读取状态。

如需引用调用方用户，请设置以下任一项：

  • me 别名。例如 users/me/spaces/{space}/spaceReadState。

  • 用户的 Workspace 电子邮件地址。例如 users/user@example.com/spaces/{space}/spaceReadState。

  • 用户 ID。例如 users/123456789/spaces/{space}/spaceReadState。

格式：users/{user}/spaces/{space}/spaceReadState
update_mask

FieldMask

必需。要更新的字段路径。目前支持的字段路径：

  • last_read_time

如果 last_read_time 早于最新消息的创建时间，聊天室会在界面中显示为未读。

如需将聊天室标记为已读，请将 last_read_time 设置为晚于（大于）最新消息创建时间的任何值。last_read_time 会强制转换为与最新消息的创建时间一致。请注意，聊天室的已读状态只会影响聊天室顶级对话中显示的消息的已读状态。会话中的回复不会受此时间戳影响，而是取决于会话的读取状态。

UpdateSpaceRequest

用于更新单个聊天室的请求。

字段
space

Space

必需。要更新字段的聊天室。Space.name 必须采用 spaces/{space} 格式进行填充。仅更新 update_mask 指定的字段。
update_mask

FieldMask

必需。更新后的字段路径，如果有多个，请用英文逗号分隔。

您可以更新聊天室的以下字段：

space_details：更新聊天室的说明。最多支持 150 个字符。

display_name：仅支持更新 spaceType 字段为 SPACE 的工作区的显示名称。如果您收到错误消息 ALREADY_EXISTS，请尝试使用其他值。Google Workspace 组织中的现有聊天室可能已使用此显示名称。

space_type：仅支持将 GROUP_CHAT 空间类型更改为 SPACE。在更新掩码中添加 display_name 和 space_type，并确保指定聊天室具有非空显示名称和 SPACE 聊天室类型。如果现有聊天室已具有 SPACE 类型，则在更新显示名称时，在指定聊天室中添加 space_type 掩码和 SPACE 类型是可选的。尝试以其他方式更新聊天室类型会导致参数无效错误。useAdminAccess 不支持 space_type。

space_history_state：通过为聊天室开启或关闭历史记录来更新聊天室历史记录设置。仅当 Google Workspace 组织启用了历史记录设置时才受支持。如需更新聊天室历史记录状态，您必须在请求中省略所有其他字段掩码。useAdminAccess 不支持 space_history_state。

access_settings.audience：更新可在命名聊天室中发现聊天室、加入聊天室以及预览消息的用户的访问权限设置，其中 spaceType 字段为 SPACE。如果现有聊天室具有目标对象群组，您可以通过省略此字段掩码的值来移除该对象群组并限制聊天室访问权限。如需更新聊天室的访问权限设置，进行身份验证的用户必须是聊天室管理员，并且在请求中省略所有其他字段掩码。如果聊天室处于导入模式，您将无法更新此字段。如需了解详情，请参阅向特定用户公开聊天室。useAdminAccess 不支持 access_settings.audience。

permission_settings：支持更改聊天室的权限设置。更新权限设置时，您只能指定 permissionSettings 字段掩码；您无法同时更新其他字段掩码。useAdminAccess 不支持 permissionSettings。支持的字段掩码包括：

  • permission_settings.manageMembersAndGroups
  • permission_settings.modifySpaceDetails
  • permission_settings.toggleHistory
  • permission_settings.useAtMentionAll
  • permission_settings.manageApps
  • permission_settings.manageWebhooks
  • permission_settings.replyMessages
use_admin_access

bool

可选。如果为 true，则该方法会使用用户的 Google Workspace 管理员权限运行。

发起通话的用户必须是拥有管理聊天和聊天室对话权限的 Google Workspace 管理员。

需要 chat.admin.spaces OAuth 2.0 范围。

使用管理员访问权限不支持使用某些 FieldMask 值。如需了解详情，请参阅 update_mask 的说明。

用户

Google Chat 中的用户。作为请求的输出返回时，如果您的 Chat 应用以用户身份进行身份验证，则 User 资源的输出仅填充用户的 name 和 type。

字段
name

string

Google Chat user 的资源名称。

格式：users/{user}。users/app 可用作调用应用 bot 用户的别名。

对于 human users，{user} 与以下用户标识符相同：

  • People API 中 Person 的 id。例如，Chat API 中的 users/123456789 代表与 People API 中的 123456789 人员个人资料 ID 相同的人员。

  • Admin SDK Directory API 中用户的 id。

  • 用户的电子邮件地址可用作 API 请求中 {user} 的别名。例如，如果 user@example.com 的 People API 人员个人资料 ID 为 123456789，您可以使用 users/user@example.com 作为别名来引用 users/123456789。API 将仅返回规范资源名称（例如 users/123456789）。
display_name

string

仅限输出。用户的显示名称。
domain_id

string

用户 Google Workspace 网域的唯一标识符。
type

Type

用户类型。
is_anonymous

bool

仅限输出。如果为 true，则表示用户已被删除或其个人资料不可见。

类型

枚举
TYPE_UNSPECIFIED 枚举的默认值。请勿使用。
HUMAN 人类用户。
BOT Chat 应用用户。

UserMentionMetadata

用户提及 (@) 的注释元数据。

字段
user

User

被提及的用户。
type

Type

用户提及的类型。

类型

枚举
TYPE_UNSPECIFIED 枚举的默认值。请勿使用。
ADD 将用户添加到聊天室。
MENTION 在聊天室中提及用户。

WidgetMarkup

微件是一种用于呈现文本和图片的界面元素。

字段
buttons[]

Button

按钮列表。Buttons 也为 oneof data，并且应仅设置其中一个字段。
联合字段 data。WidgetMarkup 只能包含以下各项之一。您可以使用多个 WidgetMarkup 字段来显示更多项。data 只能是下列其中一项：
text_paragraph

TextParagraph

在此 widget 中显示文本段落。
image

Image

在此 widget 中显示图片。
key_value

KeyValue

在此微件中显示键值对项。

按钮

一个按钮。可以是文本按钮或图片按钮。

字段

联合字段 type。

type 只能是下列其中一项：
text_button

TextButton

一个包含文本和 onclick 操作的按钮。
image_button

ImageButton

带有图片和 onclick 操作的按钮。

FormAction

表单操作用于描述表单提交时的行为。例如，您可以调用 Google Apps 脚本来处理表单。

字段
action_method_name

string

方法名称用于确定表单的哪个部分触发了表单提交。系统会在卡片点击事件中将此信息回传给 Chat 应用。您可以为触发常见行为的多个元素使用相同的方法名称。
parameters[]

ActionParameter

操作参数列表。

ActionParameter

调用操作方法时要提供的字符串参数列表。例如，假设有三个闹钟暂停按钮：“立即暂停”“暂停一天”“暂停下周”。您可以使用 action method = snooze()，在字符串参数列表中传递闹钟暂停类型和暂停时间。

字段
key

string

操作脚本的参数名称。
value

string

参数的值。

图标

支持的一组图标。

枚举
ICON_UNSPECIFIED
AIRPLANE
BOOKMARK
BUS
CAR
CLOCK
CONFIRMATION_NUMBER_ICON
DOLLAR
DESCRIPTION
EMAIL
EVENT_PERFORMER
EVENT_SEAT
FLIGHT_ARRIVAL
FLIGHT_DEPARTURE
HOTEL
HOTEL_ROOM_TYPE
INVITE
MAP_PIN
MEMBERSHIP
MULTIPLE_PEOPLE
OFFER
PERSON
PHONE
RESTAURANT_ICON
SHOPPING_CART
STAR
STORE
TICKET
TRAIN
VIDEO_CAMERA
VIDEO_PLAY

Image

通过网址指定的图片，可以包含 onclick 操作。

字段
image_url

string

图片的网址。
on_click

OnClick

onclick 操作。
aspect_ratio

double

此图片的宽高比（宽度和高度）。借助此字段，您可以在等待图片加载时为其预留合适的高度。它不应替换图片的内置宽高比。如果未设置，服务器会通过预加载图片来填充该值。

ImageButton

带有 onclick 操作的图片按钮。

字段
on_click

OnClick

onclick 操作。
name

string

此 image_button 的名称，用于确保可访问性。如果未指定此名称，系统会提供默认值。
联合字段 icons。图标可以通过 Icon enum 或网址指定。icons 只能是下列其中一项：
icon

Icon

由 enum 指定的图标，用于编入 Chat API 提供的图标的索引。
icon_url

string

由网址指定的图标。

KeyValue

界面元素包含键（标签）和值（内容）。此元素还可以包含一些操作，例如 onclick 按钮。

字段
top_label

string

顶部标签的文本。支持格式化文本。如需详细了解如何设置文本格式，请参阅在 Google Chat 应用中设置文本格式和在 Google Workspace 插件中设置文本格式。
content

string

内容的文本。支持格式化文本，且始终需要提供。如需详细了解如何设置文本格式，请参阅在 Google Chat 应用中设置文本格式和在 Google Workspace 插件中设置文本格式。
content_multiline

bool

内容是否应为多行。
bottom_label

string

底部标签的文本。支持格式化文本。如需详细了解如何设置文本格式，请参阅在 Google Chat 应用中设置文本格式和在 Google Workspace 插件中设置文本格式。
on_click

OnClick

onclick 操作。只有顶部标签、底部标签和内容区域是可点击的。
联合字段 icons。必须定义 top_label 和 bottom_label 图标中至少一个。icons 只能是下列其中一项：
icon

Icon

一个枚举值，Chat API 会将其替换为相应的图标图片。
icon_url

string

由网址指定的图标。
联合字段 control。一个控件微件。您可以设置 button 或 switch_widget，但不能同时设置这两者。control 只能是下列其中一项：
button

Button

可点击以触发操作的按钮。

OnClick

onclick 操作（例如打开链接）。

字段

联合字段 data。

data 只能是下列其中一项：
action

FormAction

如果指定了此 onclick 操作，系统会触发表单操作。

TextButton

一个包含文本和 onclick 操作的按钮。

字段
text

string

按钮文字。
on_click

OnClick

按钮的 onclick 操作。

TextParagraph

一段文本。支持格式化文本。如需详细了解如何设置文本格式，请参阅在 Google Chat 应用中设置文本格式和在 Google Workspace 插件中设置文本格式。

字段
text

string