Package google.chat.v1

索引

ChatService

可讓開發人員在 Google Chat 平台上建構 Chat 應用程式和整合功能。

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

完成指定聊天室的匯入程序，並向使用者顯示。

必須開啟應用程式驗證和全網域委派功能。詳情請參閱「授權 Google Chat 應用程式匯入資料」。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。
CreateCustomEmoji

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

建立自訂表情符號。

需要使用者驗證。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。
CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

為通話對象、即時通訊應用程式、使用者或 Google 群組建立成員資格。系統不支援為其他 Chat 擴充應用程式建立成員資格。建立會員資格時，如果指定成員已停用自動接受政策，則他們會收到邀請，必須接受空間邀請才能加入。否則，當您建立成員資格時，系統會將成員直接新增至指定聊天室。

支援以下類型的驗證：

如需使用範例，請參閱：

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。
CreateMessage

rpc CreateMessage(CreateMessageRequest) returns (Message)

在 Google Chat 聊天室中建立訊息。如需範例，請參閱「傳送訊息」。

create() 方法需要使用者驗證或應用程式驗證。Chat 會根據您在要求中使用的驗證類型，決定訊息傳送者的方式。

下圖顯示您使用應用程式驗證功能時，Chat 如何歸因訊息。Chat 會將 Chat 應用程式顯示為訊息傳送者。訊息內容可包含文字 (text)、資訊卡 (cardsV2) 和配件小工具 (accessoryWidgets)。

訊息以應用程式驗證方式傳送

下圖顯示使用者驗證功能時，Chat 如何歸屬訊息。Chat 會將使用者顯示為訊息傳送者，並顯示 Chat 應用程式的名稱，以便將訊息歸屬給該應用程式。訊息內容只能包含文字 (text)。

使用者驗證後傳送的郵件

郵件大小 (包括郵件內容) 的上限為 32,000 個位元組。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。
CreateReaction

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

建立回應並將回應新增至訊息。僅支援萬國碼表情符號。如需範例，請參閱「對郵件新增回應」。

需要使用者驗證。

授權範圍

需要下列其中一種 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 機構中的某個聊天室可能已使用這個顯示名稱。

如果您是開發人員預覽版計畫的成員，可以使用 spaceType.GROUP_CHAT 在匯入模式中建立群組通訊。

支援下列類型的驗證：

以應用程式進行驗證時，必須在要求中設定 space.customer 欄位。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。
DeleteCustomEmoji

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty)

刪除自訂表情符號。

需要使用者驗證。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。
DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

刪除會員資格。如需範例，請參閱「從聊天室中移除使用者或 Google Chat 應用程式」。

支援下列類型的驗證：

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。
DeleteMessage

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

刪除訊息。如需範例，請參閱「刪除訊息」。

支援下列類型的驗證：

使用應用程式驗證時，要求只能刪除由呼叫的 Chat 應用程式建立的訊息。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。
DeleteReaction

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

刪除訊息的回應。僅支援萬國碼表情符號。如需範例，請參閱「刪除回應」。

需要使用者驗證。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。
DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

刪除已命名的聊天室。一律執行串聯刪除，亦即聊天室子項資源 (例如在聊天室中張貼的訊息和成員資格) 也會一併刪除。如需範例，請參閱「刪除聊天室」。

支援下列類型的驗證：

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。
FindDirectMessage

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

傳回含有指定使用者的現有即時訊息。如果找不到即時訊息聊天室，則傳回 404 NOT_FOUND 錯誤。如需範例，請參閱「尋找即時訊息」。

使用應用程式驗證時，會傳回指定使用者和發出呼叫 Chat 應用程式之間的即時訊息空間。

使用使用者驗證時，會傳回指定使用者和已驗證使用者之間的即時訊息空間。

// 支援下列類型的驗證：

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。
GetAttachment

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

取得郵件附件的中繼資料。系統會使用 media API 擷取附件資料。如需範例，請參閱「取得郵件附件的中繼資料」一文。必須啟用應用程式驗證。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。
GetCustomEmoji

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

傳回自訂表情符號的詳細資料。

需要使用者驗證。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。
GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership)

傳回會員資格詳情。舉例來說，請參閱「取得使用者或 Google Chat 應用程式會員資格的詳細資料」。

支援以下類型的驗證：

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。
GetMessage

rpc GetMessage(GetMessageRequest) returns (Message)

傳回郵件的詳細資料。如需範例，請參閱「取得訊息的詳細資料」。

支援下列類型的驗證：

注意：可能會傳回來自已封鎖成員或聊天室的訊息。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。
GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space)

傳回聊天室的詳細資料。如需範例，請參閱「取得聊天室的詳細資料」。

支援下列類型的驗證：

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。
GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

傳回 Google Chat 聊天室中的事件。事件酬載包含已變更資源的最新版本。舉例來說，如果您要求有關新訊息的事件，但該訊息稍後已更新，伺服器會在事件酬載中傳回更新的 Message 資源。

注意：針對這項要求，聊天室事件資料的 Space 物件不會傳回 permissionSettings 欄位。

需要使用者驗證。如要取得事件，經過驗證的使用者必須是聊天室的成員。

如需範例，請參閱「取得 Google Chat 聊天室中的活動詳細資料」。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。
GetSpaceReadState

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

傳回使用者在聊天室中的已讀狀態詳細資料，用於識別已讀和未讀訊息。如需範例，請參閱「取得使用者空間讀取狀態的詳細資料」。

需要使用者驗證。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。
GetThreadReadState

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

傳回使用者在執行緒中讀取狀態的詳細資料，用於識別已讀和未讀郵件。如需範例，請參閱「取得使用者的執行緒讀取狀態詳細資料」。

需要使用者驗證。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。
ListCustomEmojis

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse)

列出通過驗證的使用者會看到的自訂表情符號。

需要使用者驗證。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。
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)

列出呼叫端使用者所屬聊天室中的訊息，包括來自封鎖成員和聊天室的訊息。如果您列出沒有任何訊息的聊天室中的訊息，回應會是空白物件。使用 REST/HTTP 介面時，回應會包含空白的 JSON 物件 {}。如需範例，請參閱「列出訊息」一節。

需要使用者驗證。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。
ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

列出訊息的回應。如需範例，請參閱「列出訊息的回應」。

需要使用者驗證。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。
ListSpaceEvents

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

