Package google.chat.v1

索引

• ChatService (介面)
• AccessoryWidget (訊息)
• ActionResponse (訊息)
• ActionResponse.ResponseType (列舉)
• ActionResponse.SelectionItems (訊息)
• ActionResponse.UpdatedWidget (訊息)
• ActionStatus (訊息)
• Annotation (訊息)
• AnnotationType (列舉)
• AttachedGif (訊息)
• Attachment (訊息)
• Attachment.Source (列舉)
• AttachmentDataRef (訊息)
• CardWithId (訊息)
• ChatSpaceLinkData (訊息)
• CompleteImportSpaceRequest (訊息)
• CompleteImportSpaceResponse (訊息)
• ContextualAddOnMarkup (訊息)
• ContextualAddOnMarkup.Card (訊息)
• ContextualAddOnMarkup.Card.CardAction (訊息)
• ContextualAddOnMarkup.Card.CardHeader (訊息)
• ContextualAddOnMarkup.Card.CardHeader.ImageStyle (列舉)
• ContextualAddOnMarkup.Card.Section (訊息)
• CreateMembershipRequest (訊息)
• CreateMessageRequest (訊息)
• CreateMessageRequest.MessageReplyOption (列舉)
• CreateReactionRequest (訊息)
• CreateSpaceRequest (訊息)
• CustomEmoji (訊息)
• DeleteMembershipRequest (訊息)
• DeleteMessageRequest (訊息)
• DeleteReactionRequest (訊息)
• DeleteSpaceRequest (訊息)
• DeletionMetadata (訊息)
• DeletionMetadata.DeletionType (列舉)
• Dialog (訊息)
• DialogAction (訊息)
• DriveDataRef (訊息)
• DriveLinkData (訊息)
• Emoji (訊息)
• EmojiReactionSummary (訊息)
• FindDirectMessageRequest (訊息)
• GetAttachmentRequest (訊息)
• GetMembershipRequest (訊息)
• GetMessageRequest (訊息)
• GetSpaceEventRequest (訊息)
• GetSpaceReadStateRequest (訊息)
• GetSpaceRequest (訊息)
• GetThreadReadStateRequest (訊息)
• Group (訊息)
• HistoryState (列舉)
• ListMembershipsRequest (訊息)
• ListMembershipsResponse (訊息)
• ListMessagesRequest (訊息)
• ListMessagesResponse (訊息)
• ListReactionsRequest (訊息)
• ListReactionsResponse (訊息)
• ListSpaceEventsRequest (訊息)
• ListSpaceEventsResponse (訊息)
• ListSpacesRequest (訊息)
• ListSpacesResponse (訊息)
• MatchedUrl (訊息)
• 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 (訊息)
• SpaceReadState (訊息)
• SpaceUpdatedEventData (訊息)
• Thread (訊息)
• ThreadReadState (訊息)
• UpdateMembershipRequest (訊息)
• UpdateMessageRequest (訊息)
• 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 平台上建構即時通訊應用程式與整合功能。

CompleteImportSpace
rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse) 完成指定聊天室的匯入程序，並向使用者顯示。必須啟用應用程式驗證和全網域委派功能。詳情請參閱「授權 Google Chat 應用程式匯入資料」。 授權範圍 需要下列 OAuth 範圍： https://www.googleapis.com/auth/chat.import 詳情請參閱授權指南。

CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership) 為通話應用程式建立一般成員或應用程式成員。系統不支援為其他應用程式建立會員資格。如需範例，請參閱「邀請/在聊天室中邀請/新增使用者或 Google Chat 應用程式」。建立成員時，如果指定成員關閉了自動接受政策，系統會向他們發出邀請，且必須先接受邀請才能加入。否則，當您建立成員資格時，系統會將成員直接新增至指定聊天室。需要使用者驗證。 如要指定要新增的成員，請設定人類或應用程式成員的 membership.member.name，或為群組成員設定 membership.group_member.name。 如要將呼叫應用程式新增至聊天室，或兩位真人使用者之間的即時訊息，請使用 users/app。無法將其他應用程式新增至聊天室。 如要新增真人使用者，請使用 users/{user}，其中 {user} 可以是使用者的電子郵件地址。對於同一個 Workspace 機構 ({user}) 中的使用者，您也可以為 People API 中的使用者設定 id，或是在 Directory API 中為使用者設定 id。舉例來說，如果 [e-mail] 的 People API 個人資料 ID 為 123456789，您可以將 membership.member.name 設為 users/[e-mail] 或 users/123456789，將使用者新增至聊天室。 如要在已命名聊天室中新增或邀請 Google 群組，請使用 groups/{group}，其中 {group} 是 Cloud Identity Groups API 中的群組 id。舉例來說，您可以使用 Cloud Identity Groups lookup API 擷取群組電子郵件地址 [e-mail] 的 ID 123456789，然後將 membership.group_member.name 設為 groups/123456789，藉此新增或邀請群組加入已命名的聊天室。系統不支援群組電子郵件，而且您只能在已命名的聊天室中將 Google 群組新增為成員。 授權範圍 需要下列其中一種 OAuth 範圍： 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 聊天室中建立訊息。簡訊和資訊卡等訊息大小上限為 32,000 個位元組。如需範例，請參閱「傳送訊息」。 呼叫此方法需要驗證，並支援下列驗證類型： 但支援使用者驗證或應用程式驗證。 如果是卡片訊息，僅支援應用程式驗證。(只有 Chat 應用程式可以建立資訊卡訊息)。 授權範圍 需要下列其中一種 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) 建立回應並將其新增至訊息中。僅支援萬國碼表情符號。如需範例，請參閱「對郵件新增回應」。需要使用者驗證。 授權範圍 需要下列其中一種 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) 建立具名聊天室。系統不支援依主題分組的聊天室。如需範例說明，請參閱「建立聊天室」。 如果在建立聊天室時收到 ALREADY_EXISTS 錯誤訊息，請嘗試其他displayName。Google Workspace 機構中的某個聊天室可能已使用這個顯示名稱。 需要使用者驗證。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.spaces.create 詳情請參閱授權指南。

DeleteMembership
rpc DeleteMembership(DeleteMembershipRequest) returns (Membership) 刪除會員資格。如需範例，請參閱「從聊天室中移除使用者或 Google Chat 應用程式」。 需要使用者驗證。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/chat.admin.memberships https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.memberships.app 詳情請參閱授權指南。

DeleteMessage
rpc DeleteMessage(DeleteMessageRequest) returns (Empty) 刪除訊息。如需範例，請參閱刪除郵件。 必須進行驗證。支援應用程式驗證和使用者驗證。使用應用程式驗證功能時，要求只能刪除呼叫 Chat 應用程式建立的訊息。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.messages 詳情請參閱授權指南。

DeleteReaction
rpc DeleteReaction(DeleteReactionRequest) returns (Empty) 刪除對訊息的回應。僅支援萬國碼表情符號。如需範例，請參閱「刪除回應」。需要使用者驗證。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.messages.reactions 詳情請參閱授權指南。

DeleteSpace
rpc DeleteSpace(DeleteSpaceRequest) returns (Empty) 刪除已命名的聊天室。一律執行串聯刪除，亦即聊天室子項資源 (例如在聊天室中張貼的訊息和成員資格) 也會一併刪除。如需範例，請參閱「刪除聊天室」。需要對有權刪除聊天室的使用者進行使用者驗證。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/chat.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 應用程式之間的即時訊息空間。 需要使用者驗證或應用程式驗證。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.spaces.readonly https://www.googleapis.com/auth/chat.bot 詳情請參閱授權指南。

GetAttachment
rpc GetAttachment(GetAttachmentRequest) returns (Attachment) 取得訊息附件的中繼資料。使用媒體 API 擷取附件資料。如需範例，請參閱取得郵件附件的相關中繼資料。必須啟用應用程式驗證。 授權範圍 需要下列 OAuth 範圍： https://www.googleapis.com/auth/chat.bot 詳情請參閱授權指南。

GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership) 傳回會員資格詳情。舉例來說，請參閱「取得使用者或 Google Chat 應用程式會員資格的詳細資料」。 必須進行驗證。支援應用程式驗證和使用者驗證。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/chat.admin.memberships https://www.googleapis.com/auth/chat.admin.memberships.readonly https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.memberships.readonly 詳情請參閱授權指南。

GetMessage
rpc GetMessage(GetMessageRequest) returns (Message) 傳回郵件的詳細資料。如需範例，請參閱「取得訊息的詳細資料」。 必須進行驗證。支援應用程式驗證和使用者驗證。 注意：系統可能會傳回來自封鎖成員或聊天室的訊息。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.messages.readonly 詳情請參閱授權指南。

GetSpace
rpc GetSpace(GetSpaceRequest) returns (Space) 傳回聊天室的詳細資料。如需範例，請參閱「取得聊天室的詳細資料」。 必須進行驗證。支援應用程式驗證和使用者驗證。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/chat.admin.spaces https://www.googleapis.com/auth/chat.admin.spaces.readonly https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.spaces.readonly https://www.googleapis.com/auth/chat.bot 詳情請參閱授權指南。

GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent) 傳回 Google Chat 聊天室中的事件。事件酬載包含已變更資源的最新版本。舉例來說，如果您要求含有新訊息的事件，但訊息之後已更新，伺服器會在事件酬載中傳回更新過的 Message 資源。 需要使用者驗證。如要取得活動，已驗證的使用者必須是聊天室成員。 如需範例，請參閱「取得 Google Chat 聊天室中的活動詳細資料」。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.spaces.readonly https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.messages.readonly https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.memberships.readonly https://www.googleapis.com/auth/chat.messages.reactions https://www.googleapis.com/auth/chat.messages.reactions.readonly 詳情請參閱授權指南。

