Package google.chat.v1

索引

ChatService

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

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

完成指定空间的导入流程，并使其对用户可见。

需要进行用户身份验证和全网域授权，并使用授权范围：

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

如需了解详情，请参阅授权 Google Chat 应用导入数据。

授权范围

需要以下 OAuth 范围：

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

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

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

创建自定义表情符号。

自定义表情符号仅适用于 Google Workspace 账号，并且管理员必须为组织启用自定义表情符号。如需了解详情，请参阅了解 Google Chat 中的自定义表情符号和管理自定义表情符号权限。

需要使用以下授权范围进行用户身份验证：

  • https://www.googleapis.com/auth/chat.customemojis
授权范围

需要以下 OAuth 范围：

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

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

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

为发起调用的 Chat 应用、用户或 Google 群组创建会员资格。不支持为其他 Chat 应用创建会员。创建会员时，如果指定会员关闭了自动接受政策，则系统会向其发送邀请，并且该会员必须接受聊天室邀请才能加入。否则，创建会员资格会将相应成员直接添加到指定空间。

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

  • 管理员批准的应用身份验证和授权范围：

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

  • 使用以下授权范围之一进行用户身份验证：

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.memberships.app（将通话应用添加到聊天室）
    • https://www.googleapis.com/auth/chat.import（仅限“导入模式聊天室”）
    • 当管理员账号通过身份验证时，用户身份验证会授予管理员权限，use_admin_access 为 true，并使用以下授权范围：
      • https://www.googleapis.com/auth/chat.admin.memberships

应用身份验证不支持以下使用情形：

  • 邀请聊天室所属 Workspace 组织以外的用户。
  • 向聊天室添加 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 聊天室中创建消息。有关示例，请参阅发送消息。

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

  • 使用授权范围的应用身份验证：
    • https://www.googleapis.com/auth/chat.bot
  • 通过以下授权范围之一进行用户身份验证：
    • https://www.googleapis.com/auth/chat.messages.create
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import（仅限“导入模式聊天室”）

Chat 会根据您在请求中使用的身份验证类型，以不同的方式归因消息发送者。

下图显示了使用应用身份验证时，Chat 如何为消息添加属性。Chat 会将该 Chat 应用显示为消息发送者。消息的内容可以包含文本 (text)、卡片 (cardsV2) 和辅助微件 (accessoryWidgets)。

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

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

通过用户身份验证发送的消息

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

对于 webhook 请求，响应不包含完整消息。除了请求中的信息之外，响应仅填充 name 和 thread.name 字段。

授权范围

需要以下 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)

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

需要通过以下某个授权范围进行用户身份验证：

  • https://www.googleapis.com/auth/chat.messages.reactions.create
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import（仅限“导入模式聊天室”）
授权范围

需要以下 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 中创建命名空间或群聊。如需查看示例，请参阅创建聊天室。

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

  • 应用身份验证，需要管理员批准，并使用以下授权范围之一：

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

  • 使用以下授权范围之一进行用户身份验证：

    • https://www.googleapis.com/auth/chat.spaces.create
    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import（仅限导入模式聊天室）

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

以应用身份进行身份验证时，Chat 应用会添加为聊天室的成员。不过，与人工身份验证不同的是，Chat 应用不会添加为聊天室管理员。默认情况下，所有聊天室成员都可以将 Chat 应用从聊天室中移除。如需仅允许聊天室管理员从聊天室中移除应用，请将 space.permission_settings.manage_apps 设置为 managers_allowed。

创建聊天室时的聊天室成员资格取决于聊天室是否在 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)

删除自定义表情符号。默认情况下，用户只能删除自己创建的自定义表情符号。管理员分配的表情符号管理者可以删除组织中的任何自定义表情符号。请参阅了解 Google Chat 中的自定义表情符号。

自定义表情符号仅适用于 Google Workspace 账号，并且管理员必须为组织启用自定义表情符号。如需了解详情，请参阅了解 Google Chat 中的自定义表情符号和管理自定义表情符号权限。

需要使用以下授权范围进行用户身份验证：

  • https://www.googleapis.com/auth/chat.customemojis
授权范围

需要以下 OAuth 范围：

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

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

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

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

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

  • 管理员批准的应用身份验证和授权范围：

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

  • 使用以下授权范围之一进行用户身份验证：

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.memberships.app（从聊天室中移除通话应用）
    • https://www.googleapis.com/auth/chat.import（仅限“导入模式聊天室”）
    • 当管理员账号通过身份验证时，用户身份验证会授予管理员权限，use_admin_access 为 true，并使用以下授权范围：
      • https://www.googleapis.com/auth/chat.admin.memberships