列出 Google Chat 聊天室中的事件。每個事件的酬載都包含最新版本的 Chat 資源。舉例來說，如果您列出新聊天室成員的事件，伺服器會傳回包含最新會員詳細資料的 Membership 資源。如果在要求期間移除了新會員，事件酬載就會包含空白的 Membership 資源。

需要使用者驗證。如要列出活動，已驗證的使用者必須是聊天室的成員。

如需範例，請參閱「列出 Google Chat 聊天室中的事件」。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。
ListSpaces

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse)

列出呼叫端所屬的聊天室。系統要等到第一則訊息傳送後，才會列出群組通訊和即時訊息。如需範例，請參閱「列出聊天室」。

支援下列類型的驗證：

如要列出 Google Workspace 機構的所有已命名聊天室，請改用 Workspace 管理員權限的 spaces.search() 方法。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。
SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

根據管理員的搜尋內容，傳回 Google Workspace 機構中的聊天室清單。

需要透過管理員權限進行使用者驗證。在要求中，將 use_admin_access 設為 true。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。
SetUpSpace

rpc SetUpSpace(SetUpSpaceRequest) returns (Space)

建立聊天室並將指定的使用者新增至聊天室。通話使用者會自動加入聊天室，且不應在要求中指定為成員資格。如需範例，請參閱「設定聊天室並邀請初始成員」。

如要指定要新增的人類成員，請使用適當的 membership.member.name 新增會員資格。如要新增真人使用者，請使用 users/{user}，其中 {user} 可以是使用者的電子郵件地址。對於同一個 Workspace 機構 ({user}) 中的使用者，您也可以為 People API 中的使用者設定 id，或是在 Directory API 中為使用者設定 id。舉例來說，如果 user@example.com 的 People API 個人資料 ID 為 123456789，您可以將 membership.member.name 設為 users/user@example.com 或 users/123456789，將使用者新增至聊天室。

如要指定要新增的 Google 群組，請使用適當的 membership.group_member.name 新增會員資格。如要新增或邀請 Google 群組，請使用 groups/{group}，其中 {group} 是 Cloud Identity Groups API 中群組的 id。舉例來說，您可以使用 Cloud Identity Groups Lookup API 擷取群組電子郵件 group@example.com 的 ID 123456789，然後將 membership.group_member.name 設為 groups/123456789，將群組加入空間。系統不支援群組電子郵件，而且您只能在已命名的聊天室中將 Google 群組新增為成員。

如果已命名的聊天室或群組通訊，如果來電者封鎖對象、遭到部分成員封鎖，或是沒有新增成員的權限，這些成員就不會加入建立的聊天室。

如要建立呼叫使用者與其他使用者之間的即時訊息 (DM)，請指定一個代表使用者的會員資格。如果使用者互相封鎖，要求就會失敗，系統也不會建立訊息。

如要在發出呼叫的使用者和呼叫應用程式之間建立即時訊息，請將 Space.singleUserBotDm 設為 true，且不要指定任何成員資格。您只能使用這個方法，透過通話應用程式設定即時訊息。如要將通話應用程式新增為聊天室的成員，或新增兩位使用者之間的即時訊息，請參閱「邀請使用者或應用程式加入聊天室」。

如果兩位使用者之間已存在私訊，即使其中一人於要求時封鎖對方，系統仍會傳回現有的私訊。

不支援含有分支回覆的聊天室。如果在設定聊天室時收到「ALREADY_EXISTS」錯誤訊息，請嘗試使用其他displayName。Google Workspace 機構中的現有聊天室可能已使用這個顯示名稱。

需要使用者驗證。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。
UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

更新會員資格。如需範例，請參閱「更新使用者在聊天室中的成員資格」。

支援下列類型的驗證：

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。
UpdateMessage

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

更新訊息。patch 和 update 方法有所不同。patch 方法會使用 patch 要求，而 update 方法會使用 put 要求。建議您使用 patch 方法。如需範例，請參閱「更新訊息」。

支援下列類型的驗證：

使用應用程式驗證功能時，要求只能更新呼叫 Chat 應用程式建立的訊息。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。
UpdateSpace

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

更新聊天室。如需範例，請參閱「更新聊天室」。

如果您更新 displayName 欄位時收到 ALREADY_EXISTS 錯誤訊息，請嘗試使用其他顯示名稱。Google Workspace 機構中的現有聊天室可能已使用這個顯示名稱。

支援下列類型的驗證：

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。
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

SelectionItem 物件的陣列。

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

斜線指令的中繼資料。

AnnotationType

註解類型。

列舉
ANNOTATION_TYPE_UNSPECIFIED 列舉的預設值。請勿使用。
USER_MENTION 已提及使用者。
SLASH_COMMAND 叫用斜線指令。

AttachedGif

使用網址指定的 GIF 圖片。

欄位
uri

string

僅供輸出。GIF 圖片的代管網址。

附件

Google Chat 中的附件。

欄位
name

string

附件的資源名稱，格式為 spaces/{space}/messages/{message}/attachments/{attachment}。
content_name

string

僅供輸出。內容的原始檔案名稱，而非完整路徑。
content_type

string

僅供輸出。檔案的內容類型 (MIME 類型)。
thumbnail_uri

string

僅供輸出。應用於向使用者預覽附件的縮圖網址。即時通訊應用程式不應使用這個網址下載附件內容。
download_uri

string

僅供輸出。下載網址，應用於讓使用者下載附件。即時通訊應用程式不應使用這個網址下載附件內容。
source

Source

僅供輸出。附件的來源。
聯集欄位 data_ref。附件的資料參照。data_ref 只能是下列其中一項：
attachment_data_ref

AttachmentDataRef

附件資料的參照。這個欄位可搭配媒體 API 使用，用於下載附件資料。
drive_data_ref

DriveDataRef

僅供輸出。Google 雲端硬碟附件的參照。這個欄位可搭配 Google 雲端硬碟 API 使用。

來源

附件的來源。

列舉
SOURCE_UNSPECIFIED 預留。
DRIVE_FILE 檔案是 Google 雲端硬碟檔案。
UPLOADED_CONTENT 檔案會上傳至 Chat。

AttachmentDataRef

附件資料的參照。

欄位
resource_name

string

附件資料的資源名稱。這個欄位可搭配媒體 API 使用，用於下載附件資料。
attachment_upload_token

string