GetSpaceReadState
rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState) 傳回使用者聊天室中讀取狀態的詳細資料，用於識別已讀和未讀訊息。舉例來說，請參閱「取得使用者的聊天室讀取狀態詳細資料」。 需要使用者驗證。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/chat.users.readstate https://www.googleapis.com/auth/chat.users.readstate.readonly 詳情請參閱授權指南。

GetThreadReadState
rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState) 傳回使用者在執行緒中讀取狀態的詳細資料，用於識別已讀和未讀郵件。如需範例，請參閱「取得使用者的執行緒讀取狀態詳細資料」。 需要使用者驗證。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/chat.users.readstate https://www.googleapis.com/auth/chat.users.readstate.readonly 詳情請參閱授權指南。

ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse) 列出聊天室中的成員資格。如需範例，請參閱「列出聊天室中的使用者和 Google Chat 應用程式」。採用應用程式驗證設定的成員資格清單會列出 Chat 應用程式可存取的聊天室成員，但不含 Chat 應用程式成員資格。透過使用者驗證功能列出的成員資格，清單會列出通過驗證的使用者可存取的聊天室成員。 必須進行驗證。支援應用程式驗證和使用者驗證。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/chat.admin.memberships https://www.googleapis.com/auth/chat.admin.memberships.readonly https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.memberships.readonly 詳情請參閱授權指南。

ListMessages
rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse) 列出來電者所屬聊天室中的訊息，包括已封鎖的成員和聊天室的訊息。如需範例，請參閱「列出郵件」。需要使用者驗證。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.messages.readonly 詳情請參閱授權指南。

ListReactions
rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse) 列出回應訊息的回應。如需範例，請參閱「列出訊息的回應」。需要使用者驗證。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.messages.readonly https://www.googleapis.com/auth/chat.messages.reactions https://www.googleapis.com/auth/chat.messages.reactions.readonly 詳情請參閱授權指南。

ListSpaceEvents

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse) 列出 Google Chat 聊天室中的事件。每個事件的酬載都包含最新版本的 Chat 資源。舉例來說，如果您列出新聊天室成員的事件，伺服器會傳回 Membership 資源，當中包含最新成員詳細資料。如果新成員在要求期間遭到移除，事件酬載會包含空白的 Membership 資源。 需要使用者驗證。如要列出事件，已驗證的使用者必須是聊天室成員。 如需範例，請參閱「列出 Google Chat 聊天室中的事件」。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.spaces.readonly https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.messages.readonly https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.memberships.readonly https://www.googleapis.com/auth/chat.messages.reactions https://www.googleapis.com/auth/chat.messages.reactions.readonly 詳情請參閱授權指南。

ListSpaces

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse) 列出呼叫端所屬的聊天室。系統要等到第一則訊息傳送後，才會列出群組通訊和即時訊息。如需範例，請參閱「列出聊天室」。 必須進行驗證。支援應用程式驗證和使用者驗證。 列出呼叫端或已驗證使用者可見的聊天室。系統要等到第一則訊息傳送後，才會列出群組通訊和即時訊息。 如要列出 Google Workspace 機構的所有已命名聊天室，請改用 Workspace 管理員權限的 spaces.search() 方法。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.spaces.readonly https://www.googleapis.com/auth/chat.bot 詳情請參閱授權指南。

SearchSpaces
rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse) 開發人員預覽版：這是 Google Workspace 開發人員預覽版計畫的一環，這項計畫可讓使用者搶先體驗特定功能。 根據使用者的搜尋內容傳回聊天室清單。需要使用者驗證。使用者必須是 Google Workspace 機構的管理員。在要求中，將 use_admin_access 設為 true。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/chat.admin.spaces https://www.googleapis.com/auth/chat.admin.spaces.readonly 詳情請參閱授權指南。

SetUpSpace

rpc SetUpSpace(SetUpSpaceRequest) returns (Space) 建立聊天室並將指定的使用者新增至聊天室。通話使用者會自動加入聊天室，且不應在要求中指定為成員資格。如需範例，請參閱「設定包含初始成員的聊天室」。 如要指定要新增的真人成員，請使用適當的 membership.member.name 新增成員資格。如要新增真人使用者，請使用 users/{user}，其中 {user} 可以是使用者的電子郵件地址。對於同一個 Workspace 機構 ({user}) 中的使用者，您也可以為 People API 中的使用者設定 id，或是在 Directory API 中為使用者設定 id。舉例來說，如果 [e-mail] 的 People API 個人資料 ID 為 123456789，您可以將 membership.member.name 設為 users/[e-mail] 或 users/123456789，將使用者新增至聊天室。 如要指定要新增的 Google 群組，請使用適當的 membership.group_member.name 新增成員資格。如要新增或邀請 Google 群組，請使用 groups/{group}，其中 {group} 是 Cloud Identity Groups API 中的群組 id。舉例來說，您可以使用 Cloud Identity Groups lookup API 擷取群組電子郵件地址 [e-mail] 的 ID 123456789，然後將 membership.group_member.name 設為 groups/123456789，將群組新增至聊天室。系統不支援群組電子郵件，而且您只能在已命名的聊天室中將 Google 群組新增為成員。 如果已命名的聊天室或群組通訊，如果來電者封鎖對象、遭到部分成員封鎖，或是沒有新增成員的權限，這些成員就不會加入建立的聊天室。 如要在發起通話的使用者和另一位真人使用者之間建立即時訊息 (DM)，請指定一個代表真人使用者的成員資格。如果某位使用者封鎖另一位使用者，則該要求會失敗，系統也不會建立即時訊息。 如要在發出呼叫的使用者和呼叫應用程式之間建立即時訊息，請將 Space.singleUserBotDm 設為 true，且不要指定任何成員資格。你只能使用這個方法透過呼叫應用程式設定即時訊息。如要將通話應用程式新增為聊天室成員，或兩位真人使用者之間的現有即時訊息，請參閱「邀請或將使用者或應用程式新增至聊天室」。 如果兩位使用者之間已經存在即時訊息，即使其中一位使用者在提出要求時封鎖另一位使用者，系統仍會傳回現有的即時訊息。 不支援含有討論串回覆的聊天室。如果在設定聊天室時收到「ALREADY_EXISTS」錯誤訊息，請嘗試使用其他displayName。Google Workspace 機構中的某個聊天室可能已使用這個顯示名稱。 需要使用者驗證。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.spaces.create 詳情請參閱授權指南。

UpdateMembership
rpc UpdateMembership(UpdateMembershipRequest) returns (Membership) 更新成員資格。如需範例，請參閱「更新使用者的聊天室成員資格」。 需要使用者驗證。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/chat.admin.memberships https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.memberships 詳情請參閱授權指南。

UpdateMessage
rpc UpdateMessage(UpdateMessageRequest) returns (Message) 更新訊息。patch 和 update 方法有差異。patch 方法會使用 patch 要求，update 方法則使用 put 要求。建議您使用 patch 方法。如需範例，請參閱「更新訊息」。 必須進行驗證。支援應用程式驗證和使用者驗證。使用應用程式驗證功能時，要求只能更新呼叫 Chat 應用程式建立的訊息。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.messages 詳情請參閱授權指南。

UpdateSpace
rpc UpdateSpace(UpdateSpaceRequest) returns (Space) 更新聊天室。如需範例，請參閱「更新聊天室」。 如果要更新 displayName 欄位時收到錯誤訊息 ALREADY_EXISTS，請改用其他顯示名稱。Google Workspace 機構中的現有聊天室可能已使用這個顯示名稱。 需要使用者驗證。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/chat.admin.spaces https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.spaces 詳情請參閱授權指南。

UpdateSpaceReadState
rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState) 更新使用者在聊天室中的讀取狀態，用於識別已讀和未讀訊息。如需範例，請參閱「更新使用者的聊天室讀取狀態」。 需要使用者驗證。 授權範圍 需要下列 OAuth 範圍： https://www.googleapis.com/auth/chat.users.readstate 詳情請參閱授權指南。

AccessoryWidget

顯示在訊息底部的一或多個互動小工具。詳情請參閱在訊息底部新增互動式小工具。

欄位
聯集欄位 action。動作類型。action 只能是下列其中一項：
button_list	ButtonList 按鈕清單。

ActionResponse

Chat 應用程式可用來設定回應張貼方式的參數。

欄位
type	ResponseType 僅限輸入。Chat 應用程式回應的類型。
url	string 僅限輸入。供使用者驗證或設定的網址。(僅適用於 REQUEST_CONFIG 回應類型)。
dialog_action	DialogAction 僅限輸入。對與對話方塊相關的互動事件的回應。必須隨附 ResponseType.Dialog。
updated_widget	UpdatedWidget 僅限輸入。更新小工具的回應。

ResponseType

Chat 應用程式回應的類型。

列舉
TYPE_UNSPECIFIED	處理為 NEW_MESSAGE 的預設類型。
NEW_MESSAGE	以新訊息的形式張貼在主題中。
UPDATE_MESSAGE	更新 Chat 應用程式的訊息。這只適用於訊息傳送者類型為 BOT 的 CARD_CLICKED 事件。
UPDATE_USER_MESSAGE_CARDS	更新使用者訊息中的資訊卡。這類情況只能用於回應網址相符的 MESSAGE 事件，或是訊息傳送者類型為 HUMAN 的 CARD_CLICKED 事件。會忽略文字。
REQUEST_CONFIG	私下要求使用者進行其他驗證或設定。
DIALOG	顯示對話方塊。
UPDATE_WIDGET	小工具文字自動完成選項查詢。

SelectionItems

小工具自動完成結果清單。

欄位
items[]	SelectionItem SelectItem 物件的陣列。

UpdatedWidget

更新小工具的回應。用於提供小工具的自動完成選項。

欄位
widget	string 已更新小工具的 ID。這個 ID 必須與觸發更新要求的小工具 ID 相符。
聯集欄位 updated_widget。已根據使用者動作更新小工具。updated_widget 只能是下列其中一項：
suggestions	SelectionItems 小工具自動完成結果清單