应用身份验证不支持以下使用情形：

  • 从聊天室中移除 Google 群组。
  • 从聊天室中移除 Chat 应用。

如需删除聊天室管理员的会员资格，请求者必须是聊天室管理员。如果您使用应用身份验证，则 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)

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

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

  • 使用授权范围的应用身份验证：

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

  • 使用以下授权范围之一进行用户身份验证：

    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import（仅限“导入模式聊天室”）

使用应用身份验证时，请求只能删除调用 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)

删除对消息的回应。如需查看示例，请参阅删除回应。

需要通过以下某个授权范围进行用户身份验证：

  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import（仅限“导入模式聊天室”）
授权范围

需要以下 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)

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

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

  • 管理员批准的应用身份验证和授权范围：

    • https://www.googleapis.com/auth/chat.app.delete（仅限应用创建的聊天室）

  • 使用以下授权范围之一进行用户身份验证：

    • https://www.googleapis.com/auth/chat.delete
    • https://www.googleapis.com/auth/chat.import（仅限“导入模式聊天室”）
    • 当管理员账号通过身份验证时，用户身份验证会授予管理员权限，use_admin_access 为 true，并使用以下授权范围：
      • https://www.googleapis.com/auth/chat.admin.delete
授权范围

需要以下 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 应用之间的私信聊天室。

如果使用用户身份验证，则返回指定用户与经过身份验证的用户之间的私信空间。

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

  • 使用授权范围进行应用身份验证：

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

  • 通过以下授权范围之一进行用户身份验证：

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
授权范围

需要以下 OAuth 范围之一：

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

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

rpc FindGroupChats(FindGroupChatsRequest) returns (FindGroupChatsResponse)

返回所有具有 spaceType == GROUP_CHAT 的聊天室，这些聊天室的人员成员中仅包含调用用户和 FindGroupChatsRequest.memberships 中指定的用户。

如果调用用户屏蔽了某些用户或被某些用户屏蔽，并且找不到包含指定的所有用户的聊天室，此方法会返回不包含被屏蔽用户或屏蔽用户的聊天室。

指定的用户集必须仅包含人工（非应用）成员。包含非人类用户的请求不会返回任何会议室。

需要使用以下某个授权范围进行用户身份验证：

  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.memberships
授权范围

需要以下 OAuth 范围之一：

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

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

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

获取邮件附件的元数据。附件数据通过 media API 获取。如需查看示例，请参阅获取有关邮件附件的元数据。

需要通过以下授权范围进行应用身份验证：

  • https://www.googleapis.com/auth/chat.bot
授权范围

需要以下 OAuth 范围：

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

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

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

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

自定义表情符号仅适用于 Google Workspace 账号，并且管理员必须为组织启用自定义表情符号。如需了解详情，请参阅了解 Google Chat 中的自定义表情符号和管理自定义表情符号权限。

需要通过以下某个授权范围进行用户身份验证：

  • https://www.googleapis.com/auth/chat.customemojis.readonly
  • https://www.googleapis.com/auth/chat.customemojis
授权范围

需要以下 OAuth 范围之一：

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

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

rpc GetMembership(GetMembershipRequest) returns (Membership)

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

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

  • 使用以下授权范围之一的应用身份验证：

    • https://www.googleapis.com/auth/chat.bot
    • https://www.googleapis.com/auth/chat.app.memberships（需要管理员审批）

  • 使用以下授权范围之一进行用户身份验证：

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • 当管理员账号通过身份验证、use_admin_access 为 true 且使用以下授权范围之一时，用户身份验证会授予管理员权限：
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships
授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.memberships
  • 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)

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

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

  • 使用以下授权范围之一的应用身份验证：

    • https://www.googleapis.com/auth/chat.bot：使用此授权范围时，此方法会返回 Chat 应用有权访问的消息（例如私信和调用 Chat 应用的斜杠命令）的相关详细信息。
    • https://www.googleapis.com/auth/chat.app.messages.readonly 需要管理员批准（在开发者预览版中提供）。使用此身份验证范围时，此方法会返回有关聊天室中公开消息的详细信息。

  • 使用以下授权范围之一进行用户身份验证：

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

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

授权范围

需要以下 OAuth 范围之一：

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

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

rpc GetSpace(GetSpaceRequest) returns (Space)