含有上傳附件參照的不透明權杖。由用戶端以不透明字串的形式處理，用來建立或更新含有附件的 Chat 訊息。

CardWithId

Google Chat 訊息中的資訊卡。

只有 Chat 應用程式可以建立資訊卡。如果即時通訊應用程式以使用者身分進行驗證，訊息就無法包含資訊卡。

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

開啟資訊卡建立工具

欄位
card_id

string

如果訊息含有多張卡片，則為必要欄位。訊息中卡片的專屬 ID。
card

Card

資訊卡。大小上限為 32 KB。

ChatSpaceLinkData

Chat 聊天室連結的資料。

欄位
space

string

已連結的 Chat 聊天室資源的聊天室。

格式：spaces/{space}
thread

string

已連結 Chat 聊天室資源的討論串。

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

string

已連結 Chat 聊天室資源的訊息。

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

CompleteImportSpaceRequest

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

欄位
name

string

必要欄位。匯入模式空間的資源名稱。

格式：spaces/{space}

CompleteImportSpaceResponse

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

欄位
space

Space

匯入模式聊天室。

ContextualAddOnMarkup

這個類型沒有任何欄位。

可讓開發人員指定內容相關 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

一個區段至少必須包含一個小工具。

CreateCustomEmojiRequest

建立自訂表情符號的要求。

欄位
custom_emoji

CustomEmoji

必要欄位。要建立的自訂表情符號。

CreateMembershipRequest

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

欄位
parent

string

必要欄位。要建立成員資格的聊天室資源名稱。

格式：spaces/{space}
membership

Membership

必要欄位。要建立的成員關係。

memberType 欄位必須包含使用者，且已填入 user.name 和 user.type 欄位。伺服器會指派資源名稱，並覆寫所有指定的名稱。

當 Chat 應用程式為真人使用者建立會員關係時，必須使用特定授權範圍，並為特定欄位設定特定值：

  • 以使用者的身分進行驗證時，必須提供 chat.memberships 授權範圍。

  • 以應用程式身分進行驗證時，必須使用 chat.app.memberships 授權範圍。以應用程式身分進行驗證的功能適用於

  • 將 user.type 設為 HUMAN，並將 user.name 設為格式 users/{user}，其中 {user} 可以是使用者的電子郵件地址。如果是同一個 Workspace 機構的使用者，{user} 也可以是 People API person 的 id，或是 Directory API 中使用者的 id。舉例來說，如果 user@example.com 的 People API 個人資料 ID 為 123456789，您可以將 membership.member.name 設為 users/user@example.com 或 users/123456789，將使用者新增至聊天室。

當 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 擴充應用程式不必儲存系統指派的 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 機構中的現有聊天室可能已使用這個顯示名稱。

如果您是開發人員預覽版計畫的成員，只要將 importMode 設為 true，即可使用 SpaceType.GROUP_CHAT。

系統已在伺服器上指派空格「name」，因此系統會忽略這個欄位中指定的所有值。
request_id

string

選用設定。這項要求的專屬 ID。建議隨機產生 UUID。指定現有要求 ID 時，系統會傳回使用該 ID 建立的聊天室，而不是建立新的聊天室。使用不同的已驗證使用者，指定相同 Chat 應用程式中的現有要求 ID 會傳回錯誤。

CustomEmoji

代表自訂表情符號。

欄位
name

string

ID。伺服器指派的自訂表情符號資源名稱。

格式：customEmojis/{customEmoji}
uid

string

僅供輸出。自訂表情符號資源的專屬鍵。
emoji_name

string

不可變動。使用者提供的自訂表情符號名稱 (機構內未重複)。

建立自訂表情符號時需要，否則只輸出。

表情符號名稱開頭和結尾必須為冒號，且只能使用小寫英數字元、連字號和底線。連字號和底線不能用來分隔字詞，且不能連續使用。

示例：:valid-emoji-name:
temporary_image_uri

string

僅供輸出。自訂表情符號的圖片網址，有效期間至少為 10 分鐘。請注意，建立自訂表情符號後，回應中不會填入此項目。
payload

CustomEmojiPayload

僅限輸入。酬載資料。

CustomEmojiPayload

自訂表情符號的酬載資料。

欄位
file_content

bytes

必要欄位。僅限輸入。用於自訂表情符號的圖片。

酬載大小必須小於 256 KB，且圖片尺寸必須介於 64 和 500 像素之間。限制條件可能會有所變動。
filename

string

必要欄位。僅限輸入。圖片檔案名稱。

支援的檔案副檔名：.png、.jpg、.gif。

DeleteCustomEmojiRequest

要求刪除自訂表情符號。

欄位
name

string

必要欄位。要刪除的自訂表情符號資源名稱。

格式：customEmojis/{customEmoji}

您可以使用表情符號名稱做為 {customEmoji} 的別名。例如，customEmojis/:example-emoji:，其中 :example-emoji: 是自訂表情符號的表情符號名稱。

DeleteMembershipRequest

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

欄位
name

string

必要欄位。要刪除的成員資源名稱。Chat 擴充應用程式可以刪除真人使用者或其會員資格即時通訊應用程式無法刪除其他應用程式的會員資格。

刪除使用者會員資格時，需要 chat.memberships 範圍和 spaces/{space}/members/{member} 格式。您可以使用這個電子郵件地址做為 {member} 的別名。舉例來說，spaces/{space}/members/example@gmail.com，其中 example@gmail.com 是 Google Chat 使用者的電子郵件。

刪除應用程式會員資格時，需要 chat.memberships.app 範圍和 spaces/{space}/members/app 格式。

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

bool

當 true 時，方法會使用使用者的 Google Workspace 管理員權限執行。

撥打電話的使用者必須是具備「管理即時通訊和聊天室對話」權限的 Google Workspace 管理員。

需要 chat.admin.memberships OAuth 2.0 範圍。

管理員存取權不支援刪除聊天室中的應用程式會員資格。

DeleteMessageRequest

要求刪除訊息。

欄位
name

string

必要欄位。訊息的資源名稱。

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