ActionStatus

代表叫用或提交對話方塊的要求狀態。

欄位
status_code	Code 狀態碼。
user_facing_message	string 這類訊息，用於向使用者傳送要求狀態的相關資訊。如未設定，系統會傳送以 status_code 為依據的通用訊息。

註解

僅供輸出。與訊息純文字內文相關聯的註解。如要為簡訊加上基本格式，請參閱設定簡訊格式。

純文字訊息內文範例：

Hello @FooBot how are you!"

相應的註解中繼資料：

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

欄位
type	AnnotationType 這個註解的類型。
length	int32 這個註解所對應純文字訊息內文中的子字串長度。
start_index	int32 在與這個註解對應的純文字訊息內文中開始索引 (從 0 開始，含首尾)。
聯集欄位 metadata。關於註解的其他中繼資料。metadata 只能是下列其中一項：
user_mention	UserMentionMetadata 使用者提及內容的中繼資料。
slash_command	SlashCommandMetadata 斜線指令的中繼資料。
rich_link_metadata	RichLinkMetadata 複合式連結的中繼資料。

AnnotationType

註解的類型。

列舉
ANNOTATION_TYPE_UNSPECIFIED	列舉的預設值。請勿使用。
USER_MENTION	已提及使用者。
SLASH_COMMAND	叫用斜線指令。
RICH_LINK	複合式連結註解。

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 訊息。

CardWithId

Google Chat 訊息中的資訊卡。

只有 Chat 應用程式可以建立資訊卡。如果 Chat 應用程式以使用者的身分進行驗證，則訊息不得包含卡片。

使用 Card Builder 設計及預覽資訊卡。

開啟資訊卡建立工具

欄位
card_id	string 如果訊息含有多張卡片，則為必要欄位。訊息中卡片的專屬 ID。
card	Card 資訊卡。大小上限為 32 KB。

ChatSpaceLinkData

Chat 聊天室連結的資料。

開發人員預覽版：這是 Google Workspace 開發人員預覽版計畫的一環，這項計畫可讓使用者搶先體驗特定功能。

欄位
space	string 已連結 Chat 聊天室資源的聊天室。 格式：spaces/{space}
thread	string 已連結 Chat 聊天室資源的討論串。 格式：spaces/{space}/threads/{thread}
message	string 已連結 Chat 聊天室資源的訊息。 格式：spaces/{space}/messages/{message}

CompleteImportSpaceRequest

聊天室匯入程序的要求訊息。

欄位
name	string 必要欄位。匯入模式空間的資源名稱。 格式：spaces/{space}

CompleteImportSpaceResponse

聊天室匯入程序的回應訊息。

欄位
space	Space 匯入模式空間。

ContextualAddOnMarkup

這個類型沒有任何欄位。

可讓開發人員指定內容相關 AddOn 內容的標記。

資訊卡

資訊卡是一種 UI 元素，內含文字和圖片等 UI 小工具。

欄位
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	圓形框線。

章節

區段包含一組按指定順序 (垂直) 顯示的小工具。在所有平台上，資訊卡的固定寬度都很窄，因此目前不需使用版面配置屬性 (例如浮動值)。

欄位
header	string 區段標題。支援格式化文字。如要進一步瞭解如何設定文字格式，請參閱「設定 Google Chat 應用程式中的文字格式」和「在 Google Workspace 外掛程式中設定文字格式」。
widgets[]	WidgetMarkup 區段至少必須包含一個小工具。

CreateMembershipRequest

要求建立會員資格的訊息。

欄位
parent	string 必要欄位。要建立成員資格的聊天室資源名稱。 格式：space/{space}
membership	Membership 必要欄位。要建立的成員關係。memberType 欄位必須包含已填入 user.name 和 user.type 欄位的使用者。伺服器會指派資源名稱，並覆寫指定的所有內容。當 Chat 應用程式為真人使用者建立成員資格關係時，必須使用 chat.memberships 範圍、將 user.type 設為 HUMAN，並將 user.name 的格式設為 users/{user}，其中 {user} 可以是使用者的電子郵件地址。對於同一個 Workspace 機構的使用者，{user} 也可以是 People API 中的「使用者」id，或是在 Directory API 中針對該使用者的 id。舉例來說，如果 [e-mail] 的 People API 個人資料 ID 為 123456789，您可以將 membership.member.name 設為 users/[e-mail] 或 users/123456789，將使用者新增至聊天室。當 Chat 應用程式自行建立成員資格關係時，必須使用 chat.memberships.app 範圍、將 user.type 設為 BOT，並將 user.name 設為 users/app。
use_admin_access	bool 開發人員預覽版：這是 Google Workspace 開發人員預覽版計畫的一環，這項計畫可讓使用者搶先體驗特定功能。 在 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 擴充應用程式不必儲存系統指派的 ID，不必在訊息的資源名稱中儲存、更新或刪除訊息 (如訊息 name 欄位中所示)。 這個欄位的值必須符合下列規定： 開頭為 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。 如果收到 ALREADY_EXISTS 錯誤訊息，請改用其他 displayName。Google Workspace 機構中的現有聊天室可能已使用這個顯示名稱。 系統已在伺服器上指派空格「name」，因此系統會忽略這個欄位中指定的所有值。
request_id	string 選用設定。這項要求的專屬 ID。建議隨機產生 UUID。指定現有的要求 ID 時，系統會傳回使用該 ID 建立的聊天室，而不會建立新空間。在同一個 Chat 應用程式中指定現有要求 ID，但該要求 ID 與其他使用者不同。在這種情況下，系統會傳回錯誤。

CustomEmoji

代表自訂表情符號。

欄位
uid	string 僅供輸出。自訂表情符號資源的專屬金鑰。

DeleteMembershipRequest

要求刪除聊天室中的成員資格。

欄位
name	string 必要欄位。要刪除的成員資源名稱。Chat 擴充應用程式可以刪除真人使用者或其會員資格即時通訊應用程式無法刪除其他應用程式會員功能。 刪除人工成員資格時，需要 chat.memberships 範圍和 spaces/{space}/members/{member} 格式。您可以使用這個電子郵件地址做為 {member} 的別名。舉例來說，spaces/{space}/members/[e-mail]，其中 [e-mail] 是 Google Chat 使用者的電子郵件。 刪除應用程式成員資格時，必須使用 chat.memberships.app 範圍和 spaces/{space}/members/app 格式。 格式：spaces/{space}/members/{member} 或 spaces/{space}/members/app。
use_admin_access	bool 開發人員預覽版：這是 Google Workspace 開發人員預覽版計畫的一環，這項計畫可讓使用者搶先體驗特定功能。 在 true 時，此方法會使用使用者的 Google Workspace 管理員權限執行。 通話使用者必須是具備管理即時通訊和聊天室對話權限的 Google Workspace 管理員。 需要 chat.admin.memberships OAuth 2.0 範圍。 無法使用管理員存取權刪除聊天室中的應用程式成員資格。

DeleteMessageRequest

要求刪除訊息。

欄位
name	string 必要欄位。訊息的資源名稱。 格式：spaces/{space}/messages/{message} 如果您已為訊息設定自訂 ID，就可以使用「{message}」的「clientAssignedMessageId」欄位值。詳情請參閱「為訊息命名」。
force	bool true時，刪除訊息將一併刪除其討論串式回覆。設定 false 時，如果郵件有討論串回覆，就會無法刪除。 只有以使用者的身分進行驗證時適用。以 Chat 應用程式的身分進行驗證時沒有作用。

DeleteReactionRequest

刪除對訊息的回應。

欄位
name	string 必要欄位。要刪除的回應名稱。 格式：spaces/{space}/messages/{message}/reactions/{reaction}

DeleteSpaceRequest

要求刪除聊天室。

欄位
name	string 必要欄位。要刪除的聊天室資源名稱。 格式：spaces/{space}
use_admin_access	bool 開發人員預覽版：這是 Google Workspace 開發人員預覽版計畫的一環，這項計畫可讓使用者搶先體驗特定功能。 在 true 時，此方法會使用使用者的 Google Workspace 管理員權限執行。 通話使用者必須是具備管理即時通訊和聊天室對話權限的 Google Workspace 管理員。 需要 chat.admin.delete OAuth 2.0 範圍。

DeletionMetadata

已刪除訊息的相關資訊。設定 delete_time 時，系統會刪除訊息。

欄位
deletion_type	DeletionType 顯示刪除訊息的使用者。

DeletionType

刪除訊息的使用者及其刪除方式。

列舉
DELETION_TYPE_UNSPECIFIED	這個值未使用。
CREATOR	使用者刪除了自己的訊息。
SPACE_OWNER	聊天室擁有者刪除了訊息。
ADMIN	Google Workspace 管理員刪除了訊息。
APP_MESSAGE_EXPIRY	Chat 應用程式本身在訊息到期後遭到刪除。
CREATOR_VIA_APP	Chat 應用程式代表使用者刪除了訊息。
SPACE_OWNER_VIA_APP	Chat 應用程式代表聊天室擁有者刪除了訊息。

對話方塊

對話方塊資訊卡內文周圍的包裝函式。

欄位
body	Card 僅限輸入。對話方塊的內文，透過互動視窗顯示。Google Chat 應用程式不支援下列卡片實體：DateTimePicker、OnChangeAction。

DialogAction

包含對話方塊和要求狀態碼。

欄位
action_status	ActionStatus 僅限輸入。叫用或提交對話方塊的要求狀態。視需要顯示狀態和要向使用者顯示的訊息。例如發生錯誤或成功時。
聯集欄位 action。要執行的動作。action 只能是下列其中一項：
dialog	Dialog 僅限輸入。要求的 Dialog。

DriveDataRef

參照雲端硬碟附件的資料。

欄位
drive_file_id	string 雲端硬碟檔案的 ID。搭配 Drive API 使用。