返回有关聊天室的详细信息。如需查看示例，请参阅获取空间的详细信息。

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

  • 使用以下授权范围之一的应用身份验证：

    • https://www.googleapis.com/auth/chat.bot
    • https://www.googleapis.com/auth/chat.app.spaces 需要管理员批准

  • 使用以下授权范围之一进行用户身份验证：

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
    • 用户身份验证在管理员账号通过身份验证时授予管理员权限，use_admin_access 为 true，并使用以下授权范围之一：
      • https://www.googleapis.com/auth/chat.admin.spaces.readonly
      • https://www.googleapis.com/auth/chat.admin.spaces

应用身份验证具有以下限制：

  • 只有在使用 chat.app.spaces 范围时，才会填充 space.access_settings。
  • 只有在使用 chat.app.spaces 范围时，并且仅针对应用创建的聊天室，才会填充 space.predefind_permission_settings 和 space.permission_settings。
授权范围

需要以下 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 字段不会在空间事件数据的空间对象中返回。

支持以下类型的身份验证，并提供适合读取所请求数据的授权范围：

  • 在开发者预览版中，通过管理员批准进行应用身份验证，并使用以下授权范围之一：

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

  • 使用以下授权范围之一进行用户身份验证：

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

如需获取活动，经过身份验证的调用者必须是相应聊天室的成员。

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

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • 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)

获取聊天室通知设置。如需查看示例，请参阅获取调用者的空间通知设置。

需要使用以下授权范围进行用户身份验证：

  • https://www.googleapis.com/auth/chat.users.spacesettings
授权范围

需要以下 OAuth 范围：

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

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

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

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

需要通过以下某个授权范围进行用户身份验证：

  • https://www.googleapis.com/auth/chat.users.readstate.readonly
  • https://www.googleapis.com/auth/chat.users.readstate
授权范围

需要以下 OAuth 范围之一：

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

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

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

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

需要通过以下某个授权范围进行用户身份验证：

  • https://www.googleapis.com/auth/chat.users.readstate.readonly
  • https://www.googleapis.com/auth/chat.users.readstate
授权范围

需要以下 OAuth 范围之一：

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

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

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse)

列出已通过身份验证的用户可看到的自定义表情符号。

自定义表情符号仅适用于 Google Workspace 账号，并且管理员必须为组织启用自定义表情符号。如需了解详情，请参阅了解 Google Chat 中的自定义表情符号和管理自定义表情符号权限。

需要使用以下某个授权范围进行用户身份验证：

  • https://www.googleapis.com/auth/chat.customemojis.readonly
  • https://www.googleapis.com/auth/chat.customemojis
授权范围

需要以下 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 应用的成员资格（包括其自身的成员资格）。列出具有用户身份验证的会员资格会列出已通过身份验证的用户有权访问的会议室中的会员资格。

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

  • 使用以下授权范围之一的应用身份验证：

    • https://www.googleapis.com/auth/chat.bot
    • https://www.googleapis.com/auth/chat.app.memberships（需要管理员审批）

  • 使用以下授权范围之一进行用户身份验证：

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import（仅限“导入模式聊天室”）
    • 用户身份验证在管理员账号通过身份验证时授予管理员权限，use_admin_access 为 true，并使用以下授权范围之一：
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships
授权范围

需要以下 OAuth 范围之一：

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

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

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

列出调用者所属聊天室中的消息，包括来自被屏蔽的成员和聊天室的消息。系统消息（例如宣布有新聊天室成员加入的消息）不包括在内。如果您列出没有消息的聊天室中的消息，则响应为空对象。使用 REST/HTTP 接口时，响应包含一个空的 JSON 对象 {}。如需查看示例，请参阅列出消息。

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

  • 在开发者预览版中，通过管理员审批进行应用身份验证，并使用以下授权范围：

    • https://www.googleapis.com/auth/chat.app.messages.readonly。使用此身份验证范围时，此方法仅返回聊天室中的公开消息。不包括私信。

  • 通过以下授权范围之一进行用户身份验证：

    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import（仅限导入模式聊天室）
授权范围

需要以下 OAuth 范围之一：

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

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

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

列出对消息的回应。如需查看示例，请参阅列出消息的表情符号回应。

需要使用以下某个授权范围进行用户身份验证：

  • https://www.googleapis.com/auth/chat.messages.reactions.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages
授权范围

需要以下 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 聊天室中的活动。对于每个事件，载荷都包含聊天资源的最最新版本。例如，如果您列出有关新聊天室成员的活动，服务器会返回包含最新成员资格详细信息的 Membership 资源。如果新会员在请求的时间段内被移除，则事件载荷包含一个空的 Membership 资源。

支持以下类型的身份验证，并提供适合读取所请求数据的授权范围：

  • 在开发者预览版中，通过管理员批准进行应用身份验证，并使用以下授权范围之一：

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

  • 使用以下授权范围之一进行用户身份验证：

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