如果您已為訊息設定自訂 ID，就可以使用「{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

當 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/example@gmail.com，其中 example@gmail.com 是 Google Chat 使用者的電子郵件地址。

GetAttachmentRequest

要求取得附件。

欄位
name

string

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

GetCustomEmojiRequest

傳回單一自訂表情符號的要求。

欄位
name

string

必要欄位。自訂表情符號的資源名稱。

格式：customEmojis/{customEmoji}

您可以使用表情符號名稱做為 {customEmoji} 的別名。例如 customEmojis/:example-emoji:，其中 :example-emoji: 是自訂表情符號的表情符號名稱。

GetMembershipRequest

要求加入聊天室。

欄位
name

string

必要欄位。要擷取的會員資源名稱。

如要利用使用者驗證機制取得應用程式本身的成員資格，您可以選擇使用 spaces/{space}/members/app。

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

您可以使用使用者的電子郵件地址做為 {member} 的別名。舉例來說，spaces/{space}/members/example@gmail.com，其中 example@gmail.com 是 Google Chat 使用者的電子郵件。
use_admin_access

bool

當 true 時，方法會使用使用者的 Google Workspace 管理員權限執行。

通話使用者必須是具備管理即時通訊和聊天室對話權限的 Google Workspace 管理員。

需要 chat.admin.memberships 或 chat.admin.memberships.readonly OAuth 2.0 範圍。

使用管理員存取權時，無法在聊天室中取得應用程式成員資格。

GetMessageRequest

要求取得訊息。

欄位
name

string

必要欄位。訊息的資源名稱。

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

如果您已為訊息設定自訂 ID，可以將 clientAssignedMessageId 欄位的值用於 {message}。詳情請參閱「命名訊息」。

GetSpaceEventRequest

用於取得聊天室事件的請求訊息。

欄位
name

string

必要欄位。聊天室活動的資源名稱。

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

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 開啟記錄功能。機構的保管箱資料保留規則指定郵件和討論串的保留時間長度。

ListCustomEmojisRequest

傳回自訂表情符號清單的要求。

欄位
page_size

int32

選用設定。傳回的自訂表情符號數量上限。服務傳回的自訂表情符號可以少於這個值。如未指定，則預設值為 25。許可的最大值為 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

必要欄位。要擷取成員名單的聊天室資源名稱。

格式：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

在 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 運算子。

如要依據執行緒篩選，請指定 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。
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

從先前 list space events 呼叫收到的頁面權杖。提供此項目即可擷取後續網頁。

進行分頁時，提供至清單空間事件的所有其他參數，都必須與提供網頁權杖的呼叫相符。將不同值傳遞至其他參數可能會導致意外結果。
filter

string

必要欄位。查詢篩選器。

您必須使用 has : 運算子，指定至少一個事件類型 (event_type)。如要依據多個事件類型進行篩選，請使用 OR 運算子。在篩選器中省略批次事件類型。要求會自動傳回任何相關的批次事件。舉例來說，如果你依新的回應 (google.workspace.chat.reaction.v1.created) 進行篩選，伺服器也會傳回批次新的回應事件 (google.workspace.chat.reaction.v1.batchCreated)。如需支援的事件類型清單，請參閱 SpaceEvents 參考說明文件。

您也可以選擇依開始時間 (start_time) 和結束時間 (end_time) 進行篩選：

  • start_time：用於開始列出聊天室事件的專屬時間戳記。您最多可以列出 28 天前發生的事件。如果未指定，則會列出過去 28 天內的空間事件。
  • end_time：包含完整時間戳記，直到列出該聊天室事件為止。如果未指定，則會列出要求發生前的事件。

如要指定開始或結束時間，請在 RFC-3339 中使用等於 = 運算子和格式。如要同時依 start_time 和 end_time 篩選，請使用 AND 運算子。

舉例來說，下列查詢有效：

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

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

以下查詢無效：

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

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

伺服器會拒絕無效的查詢，並傳回 INVALID_ARGUMENT 錯誤。

ListSpaceEventsResponse

列出聊天室事件的回應訊息。

欄位
space_events[]

SpaceEvent

結果會依時間順序傳回 (最舊的事件會排在最前面)。注意：清單要求不會在 Space 物件中傳回 permissionSettings 欄位。
next_page_token

string

用於擷取更多事件的接續權杖。如果省略這個欄位，就不會有後續頁面。

ListSpacesRequest

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

欄位
page_size

int32

選用設定。要傳回的空格數量上限。服務傳回的產品數量可能會少於這個值。

如未指定，最多會傳回 100 個空格。

值的數量上限是 1000。如果您使用的值超過 1000，系統會自動將其變更為 1000。

負值會傳回 INVALID_ARGUMENT 錯誤。
page_token

string

選用設定。從先前的 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

要求 (或第一個) 頁面中的聊天室清單。注意：清單要求不會在 Space 物件中傳回 permissionSettings 欄位。
next_page_token

string

您可以傳送權杖為 pageToken，擷取下一頁的結果。如果空白，表示沒有後續網頁。

MatchedUrl

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

欄位
url

string

僅供輸出。比對成功的網址。

成員資格

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

欄位
name

string

由伺服器指派的會員資源名稱。

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

MembershipState

僅供輸出。會員資格狀態。
role

MembershipRole

選用設定。使用者在 Chat 聊天室中的角色，會決定他們能在聊天室中執行的動作。

這個欄位只能在 UpdateMembership 中做為輸入值。
create_time

Timestamp

選用設定。不可變動。成員資格的建立時間，例如成員加入或受邀加入聊天室的時間。系統只會輸出此欄位，但用於在匯入模式聊天室中匯入過往成員資料時除外。
delete_time

Timestamp

選用設定。不可變動。刪除會員資格的時間，例如成員離開或從聊天室中移除的時間。系統只會輸出此欄位，但用於在匯入模式聊天室中匯入過往成員資料時除外。
聯集欄位 memberType。與此會員資格相關聯的成員。日後可能會支援其他會員類型。memberType 只能是下列其中一項：
member

User

會員所對應的 Google Chat 使用者或應用程式。如果 Chat 擴充應用程式以使用者的身分進行驗證，輸出內容會填入「使用者」name 和 type。
group_member

Group

與成員資格對應的 Google 群組。

如要讀取或變更 Google 群組的成員資格，您必須驗證使用者身分。

MembershipRole

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

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

MembershipState

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

列舉
MEMBERSHIP_STATE_UNSPECIFIED 預設值。請勿使用。
JOINED 使用者會加入聊天室，並可參與聊天室。
INVITED 使用者已獲邀加入聊天室，但尚未加入。
NOT_A_MEMBER 使用者不是聊天室成員，也沒有加入聊天室的待處理邀請。

MembershipBatchCreatedEventData

多個新會籍的事件酬載。

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

欄位
memberships[]

MembershipCreatedEventData

新會員清單。

MembershipBatchDeletedEventData

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

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

欄位
memberships[]

MembershipDeletedEventData

已刪除的成員清單。

MembershipBatchUpdatedEventData

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

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

欄位
memberships[]

MembershipUpdatedEventData

更新會員的清單。

MembershipCreatedEventData

新成員的事件酬載。

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

欄位
membership

Membership

新會員方案。

MembershipDeletedEventData

已刪除成員的事件酬載。

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

欄位
membership

Membership

已刪除的會籍。只有 name 和 state 欄位會填入資料。

MembershipUpdatedEventData

更新會員資格的事件酬載。

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

欄位
membership

Membership

更新後的成員資格。

訊息

Google Chat 聊天室中的訊息。

欄位
name

string

訊息的資源名稱。

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

其中 {space} 是張貼訊息的聊天室 ID，{message} 則是系統指派給訊息的 ID。例如：spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB。

如果您在建立訊息時設定自訂 ID，您可以使用這個 ID 在要求中指定訊息，方法是將 {message} 替換為 clientAssignedMessageId 欄位的值。例如 spaces/AAAAAAAAAAA/messages/client-custom-name。詳情請參閱「為訊息命名」。
sender

User

僅供輸出。建立訊息的使用者。如果 Chat 擴充應用程式以使用者的身分進行驗證，輸出內容會填入「使用者」name 和 type。
create_time

Timestamp

選用設定。不可變動。在 Chat 中建立的聊天室，也就是建立訊息的時間。這個欄位僅供輸出 (用於匯入模式空格時除外)。

如果是匯入模式聊天室，請將這個欄位設為在來源中建立訊息的過往時間戳記，以便保留原始的建立時間。
last_update_time

Timestamp

僅供輸出。使用者上次編輯訊息的時間。如果訊息從未編輯過，這個欄位就會空白。
delete_time

Timestamp

僅供輸出。訊息在 Google Chat 中遭到刪除的時間。如果訊息從未刪除，這個欄位會留空。
text

string

郵件的純文字內文。第一個連至圖片、影片或網頁的連結會產生預覽方塊。你也可以@提及 Google Chat 使用者，或是提及聊天室中的所有人。

如要瞭解如何建立簡訊，請參閱傳送訊息。
formatted_text

string

僅供輸出。包含訊息 text 並加上標記，用於傳達格式。這個欄位可能不會擷取 UI 中顯示的所有格式，但包含下列內容：

  • 標記語法適用於粗體、斜體、刪除線、等寬字元、等寬區塊和項目符號清單。

  • 使用者提及：使用格式 <users/{user}>。

  • 使用 <{url}|{rendered_text}> 格式的自訂超連結，其中第一個字串是網址，第二個字串則是實際顯示的文字，例如 <http://example.com|custom text>。

  • 使用 :{emoji_name}: 格式的自訂表情符號，例如 :smile:。這項功能不適用於萬國碼表情符號，例如 U+1F600 代表笑臉表情符號。

詳情請參閱查看郵件中傳送的文字格式。
cards[]
(deprecated)

Card

已淘汰：請改用 cards_v2。

豐富的格式與互動式資訊卡，可用於顯示 UI 元素，例如格式化的文字、按鈕和可點擊的圖片。資訊卡通常會顯示在郵件純文字內文下方。cards 和 cards_v2 的大小上限為 32 KB。
cards_v2[]

CardWithId

cards 陣列。

只有 Chat 應用程式可以建立資訊卡。如果即時通訊應用程式以使用者身分進行驗證，訊息就無法包含資訊卡。

如要瞭解如何建立含有資訊卡的訊息，請參閱傳送訊息。

使用資訊卡建構工具設計及預覽資訊卡。

開啟資訊卡建立工具
annotations[]

Annotation

僅供輸出。與這則訊息中 text 相關的註解。
thread

Thread

訊息所屬的討論串。如需使用範例，請參閱「發起或回覆訊息討論串」。
space

Space

如果 Chat 應用程式以使用者身分進行驗證，輸出內容就會填入 space name。
fallback_text

string

訊息資訊卡的純文字說明，用於實際資訊卡無法顯示時 (例如行動通知)。
action_response

ActionResponse

僅限輸入。Chat 應用程式可用來設定回應發布方式的參數。
argument_text

string

僅供輸出。所有提及 Chat 應用程式的訊息都會移除訊息的純文字內文。
slash_command

SlashCommand

僅供輸出。斜線指令資訊 (如適用)。
attachment[]

Attachment

使用者上傳的附件。
matched_url

MatchedUrl

僅供輸出。spaces.messages.text 中的網址，符合連結預覽模式。詳情請參閱「預覽連結」。
thread_reply

bool

僅供輸出。如果是 true，則表示該訊息是回覆串中的回覆。設為 false 時，訊息會在聊天室頂層對話中顯示為討論串的第一則訊息，或是沒有討論串回覆的訊息。

如果聊天室不支援在討論串中回覆，這個欄位一律會顯示 false。
client_assigned_message_id

string

選用設定。訊息的自訂 ID。您可以使用欄位辨識訊息，也可以取得、刪除或更新訊息。如要設定自訂 ID，請在建立訊息時指定 messageId 欄位。詳情請參閱「命名訊息」。
emoji_reaction_summaries[]

EmojiReactionSummary

僅供輸出。訊息中的表情符號回應摘要清單。
private_message_viewer

User

不可變動。建立訊息的輸入內容，否則只會輸出。可查看訊息的使用者。設定後，訊息就會處於私人狀態，只有指定使用者和 Chat 應用程式看得到。如要在要求中加入這個欄位，請務必使用應用程式驗證呼叫 Chat API，並省略以下內容：

詳情請參閱以私人方式傳送訊息。
deletion_metadata

DeletionMetadata

僅供輸出。已刪除訊息的相關資訊。設定 delete_time 時，系統會刪除訊息。
quoted_message_metadata

QuotedMessageMetadata

僅供輸出。Google Chat 使用者在聊天室中引用的訊息相關資訊。Google Chat 使用者可以引用訊息來回覆。
attached_gifs[]

AttachedGif

僅供輸出。郵件中附加的 GIF 圖片。
accessory_widgets[]

AccessoryWidget

一或多個會顯示在訊息底部的互動式小工具。您可以將配件小工具新增至含有文字、卡片或兩者皆有的訊息中。不支援包含對話方塊的訊息。詳情請參閱「在訊息底部新增互動式小工具」。

如要建立含有配件小工具的訊息，您必須進行應用程式驗證。

MessageBatchCreatedEventData

多則新訊息的事件酬載。

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

欄位
messages[]

MessageCreatedEventData

新訊息清單。

MessageBatchDeletedEventData

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

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

欄位
messages[]

MessageDeletedEventData

已刪除的訊息清單。

MessageBatchUpdatedEventData

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

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

欄位
messages[]

MessageUpdatedEventData

已更新的訊息清單。

MessageCreatedEventData

新訊息的事件酬載。

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

欄位
message

Message

新訊息。

MessageDeletedEventData

已刪除訊息的事件酬載。

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

欄位
message

Message

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

MessageUpdatedEventData

更新訊息的事件酬載。

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

欄位
message

Message

更新後的訊息。

QuotedMessageMetadata

引述訊息的相關資訊。

欄位
name

string

僅供輸出。引述訊息的資源名稱。

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

Timestamp

僅供輸出。引述訊息的建立時間戳記或上次更新時間戳記。

反應影片

對訊息的回應。

欄位
name

string

反應的資源名稱。

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

User

僅供輸出。建立回應的使用者。
emoji

Emoji

回應中使用的表情符號。

ReactionBatchCreatedEventData

多個新回應的事件酬載。

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

欄位
reactions[]

ReactionCreatedEventData

新回應清單。

ReactionBatchDeletedEventData

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

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

欄位
reactions[]

ReactionDeletedEventData

已刪除回應的清單。

ReactionCreatedEventData

新回應的事件酬載。

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

欄位
reaction

Reaction

新的回應。

ReactionDeletedEventData

已刪除的回應事件酬載。

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

欄位
reaction

Reaction

已刪除回應。

RichLinkMetadata

豐富的資源連結。

欄位
uri

string

這個連結的 URI。
聯集欄位 data。已連結資源的資料。data 只能是下列其中一項：

RichLinkType

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

列舉
DRIVE_FILE Google 雲端硬碟的互動連結類型。
CHAT_SPACE Chat 聊天室的富連結類型。例如聊天室智慧型方塊。

SearchSpacesRequest

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

欄位
use_admin_access

bool

當 true 時，方法會使用使用者的 Google Workspace 管理員權限執行。

撥打電話的使用者必須是具備「管理即時通訊和聊天室對話」權限的 Google Workspace 管理員。

需要 chat.admin.spaces.readonly 或 chat.admin.spaces OAuth 2.0 範圍。

這個方法目前僅支援管理員存取權，因此這個欄位只接受 true。
page_size

int32

要傳回的空格數量上限。服務傳回的產品數量可能會少於這個值。

如未指定，最多會傳回 100 個空間。

值的數量上限是 1000。如果使用的值超過 1000，系統會自動將值變更為 1000。
page_token

string

從前一個搜尋聊天室呼叫接收的權杖。提供這個參數即可擷取後續網頁。

進行分頁時，提供的所有其他參數都應與提供網頁權杖的呼叫相符。將不同的值傳送至其他參數，可能會導致非預期的結果。
query

string

必要欄位。搜尋查詢。

您可以使用下列參數進行搜尋：

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

create_time 和 last_active_time 接受 RFC-3339 格式的時間戳記，支援的比較運算子為 =、<、>、<=、>=。

customer 為必要參數，用於指出要從哪位客戶擷取聊天室。customers/my_customer 是唯一支援的值。

display_name 只接受 HAS (:) 運算子。要比對的文字會先切割成符記，然後每個符記會以不區分大小寫的方式，獨立比對為 display_name 空間中的任一子字串。舉例來說，Fun Eve 符合 Fun event 或 The evening was fun，但不符合 notFun event 或 even。

external_user_allowed 接受 true 或 false。

space_history_state 只接受 space 資源 historyState 欄位中的值。

必須提供 space_type，且唯一有效值為 SPACE。

不同欄位僅支援 AND 運算子。有效的範例為 space_type = "SPACE" AND display_name:"Hello"，無效的範例為 space_type = "SPACE" OR display_name:"Hello"。

在相同欄位中，space_type 不支援 AND 或 OR 運算子。display_name、「space_history_state」和「external_user_allowed」僅支援 OR 運算子。last_active_time 和 create_time 同時支援 AND 和 OR 運算子。AND 只能用來表示時間間隔，例如 last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00"。

以下查詢範例有效：

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

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

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

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

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

string

選用設定。聊天室清單的排序方式。

支援的排序屬性如下：

  • membership_count.joined_direct_human_user_count：表示直接加入聊天室的真人使用者人數。
  • last_active_time：表示最後一個符合資格的項目新增至這個聊天室主題的時間。
  • create_time：表示聊天室建立時間，

有效的排序作業值如下：

  • ASC 表示遞增。預設值。

  • DESC 代表遞減。

支援的語法如下：

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

SearchSpacesResponse

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

欄位
spaces[]

Space

要求的聊天室頁面。
next_page_token

string

可用於擷取後續網頁的符記。如果這個欄位留空，表示沒有後續網頁。
total_size

int32

在所有網頁中，符合查詢的空間總數。如果結果超過 10,000 個空格，這個值就是預估值。

SetUpSpaceRequest

要求建立聊天室，並將指定使用者加進其中。

欄位
space

Space

必要欄位。Space.spaceType 為必填欄位。

如要建立聊天室，請將「Space.spaceType」設為「SPACE」並設定 Space.displayName。如果在設定聊天室時收到 ALREADY_EXISTS 錯誤訊息，請嘗試使用其他 displayName。Google Workspace 機構內的現有聊天室可能已使用這個顯示名稱。

如要建立群組通訊，請將 Space.spaceType 設為 GROUP_CHAT。請勿設定 Space.displayName。

如要在真人之間建立 1:1 對話，請將 Space.spaceType 設為 DIRECT_MESSAGE，並將 Space.singleUserBotDm 設為 false。請勿設定 Space.displayName 或 Space.spaceDetails。

如要建立人與呼叫 Chat 應用程式之間的 1:1 對話，請將 Space.spaceType 設為 DIRECT_MESSAGE，並將 Space.singleUserBotDm 設為 true。請勿設定 Space.displayName 或 Space.spaceDetails。

如果 DIRECT_MESSAGE 聊天室已存在，系統會傳回該聊天室，而不是建立新聊天室。
request_id

string

選用設定。此要求的專屬 ID。建議使用隨機 UUID。指定現有要求 ID 時，系統會傳回使用該 ID 建立的聊天室，而不是建立新的聊天室。在同一個 Chat 應用程式中指定現有要求 ID，且該要求 ID 與不同驗證的使用者相同，系統會傳回錯誤。
memberships[]

Membership

選用設定。邀請加入聊天室的 Google Chat 使用者或群組。省略呼叫的使用者 (由系統自動新增)。

目前此集合允許最多 20 個會員 (除了呼叫端)。

如果是人類成員資格，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 欄位必須包含 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}

