索引
ChatService
(接口)AccessoryWidget
(消息)ActionResponse
(消息)ActionResponse.ResponseType
(枚举)ActionResponse.SelectionItems
(消息)ActionResponse.UpdatedWidget
(消息)ActionStatus
(消息)Annotation
(消息)AnnotationType
(枚举)AppCommandMetadata
(消息)AppCommandMetadata.AppCommandType
(枚举)AttachedGif
(消息)Attachment
(消息)Attachment.Source
(枚举)AttachmentDataRef
(消息)CalendarEventLinkData
(消息)CardWithId
(消息)ChatSpaceLinkData
(消息)CompleteImportSpaceRequest
(消息)CompleteImportSpaceResponse
(消息)ContextualAddOnMarkup
(消息)ContextualAddOnMarkup.Card
(消息)ContextualAddOnMarkup.Card.CardAction
(消息)ContextualAddOnMarkup.Card.CardHeader
(消息)ContextualAddOnMarkup.Card.CardHeader.ImageStyle
(枚举)ContextualAddOnMarkup.Card.Section
(消息)CreateCustomEmojiRequest
(消息)CreateMembershipRequest
(消息)CreateMessageRequest
(消息)CreateMessageRequest.MessageReplyOption
(枚举)CreateReactionRequest
(消息)CreateSpaceRequest
(消息)CustomEmoji
(消息)CustomEmoji.CustomEmojiPayload
(消息)CustomEmojiMetadata
(消息)DeleteCustomEmojiRequest
(消息)DeleteMembershipRequest
(消息)DeleteMessageRequest
(消息)DeleteReactionRequest
(消息)DeleteSpaceRequest
(消息)DeletionMetadata
(消息)DeletionMetadata.DeletionType
(枚举)Dialog
(消息)DialogAction
(消息)DriveDataRef
(消息)DriveLinkData
(消息)Emoji
(消息)EmojiReactionSummary
(消息)FindDirectMessageRequest
(消息)GetAttachmentRequest
(消息)GetCustomEmojiRequest
(消息)GetMembershipRequest
(消息)GetMessageRequest
(消息)GetSpaceEventRequest
(消息)GetSpaceNotificationSettingRequest
(消息)GetSpaceReadStateRequest
(消息)GetSpaceRequest
(消息)GetThreadReadStateRequest
(消息)Group
(消息)HistoryState
(枚举)ListCustomEmojisRequest
(消息)ListCustomEmojisResponse
(消息)ListMembershipsRequest
(消息)ListMembershipsResponse
(消息)ListMessagesRequest
(消息)ListMessagesResponse
(消息)ListReactionsRequest
(消息)ListReactionsResponse
(消息)ListSpaceEventsRequest
(消息)ListSpaceEventsResponse
(消息)ListSpacesRequest
(消息)ListSpacesResponse
(消息)MatchedUrl
(消息)MeetSpaceLinkData
(消息)MeetSpaceLinkData.HuddleStatus
(枚举)MeetSpaceLinkData.Type
(枚举)Membership
(消息)Membership.MembershipRole
(枚举)Membership.MembershipState
(枚举)MembershipBatchCreatedEventData
(消息)MembershipBatchDeletedEventData
(消息)MembershipBatchUpdatedEventData
(消息)MembershipCreatedEventData
(消息)MembershipDeletedEventData
(消息)MembershipUpdatedEventData
(消息)Message
(消息)MessageBatchCreatedEventData
(消息)MessageBatchDeletedEventData
(消息)MessageBatchUpdatedEventData
(消息)MessageCreatedEventData
(消息)MessageDeletedEventData
(消息)MessageUpdatedEventData
(消息)QuotedMessageMetadata
(消息)Reaction
(消息)ReactionBatchCreatedEventData
(消息)ReactionBatchDeletedEventData
(消息)ReactionCreatedEventData
(消息)ReactionDeletedEventData
(消息)RichLinkMetadata
(消息)RichLinkMetadata.RichLinkType
(枚举)SearchSpacesRequest
(消息)SearchSpacesResponse
(消息)SetUpSpaceRequest
(消息)SlashCommand
(消息)SlashCommandMetadata
(消息)SlashCommandMetadata.Type
(枚举)Space
(消息)Space.AccessSettings
(消息)Space.AccessSettings.AccessState
(枚举)Space.MembershipCount
(消息)Space.PermissionSetting
(消息)Space.PermissionSettings
(消息)Space.PredefinedPermissionSettings
(枚举)Space.SpaceDetails
(消息)Space.SpaceThreadingState
(枚举)Space.SpaceType
(枚举)Space.Type
(枚举)SpaceBatchUpdatedEventData
(消息)SpaceEvent
(消息)SpaceNotificationSetting
(消息)SpaceNotificationSetting.MuteSetting
(枚举)SpaceNotificationSetting.NotificationSetting
(枚举)SpaceReadState
(消息)SpaceUpdatedEventData
(消息)Thread
(消息)ThreadReadState
(消息)UpdateMembershipRequest
(消息)UpdateMessageRequest
(消息)UpdateSpaceNotificationSettingRequest
(消息)UpdateSpaceReadStateRequest
(消息)UpdateSpaceRequest
(消息)User
(消息)User.Type
(枚举)UserMentionMetadata
(消息)UserMentionMetadata.Type
(枚举)WidgetMarkup
(消息)WidgetMarkup.Button
(消息)WidgetMarkup.FormAction
(消息)WidgetMarkup.FormAction.ActionParameter
(消息)WidgetMarkup.Icon
(枚举)WidgetMarkup.Image
(消息)WidgetMarkup.ImageButton
(消息)WidgetMarkup.KeyValue
(消息)WidgetMarkup.OnClick
(消息)WidgetMarkup.OpenLink
(消息)WidgetMarkup.TextButton
(消息)WidgetMarkup.TextParagraph
(消息)
ChatService
使开发者能够在 Google Chat 平台上构建 Chat 应用和集成。
CompleteImportSpace |
---|
完成指定空间的导入流程,并使其对用户可见。
如需了解详情,请参阅授权 Google Chat 应用导入数据。
|
CreateCustomEmoji |
---|
创建自定义表情符号。 自定义表情符号仅适用于 Google Workspace 账号,并且管理员必须为组织启用自定义表情符号。如需了解详情,请参阅了解 Google Chat 中的自定义表情符号和管理自定义表情符号权限。
|
CreateMembership |
---|
为通话 Chat 应用、用户或 Google 群组创建会员资格。不支持为其他聊天应用创建会员资格。创建会员时,如果指定会员关闭了自动接受政策,则系统会向其发送邀请,该会员必须接受聊天室邀请才能加入。否则,创建会员资格会将相应成员直接添加到指定空间。 支持以下类型的身份验证:
应用身份验证不支持以下使用情形:
如需查看使用示例,请参阅:
|
CreateMessage |
---|
在 Google Chat 聊天室中创建消息。有关示例,请参阅发送消息。 支持以下类型的身份验证:
Chat 会根据您在请求中使用的身份验证类型,以不同的方式归因消息发送者。 下图显示了使用应用身份验证时,Chat 如何为消息添加属性。Chat 会将 Chat 应用显示为消息发送者。消息的内容可以包含文本 ( 下图显示了在使用用户身份验证时,Chat 如何为消息添加属性。Chat 会将用户显示为消息发送者,并通过显示 Chat 应用的名称将消息归因于该应用。消息内容只能包含文本 ( 邮件大小上限(包括邮件内容)为 32,000 字节。 对于 webhook 请求,响应不包含完整消息。除了请求中的信息之外,响应仅填充
|
CreateReaction |
---|
创建回应并将其添加到消息中。如需查看示例,请参阅为消息添加回应。
|
CreateSpace |
---|
创建聊天室。可用于在 支持以下类型的身份验证:
以应用身份进行身份验证时,必须在请求中设置 以应用身份进行身份验证时,Chat 应用会添加为聊天室的成员。不过,与人工身份验证不同的是,Chat 应用不会添加为聊天室管理员。默认情况下,所有聊天室成员都可以将 Chat 应用从聊天室中移除。如需仅允许聊天室管理员从聊天室中移除应用,请将 创建聊天室时的成员资格取决于聊天室是否在
如果您在创建聊天室时收到
|
DeleteCustomEmoji |
---|
删除自定义表情符号。默认情况下,用户只能删除自己创建的自定义表情符号。管理员分配的表情符号管理者可以删除组织中的任何自定义表情符号。请参阅了解 Google Chat 中的自定义表情符号。 自定义表情符号仅适用于 Google Workspace 账号,并且管理员必须为组织启用自定义表情符号。如需了解详情,请参阅了解 Google Chat 中的自定义表情符号和管理自定义表情符号权限。
|
DeleteMembership |
---|
删除会员资格。如需查看示例,请参阅从聊天室中移除用户或 Google Chat 应用。 支持以下类型的身份验证:
应用身份验证不支持以下使用情形:
如需删除聊天室管理员的成员身份,请求者必须是聊天室管理员。如果您使用的是应用身份验证,则 Chat 应用必须是聊天室创建者。
|
DeleteMessage |
---|
删除消息。如需查看示例,请参阅删除消息。 支持以下类型的身份验证:
使用应用身份验证时,请求只能删除调用 Chat 应用创建的消息。
|
DeleteReaction |
---|
删除对消息的回应。如需查看示例,请参阅删除回应。
|
DeleteSpace |
---|
删除指定聊天室。始终执行级联删除,这意味着聊天室的子资源(例如聊天室中发布的消息和聊天室中的成员资格)也会被删除。有关示例,请参阅删除聊天室。 支持以下类型的身份验证:
|
FindDirectMessage |
---|
返回与指定用户的现有私信。如果未找到任何私信空间,则返回 通过应用身份验证,返回指定用户与调用方 Chat 应用之间的私信聊天室。 如果使用用户身份验证,则返回指定用户与经过身份验证的用户之间的私信空间。 支持以下类型的身份验证:
|
GetAttachment |
---|
获取邮件附件的元数据。附件数据使用 media API 提取。如需查看示例,请参阅获取有关邮件附件的元数据。
|
GetCustomEmoji |
---|
返回有关自定义表情符号的详细信息。 自定义表情符号仅适用于 Google Workspace 账号,并且管理员必须为组织启用自定义表情符号。如需了解详情,请参阅了解 Google Chat 中的自定义表情符号和管理自定义表情符号权限。
|
GetMembership |
---|
返回有关会员资格的详细信息。如需查看示例,请参阅获取有关用户或 Google Chat 应用会员资格的详细信息。 支持以下类型的身份验证:
|
GetMessage |
---|
返回有关消息的详细信息。如需查看示例,请参阅获取有关消息的详细信息。 支持以下类型的身份验证:
注意:可能会返回来自被屏蔽的成员或聊天室的消息。
|
GetSpace |
---|
返回有关聊天室的详细信息。如需查看示例,请参阅获取有关空间的详细信息。 支持以下类型的身份验证:
应用身份验证具有以下限制:
|
GetSpaceEvent |
---|
返回 Google Chat 聊天室中的事件。事件载荷包含发生更改的资源的最新版本。例如,如果您请求有关新消息的事件,但该消息后来进行了更新,则服务器会在事件载荷中返回更新后的 注意:对于此请求,空间事件数据的空间对象中不会返回 支持以下类型的身份验证,并提供适合读取所请求数据的授权范围:
如需获取活动,经过身份验证的调用者必须是相应聊天室的成员。 如需查看示例,请参阅获取 Google Chat 聊天室中活动的详细信息。
|
GetSpaceNotificationSetting |
---|
获取聊天室通知设置。如需查看示例,请参阅获取调用者的空间通知设置。
|
GetSpaceReadState |
---|
返回有关聊天室中用户已读状态的详细信息,用于标识已读和未读消息。如需查看示例,请参阅获取有关用户空间读取状态的详细信息。
|
GetThreadReadState |
---|
返回有关用户在线程中的已读状态的详细信息,用于标识已读和未读消息。如需查看示例,请参阅获取有关用户线程读取状态的详细信息。
|
ListCustomEmojis |
---|
列出已通过身份验证的用户可看到的自定义表情符号。 自定义表情符号仅适用于 Google Workspace 账号,并且管理员必须为组织启用自定义表情符号。如需了解详情,请参阅了解 Google Chat 中的自定义表情符号和管理自定义表情符号权限。
|
ListMemberships |
---|
列出聊天室中的会员。如需查看示例,请参阅列出聊天室中的用户和 Google Chat 应用。使用应用身份验证列出成员时,系统会列出 Chat 应用有权访问的聊天室中的成员,但会排除 Chat 应用成员(包括其自身)。列出具有用户身份验证的会员资格会列出经过身份验证的用户有权访问的会议室中的会员资格。 支持以下类型的身份验证:
|
ListMessages |
---|
列出调用者所属聊天室中的消息,包括来自被屏蔽的成员和聊天室的消息。系统消息(例如宣布有新聊天室成员加入的消息)不包括在内。如果您列出没有消息的聊天室中的消息,则响应为空对象。使用 REST/HTTP 接口时,响应包含一个空的 JSON 对象 支持以下类型的身份验证:
|
ListReactions |
---|
列出对消息的回应。如需查看示例,请参阅列出消息的表情符号回应。
|
ListSpaceEvents |
---|
列出 Google Chat 聊天室中的活动。对于每个事件,载荷都包含聊天资源的最最新版本。例如,如果您列出有关新聊天室成员的活动,服务器会返回包含最新成员资格详细信息的 支持以下类型的身份验证,并提供适合读取所请求数据的授权范围:
如需列出活动,已通过身份验证的调用者必须是相应聊天室的成员。 如需查看示例,请参阅列出 Google Chat 聊天室中的活动。
|
ListSpaces |
---|
列出调用方所属的聊天室。在发送第一条消息之前,群聊和私信不会显示在列表中。如需查看示例,请参阅列出空间。 支持以下类型的身份验证:
如需按 Google Workspace 组织列出所有已命名的空间,请改用具有 Workspace 管理员权限的
|
SearchSpaces |
---|
根据管理员的搜索返回 Google Workspace 组织中的聊天室列表。在请求中,将 需要具有管理员权限的用户身份验证和以下授权范围之一:
|
SetUpSpace |
---|
创建聊天室并将指定用户添加到其中。调用用户会自动添加到聊天室,不应在请求中指定为成员。如需查看示例,请参阅设置包含初始成员的空间。 如需指定要添加的人员成员,请添加具有相应 如需指定要添加的 Google 群组,请添加具有相应 对于命名聊天室或群组对话,如果主叫方屏蔽了部分成员或被部分成员屏蔽,或者没有权限添加部分成员,则这些成员不会被添加到创建的聊天室中。 如需在调用用户与另一位人类用户之间创建私信 (DM),请指定一个成员身份来表示该人类用户。如果其中一位用户屏蔽了另一位用户,则请求会失败,并且不会创建私信。 如需在调用用户和调用应用之间创建私信,请将 如果两位用户之间已存在私信,即使其中一位用户在发出请求时屏蔽了另一位用户,系统也会返回现有的私信。 不支持包含串联回复的群组。如果您在设置聊天室时收到
|
UpdateMembership |
---|
更新会员资格。如需查看示例,请参阅更新用户在聊天室中的成员身份。 支持以下类型的身份验证:
|
UpdateMessage |
---|
更新消息。 支持以下类型的身份验证:
使用应用身份验证时,请求只能更新调用 Chat 应用创建的消息。
|
UpdateSpace |
---|
更新空间。如需查看示例,请参阅更新会议室。 如果您正在更新 支持以下类型的身份验证:
应用身份验证具有以下限制:
|
UpdateSpaceNotificationSetting |
---|
更新聊天室通知设置。如需查看示例,请参阅更新调用者的会议室通知设置。
|
UpdateSpaceReadState |
---|
|