如需列出活动，已通过身份验证的调用者必须是相应聊天室的成员。

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

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • 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)

列出调用方所属的聊天室。在发送第一条消息之前，系统不会列出群聊和私信。如需查看示例，请参阅列出空间。

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

  • 使用授权范围进行应用身份验证：

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

  • 通过以下授权范围之一进行用户身份验证：

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

如需按 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。如需查看示例，请参阅搜索和管理聊天室。

需要具有管理员权限的用户身份验证和以下授权范围之一：

  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.admin.spaces
授权范围

需要以下 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 Person 个人资料 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 查找 API 检索群组电子邮件地址 group@example.com 的 ID 123456789，然后将 membership.group_member.name 设置为 groups/123456789，从而将该群组添加到聊天室。不支持群组电子邮件，并且只能在命名聊天室中将 Google 群组添加为成员。

对于命名聊天室或群组对话，如果主叫方屏蔽了部分成员或被部分成员屏蔽，或者没有权限添加部分成员，则这些成员不会被添加到创建的聊天室中。

如需在调用用户与另一位人类用户之间创建私信 (DM)，请指定一个成员身份来表示该人类用户。如果一位用户屏蔽了另一位用户，则请求会失败，并且系统不会创建私信。

如需在调用用户与调用应用之间创建私信，请将 Space.singleUserBotDm 设置为 true，并且不指定任何成员。您只能使用此方法设置与调用应用的直接消息。如需将调用应用添加为聊天室或两个人类用户之间现有直接消息的成员，请参阅邀请用户或应用加入聊天室或将用户或应用添加到聊天室。

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

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

需要通过以下某个授权范围进行用户身份验证：

  • https://www.googleapis.com/auth/chat.spaces.create
  • https://www.googleapis.com/auth/chat.spaces
授权范围

需要以下 OAuth 范围之一：

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

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

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

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

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

  • 管理员批准的应用身份验证和授权范围：

    • https://www.googleapis.com/auth/chat.app.memberships（仅限应用创建的聊天室）

  • 使用以下授权范围之一进行用户身份验证：

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import（仅限“导入模式聊天室”）
    • 当管理员账号通过身份验证时，用户身份验证会授予管理员权限，use_admin_access 为 true，并使用以下授权范围：
      • https://www.googleapis.com/auth/chat.admin.memberships
授权范围

需要以下 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 方法。如需查看示例，请参阅更新消息。

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

  • 使用授权范围的应用身份验证：

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

  • 使用以下授权范围之一进行用户身份验证：

    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import（仅限“导入模式聊天室”）

使用应用身份验证时，请求只能更新调用 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 组织内的现有聊天室可能已使用此显示名称。

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

  • 应用身份验证，需要管理员批准，并使用以下授权范围之一：

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

  • 使用以下授权范围之一进行用户身份验证：

    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import（仅限“导入模式聊天室”）
    • 当管理员账号通过身份验证时，用户身份验证会授予管理员权限，use_admin_access 为 true，并使用以下授权范围：
      • https://www.googleapis.com/auth/chat.admin.spaces

应用身份验证具有以下限制：

  • 如需更新 space.predefined_permission_settings 或 space.permission_settings，应用必须是聊天室创建者。
  • 不支持为应用身份验证更新 space.access_settings.audience。
授权范围

需要以下 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)

更新聊天室通知设置。如需查看示例，请参阅更新调用者的会议室通知设置。

需要使用以下授权范围进行用户身份验证：

  • https://www.googleapis.com/auth/chat.users.spacesettings
授权范围

需要以下 OAuth 范围：

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

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

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

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

需要使用以下授权范围进行用户身份验证：

  • https://www.googleapis.com/auth/chat.users.readstate
授权范围

需要以下 OAuth 范围：

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

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

AccessoryWidget

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

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

ButtonList

按钮列表。

ActionResponse

聊天应用可用于配置其响应发布方式的参数。

字段
type

ResponseType

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

string

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

DialogAction

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

UpdatedWidget

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

ResponseType

聊天应用响应的类型。

枚举
TYPE_UNSPECIFIED 作为 NEW_MESSAGE 处理的默认类型。
NEW_MESSAGE 以新消息的形式发布到主题中。
UPDATE_MESSAGE 更新 Chat 应用的消息。仅当 CARD_CLICKED 事件的消息发送者类型为 BOT 时，才允许使用此方法。
UPDATE_USER_MESSAGE_CARDS 更新用户消息中的卡片。只有在以下情况下，才允许使用此方法：作为对具有匹配网址的 MESSAGE 事件的响应，或者作为对消息发送者类型为 HUMAN 的 CARD_CLICKED 事件的响应。文本会被忽略。
REQUEST_CONFIG 私下要求用户进行额外的身份验证或配置。
DIALOG 显示一个对话框。
UPDATE_WIDGET widget 文本自动补全选项查询。