其中 {space} 代表系統指派的聊天室 ID。您可以呼叫 spaces.list() 方法，或從聊天室網址取得聊天室 ID。舉例來說，如果聊天室網址為 https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA，則聊天室 ID 就是 AAAAAAAAA。
type
(deprecated)

Type

僅供輸出。已淘汰：請改用 space_type。聊天室類型。
space_type

SpaceType

聊天室類型。建立聊天室或更新聊天室類型時必須提供。僅供其他用途輸出。
single_user_bot_dm

bool

選用設定。聊天室是否為 Chat 應用程式和單一真人之間的即時訊息。
threaded
(deprecated)

bool

僅供輸出。已淘汰：請改用 spaceThreadingState。這個聊天室中的訊息是否為討論串形式。
display_name

string

聊天室的顯示名稱。使用 SPACE 的 spaceType 建立聊天室時，這是必要屬性。如果在建立聊天室或更新displayName時收到 ALREADY_EXISTS 錯誤訊息，請嘗試其他 displayName。Google Workspace 機構內的現有聊天室可能已使用這個顯示名稱。

如果是即時訊息，這個欄位可能會留空。

最多支援 128 個半形字元。
external_user_allowed

bool

不可變動。這個聊天室是否允許任何 Google Chat 使用者加入。在 Google Workspace 機構中建立聊天室時輸入。於下列條件建立空格時，請略過這個欄位：

  • 已驗證的使用者使用的是個人帳戶 (非代管使用者帳戶)。根據預設，個人帳戶建立的聊天室會允許任何 Google Chat 使用者加入。

