Package google.chat.v1

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

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

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

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

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

授权范围

需要以下 OAuth 范围：

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

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

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

创建自定义表情符号。

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

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

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

授权范围

需要以下 OAuth 范围：

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

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

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

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

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

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

  • 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 应用添加到聊天室。

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

• 邀请用户加入聊天室或将用户添加到聊天室。
• 邀请 Google 群组加入聊天室或将 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

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

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

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

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

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

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

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

rpc DeleteCustomEmoji(