DriveLinkData

Google 雲端硬碟連結的資料。

欄位
drive_data_ref	DriveDataRef 參照 Google 雲端硬碟檔案的 DriveDataRef。
mime_type	string 已連結 Google 雲端硬碟資源的 MIME 類型。

Emoji

做為訊息回應的表情符號。

欄位
聯集欄位 content。表情符號的內容。content 只能是下列其中一項：
unicode	string 以萬國碼 (Unicode) 字串表示的基本表情符號。
custom_emoji	CustomEmoji 僅供輸出。自訂表情符號。

EmojiReactionSummary

回應含有特定表情符號的訊息的使用者人數。

欄位
emoji	Emoji 與回應相關聯的表情符號。
reaction_count	int32 使用相關表情符號的回應總數。

FindDirectMessageRequest

根據使用者資源取得即時訊息空間的要求。

欄位
name	string 必要欄位。要尋找即時訊息的使用者資源名稱。 格式：users/{user}，其中 {user} 是 People API 中「個人」的 id，或 Directory API 中使用者的 id。舉例來說，如果 People API 個人資料 ID 為 123456789，您就可以使用 users/123456789 做為 name，尋找與對方的即時訊息。當您以使用者身分進行驗證時，您就能使用這個電子郵件地址做為 {user} 的別名。舉例來說，users/[e-mail]，其中 [e-mail] 是 Google Chat 使用者的電子郵件。

GetAttachmentRequest

要求取得附件。

欄位
name	string 必要欄位。附件的資源名稱，格式為 spaces/{space}/messages/{message}/attachments/{attachment}。

GetMembershipRequest

要求取得聊天室成員資格。

欄位
name	string 必要欄位。要擷取成員資格的資源名稱。 如要利用使用者驗證機制取得應用程式本身的成員資格，您可以選擇使用 spaces/{space}/members/app。 格式：spaces/{space}/members/{member} 或 spaces/{space}/members/app 當您以使用者身分進行驗證時，您可以將使用者的電子郵件地址設為 {member} 的別名。舉例來說，spaces/{space}/members/[e-mail]，其中 [e-mail] 是 Google Chat 使用者的電子郵件。
use_admin_access	bool 開發人員預覽版：這是 Google Workspace 開發人員預覽版計畫的一環，這項計畫可讓使用者搶先體驗特定功能。 在 true 時，此方法會使用使用者的 Google Workspace 管理員權限執行。 通話使用者必須是具備管理即時通訊和聊天室對話權限的 Google Workspace 管理員。 需要 chat.admin.memberships 或 chat.admin.memberships.readonly OAuth 2.0 範圍。 使用管理員存取權時，無法在聊天室中取得應用程式成員資格。

GetMessageRequest

要求取得訊息。

欄位
name	string 必要欄位。訊息的資源名稱。 格式：spaces/{space}/messages/{message} 如果您已為訊息設定自訂 ID，就可以使用「{message}」的「clientAssignedMessageId」欄位值。詳情請參閱「為訊息命名」。

GetSpaceEventRequest

要求取得聊天室活動的訊息。

欄位
name	string 必要欄位。聊天室活動的資源名稱。 格式：spaces/{space}/spaceEvents/{spaceEvent}

GetSpaceReadStateRequest

GetSpaceReadState API 的要求訊息。

欄位
name	string 必要欄位。要擷取的聊天室讀取狀態資源名稱。 僅支援取得發出呼叫的使用者讀取狀態。 如要參照發出呼叫的使用者，請設定下列其中一項： me 別名。例如 users/me/spaces/{space}/spaceReadState。 他們的 Workspace 電子郵件地址。例如 users/[e-mail]/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 開發人員預覽版：這是 Google Workspace 開發人員預覽版計畫的一環，這項計畫可讓使用者搶先體驗特定功能。 在 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/[e-mail]/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	開啟記錄功能。機構的保管箱資料保留規則指定郵件和討論串的保留時間長度。

ListMembershipsRequest

列出成員資格的訊息。

欄位
parent	string 必要欄位。要擷取成員清單的聊天室資源名稱。 格式：space/{space}
page_size	int32 選用設定。可退貨的會員數量上限。服務傳回的產品數量可能會少於這個值。 如未指定，最多會傳回 100 個成員資格。 值的數量上限是 1000。如果使用的值超過 1000，系統會自動將值變更為 1000。 負值會傳回 INVALID_ARGUMENT 錯誤。
page_token	string 選用設定。頁面符記，從先前的呼叫列出成員。提供這個參數即可擷取後續網頁。 進行分頁時，提供的所有其他參數應與提供網頁權杖的呼叫相符。將不同的值傳送至其他參數，可能會導致非預期的結果。
filter	string 選用設定。查詢篩選器。 你可以依成員的角色 (role) 和類型 (member.type) 篩選成員資格， 如要依角色篩選，請將 role 設為 ROLE_MEMBER 或 ROLE_MANAGER。 如要依類型篩選，請將 member.type 設為 HUMAN 或 BOT。開發人員預覽：您也可以使用 != 運算子篩選 member.type。 如要同時依角色和類型進行篩選，請使用 AND 運算子。如要依角色或類型進行篩選，請使用 OR 運算子。 use_admin_access 設為 true 時，必須提供 member.type = "HUMAN" 或 member.type != "BOT"。其他成員類型篩選條件將遭到拒絕。 舉例來說，以下查詢是有效的查詢： role = "ROLE_MANAGER" OR role = "ROLE_MEMBER" member.type = "HUMAN" AND role = "ROLE_MANAGER" member.type != "BOT" 以下查詢無效： member.type = "HUMAN" AND member.type = "BOT" role = "ROLE_MANAGER" AND role = "ROLE_MEMBER" 無效查詢遭到伺服器拒絕，並顯示 INVALID_ARGUMENT 錯誤。
show_groups	bool 選用設定。執行 true 時，除了其他類型的會員外，也會傳回與 Google Group 相關聯的會員。如果設定了 filter，系統不會傳回不符合篩選條件的 Google Group 項成員資格。
show_invited	bool 選用設定。變更 true 設定後，系統會一併傳回與 invited 會員相關聯的會員，以及其他類型的會員服務。如果設定了篩選器，系統就不會傳回 invited 個不符合篩選條件的成員資格。 目前需要使用者驗證。
use_admin_access	bool 開發人員預覽版：這是 Google Workspace 開發人員預覽版計畫的一環，這項計畫可讓使用者搶先體驗特定功能。 在 true 時，此方法會使用使用者的 Google Workspace 管理員權限執行。 通話使用者必須是具備管理即時通訊和聊天室對話權限的 Google Workspace 管理員。 需要 chat.admin.memberships.readonly 或 chat.admin.memberships OAuth 2.0 範圍。 使用管理員存取權時，無法在聊天室中列出應用程式成員。

ListMembershipsResponse

針對聊天室成員清單的回應。

欄位
memberships[]	Membership 未排序的清單。要求 (或第一個) 頁面中的成員清單。
next_page_token	string 可做為 pageToken 傳送的權杖，用於擷取下一頁的結果。如果空白，表示沒有後續網頁。

ListMessagesRequest

列出指定聊天室中使用者所屬的訊息。

欄位
parent	string 必要欄位。要列出訊息的來源聊天室資源名稱。 格式：spaces/{space}
page_size	int32 傳回的訊息數量上限。服務傳回的訊息可能會少於這個值。 如未指定，最多會傳回 25 個。 值的數量上限是 1000。如果使用的值超過 1000，系統會自動將值變更為 1000。 負值會傳回 INVALID_ARGUMENT 錯誤。
page_token	string 如果繼續執行先前的查詢，則為選用項目。 接收自先前 list 訊息呼叫的頁面符記。提供這個參數即可擷取後續網頁。 進行分頁時，提供的所有其他參數應與提供網頁權杖的呼叫相符。將不同的值傳送至其他參數，可能會導致非預期的結果。
filter	string 查詢篩選器。 您可以按照日期 (create_time) 和討論串 (thread.name) 篩選訊息。 如要依建立日期篩選郵件，請指定 create_time 以及 RFC-3339 格式的時間戳記，並加上雙引號。例如 "2023-04-21T11:30:00-04:00"。您可以使用大於運算子 > 列出在時間戳記之後建立的訊息；也可以使用小於運算子 < 列出在時間戳記之前建立的訊息。如要篩選時間間隔內的訊息，請在兩個時間戳記之間使用 AND 運算子。 如要依執行緒篩選，請指定格式為 spaces/{space}/threads/{thread} 的 thread.name。每項查詢只能指定一個 thread.name。 如要同時依執行緒和日期進行篩選，請在查詢中使用 AND 運算子。 舉例來說，以下查詢是有效的查詢： create_time > "2012-04-21T11:30:00-04:00" create_time > "2012-04-21T11:30:00-04:00" AND thread.name = spaces/AAAAAAAAAAA/threads/123 create_time > "2012-04-21T11:30:00+00:00" AND create_time < "2013-01-01T00:00:00+00:00" AND thread.name = spaces/AAAAAAAAAAA/threads/123 thread.name = spaces/AAAAAAAAAAA/threads/123 無效查詢遭到伺服器拒絕，並顯示 INVALID_ARGUMENT 錯誤。
order_by	string 如果繼續執行先前的查詢，則為選用項目。 訊息清單的排序方式。指定排序作業要排序的值。有效的排序作業值如下： ASC 代表遞增。 DESC 代表遞減。 預設順序為 create_time ASC。
show_deleted	bool 是否包含已刪除的郵件。刪除的郵件會包含刪除時間以及相關刪除時間的中繼資料，但無法取得郵件內容。

ListMessagesResponse

列出訊息的回應訊息。

欄位
messages[]	Message 訊息清單。
next_page_token	string 您可以傳送權杖為 pageToken，擷取下一頁的結果。如果空白，表示沒有後續網頁。