對於現有的聊天室，這個欄位僅供輸出。
space_threading_state

SpaceThreadingState

僅供輸出。Chat 聊天室的討論串狀態。
space_details

SpaceDetails

聊天室的詳細資料，包括說明和規則。
space_history_state

HistoryState

這個聊天室中訊息和討論串的訊息記錄狀態。
import_mode

bool

選用設定。將資料遷移至 Google Workspace 時，系統是否在「Import Mode」建立這個聊天室。匯入聊天室時，使用者必須等到匯入作業完成，才能看到聊天室。

在 Import Mode 中建立聊天室時，需要使用者驗證。
create_time

Timestamp

選用設定。不可變動。如果是 Chat 中的聊天室，則會顯示聊天室建立的時間。這個欄位只會輸出，除非用於匯入模式聊天室。

如果是匯入模式聊天室，請將這個欄位設為來源中建立聊天室的歷史時間戳記，以便保留原始建立時間。

只有在 spaceType 為 GROUP_CHAT 或 SPACE 時，才會在輸出內容填入。
last_active_time

Timestamp

僅供輸出。聊天室中最後一則訊息的時間戳記。
admin_installed

bool

僅供輸出。針對採用 Chat 應用程式的即時訊息 (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。
customer

string

選用設定。不可變動。聊天室網域的客戶 ID。只有在使用應用程式驗證功能建立聊天室，且 SpaceType 為 SPACE 時，才需要；否則請勿設定。

customers/{customer} 格式，其中 customer 是 [Admin SDK 客戶資源]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) 中的 id。私人應用程式也可以使用 customers/my_customer 別名，在與應用程式相同的 Google Workspace 機構中建立聊天室。