SelectionItems

widget 自动填充结果的列表。

字段
items[]

SelectionItem

SelectionItem 对象的数组。

UpdatedWidget

对于 selectionInput widget，返回多选菜单的自动补全建议。

字段
widget

string

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

SelectionItems

widget 自动填充结果列表

ActionStatus

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

字段
status_code

Code

状态代码。
user_facing_message

string

要向用户发送的有关其请求状态的消息。如果未设置，则发送基于 status_code 的通用消息。

注释

仅限输出。注释可以与邮件的纯文本正文相关联，也可以与链接到 Google Workspace 资源（例如 Google 文档或表格）的 chip 相关联，其中 start_index 和 length 的值为 0。如需为短信添加基本格式，请参阅设置短信格式。

纯文本消息正文示例：

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

相应注释所对应的纯文本消息正文中的子字符串长度。如果不存在，则表示长度为 0。
start_index

int32

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

UserMentionMetadata

用户提及的元数据。
slash_command

SlashCommandMetadata

斜杠命令的元数据。
custom_emoji_metadata

CustomEmojiMetadata

自定义表情符号的元数据。

AnnotationType

注释的类型。

枚举
ANNOTATION_TYPE_UNSPECIFIED 枚举的默认值。请勿使用。
USER_MENTION 提及了用户。
SLASH_COMMAND 调用斜杠命令。
CUSTOM_EMOJI 自定义表情符号注释。

AppCommandMetadata

有关 Chat 应用命令的元数据。

字段
app_command_id

int32

Chat API 配置中指定的命令的 ID。
app_command_type

AppCommandType

聊天应用命令的类型。

AppCommandType

聊天应用命令的类型。如需了解详情，请参阅聊天应用命令类型。

枚举
APP_COMMAND_TYPE_UNSPECIFIED 默认值。未指定。
SLASH_COMMAND 斜杠命令。用户在 Chat 消息中发送命令。
QUICK_COMMAND 快速命令。用户在消息回复区域的 Chat 菜单中选择相应命令。

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

可选。对附件数据的引用。此字段用于创建或更新带附件的消息，或使用媒体 API 下载附件数据。
drive_data_ref

DriveDataRef

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

来源

附件的来源。

枚举
SOURCE_UNSPECIFIED 保留。
DRIVE_FILE 相应文件是 Google 云端硬盘文件。
UPLOADED_CONTENT 文件已上传到 Chat。

AttachmentDataRef

对附件数据的引用。

字段
resource_name

string

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

string

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

CalendarEventLinkData

日历活动链接的数据。

字段
calendar_id

string

关联日历的日历标识符。
event_id

string

关联的日历活动的活动标识符。

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 聊天室资源的 message。

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

CompleteImportSpaceRequest

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

字段
name

string

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

格式：spaces/{space}

CompleteImportSpaceResponse

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

字段
space

Space

导入模式聊天室。

ContextualAddOnMarkup

此类型没有字段。

供开发者指定情境化插件内容的标记。

卡片

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

字段
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 圆形边框。

部分

一个部分包含一组按指定顺序呈现（垂直）的小部件。在所有平台上，卡片的宽度都是固定的，因此目前不需要布局属性（例如 float）。

字段
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，并以 users/{user} 格式设置 user.name，其中 {user} 可以是用户的电子邮件地址。对于同一 Workspace 组织中的用户，{user} 也可以是 People API 中人员的 id，或者是 Directory API 中用户的 id。例如，如果 user@example.com 的 People API Person 个人资料 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。最多支持 4000 个字符。如需发起或添加消息串，请创建消息并指定 threadKey 或 thread.name。如需查看使用示例，请参阅发起或回复消息串。
request_id

string

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

MessageReplyOption

可选。指定消息是发起话题还是回复话题。仅在已命名的聊天室中受支持。

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

string

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

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

  • 以 client- 开头。例如，client-custom-name 是有效的自定义 ID，但 custom-name 不是。
  • 最多包含 63 个字符，并且只能包含小写字母、数字和连字符。
  • 在空间内是唯一的。Chat 应用无法为不同的消息使用相同的自定义 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。

CustomEmojiMetadata

自定义表情符号的注释元数据。

字段
custom_emoji

CustomEmoji

自定义表情符号。

DeleteCustomEmojiRequest

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

字段
name

string

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

格式：customEmojis/{customEmoji}

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