ListReactionsRequest

列出回應訊息的回應。

欄位
parent	string 必要欄位。使用者回應的訊息。 格式：spaces/{space}/messages/{message}
page_size	int32 選用設定。傳回的回應數量上限。服務傳回的回應數可以少於這個值。如未指定，則預設值為 25。許可的最大值為 200；超過 200 個值會變更為 200。
page_token	string 選用設定。(如果恢復先前的查詢)。 接收自前一個清單回應呼叫的頁面符記。提供此項目即可擷取後續網頁。 進行分頁時，篩選器值應與提供網頁權杖的呼叫相符。如果傳送不同的值，可能會導致非預期的結果。
filter	string 選用設定。查詢篩選器。 你可以依 emoji (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 頁面符記，接收自前一個清單空間事件呼叫。提供此項目即可擷取後續網頁。 進行分頁時，提供給列出空間事件的所有其他參數都必須與提供網頁權杖的呼叫相符。將不同的值傳送至其他參數，可能會導致非預期的結果。
filter	string 必要欄位。查詢篩選器。 您必須使用 : 運算子指定至少一個事件類型 (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 系統會按照時間順序傳回結果 (由舊到新)。
next_page_token	string 用於擷取更多事件的接續權杖。如果省略這個欄位，就不會有後續頁面。

ListSpacesRequest

列出呼叫端所屬聊天室的要求。

欄位
page_size	int32 選用設定。要傳回的聊天室數量上限。服務傳回的產品數量可能會少於這個值。 如未指定，最多會傳回 100 個空格。 值的數量上限是 1000。如果使用的值超過 1000，系統會自動將值變更為 1000。 負值會傳回 INVALID_ARGUMENT 錯誤。
page_token	string 選用設定。從先前的 list 空格呼叫接收的頁面符記。提供這個參數即可擷取後續網頁。 進行分頁時，篩選器值應與提供網頁權杖的呼叫相符。如果傳送不同的值，可能會導致非預期的結果。
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 要求 (或第一個) 頁面中的聊天室清單。
next_page_token	string 您可以傳送權杖為 pageToken，擷取下一頁的結果。如果空白，表示沒有後續網頁。

MatchedUrl

Chat 訊息中的相符網址。即時通訊應用程式可以預覽相符的網址。詳情請參閱「預覽連結」一文。

欄位
url	string 僅供輸出。符合的網址。

成員資格

代表 Google Chat 中的成員身分，例如使用者或 Chat 應用程式是否受邀加入、加入或不在聊天室中。

欄位
name	string 由伺服器指派的成員資源名稱。 格式：spaces/{space}/members/{member}
state	MembershipState 僅供輸出。會員狀態。
role	MembershipRole 選用設定。使用者在 Chat 聊天室中的角色，會決定他們能在聊天室中執行的動作。 這個欄位只能做為 UpdateMembership 的輸入內容。
create_time	Timestamp 選用設定。不可變動。成員資格的建立時間，例如成員加入或受邀加入聊天室的時間。系統只會輸出此欄位，但用於在匯入模式聊天室中匯入過往成員資料時除外。
delete_time	Timestamp 選用設定。不可變動。成員資格的刪除時間，例如成員離開聊天室或從聊天室中移除的時間。系統只會輸出此欄位，但用於在匯入模式聊天室中匯入過往成員資料時除外。
聯集欄位 memberType。已取得這個會員資格的成員。日後可能會支援其他成員類型。memberType 只能是下列其中一項：
member	User 與成員資格對應的 Google Chat 使用者或應用程式。如果 Chat 擴充應用程式以使用者的身分進行驗證，輸出內容會填入「使用者」name 和 type。
group_member	Group 與成員資格對應的 Google 群組。

MembershipRole

代表使用者在 Chat 聊天室中允許的操作。日後可能會新增更多列舉值。

列舉
MEMBERSHIP_ROLE_UNSPECIFIED	預設值。users：他們不是聊天室成員，但可以受邀加入。如果是 Google Groups：系統一律會指派這個角色 (日後可能會使用其他列舉值)。
ROLE_MEMBER	聊天室成員。使用者俱備基本權限，例如傳送訊息至聊天室。在 1:1 和未命名的群組對話中，所有使用者都擁有這個角色。
ROLE_MANAGER	聊天室管理員。使用者俱備所有基本權限，以及可讓使用者管理聊天室的管理員權限，例如新增或移除成員。只能在 SpaceType.SPACE 中使用。

MembershipState

指定成員與聊天室的關係。日後可能會支援其他成員狀態。

列舉
MEMBERSHIP_STATE_UNSPECIFIED	預設值。請勿使用。
JOINED	使用者就會加入聊天室，而且可以加入聊天室。
INVITED	使用者受邀加入聊天室，但尚未加入。
NOT_A_MEMBER	使用者不是聊天室成員，也沒有加入聊天室的待處理邀請。

MembershipBatchCreatedEventData

多個新成員的事件酬載。

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

欄位
memberships[]	MembershipCreatedEventData 新會員清單。

MembershipBatchDeletedEventData

多個已刪除成員的事件酬載。

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

欄位
memberships[]	MembershipDeletedEventData 已刪除的成員清單。

MembershipBatchUpdatedEventData

多個已更新成員的事件酬載。

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

欄位
memberships[]	MembershipUpdatedEventData 更新會員清單。

MembershipCreatedEventData

新成員的事件酬載。

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

欄位
membership	Membership 新會員。

MembershipDeletedEventData

已刪除成員的事件酬載。

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

欄位
membership	Membership 已刪除的會員資格。只有 name 和 state 欄位會填入資料。

MembershipUpdatedEventData

更新成員的事件酬載。

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

欄位
membership	Membership 更新後的成員。

訊息

Google Chat 聊天室中的訊息。

欄位
name	string 訊息的資源名稱。 格式：spaces/{space}/messages/{message} 其中 {space} 是張貼訊息的聊天室 ID，{message} 則是系統指派的訊息 ID。例如：spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB。 如果您在建立訊息時設定了自訂 ID，就可以使用這個 ID，將 {message} 替換為 clientAssignedMessageId 欄位中的值，指定要求中的訊息。例如 spaces/AAAAAAAAAAA/messages/client-custom-name。詳情請參閱「為訊息命名」。
sender	User 僅供輸出。建立訊息的使用者。如果 Chat 擴充應用程式以使用者的身分進行驗證，輸出內容會填入「使用者」name 和 type。
create_time	Timestamp 選用設定。不可變動。在 Chat 中建立的聊天室，也就是建立訊息的時間。這個欄位僅供輸出 (用於匯入模式空格時除外)。 如果是匯入模式聊天室，請將這個欄位設為在來源中建立訊息的過往時間戳記，以便保留原始的建立時間。
last_update_time	Timestamp 僅供輸出。使用者上次編輯訊息的時間。如果訊息從未編輯過，這個欄位就會空白。
delete_time	Timestamp 僅供輸出。Google Chat 中刪除訊息的時間。如果郵件從未刪除，這個欄位會留空。
text	string 郵件的純文字內文。第一個連至圖片、影片或網頁的連結會產生預覽方塊。你也可以使用@號提及 Google Chat 使用者或聊天室中的所有成員。 如要瞭解如何建立簡訊，請參閱傳送簡訊。
formatted_text	string 僅供輸出。包含訊息 text 並加上標記，用於傳達格式。這個欄位可能不會擷取 UI 中顯示的所有格式，但包含下列內容： 標記語法適用於粗體、斜體、刪除線、等寬字元、等寬區塊和項目符號清單。 使用者提及的格式為 <users/{user}>。 使用 <{url}|{rendered_text}> 格式的自訂超連結，其中第一個字串是網址，第二個字串則是實際顯示的文字，例如 <http://example.com|custom text>。 使用 :{emoji_name}: 格式的自訂表情符號，例如 :smile:。這不適用於萬國碼 (Unicode) 表情符號，例如使用 U+1F600 表示笑臉表情符號。 詳情請參閱查看郵件中傳送的文字格式。
cards[] (deprecated)	Card 這個項目已遭淘汰！ 已淘汰：請改用 cards_v2。 豐富的格式與互動式資訊卡，可用於顯示 UI 元素，例如格式化的文字、按鈕和可點擊的圖片。資訊卡通常顯示在訊息的純文字內文下方。cards 和 cards_v2 的大小上限為 32 KB。
cards_v2[]	CardWithId 資訊卡的陣列。 只有 Chat 應用程式可以建立資訊卡。如果 Chat 應用程式以使用者的身分進行驗證，訊息就無法包含卡片。 如要瞭解資訊卡及其建立方式，請參閱「傳送資訊卡訊息」。 使用 Card Builder 設計及預覽資訊卡。 開啟資訊卡建立工具
annotations[]	Annotation 僅供輸出。與這則訊息中的 text 相關聯的註解。
thread	Thread 訊息所屬的討論串。如需使用說明，請參閱「發起或回覆訊息串」。
space	Space 如果 Chat 擴充應用程式以使用者的身分進行驗證，輸出內容就會填入「聊天室」name。
fallback_text	string 訊息資訊卡的純文字說明，用於無法顯示實際卡片 (例如行動裝置通知)。
action_response	ActionResponse 僅限輸入。Chat 應用程式可用來設定回應張貼方式的參數。
argument_text	string 僅供輸出。所有提及 Chat 應用程式的訊息都會移除訊息的純文字內文。
slash_command	SlashCommand 僅供輸出。斜線指令資訊 (如適用)。
attachment[]	Attachment 使用者上傳的附件。
matched_url	MatchedUrl 僅供輸出。spaces.messages.text 中的網址與連結預覽模式相符。詳情請參閱「預覽連結」一文。
thread_reply	bool 僅供輸出。設為 true 時，訊息是回覆討論串中的回覆。設為 false 時，訊息會在聊天室頂層對話中顯示為討論串的第一則訊息，或是沒有討論串回覆的訊息。 如果聊天室不支援在討論串中回覆，這個欄位將一律為 false。
client_assigned_message_id	string 選用設定。訊息的自訂 ID。您可以使用欄位辨識訊息，也可以取得、刪除或更新訊息。如要設定自訂 ID，請在建立訊息時指定 messageId 欄位。詳情請參閱「為訊息命名」。
emoji_reaction_summaries[]	EmojiReactionSummary 僅供輸出。訊息中的表情符號回應摘要清單。
private_message_viewer	User 不可變動。用於建立訊息的輸入內容，否則為僅限輸出。可查看訊息的使用者。設定後，訊息就會處於私人狀態，只有指定使用者和 Chat 應用程式看得到。私人訊息不支援連結預覽和附件。 只有 Chat 應用程式可以傳送私人訊息，如果你的 Chat 擴充應用程式以使用者身分進行驗證來傳送訊息，就無法設為私人訊息，而且必須略過這個欄位。 詳情請參閱「傳送私人訊息給 Google Chat 使用者」。
deletion_metadata	DeletionMetadata 僅供輸出。已刪除訊息的相關資訊。設定 delete_time 時，系統會刪除訊息。
quoted_message_metadata	QuotedMessageMetadata 僅供輸出。Google Chat 使用者在聊天室中引用的訊息相關資訊。Google Chat 使用者可以引用訊息來回覆。
attached_gifs[]	AttachedGif 僅供輸出。附加至訊息的 GIF 圖片。
accessory_widgets[]	AccessoryWidget 顯示在訊息底部的一或多個互動小工具。您可以將配件小工具新增至含有文字、卡片或兩者皆有的訊息中。不支援含有對話方塊的訊息。詳情請參閱在訊息底部新增互動式小工具。 如要建立含有配件小工具的訊息，您必須完成應用程式驗證。

MessageBatchCreatedEventData

多則新訊息的事件酬載。

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

欄位
messages[]	MessageCreatedEventData 新訊息清單。

MessageBatchDeletedEventData

多則已刪除訊息的事件酬載。

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

欄位
messages[]	MessageDeletedEventData 已刪除訊息的清單。

MessageBatchUpdatedEventData

多則已更新訊息的事件酬載。

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

欄位
messages[]	MessageUpdatedEventData 更新訊息的清單。

MessageCreatedEventData

新訊息的事件酬載。

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

欄位
message	Message 新訊息。

MessageDeletedEventData

已刪除訊息的事件酬載。

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

欄位
message	Message 刪除的訊息。系統只會填入 name、createTime、deleteTime 和 deletionMetadata 欄位。

MessageUpdatedEventData

更新訊息的事件酬載。

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

欄位
message	Message 更新後的訊息。

QuotedMessageMetadata

引用訊息的相關資訊。

欄位
name	string 僅供輸出。引用訊息的資源名稱。 格式：spaces/{space}/messages/{message}
last_update_time	Timestamp 僅供輸出。引用訊息的建立時間或上次更新引用訊息的時間戳記。

反應影片

訊息的回應。

欄位
name	string 回應的資源名稱。 格式：spaces/{space}/messages/{message}/reactions/{reaction}
user	User 僅供輸出。建立回應的使用者。
emoji	Emoji 回應中使用的表情符號。

ReactionBatchCreatedEventData

多個新回應的事件酬載。

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

欄位
reactions[]	ReactionCreatedEventData 新回應的清單。

ReactionBatchDeletedEventData

多個已刪除回應的事件酬載。

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

欄位
reactions[]	ReactionDeletedEventData 已刪除回應的清單。

ReactionCreatedEventData

新回應的事件酬載。

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

欄位
reaction	Reaction 新回應。

ReactionDeletedEventData

已刪除回應的事件酬載。

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

欄位
reaction	Reaction 已刪除回應。

RichLinkMetadata

豐富的資源連結。

欄位
uri	string 這個連結的 URI。
rich_link_type	RichLinkType 複合式連結類型。
聯集欄位 data。已連結資源的資料。data 只能是下列其中一項：
drive_link_data	DriveLinkData 雲端硬碟連結的資料。
chat_space_link_data	ChatSpaceLinkData Chat 聊天室連結的資料。 開發人員預覽版：這是 Google Workspace 開發人員預覽版計畫的一環，這項計畫可讓使用者搶先體驗特定功能。

RichLinkType

複合式連結類型。日後可能會有更多類型。

列舉
RICH_LINK_TYPE_UNSPECIFIED	列舉的預設值。請勿使用。
DRIVE_FILE	Google 雲端硬碟複合式連結類型。
CHAT_SPACE	Chat 聊天室複合式連結類型。例如聊天室智慧型方塊。 開發人員預覽版：這是 Google Workspace 開發人員預覽版計畫的一環，這項計畫可讓使用者搶先體驗特定功能。

SearchSpacesRequest

要求根據查詢搜尋聊天室清單。

欄位
use_admin_access	bool 在 true 時，此方法會使用使用者的 Google Workspace 管理員權限執行。 通話使用者必須是具備管理即時通訊和聊天室對話權限的 Google Workspace 管理員。 需要 chat.admin.spaces.readonly 或 chat.admin.spaces OAuth 2.0 範圍。 這個方法目前僅支援管理員存取權，因此這個欄位只接受 true。
page_size	int32 要傳回的聊天室數量上限。服務傳回的產品數量可能會少於這個值。 如未指定，最多會傳回 100 個空格。 值的數量上限是 1000。如果使用的值超過 1000，系統會自動將值變更為 1000。
page_token	string 從前一個搜尋聊天室呼叫接收的權杖。提供這個參數即可擷取後續網頁。 進行分頁時，提供的所有其他參數應與提供網頁權杖的呼叫相符。將不同的值傳送至其他參數，可能會導致非預期的結果。
query	string 必要欄位。搜尋查詢。 你可以使用下列參數進行搜尋： create_time customer display_name external_user_allowed last_active_time space_history_state space_type create_time 和 last_active_time 可接受 RFC-3339 格式的時間戳記，且支援的比較運算子為：=、<、>、<=、>=。 customer 是必要項目，用於指出要從哪個客戶擷取聊天室。customers/my_customer 是唯一支援的值。 display_name 只接受 HAS (:) 運算子。要比對的文字會先以代碼化為符記，每個符記均區分大小寫，且獨立為字串 display_name 中任何位置的子字串。舉例來說，Fun Eve 符合 Fun event 或 The evening was fun，但不符合 notFun event 或 even。 external_user_allowed 接受 true 或 false。 space_history_state 只接受 space 資源 historyState 欄位中的值。 必須提供 space_type，且唯一有效值為 SPACE。 不同欄位僅支援 AND 運算子。有效的範例為 space_type = "SPACE" AND display_name:"Hello"，無效的範例為 space_type = "SPACE" OR display_name:"Hello"。 在相同欄位中，space_type 不支援 AND 或 OR 運算子。display_name、「space_history_state」和「external_user_allowed」僅支援 OR 運算子。last_active_time 和 create_time 同時支援 AND 和 OR 運算子。AND 只能用來表示間隔，例如 last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00"。 以下查詢範例有效： customer = "customers/my_customer" AND space_type = "SPACE" customer = "customers/my_customer" AND space_type = "SPACE" AND display_name:"Hello World" customer = "customers/my_customer" AND space_type = "SPACE" AND (last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time > "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (display_name:"Hello World" OR display_name:"Fun event") AND (last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time < "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (create_time > "2019-01-01T00:00:00+00:00" AND create_time < "2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND (space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
order_by	string 選用設定。聊天室清單的排序方式。 支援的排序屬性如下： membership_count.joined_direct_human_user_count — 表示直接加入聊天室的真人使用者人數。 last_active_time：表示最後一個符合資格的項目新增至這個聊天室主題的時間。 create_time：表示聊天室建立時間， 有效的排序作業值如下： ASC 代表遞增。預設值。 DESC 代表遞減。 支援的語法如下： membership_count.joined_direct_human_user_count DESC membership_count.joined_direct_human_user_count ASC last_active_time DESC last_active_time ASC create_time DESC create_time ASC

SearchSpacesResponse

傳回與搜尋聊天室要求相對應的聊天室清單。

欄位
spaces[]	Space 要求的聊天室頁面。
next_page_token	string 可用來擷取下一頁的權杖。如果這個欄位留空，表示沒有後續網頁。
total_size	int32 在所有網頁中，符合查詢的聊天室總數。如果結果超過 10,000 個空格，此值即為估計值。

SetUpSpaceRequest

要求建立聊天室並新增指定使用者。

欄位
space	Space 必要欄位。Space.spaceType 為必填欄位。 如要建立聊天室，請將「Space.spaceType」設為「SPACE」並設定 Space.displayName。如果在設定聊天室時收到「ALREADY_EXISTS」錯誤訊息，請嘗試使用其他displayName。Google Workspace 機構中的某個聊天室可能已使用這個顯示名稱。 如要建立群組通訊，請將 Space.spaceType 設為 GROUP_CHAT。不要設定 Space.displayName。 如要在真人之間建立 1:1 對話，請將 Space.spaceType 設為 DIRECT_MESSAGE，並將 Space.singleUserBotDm 設為 false。請勿設定 Space.displayName 或 Space.spaceDetails。 如要在真人和通話應用程式之間建立 1:1 對話，請將 Space.spaceType 設為 DIRECT_MESSAGE，並將 Space.singleUserBotDm 設為 true。請勿設定 Space.displayName 或 Space.spaceDetails。 如果 DIRECT_MESSAGE 聊天室已存在，系統會傳回該聊天室，而不是建立新聊天室。
request_id	string 選用設定。這項要求的專屬 ID。建議隨機產生 UUID。指定現有的要求 ID 時，系統會傳回使用該 ID 建立的聊天室，而不會建立新空間。在同一個 Chat 應用程式中指定現有要求 ID，且該要求 ID 與不同驗證的使用者相同，系統會傳回錯誤。
memberships[]	Membership 選用設定。要邀請加入聊天室的 Google Chat 使用者或群組。省略呼叫的使用者 (由系統自動新增)。 設定目前除了來電者以外，最多允許 20 個會員資格。 如果是人類成員資格，Membership.member 欄位必須包含 user，且已填入 name (格式：users/{user})，type 則設為 User.Type.HUMAN。只能在設定聊天室時新增真人使用者 (只能透過通話應用程式新增即時通訊應用程式)。您也可以利用使用者的電子郵件地址做為 {user} 的別名，藉此新增成員。舉例來說，user.name 可以是 users/[e-mail]。如要邀請 Gmail 使用者或外部 Google Workspace 網域的使用者，必須使用使用者的電子郵件地址來邀請 {user}。 如果是 Google 群組成員，Membership.group_member 欄位必須包含 group 且已填入 name (格式：groups/{group})。只有在將「Space.spaceType」設為「SPACE」時，才能新增 Google 群組。 將 Space.spaceType 設為 SPACE 時可選用。 將 Space.spaceType 設為 GROUP_CHAT，且至少有兩個成員時，此為必要欄位。 將 Space.spaceType 設為 DIRECT_MESSAGE 且包含真人使用者 (含一個成員資格) 時，此為必要欄位。 為真人和發出呼叫的 Chat 應用程式進行 1:1 對話 (將 Space.spaceType 設為 DIRECT_MESSAGE，並將 Space.singleUserBotDm 設為 true 時)，這個欄位必須留空。

SlashCommand

Google Chat 中的斜線指令。

欄位
command_id	int64 叫用的斜線指令 ID。

SlashCommandMetadata

斜線指令 (/) 的註解中繼資料。

欄位
bot	User 叫用指令的 Chat 應用程式。
type	Type 斜線指令的類型，
command_name	string 叫用的斜線指令的名稱。
command_id	int64 叫用的斜線指令的指令 ID。
triggers_dialog	bool 指出斜線指令是否用於對話方塊。

類型

列舉
TYPE_UNSPECIFIED	列舉的預設值。請勿使用。
ADD	將 Chat 應用程式新增至聊天室。
INVOKE	在空間中叫用斜線指令。

空格

Google Chat 中的聊天室。聊天室是指兩名以上使用者之間的對話，或使用者和 Chat 應用程式之間的 1:1 訊息。

欄位
name	string 聊天室的資源名稱。 格式：spaces/{space}
type (deprecated)	Type 這個項目已遭淘汰！ 僅供輸出。已淘汰：請改用 space_type。聊天室的類型，
space_type	SpaceType 聊天室類型。建立聊天室或更新聊天室類型時為必要項目。僅供其他用途輸出。
single_user_bot_dm	bool 選用設定。聊天室是否為 Chat 應用程式和單一真人之間的即時訊息。
threaded (deprecated)	bool 這個項目已遭淘汰！ 僅供輸出。已淘汰：請改用 spaceThreadingState。這個聊天室中的訊息是否為討論串形式。
display_name	string 聊天室的顯示名稱。建立聊天室時必填。如果在建立聊天室或更新displayName時收到 ALREADY_EXISTS 錯誤訊息，請嘗試其他 displayName。Google Workspace 機構中的現有聊天室可能已使用這個顯示名稱。 如果是即時訊息，這個欄位可能會留空。 最多可支援 128 個半形字元。
external_user_allowed	bool 不可變動。這個聊天室是否允許任何 Google Chat 使用者加入。在 Google Workspace 機構建立聊天室時輸入。於下列條件建立空格時，請略過這個欄位： 已驗證的使用者使用個人帳戶 (非受管使用者帳戶)。根據預設，透過個人帳戶建立的聊天室可允許所有 Google Chat 使用者存取。 如為現有聊天室，這個欄位只會輸出。
space_threading_state	SpaceThreadingState 僅供輸出。Chat 聊天室的討論串狀態。
space_details	SpaceDetails 聊天室的詳細資料，包括說明和規則。
space_history_state	HistoryState 這個聊天室中訊息和討論串的訊息記錄狀態。
import_mode	bool 選用設定。將資料遷移至 Google Workspace 時，系統是否在「Import Mode」建立這個聊天室。正在匯入聊天室時，使用者必須等到匯入完成後才會看到聊天室。
create_time	Timestamp 選用設定。不可變動。在 Chat 中建立的聊天室，是指聊天室的建立時間。這個欄位僅供輸出 (用於匯入模式空格時除外)。 如果是匯入模式聊天室，請將這個欄位設為在來源中建立聊天室的過往時間戳記，以便保留原始的建立時間。 只有在 spaceType 為 GROUP_CHAT 或 SPACE 時，才會在輸出內容填入。
last_active_time	Timestamp 僅供輸出。聊天室中最後一則訊息的時間戳記。 開發人員預覽版：這是 Google Workspace 開發人員預覽版計畫的一環，這項計畫可讓使用者搶先體驗特定功能。
admin_installed	bool 僅供輸出。針對採用 Chat 應用程式的即時訊息 (DM) 聊天室，無論聊天室是否由 Google Workspace 管理員建立，管理員可以代表機構使用者安裝及設定 Chat 應用程式的即時訊息。 如要支援管理員安裝功能，您的 Chat 應用程式必須提供即時訊息。
membership_count	MembershipCount 僅供輸出。會員人數按成員類型分組。在 space_type 為 SPACE、DIRECT_MESSAGE 或 GROUP_CHAT 時填入。 開發人員預覽版：這是 Google Workspace 開發人員預覽版計畫的一環，這項計畫可讓使用者搶先體驗特定功能。
access_settings	AccessSettings 選用設定。指定聊天室的存取權設定。只有在 space_type 為 SPACE 時才會填入。
space_uri	string 僅供輸出。供使用者存取聊天室的 URI。
聯集欄位 space_permission_settings。代表聊天室的權限設定。只有在 space_type 為 SPACE 時才會填入。 開發人員預覽版：這是 Google Workspace 開發人員預覽版計畫的一環，這項計畫可讓使用者搶先體驗特定功能。 space_permission_settings 只能採用下列其中一種設定：
predefined_permission_settings	PredefinedPermissionSettings 選用設定。僅限輸入。聊天室權限設定。用於建立聊天室的輸入內容。如未設定這個欄位，系統就會建立協作聊天室。建立聊天室後，PermissionSettings 欄位中會填入設定。 開發人員預覽版：這是 Google Workspace 開發人員預覽版計畫的一環，這項計畫可讓使用者搶先體驗特定功能。
permission_settings	PermissionSettings 選用設定。可調整聊天室的確切權限設定。更新聊天室的輸入內容。否則只會輸出。如要建立聊天室，請改用 predefined_permission_settings。 開發人員預覽版：這是 Google Workspace 開發人員預覽版計畫的一環，這項計畫可讓使用者搶先體驗特定功能。

AccessSettings

代表聊天室的存取權設定。

欄位
access_state	AccessState 僅供輸出。指出聊天室的存取權狀態。
audience	string 選用設定。這是目標對象的資源名稱，可以探索聊天室、加入聊天室及預覽聊天室中的訊息。如未設定，則只有受到個別邀請或新增至聊天室的使用者或 Google 群組才能存取聊天室。詳情請參閱「允許目標對象搜尋聊天室」。 格式：audiences/{audience} 如要使用 Google Workspace 機構的預設目標對象，請設為 audiences/default。

AccessState

代表聊天室的存取狀態。

列舉
ACCESS_STATE_UNSPECIFIED	存取狀態不明，或不支援這個 API。
PRIVATE	只有其他使用者或 Google Workspace 管理員獨自新增或邀請的使用者或 Google 群組，才能找到及存取聊天室。
DISCOVERABLE	聊天室管理員已將目標對象存取權授予聊天室。個別加入或受邀加入聊天室的使用者或 Google 群組，也能探索及存取聊天室。詳情請參閱「將聊天室設為開放特定使用者搜尋」。

MembershipCount

開發人員預覽版：這是 Google Workspace 開發人員預覽版計畫的一環，這項計畫可讓使用者搶先體驗特定功能。

代表依類別分組的聊天室成員數量。

欄位
joined_direct_human_user_count	int32 直接加入聊天室的真人使用者人數 (不計入在加入群組的情況下加入的使用者數)。
joined_group_count	int32 直接加入聊天室的所有群組數量。

PermissionSetting

代表聊天室權限設定。

開發人員預覽版：這是 Google Workspace 開發人員預覽版計畫的一環，這項計畫可讓使用者搶先體驗特定功能。

欄位
managers_allowed	bool 聊天室管理員是否具備這項權限。
members_allowed	bool 非管理員成員是否擁有這項權限。

PermissionSettings

命名聊天室的權限設定。如要在建立聊天室時設定權限，請在要求中指定 PredefinedPermissionSettings 欄位。

開發人員預覽版：這是 Google Workspace 開發人員預覽版計畫的一環，這項計畫可讓使用者搶先體驗特定功能。

欄位
manage_members_and_groups	PermissionSetting 管理聊天室成員和群組的設定。
modify_space_details	PermissionSetting 這項設定代表的是更新聊天室名稱、顯示圖片、說明和規範。
toggle_history	PermissionSetting 這項設定用於開啟或關閉聊天室記錄。
use_at_mention_all	PermissionSetting 這項設定代表要在聊天室中使用「@all」符號。
manage_apps	PermissionSetting 管理聊天室應用程式的設定。
manage_webhooks	PermissionSetting 管理聊天室 Webhook 的設定。
post_messages	PermissionSetting 僅供輸出。這項設定適用於在聊天室中張貼訊息的設定。
reply_messages	PermissionSetting 回覆聊天室訊息的設定。

PredefinedPermissionSettings

建立具名聊天室時可指定的聊天室權限設定。日後可能會有更多設定加入。如要進一步瞭解具名聊天室的權限設定，請參閱「瞭解聊天室」。

開發人員預覽版：這是 Google Workspace 開發人員預覽版計畫的一環，這項計畫可讓使用者搶先體驗特定功能。

列舉
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	雙方的 1:1 訊息，或真人與 Chat 應用程式。

類型

已淘汰：請改用 SpaceType。

列舉
TYPE_UNSPECIFIED	預留。
ROOM	兩人之間的對話。
DM	1:1 即時訊息和 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() 要求，請在查詢篩選器中略過批次事件類型。根據預設，伺服器會傳回事件類型和批次版本。 messages 支援的事件類型： 新訊息：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

SpaceReadState

使用者在聊天室中的讀取狀態，用於識別已讀和未讀訊息。

欄位
name	string 聊天室讀取狀態的資源名稱。 格式：users/{user}/spaces/{space}/spaceReadState
last_read_time	Timestamp 選用設定。使用者聊天室讀取狀態更新的時間。通常會對應到上次讀取訊息的時間戳記，或是使用者指定的時間戳記，以標記聊天室中最後讀取的位置。

SpaceUpdatedEventData

已更新空間的事件酬載。

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

欄位
space	Space 已更新的聊天室。

討論串

Google Chat 聊天室中的討論串。如需使用說明，請參閱「發起或回覆訊息串」。

如果您在建立訊息時指定討論串，可以設定 messageReplyOption 欄位，指定在沒有相符的討論串時，系統將如何處理。

欄位
name	string 執行緒的資源名稱。 範例：spaces/{space}/threads/{thread}
thread_key	string 選用設定。建立或更新執行緒的輸入內容。否則只會輸出。執行緒 ID。最多可支援 4000 個半形字元。 這個 ID 專屬於設定該 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 開發人員預覽版：這是 Google Workspace 開發人員預覽版計畫的一環，這項計畫可讓使用者搶先體驗特定功能。 在 true 時，此方法會使用使用者的 Google Workspace 管理員權限執行。 通話使用者必須是具備管理即時通訊和聊天室對話權限的 Google Workspace 管理員。 需要 chat.admin.memberships OAuth 2.0 範圍。

UpdateMessageRequest

要求更新訊息。

欄位
message	Message 必要欄位。已更新欄位的訊息。
update_mask	FieldMask 必要欄位。要更新的欄位路徑。請以半形逗號分隔多個值，或使用 * 更新所有欄位路徑。 目前支援的欄位路徑： text attachment cards (需要應用程式驗證)。 cards_v2 (需要應用程式驗證)。 accessory_widgets (需要應用程式驗證)。
allow_missing	bool 選用設定。如果 true 且找不到訊息，系統會建立新訊息並忽略 updateMask。指定的郵件 ID 必須為用戶端指派，否則要求失敗。

UpdateSpaceReadStateRequest

UpdateSpaceReadState API 的要求訊息。

欄位
space_read_state	SpaceReadState 必要欄位。要更新的聊天室讀取狀態和欄位。 僅支援更新發出呼叫的使用者的讀取狀態。 如要參照發出呼叫的使用者，請設定下列其中一項： me 別名。例如 users/me/spaces/{space}/spaceReadState。 他們的 Workspace 電子郵件地址。例如 users/[e-mail]/spaces/{space}/spaceReadState。 使用者的使用者 ID。例如 users/123456789/spaces/{space}/spaceReadState。 格式：users/{user}/spaces/{space}/spaceReadState
update_mask	FieldMask 必要欄位。要更新的欄位路徑。目前支援的欄位路徑： last_read_time 如果 last_read_time 早於最新訊息建立時間，UI 就會顯示為未讀取。 如要將聊天室標示為已讀，請將 last_read_time 設為晚於最新訊息建立時間的值。系統會將 last_read_time 強制轉換成最新的訊息建立時間。請注意，聊天室讀取狀態只會影響聊天室頂層對話中顯示的訊息讀取狀態。執行緒的回覆不受此時間戳記影響，而是以執行緒讀取狀態為準。

UpdateSpaceRequest

更新單一聊天室的要求。

欄位
space	Space 必要欄位。要更新欄位的聊天室。必須以 spaces/{space} 的格式填入 Space.name。系統只會更新 update_mask 指定的欄位。
update_mask	FieldMask 必要欄位。更新後的欄位路徑 (如有多個路徑，以半形逗號分隔)。 你可以更新聊天室的下列欄位： space_details display_name：僅支援針對 spaceType 欄位為 SPACE 的聊天室更新顯示名稱。如果收到 ALREADY_EXISTS 錯誤訊息，請改用其他值。Google Workspace 機構中的某個聊天室可能已使用這個顯示名稱。 space_type：僅支援將 GROUP_CHAT 聊天室類型變更為 SPACE。在更新遮罩中將 display_name 和 space_type 一起加入，並確認指定的空間具有非空白的顯示名稱和 SPACE 空間類型。如果現有空間已具有 SPACE 類型，則在更新顯示名稱時，不一定要在指定空間中加入 space_type 遮罩和 SPACE 類型。嘗試透過其他方式更新聊天室類型會導致引數無效錯誤。管理員存取權不支援「space_type」。 space_history_state：開啟或關閉聊天室的記錄功能，更新聊天室記錄設定。只有在 Google Workspace 機構啟用記錄設定的情況下，系統支援這個選項。如要更新聊天室記錄狀態，必須省略要求中的所有其他欄位遮罩。管理員存取權不支援「space_history_state」。 access_settings.audience：更新存取權設定，指定哪些人可以探索聊天室、加入聊天室，以及預覽已命名聊天室中的訊息 (spaceType 欄位為 SPACE)。如果現有的聊天室已有目標對象，您可以略過這個欄位遮罩的值，移除目標對象並限制空間存取權。如要更新聊天室的存取權設定，驗證的使用者必須是聊天室管理員，且會在要求中略過所有其他欄位遮罩。如果聊天室處於匯入模式，就無法更新這個欄位。詳情請參閱「將聊天室設為開放特定使用者搜尋」。管理員存取權不支援「access_settings.audience」。 開發人員預覽：支援變更聊天室的權限設定，支援的欄位路徑包括：permission_settings.manage_members_and_groups、permission_settings.modify_space_details、permission_settings.toggle_history、permission_settings.use_at_mention_all、permission_settings.manage_apps、permission_settings.manage_webhooks、permission_settings.reply_messages (警告：與所有其他非權限設定欄位路徑互斥)。管理員存取權不支援「permission_settings」。
use_admin_access	bool 開發人員預覽版：這是 Google Workspace 開發人員預覽版計畫的一環，這項計畫可讓使用者搶先體驗特定功能。 在 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} 與使用者 ID 相同： People API 中 Person 的 id。舉例來說，Chat API 中的 users/123456789 代表 People API 中的 123456789 使用者個人資料 ID。 Admin SDK Directory API 中使用者的 id。 使用者的電子郵件地址可做為 API 要求中 {user} 的別名。舉例來說，如果 [e-mail] 的 People API 個人資料 ID 是 123456789，您就可以使用 users/[e-mail] 做為參照 users/123456789 的別名。API 只會傳回標準資源名稱 (例如 users/123456789)。
display_name	string 僅供輸出。使用者的顯示名稱。
domain_id	string 使用者 Google Workspace 網域的專屬 ID。
type	Type 使用者類型。
is_anonymous	bool 僅供輸出。設為 true 後，系統會刪除使用者或無法查看其個人資料。

類型

列舉
TYPE_UNSPECIFIED	列舉的預設值。請勿使用。
HUMAN	人類使用者。
BOT	Chat 應用程式使用者。

UserMentionMetadata

使用者提及內容的註解中繼資料 (@)。

欄位
user	User 使用者提及。
type	Type 使用者提及的內容類型。

類型

列舉
TYPE_UNSPECIFIED	列舉的預設值。請勿使用。
ADD	將使用者新增至聊天室。
MENTION	在聊天室中提及使用者。

WidgetMarkup

小工具是一種可顯示文字和圖片的 UI 元素。

欄位
buttons[]	Button 按鈕清單。按鈕也是 oneof data，因此只能設定其中一個欄位。
聯集欄位 data。WidgetMarkup 只能包含下列其中一個項目。您可以使用多個 WidgetMarkup 欄位顯示更多項目。data 只能採用下列其中一種設定：
text_paragraph	TextParagraph 在這項小工具中顯示文字段落。
image	Image 在這個小工具中顯示圖片。
key_value	KeyValue 在這個小工具中顯示鍵/值項目。

按鈕

按鈕。可以是文字按鈕或圖片按鈕。

欄位
聯集欄位 type。 type 只能採用下列其中一種設定：
text_button	TextButton 包含文字和onclick動作的按鈕。
image_button	ImageButton 含有圖片和onclick動作的按鈕。

FormAction

表單動作是指提交表單時的行為。舉例來說，您可以叫用 Apps Script 來處理表單。

欄位
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 指定的圖示，會指向 Chat API 提供的圖示。
icon_url	string 網址指定的圖示。

KeyValue

UI 元素包含鍵 (標籤) 和值 (內容)。這個元素也可以包含某些動作，例如 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 動作會觸發表單動作。
open_link	OpenLink 如有指定，這項onclick動作會觸發公開連結動作。

OpenLink

點選這個連結即可開啟新視窗。

欄位
url	string 要開啟的網址。

TextButton

包含文字和onclick動作的按鈕。

欄位
text	string 按鈕文字。
on_click	OnClick 按鈕的 onclick 動作。

TextParagraph

一段文字。支援格式化文字。如要進一步瞭解如何設定文字格式，請參閱「設定 Google Chat 應用程式中的文字格式」和「在 Google Workspace 外掛程式中設定文字格式」。

欄位
text	string