對於即時訊息，這個欄位不會填入資料。

聯集欄位 space_permission_settings。代表聊天室的權限設定。只有在 space_type 為 SPACE 時才會填入。

需要使用者驗證。space_permission_settings 只能是下列其中一項：
predefined_permission_settings

PredefinedPermissionSettings

選用設定。僅限輸入。預先定義的聊天室權限設定，僅限在建立聊天室時輸入。如果未設定這個欄位，系統會建立協作空間。建立聊天室後，系統會在 PermissionSettings 欄位中填入設定。
permission_settings

PermissionSettings

選用設定。現有聊天室的聊天室權限設定。更新確切聊天室權限設定 (取代現有權限設定) 的輸入內容。輸出內容會列出目前的權限設定。

AccessSettings

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

欄位
access_state

AccessState

僅供輸出。指出聊天室的存取權狀態。
audience

string

選用設定。目標對象的資源名稱，這些使用者可以探索聊天室、加入聊天室，以及預覽聊天室中的訊息。如果未設定，只有個別邀請或新增至聊天室的使用者或 Google 網路論壇成員才能存取聊天室。詳情請參閱「允許目標對象搜尋聊天室」。

格式：audiences/{audience}

如要使用 Google Workspace 機構的預設目標對象，請設為 audiences/default。

讀取目標對象可以帶來以下支援：

搭配應用程式驗證使用 chat.bot 範圍時，系統不會填入這個欄位。

設定目標對象時，需要進行使用者驗證。

AccessState

代表聊天室的存取狀態。

列舉
ACCESS_STATE_UNSPECIFIED 這個 API 不支援或無法判斷存取狀態。
PRIVATE 只有其他使用者或 Google Workspace 管理員個別新增或邀請的使用者或 Google 網路論壇群組，才能探索及存取聊天室。
DISCOVERABLE

聊天室管理員已授予目標對象聊天室存取權。個別加入或受邀加入聊天室的使用者或 Google 群組，也能探索及存取聊天室。詳情請參閱「讓特定使用者可自由加入聊天室」。

如要建立可自由加入的聊天室，需要使用者驗證。

MembershipCount

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

欄位
joined_direct_human_user_count

int32

直接加入聊天室的使用者人數，不含透過加入群組而加入聊天室的使用者。
joined_group_count

int32

直接加入聊天室的所有群組數量。