DeleteMembershipRequest

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

字段
name

string

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

删除人员成员身份时，需要 chat.memberships 范围（包含用户身份验证）或 chat.memberships.app 范围（包含应用身份验证）以及 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 时，如果消息有串式回复，则删除失败。

仅在以用户身份进行身份验证时适用。在以 Chat 应用身份进行身份验证时，此参数不起作用。

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

谁删除了消息以及消息是如何被删除的。未来可能会添加更多值。如需详细了解何时可以删除消息，请参阅在 Google Chat 中修改或删除消息。

枚举
DELETION_TYPE_UNSPECIFIED 此值未使用。
CREATOR 用户删除了自己的消息。
SPACE_OWNER 所有者或管理员删除了相应消息。
ADMIN Google Workspace 管理员已删除相应消息。管理员可以删除聊天室中的任何消息，包括任何聊天室成员或 Chat 应用发送的消息。
APP_MESSAGE_EXPIRY Chat 应用在过期时删除了自己的消息。
CREATOR_VIA_APP Chat 应用代表创建者（使用用户身份验证）删除了消息。
SPACE_OWNER_VIA_APP Chat 应用代表聊天室管理员（使用用户身份验证）删除了消息。
SPACE_MEMBER 聊天室的某位成员删除了相应消息。用户可以删除应用发送的消息。

Dialog

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

字段
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 字符串表示的基本 emoji 表情符号。
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 用户的电子邮件地址。

FindGroupChatsRequest

根据用户资源获取群组聊天室的请求。

字段
user[]

string

群组聊天中所有人类用户的资源名称，包括调用用户。聊天应用不能包含在请求中。

格式：users/{user}，其中 {user} 是 People API 中人员的 id，或 Directory API 中用户的 id。例如，如需查找包含通话用户和另外两名用户（People API 个人资料 ID 为 123456789 和 987654321）的所有群组聊天，您可以使用 users/123456789 和 users/987654321。您还可以将该电子邮件地址用作 {user} 的别名。例如，users/example@gmail.com，其中 example@gmail.com 是 Google Chat 用户的电子邮件地址。

如果调用用户是 Google Workspace 用户，则所有请求的用户都必须与调用用户属于同一 Google Workspace 组织。
page_size

int32

可选。要返回的空间数量上限。服务返回的值可能小于此值。

如果未指定，则系统最多返回 100 个空间。

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

负值会返回 INVALID_ARGUMENT 错误。
page_token

string

可选。从之前的群聊查找调用接收的页面令牌。提供此参数可检索后续页面。

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

SpaceView

所请求的聊天室视图类型。如果未设置，则默认为 SPACE_VIEW_RESOURCE_NAME_ONLY。指定 SPACE_VIEW_EXPANDED 的请求必须包含允许读取聊天室数据的范围，例如 https://www.googleapis.com/auth/chat.spaces 或 https://www.googleapis.com/auth/chat.spaces.readonly。

FindGroupChatsResponse

包含群组聊天室的响应，其中仅包含调用用户和所请求的用户。

字段
spaces[]

Space

所请求页面（或第一个页面）中的聊天室列表。
next_page_token

string

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

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 聊天记录功能已开启。组织的 Google 保险柜保留规则会指定邮件和对话的保留时长。

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。如果您使用的值超过 1,000，系统会自动将其更改为 1,000。

负值会返回 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。如果您使用的值超过 1,000，系统会自动将其更改为 1,000。

负值会返回 INVALID_ARGUMENT 错误。
page_token

string

可选。从之前的 list messages 调用接收的页面令牌。提供此参数可检索后续页面。

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

string

可选。查询过滤条件。

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

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

如需按线程过滤，请指定 thread.name，格式为 spaces/{space}/threads/{thread}。每个查询只能指定一个 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。如果您使用的值超过 1,000，系统会自动将其更改为 1,000。

负值会返回 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

仅限输出。匹配的网址。

MeetSpaceLinkData

Meet 空间链接的数据。

字段
meeting_code

string

关联的 Meet 空间的会议代码。
type

Type

表示 Meet 会议室的类型。
huddle_status

HuddleStatus

可选。仅限输出。如果 Meet 是群聊，则表示群聊的状态。否则，此属性处于未设置状态。

HuddleStatus

群聊的状态

枚举
HUDDLE_STATUS_UNSPECIFIED 枚举的默认值。请勿使用。
STARTED 即时会议已开始。
ENDED 即时会议已结束。在这种情况下，Meet 聊天室 URI 和标识符将不再有效。
MISSED 错过了即时会议。在这种情况下，Meet 聊天室 URI 和标识符将不再有效。

类型