PermissionSetting

代表聊天室權限設定。

欄位
managers_allowed

bool

聊天室管理員是否具備這項權限。
members_allowed

bool

非管理員成員是否擁有這項權限。

PermissionSettings

更新現有已命名聊天室時可指定的權限設定。

如要在建立空間時設定權限，請在要求中指定 PredefinedPermissionSettings 欄位。

欄位
manage_members_and_groups

PermissionSetting

管理聊天室成員和群組的設定。
modify_space_details

PermissionSetting

設定聊天室名稱、顯示圖片、說明和規範的更新方式。
toggle_history

PermissionSetting

這項設定用於開啟或關閉聊天室記錄。
use_at_mention_all

PermissionSetting

在聊天室中使用 @all 的設定。
manage_apps

PermissionSetting

管理聊天室應用程式的設定。
manage_webhooks

PermissionSetting

管理聊天室 Webhook 的設定。
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 雙方的 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() 要求，請在查詢篩選器中略過批次事件類型。根據預設，伺服器會傳回事件類型和批次版本。

訊息支援的事件類型：

  • 新訊息：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

當 true 時，方法會使用使用者的 Google Workspace 管理員權限執行。

通話使用者必須是具備管理即時通訊和聊天室對話權限的 Google Workspace 管理員。

需要 chat.admin.memberships OAuth 2.0 範圍。

UpdateMessageRequest

要求更新訊息。

欄位
message

Message

必要欄位。訊息已更新欄位。
update_mask

FieldMask

必要欄位。要更新的欄位路徑。請使用半形逗號分隔多個值，或使用 * 更新所有欄位路徑。

目前支援的欄位路徑：
allow_missing

bool

選用設定。如果系統找不到 true 且找不到訊息，系統會建立新訊息並忽略 updateMask。指定的郵件 ID 必須為client-assigned，否則要求失敗。

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 早於最新訊息建立時間，UI 就會顯示為未讀取。

如要將此空間標示為已讀取，請將 last_read_time 設為大於 (晚於) 最新訊息建立時間的任何值。系統會將 last_read_time 強制轉換成最新的訊息建立時間。請注意，聊天室讀取狀態只會影響聊天室頂層對話中顯示的訊息讀取狀態。討論串中的回覆不會受到這個時間戳記的影響，而是取決於討論串的讀取狀態。

UpdateSpaceRequest

要求更新單一聊天室。

欄位
space

Space

必要欄位。含有要更新欄位的聊天室。必須以 spaces/{space} 的格式填入 Space.name。只有 update_mask 指定的欄位會更新。
update_mask

FieldMask

必要欄位。更新後的欄位路徑 (如有多個路徑，以半形逗號分隔)。

你可以更新下列空間欄位：

space_details：更新聊天室說明。最多支援 150 個半形字元。

display_name：僅支援針對 spaceType 欄位為 SPACE 的聊天室更新顯示名稱。如果收到錯誤訊息 ALREADY_EXISTS，請嘗試使用其他值。Google Workspace 機構內的現有聊天室可能已使用這個顯示名稱。

space_type：僅支援將 GROUP_CHAT 聊天室類型變更為 SPACE。在更新遮罩中將 display_name 和 space_type 一起加入，並確認指定的空間具有非空白的顯示名稱和 SPACE 空間類型。如果現有空間已具有 SPACE 類型，則在更新顯示名稱時，不一定要在指定空間中加入 space_type 遮罩和 SPACE 類型。嘗試透過其他方式更新聊天室類型會導致引數無效錯誤。useAdminAccess 不支援 space_type。

space_history_state：開啟或關閉聊天室的記錄功能，更新聊天室記錄設定。只有在 Google Workspace 機構啟用記錄設定的情況下，系統支援這個選項。如要更新聊天室歷程狀態，您必須在要求中省略所有其他欄位遮罩。useAdminAccess 不支援 space_history_state。

access_settings.audience：更新存取權設定，指定哪些人可以探索聊天室、加入聊天室，以及預覽已命名聊天室中的訊息 (spaceType 欄位為 SPACE)。如果現有聊天室有目標對象，您可以省略這個欄位遮罩的值，藉此移除目標對象並限制聊天室存取權。如要更新聊天室的存取權設定，驗證使用者必須是聊天室管理員，且請在要求中省略所有其他欄位遮罩。如果聊天室處於匯入模式，就無法更新這個欄位。詳情請參閱「讓特定使用者可自由加入聊天室」。「useAdminAccess」不支援「access_settings.audience」。

permission_settings：支援變更聊天室的權限設定。更新權限設定時，您只能指定 permissionSettings 欄位遮罩；無法同時更新其他欄位遮罩。useAdminAccess 不支援 permissionSettings。支援的欄位遮罩包括：

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

bool

在 true 時，此方法會使用使用者的 Google Workspace 管理員權限執行。

通話使用者必須是具備管理即時通訊和聊天室對話權限的 Google Workspace 管理員。

需要 chat.admin.spaces OAuth 2.0 範圍。

管理員存取權不支援部分 FieldMask 值。詳情請參閱 update_mask 的說明。

使用者

Google Chat 中的使用者。如果 Chat 應用程式以使用者身分進行驗證，則在要求的輸出內容中，User 資源的輸出內容只會填入使用者的 name 和 type。

欄位
name

string

Google Chat user 的資源名稱。

格式：users/{user}。users/app 可做為發出呼叫的應用程式 bot 使用者的別名。

如果是 human users，{user} 與使用者 ID 相同：

  • People API 中 Person 的 id。舉例來說，Chat API 中的 users/123456789 代表 People API 中的 123456789 使用者個人資料 ID。

  • Admin SDK Directory API 中使用者的 id。

  • 使用者的電子郵件地址可做為 API 要求中 {user} 的別名。舉例來說，如果 user@example.com 的 People API 個人資料 ID 為 123456789，您可以使用 users/user@example.com 做為別名來參照 users/123456789。API 只會傳回正規資源名稱 (例如 users/123456789)。
display_name

string

僅供輸出。使用者的顯示名稱。
domain_id

string

使用者 Google Workspace 網域的專屬 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 動作，系統會觸發表單動作。

TextButton

含文字和 onclick 動作的按鈕。

欄位
text

string

按鈕文字。
on_click

OnClick

按鈕的 onclick 動作。

TextParagraph

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

欄位
text

string