Meet 聊天室的类型。

枚举
TYPE_UNSPECIFIED 枚举的默认值。请勿使用。
MEETING Meet 空间即会议。
HUDDLE Meet 空间是群聊。

会员资格

表示 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 应用以用户身份进行身份验证，则输出会填充 user name 和 type。
group_member

Group

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

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

MembershipRole

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

枚举
MEMBERSHIP_ROLE_UNSPECIFIED 默认值。对于 users：他们不是聊天室成员，但可以被邀请。对于 Google Groups：系统始终会分配此角色（未来可能会使用其他枚举值）。
ROLE_MEMBER

聊天室的成员。在 Chat 界面中，此角色称为“成员”。

用户拥有基本权限，例如向聊天室发送消息。管理员和所有者可以向聊天室中的成员授予其他权限，包括：

  • 添加或移除成员。
  • 修改聊天室详细信息。
  • 开启或关闭聊天记录。
  • 使用 @all 提及聊天室中的所有人。
  • 管理聊天室中安装的 Chat 应用和 webhook。

在私信和未命名的群组对话中，所有人都具有此角色。
ROLE_MANAGER

聊天室所有者。在 Chat 界面中，此角色称为“所有者”。

用户拥有管理聊天室的完整聊天室权限，包括：

  • 将聊天室中其他成员的角色更改为成员、管理员或所有者。
  • 删除聊天室。

仅在 SpaceType.SPACE（已命名的聊天室）中受支持。

如需了解详情，请参阅详细了解您作为聊天室所有者或管理员的角色。
ROLE_ASSISTANT_MANAGER

聊天室管理员。在 Chat 界面中，此角色称为“管理员”。

用户拥有 ROLE_MEMBER 的所有基本权限，并且可以由所有者授予部分管理权限。默认情况下，管理员拥有所有者的所有权限，但无法执行以下操作：

  • 删除聊天室。
  • 将其他聊天室成员设为所有者。
  • 更改所有者的角色。

默认情况下，经理的权限包括但不限于：

  • 将其他成员设为管理员。
  • 删除聊天室中的消息。
  • 管理聊天室权限。
  • 如果管理员在聊天室设置中拥有“管理成员”权限，则会收到加入聊天室的请求通知。
  • 使聊天室可供搜索。

仅在 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 应用以用户身份进行身份验证，则输出会填充 user name 和 type。
create_time

Timestamp

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

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

Timestamp

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

Timestamp

仅限输出。相应消息在 Google Chat 中被删除的时间。如果消息永远不会被删除，则此字段为空。
text

string

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

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

string

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

  • 用于粗体、斜体、删除线、等宽字体、等宽字体块和项目符号列表的标记语法。

  • 使用 <users/{user}> 格式的用户提及内容。

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

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

  • 使用星号 (*) 列出项目符号列表项，例如 * item。

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

Card

已弃用：请改用 cards_v2。

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

CardWithId

可选。卡片的数组。

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

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

使用卡片构建器设计和预览卡片。

打开卡片构建器
annotations[]

Annotation

仅限输出。注释可以与邮件的纯文本正文相关联，也可以与链接到 Google Workspace 资源（例如 Google 文档或表格）的 chip 相关联，其中 start_index 和 length 的值为 0。
thread

Thread

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

Space

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

string

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

ActionResponse

仅限输入。聊天应用可用于配置其响应发布方式的参数。
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

可选。有关另一条消息所引用消息的信息。

创建消息时，您可以引用同一话题中的消息，也可以引用根消息来创建新的根消息。不过，您无法引用其他消息串中的消息回复。

更新消息时，您无法添加或替换 quotedMessageMetadata 字段，但可以移除该字段。

如需查看使用示例，请参阅引用其他邮件。
attached_gifs[]

AttachedGif

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

AccessoryWidget

可选。显示在邮件底部的一个或多个互动 widget。您可以向包含文本、卡片或同时包含文本和卡片的消息添加辅助 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 和 deletionMetadata 字段。

MessageUpdatedEventData

更新后消息的事件载荷。

活动类型：google.workspace.chat.message.v1.updated

字段
message

Message

更新后的消息。

QuotedMessageMetadata

有关另一条消息所引用消息的信息。

创建消息时，您可以引用同一话题中的消息，也可以引用根消息来创建新的根消息。不过，您无法引用其他消息串中的消息回复。

更新消息时，您无法添加或替换 quotedMessageMetadata 字段，但可以移除该字段。

如需查看使用示例，请参阅引用其他邮件。

字段
name

string

必需。被引用的消息的资源名称。

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

Timestamp

必需。引用消息的创建时间或上次更新时间的时间戳。

如果消息已被修改，请使用此字段 last_update_time。如果消息从未经过修改，请使用 create_time。

如果 last_update_time 与引用消息的最新版本不匹配，则请求失败。

回应

对消息的回应。

字段
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

指向资源的富链接。富链接可以与邮件的纯文本正文相关联，也可以表示链接到 Google Workspace 资源（例如 Google 文档或表格）的 chip，其中 start_index 和 length 为 0。

字段
uri

string

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

RichLinkType

富链接类型。未来可能会添加更多类型。

枚举
DRIVE_FILE Google 云端硬盘富链接类型。
CHAT_SPACE Chat 聊天室富链接类型。例如，空间智能条状标签。
MEET_SPACE Meet 消息富链接类型。例如，Meet 芯片。
CALENDAR_EVENT 日历消息富链接类型。例如，日历功能块。

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。如果您使用的值超过 1,000，系统会自动将其更改为 1,000。
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 用户或群组。省略调用用户，因为系统会自动添加该用户。

该集合目前最多允许 49 个成员（不包括调用方）。

对于人类会员，Membership.member 字段必须包含 user，其中 name 已填充（格式：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 且包含人工用户以及一个会员时，需要此参数。

在创建人工客服与调用方聊天应用之间的 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

可选。聊天室是否为聊天应用与单个用户之间的私信。
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

可选。相应聊天室是否是在 Import Mode 中创建的，作为将数据迁移到 Google Workspace 的一部分。在导入聊天室期间，用户在导入完成之前无法看到聊天室。

在 Import Mode 中创建空间需要用户身份验证。
create_time

Timestamp

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

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

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

Timestamp

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

bool

仅限输出。对于包含 Chat 应用的私信 (DM) 聊天室，该聊天室是否由 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 客户资源中的 id。专用应用还可以使用 customers/my_customer 别名在与应用相同的 Google Workspace 组织中创建空间。

对于私信 (DM)，或者当空间由非 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

可选。聊天室所有者 (ROLE_MANAGER) 是否拥有此权限。
members_allowed

bool

可选。基本聊天室成员 (ROLE_MEMBER) 是否具有此权限。
assistant_managers_allowed

bool

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

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 当有人用“@”提及您、所关注的话题有新消息，或新话题中有首条消息时，系统会触发通知。不适用于 1 对 1 私信。
FOR_YOU 当有人用“@”提及您或您关注的话题有新消息时，系统会触发通知。不适用于 1 对 1 私信。
OFF 通知功能已关闭。

SpaceReadState

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

字段
name

string

空间读取状态的资源名称。

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

Timestamp

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

SpaceUpdatedEventData

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

活动类型：google.workspace.chat.space.v1.updated

字段
space

Space

更新后的聊天室。

SpaceView

一种视图，用于指定应在 Space 资源中填充哪些字段。为确保与未来版本兼容，我们建议您的代码考虑其他值。

枚举
SPACE_VIEW_UNSPECIFIED 默认值 / 未设置的值。
SPACE_VIEW_RESOURCE_NAME_ONLY 仅填充空间资源名称。
SPACE_VIEW_EXPANDED 填充聊天室资源字段。注意：permissionSettings 字段不会填充任何内容。指定 SPACE_VIEW_EXPANDED 的请求必须包含允许读取聊天室数据的范围，例如 https://www.googleapis.com/auth/chat.spaces 或 https://www.googleapis.com/auth/chat.spaces.readonly。

会话

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

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

字段
name

string

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

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

string

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

此 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。指定的 message 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：更新聊天室的说明和指南。您必须在更新请求中以 SpaceDetails 形式同时传递说明和准则。如果您只想更新其中一个字段，请传递另一个字段的现有值。

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

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

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

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

permission_settings：支持更改聊天室的权限设置。更新权限设置时，您只能指定 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 Person 个人资料 ID 表示同一人。

  • Admin SDK Directory API 中用户的 id。

  • 用户的电子邮件地址可用作 API 请求中 {user} 的别名。例如，如果 user@example.com 的 People API Person 个人资料 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

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

TextParagraph

在此 widget 中显示一段文字。
image

Image

在此 widget 中显示图片。
key_value

KeyValue

在此 widget 中显示键值对项。

按钮

按钮。可以是文字按钮或图片按钮。

字段

联合字段 type。

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

TextButton

包含文字和 onclick 操作的按钮。
image_button

ImageButton

包含图片和 onclick 操作的按钮。

FormAction

表单操作描述的是提交表单时的行为。例如，您可以调用 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

图片

由网址指定的图片，可以具有 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 指定的图标，该 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