Package google.chat.v1

索引

ChatService

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

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

完成指定空間的匯入程序，並向使用者顯示。

需要使用者驗證和全網域委派，並使用授權範圍：

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

詳情請參閱「授權 Google Chat 應用程式匯入資料」。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。
CreateCustomEmoji

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

建立自訂表情符號。

自訂表情符號僅適用於 Google Workspace 帳戶，且管理員必須為機構啟用自訂表情符號。詳情請參閱「瞭解 Google Chat 中的自訂表情符號」和「管理自訂表情符號權限」。

需要使用授權範圍進行使用者驗證：

  • https://www.googleapis.com/auth/chat.customemojis
授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。
CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

為通話 Chat 應用程式、使用者或 Google 群組建立成員資格。目前不支援為其他 Chat 應用程式建立成員資格。建立成員時，如果指定成員關閉了自動接受政策，系統會傳送邀請給對方，對方必須接受邀請才能加入。否則，建立成員資格會直接將成員新增至指定聊天室。

支援下列類型的驗證：

  • 應用程式驗證 (須經管理員核准)，授權範圍如下：

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

  • 使用者驗證，並使用下列其中一個授權範圍：

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.memberships.app (將通話應用程式加入聊天室)
    • https://www.googleapis.com/auth/chat.import (僅限匯入模式聊天室)
    • 使用者驗證會在管理員帳戶通過驗證時授予管理員權限，use_admin_access 為 true，且使用下列授權範圍：
      • https://www.googleapis.com/auth/chat.admin.memberships

應用程式驗證不支援下列用途：

  • 邀請不屬於聊天室所屬 Workspace 機構的使用者。
  • 將 Google 群組新增至聊天室。
  • 將 Chat 應用程式新增至聊天室。

如需使用範例，請參閱：

授權範圍

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

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

詳情請參閱授權指南。
CreateMessage

rpc CreateMessage(CreateMessageRequest) returns (Message)

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

支援下列類型的驗證：

  • 使用授權範圍進行應用程式驗證：
    • https://www.googleapis.com/auth/chat.bot
  • 透過下列任一授權範圍進行使用者驗證：
    • https://www.googleapis.com/auth/chat.messages.create
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (僅限匯入模式聊天室)

視要求中使用的驗證類型而定，Chat 會以不同方式歸因訊息傳送者。

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

透過應用程式驗證傳送的訊息

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

透過使用者驗證傳送的訊息

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

如果是 Webhook 要求，回應不會包含完整訊息。除了要求中的資訊外，回應只會填入 name 和 thread.name 欄位。

授權範圍

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

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

詳情請參閱授權指南。
CreateReaction

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

建立回應並新增至訊息。如需範例，請參閱「對訊息新增回應」。

需要使用者驗證，並使用下列其中一個授權範圍：

  • https://www.googleapis.com/auth/chat.messages.reactions.create
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import (僅限匯入模式聊天室)
授權範圍

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

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

詳情請參閱授權指南。
CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space)

建立聊天室。可用於在 Import mode 中建立具名聊天室或群組對話。如需範例，請參閱「建立聊天室」。

支援下列類型的驗證：

  • 應用程式驗證 (須經管理員核准)，以及下列其中一個授權範圍：

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

  • 使用者驗證，並使用下列其中一個授權範圍：

    • https://www.googleapis.com/auth/chat.spaces.create
    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import (僅限匯入模式聊天室)

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

以應用程式身分驗證時，Chat 應用程式會新增為聊天室成員。不過，與人工驗證不同的是，Chat 應用程式不會新增為聊天室管理員。根據預設，所有聊天室成員都能從聊天室中移除 Chat 應用程式。如要只允許聊天室管理員從聊天室移除應用程式，請將 space.permission_settings.manage_apps 設為 managers_allowed。

建立聊天室時的成員資格取決於聊天室是否在 Import mode 中建立：

  • 匯入模式：不會建立任何成員。
  • 所有其他模式：系統會將通話使用者新增為成員。包括：
    • 使用應用程式驗證時，應用程式本身。
    • 使用使用者驗證時的人類使用者。

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

授權範圍

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

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

詳情請參閱授權指南。
DeleteCustomEmoji

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty)

刪除自訂表情符號。根據預設，使用者只能刪除自己建立的自訂表情符號。管理員指派的表情符號管理員可以刪除機構中的任何自訂表情符號。請參閱「瞭解 Google Chat 中的自訂表情符號」。

自訂表情符號僅適用於 Google Workspace 帳戶，且管理員必須為機構啟用自訂表情符號。詳情請參閱「瞭解 Google Chat 中的自訂表情符號」和「管理自訂表情符號權限」。

需要使用授權範圍進行使用者驗證：

  • https://www.googleapis.com/auth/chat.customemojis
授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。
DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

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

支援下列類型的驗證：

  • 應用程式驗證 (須經管理員核准)，授權範圍如下：

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

  • 使用者驗證，並使用下列其中一個授權範圍：

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.memberships.app (從聊天室中移除通話應用程式)
    • https://www.googleapis.com/auth/chat.import (僅限匯入模式聊天室)
    • 使用者驗證會在管理員帳戶通過驗證時授予管理員權限，use_admin_access 為 true，且使用下列授權範圍：
      • https://www.googleapis.com/auth/chat.admin.memberships

應用程式驗證不支援下列用途：

  • 從聊天室中移除 Google 網路論壇。
  • 從聊天室中移除 Google Chat 應用程式。

如要刪除聊天室管理員的成員資格，要求者必須是聊天室管理員。如果使用應用程式驗證，則必須由 Chat 應用程式建立聊天室。

授權範圍

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

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

詳情請參閱授權指南。
DeleteMessage

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

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

支援下列類型的驗證：

  • 應用程式驗證，授權範圍如下：

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

  • 使用者驗證，並使用下列其中一個授權範圍：

    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (僅限匯入模式聊天室)

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

授權範圍

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

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

詳情請參閱授權指南。
DeleteReaction

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

刪除訊息的回應。如需範例，請參閱刪除回應。

需要使用者驗證，並使用下列其中一個授權範圍：

  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import (僅限匯入模式聊天室)
授權範圍

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

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

詳情請參閱授權指南。
DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

刪除具名空間。一律執行連鎖刪除作業，也就是一併刪除聊天室的子項資源，例如聊天室中發布的訊息和聊天室成員。如需範例，請參閱「刪除聊天室」。

支援下列類型的驗證：

  • 應用程式驗證 (須經管理員核准)，授權範圍如下：

    • https://www.googleapis.com/auth/chat.app.delete (僅限應用程式建立的聊天室)

  • 使用者驗證，並使用下列其中一個授權範圍：

    • https://www.googleapis.com/auth/chat.delete
    • https://www.googleapis.com/auth/chat.import (僅限匯入模式聊天室)
    • 使用者驗證會在管理員帳戶通過驗證時授予管理員權限，use_admin_access 為 true，且使用下列授權範圍：
      • https://www.googleapis.com/auth/chat.admin.delete
授權範圍

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

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

詳情請參閱授權指南。
FindDirectMessage

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

傳回與指定使用者互傳的現有即時訊息。如果找不到任何直接訊息空間，則會傳回 404 NOT_FOUND 錯誤。如需範例，請參閱「尋找即時訊息」。

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

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

支援下列類型的驗證：

  • 應用程式驗證，授權範圍如下：

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

  • 使用者驗證，並使用下列其中一個授權範圍：

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
授權範圍

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

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

詳情請參閱授權指南。
FindGroupChats

rpc FindGroupChats(FindGroupChatsRequest) returns (FindGroupChatsResponse)

傳回所有具有 spaceType == GROUP_CHAT 的聊天室，這些聊天室的人類成員必須包含呼叫使用者和 FindGroupChatsRequest.memberships 中指定的使用者。

如果呼叫使用者封鎖或遭到部分使用者封鎖，且系統找不到包含所有指定使用者的聊天室，這個方法會傳回不含遭封鎖或封鎖使用者的聊天室。

指定的使用者組合只能包含人類 (非應用程式) 成員。如果要求包含非真人使用者，系統不會傳回任何聊天室。

需要使用者驗證，並使用下列其中一個授權範圍：

  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.memberships
授權範圍

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

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

詳情請參閱授權指南。
GetAttachment

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

取得郵件附件的中繼資料。附件資料是使用媒體 API 擷取。如需範例，請參閱「取得郵件附件的中繼資料」。

需要使用授權範圍進行應用程式驗證：

  • https://www.googleapis.com/auth/chat.bot
授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。
GetCustomEmoji

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

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

自訂表情符號僅適用於 Google Workspace 帳戶，且管理員必須為機構啟用自訂表情符號。詳情請參閱「瞭解 Google Chat 中的自訂表情符號」和「管理自訂表情符號權限」。

需要使用者驗證，並使用下列其中一個授權範圍：

  • https://www.googleapis.com/auth/chat.customemojis.readonly
  • https://www.googleapis.com/auth/chat.customemojis
授權範圍

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

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

詳情請參閱授權指南。
GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership)

傳回會員方案的詳細資料。如需範例，請參閱「取得使用者或 Google Chat 應用程式的成員資格詳細資料」。

支援下列類型的驗證：

  • 應用程式驗證，並使用下列其中一個授權範圍：

    • https://www.googleapis.com/auth/chat.bot
    • https://www.googleapis.com/auth/chat.app.memberships (需要管理員核准)

  • 使用者驗證，並使用下列其中一個授權範圍：

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • 使用者驗證會在管理員帳戶驗證時授予管理員權限，use_admin_access為 true，且使用下列其中一個授權範圍：
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships
授權範圍

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

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

詳情請參閱授權指南。
GetMessage

rpc GetMessage(GetMessageRequest) returns (Message)

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

支援下列類型的驗證：

  • 應用程式驗證，並使用下列其中一個授權範圍：

    • https://www.googleapis.com/auth/chat.bot：使用這個授權範圍時，這個方法會傳回 Chat 應用程式可存取訊息的詳細資料，例如即時訊息和叫用 Chat 應用程式的斜線指令。
    • https://www.googleapis.com/auth/chat.app.messages.readonly (須管理員核准，適用於開發人員預覽版)。使用這個驗證範圍時，這個方法會傳回空間中公開訊息的詳細資料。

  • 使用者驗證，並使用下列其中一個授權範圍：

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

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

授權範圍

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

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

詳情請參閱授權指南。
GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space)

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

支援下列類型的驗證：

  • 應用程式驗證，並使用下列其中一個授權範圍：

    • https://www.googleapis.com/auth/chat.bot
    • https://www.googleapis.com/auth/chat.app.spaces 須經管理員核准

  • 使用者驗證，並使用下列其中一個授權範圍：

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
    • 使用者驗證會在管理員帳戶驗證時授予管理員權限，use_admin_access為 true，且使用下列其中一個授權範圍：
      • https://www.googleapis.com/auth/chat.admin.spaces.readonly
      • https://www.googleapis.com/auth/chat.admin.spaces

應用程式驗證有下列限制：

  • 只有在使用 chat.app.spaces 範圍時，才會填入 space.access_settings。
  • 只有在使用 chat.app.spaces 範圍時，且僅限應用程式建立的聊天室，才會填入 space.predefind_permission_settings 和 space.permission_settings。
授權範圍

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

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

詳情請參閱授權指南。
GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

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

注意：這項要求的空間事件資料空間物件不會傳回 permissionSettings 欄位。

支援下列類型的驗證，並提供適當的授權範圍，可讀取所要求的資料：

  • 應用程式驗證 (須經管理員核准) 開發人員預覽版，並使用下列其中一個授權範圍：

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

  • 使用者驗證，並使用下列其中一個授權範圍：

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

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

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

授權範圍

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

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

詳情請參閱授權指南。
GetSpaceNotificationSetting

rpc GetSpaceNotificationSetting(GetSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

取得聊天室通知設定。如需範例，請參閱「取得通話者的空間通知設定」。

需要使用授權範圍進行使用者驗證：

  • https://www.googleapis.com/auth/chat.users.spacesettings
授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。
GetSpaceReadState

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

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

需要使用者驗證，並使用下列其中一個授權範圍：

  • https://www.googleapis.com/auth/chat.users.readstate.readonly
  • https://www.googleapis.com/auth/chat.users.readstate
授權範圍

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

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

詳情請參閱授權指南。
GetThreadReadState

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

傳回有關執行緒中使用者讀取狀態的詳細資料，用於識別已讀和未讀訊息。如需範例，請參閱「取得使用者討論串讀取狀態的詳細資料」。

需要使用者驗證，並使用下列其中一個授權範圍：

  • https://www.googleapis.com/auth/chat.users.readstate.readonly
  • https://www.googleapis.com/auth/chat.users.readstate
授權範圍

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

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

詳情請參閱授權指南。
ListCustomEmojis

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse)

列出已驗證使用者可見的自訂表情符號。

自訂表情符號僅適用於 Google Workspace 帳戶，且管理員必須為機構啟用自訂表情符號。詳情請參閱「瞭解 Google Chat 中的自訂表情符號」和「管理自訂表情符號權限」。

需要使用者驗證，並使用下列其中一個授權範圍：

  • https://www.googleapis.com/auth/chat.customemojis.readonly
  • https://www.googleapis.com/auth/chat.customemojis
授權範圍

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

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

詳情請參閱授權指南。
ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

列出聊天室中的成員。如需範例，請參閱「列出聊天室中的使用者和 Google Chat 應用程式」。使用應用程式驗證列出成員資格時，系統會列出 Chat 應用程式有權存取的聊天室成員資格，但會排除 Chat 應用程式成員資格 (包括應用程式本身的成員資格)。使用「使用者驗證」列出成員資格：列出已驗證使用者可存取空間的成員資格。

支援下列類型的驗證：

  • 應用程式驗證，並使用下列其中一個授權範圍：

    • https://www.googleapis.com/auth/chat.bot
    • https://www.googleapis.com/auth/chat.app.memberships (需要管理員核准)

  • 使用者驗證，並使用下列其中一個授權範圍：

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import (僅限匯入模式聊天室)
    • 使用者驗證會在管理員帳戶驗證時授予管理員權限，use_admin_access為 true，且使用下列其中一個授權範圍：
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships
授權範圍

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

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

詳情請參閱授權指南。
ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

列出通話者所屬聊天室中的訊息，包括來自已封鎖成員和聊天室的訊息。系統訊息 (例如公告新聊天室成員的訊息) 不會納入。如果列出沒有訊息的聊天室訊息，回應會是空白物件。使用 REST/HTTP 介面時，回應會包含空白的 JSON 物件 {}。如需範例，請參閱「列出訊息」一文。

支援下列類型的驗證：

  • 應用程式驗證 (須經管理員核准) 開發人員預覽版，授權範圍如下：

    • https://www.googleapis.com/auth/chat.app.messages.readonly。使用這個驗證範圍時，這個方法只會傳回空間中的公開訊息。不包括私人訊息。

  • 使用者驗證，並使用下列其中一個授權範圍：

    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (僅限匯入模式聊天室)
授權範圍

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

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

詳情請參閱授權指南。
ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

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

需要使用者驗證，並使用下列其中一個授權範圍：

  • https://www.googleapis.com/auth/chat.messages.reactions.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages
授權範圍

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

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

詳情請參閱授權指南。
ListSpaceEvents

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

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

支援下列類型的驗證，並提供適當的授權範圍，可讀取所要求的資料：

  • 應用程式驗證 (須經管理員核准) 開發人員預覽版，並使用下列其中一個授權範圍：

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

  • 使用者驗證，並使用下列其中一個授權範圍：

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

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

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

授權範圍

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

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

詳情請參閱授權指南。
ListSpaces

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse)

列出呼叫者所屬的聊天室。系統不會列出群組通訊和即時訊息，直到傳送第一則訊息為止。如需範例，請參閱「列出聊天室」。

支援下列類型的驗證：

  • 應用程式驗證，授權範圍如下：

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

  • 使用者驗證，並使用下列其中一個授權範圍：

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

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

授權範圍

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

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

詳情請參閱授權指南。
SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

根據管理員的搜尋條件，傳回 Google Workspace 機構中的空間清單。在要求中，將 use_admin_access 設為 true。如需範例，請參閱「搜尋及管理聊天室」。

需要具備管理員權限的使用者驗證，以及下列其中一個授權範圍：

  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.admin.spaces
授權範圍

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

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

詳情請參閱授權指南。
SetUpSpace

rpc SetUpSpace(SetUpSpaceRequest) returns (Space)

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

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

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

如果是具名聊天室或群組對話，如果通話者封鎖部分成員，或遭到部分成員封鎖，或沒有權限新增部分成員，系統就不會將這些成員加入建立的聊天室。

如要在通話使用者和其他真人使用者之間建立即時訊息 (DM)，請指定一個成員資格來代表真人使用者。如果其中一位使用者封鎖了另一位，要求就會失敗，系統也不會建立私訊。

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

如果兩位使用者之間已有私訊，即使其中一位使用者在提出要求時封鎖另一位，系統仍會傳回現有私訊。

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

需要使用者驗證，並使用下列其中一個授權範圍：

  • https://www.googleapis.com/auth/chat.spaces.create
  • https://www.googleapis.com/auth/chat.spaces
授權範圍

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

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

詳情請參閱授權指南。
UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

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

支援下列類型的驗證：

  • 應用程式驗證 (須經管理員核准)，授權範圍如下：

    • https://www.googleapis.com/auth/chat.app.memberships (僅限應用程式建立的聊天室)

  • 使用者驗證，並使用下列其中一個授權範圍：

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import (僅限匯入模式聊天室)
    • 使用者驗證會在管理員帳戶通過驗證時授予管理員權限，use_admin_access 為 true，且使用下列授權範圍：
      • https://www.googleapis.com/auth/chat.admin.memberships
授權範圍

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

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

詳情請參閱授權指南。
UpdateMessage

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

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

支援下列類型的驗證：

  • 應用程式驗證，授權範圍如下：

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

  • 使用者驗證，並使用下列其中一個授權範圍：

    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (僅限匯入模式聊天室)

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

授權範圍

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

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

詳情請參閱授權指南。
UpdateSpace

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

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

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

支援下列類型的驗證：

  • 應用程式驗證 (須經管理員核准)，以及下列其中一個授權範圍：

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

  • 使用者驗證，並使用下列其中一個授權範圍：

    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import (僅限匯入模式聊天室)
    • 使用者驗證會在管理員帳戶通過驗證時授予管理員權限，use_admin_access為 true，並使用下列授權範圍：
      • https://www.googleapis.com/auth/chat.admin.spaces

應用程式驗證有下列限制：

  • 如要更新 space.predefined_permission_settings 或 space.permission_settings，您必須是聊天室建立者。
  • 應用程式驗證不支援更新 space.access_settings.audience。
授權範圍

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

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

詳情請參閱授權指南。
UpdateSpaceNotificationSetting

rpc UpdateSpaceNotificationSetting(UpdateSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

更新聊天室通知設定。如需範例，請參閱「更新來電者的空間通知設定」。

需要使用授權範圍進行使用者驗證：

  • https://www.googleapis.com/auth/chat.users.spacesettings
授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。
UpdateSpaceReadState

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

更新聊天室中使用者已讀狀態，用於識別已讀和未讀訊息。如需範例，請參閱「更新使用者的聊天室讀取狀態」。

需要使用授權範圍進行使用者驗證：

  • https://www.googleapis.com/auth/chat.users.readstate
授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。

AccessoryWidget

顯示在郵件底部的互動式小工具。詳情請參閱「在訊息底部新增互動式小工具」。

欄位
聯集欄位 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

如果是 selectionInput 小工具，則會傳回多選選單的自動完成建議。

欄位
widget

string

更新後的小工具 ID。ID 必須與觸發更新要求的小工具 ID 相符。
聯集欄位 updated_widget。小工具已更新，以回應使用者動作。updated_widget 只能是下列其中一項：
suggestions

SelectionItems

小工具自動完成結果清單

ActionStatus

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

欄位
status_code

Code

狀態碼。
user_facing_message

string

要傳送給使用者的訊息，說明要求狀態。如果未設定，系統會根據 status_code 傳送一般訊息。

備註

僅供輸出。註解可與郵件的純文字內文建立關聯，也可以與連結至 Google 文件或試算表等 Google Workspace 資源的資訊方塊建立關聯，並以 start_index 和 length 的 0 表示。如要為訊息加上基本格式設定，請參閱「設定訊息格式」。

純文字訊息內文範例：

Hello @FooBot how are you!"

對應的註解中繼資料：

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

AnnotationType

這個註解的類型。
length

int32

此註解對應的純文字訊息內文子字串長度。如果沒有這個屬性，表示長度為 0。
start_index

int32

此註解對應的純文字訊息內文中的起始索引 (從 0 開始，含該索引)。
聯集欄位 metadata。註解的其他中繼資料。metadata 只能是下列其中一項：
user_mention

UserMentionMetadata

使用者提及的中繼資料。
slash_command

SlashCommandMetadata

斜線指令的中繼資料。
custom_emoji_metadata

CustomEmojiMetadata

自訂表情符號的中繼資料。

AnnotationType

註解類型。

列舉
ANNOTATION_TYPE_UNSPECIFIED 列舉的預設值。請勿使用。
USER_MENTION 提及使用者。
SLASH_COMMAND 系統會叫用斜線指令。
CUSTOM_EMOJI 自訂表情符號註解。

AppCommandMetadata

Chat 應用程式指令的中繼資料。

欄位
app_command_id

int32

Chat API 設定中指定的指令 ID。
app_command_type

AppCommandType

Chat 應用程式指令的類型。

AppCommandType

Chat 應用程式指令的類型。詳情請參閱「Chat 擴充應用程式指令類型」。

列舉
APP_COMMAND_TYPE_UNSPECIFIED 預設值。未指明
SLASH_COMMAND 斜線指令。使用者在 Chat 訊息中傳送指令。
QUICK_COMMAND 快速指令。使用者在訊息回覆區的 Chat 選單中選取指令。

AttachedGif

網址指定的 GIF 圖片。

欄位
uri

string

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

附件

Google Chat 中的附件。

欄位
name

string

ID。附件的資源名稱。

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

(選用步驟) 附件資料的參照。這個欄位可用於建立或更新含有附件的訊息，或使用 Media API 下載附件資料。
drive_data_ref

DriveDataRef

僅供輸出。Google 雲端硬碟附件的參照。這個欄位會與 Google Drive API 一併使用。

來源

附件來源。

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

AttachmentDataRef

附件資料的參照。

欄位
resource_name

string

(選用步驟) 附件資料的資源名稱。這個欄位會與 Media API 搭配使用，下載附件資料。
attachment_upload_token

string

(選用步驟) 不透明符記，內含上傳附件的參照。用戶端會將其視為不透明的字串，並用於建立或更新含有附件的 Chat 訊息。

CalendarEventLinkData

日曆活動連結的資料。

欄位
calendar_id

string

已連結日曆的日曆 ID。
event_id

string

連結日曆活動的活動 ID。

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

這個類型沒有任何欄位。

開發人員可使用標記指定情境式外掛程式的內容。

資訊卡

資訊卡是一種 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 圓形邊框。

區段

一個區段包含一組小工具，這些小工具會按照指定順序 (垂直) 顯示。在所有平台上，資訊卡的寬度都是固定的，因此目前不需要版面配置屬性 (例如 float)。

欄位
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，並以 users/{user} 格式設定 user.name，其中 {user} 可以是使用者的電子郵件地址。如果使用者位於同一個 Workspace 機構，{user} 也可以是 People API 中 person 的 id，或是 Directory API 中使用者的 id。舉例來說，如果 user@example.com 的 People API Person 設定檔 ID 為 123456789，您可以將 membership.member.name 設為 users/user@example.com 或 users/123456789，將使用者新增至空間。

邀請 Workspace 組織外部使用者加入聊天室時，必須驗證使用者身分。

當 Chat 應用程式為自己建立成員關係時，必須以使用者身分進行驗證，並使用 chat.memberships.app 範圍，將 user.type 設為 BOT，並將 user.name 設為 users/app。
use_admin_access

bool

(選用步驟) 時，這個方法會使用使用者的 Google Workspace 管理員權限執行。true

通話使用者必須是具備「管理即時通訊和聊天室對話」權限的 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。最多可輸入 4,000 個半形字元。如要發起或加入討論串，請建立訊息並指定 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 和 SpaceType.GROUP_CHAT。只有在 importMode 設為 true 時，才能使用 SpaceType.GROUP_CHAT。

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

伺服器會指派空間 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。

CustomEmojiMetadata

自訂表情符號的註解中繼資料。

欄位
custom_emoji

CustomEmoji

自訂表情符號。

DeleteCustomEmojiRequest

要求刪除自訂表情符號。

欄位
name

string

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

格式：customEmojis/{customEmoji}

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

DeleteMembershipRequest

請求刪除空間中的成員資格。

欄位
name

string

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

刪除使用者成員時，需要 chat.memberships 範圍和使用者驗證，或 chat.memberships.app 範圍和應用程式驗證，以及 spaces/{space}/members/{member} 格式。你可以將該電子郵件地址做為 {member} 的別名。例如 spaces/{space}/members/example@gmail.com，其中 example@gmail.com 是 Google Chat 使用者的電子郵件地址。

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

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

bool

(選用步驟) 時，這個方法會使用使用者的 Google Workspace 管理員權限執行。true

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

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

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

DeleteMessageRequest

要求刪除訊息。

欄位
name

string

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

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

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

bool

(選用步驟) true，刪除訊息時，系統也會一併刪除相關回覆。如果訊息有討論串回覆，則無法刪除 false。

僅適用於以使用者身分進行驗證。以 Chat 應用程式身分驗證時，這項設定不會生效。

DeleteReactionRequest

刪除訊息的回應。

欄位
name

string

必要欄位。要刪除的回應名稱。

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

DeleteSpaceRequest

要求刪除聊天室。

欄位
name

string

必要欄位。要刪除的空間資源名稱。

格式：spaces/{space}
use_admin_access

bool

(選用步驟) 時，這個方法會使用使用者的 Google Workspace 管理員權限執行。true

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

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

DeletionMetadata

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

欄位
deletion_type

DeletionType

指出刪除訊息的使用者。

DeletionType

刪除郵件的使用者和方式。日後可能會新增更多值。如要瞭解何時可以刪除訊息，請參閱「編輯或刪除 Google Chat 中的訊息」。

列舉
DELETION_TYPE_UNSPECIFIED 這個值不會使用。
CREATOR 使用者刪除自己的訊息。
SPACE_OWNER 擁有者或管理員刪除了訊息。
ADMIN Google Workspace 管理員已刪除訊息。管理員可以刪除聊天室中的所有訊息，包括聊天室成員或 Chat 應用程式傳送的訊息。
APP_MESSAGE_EXPIRY Chat 應用程式刪除了自己的訊息 (已過期)。
CREATOR_VIA_APP Chat 應用程式代表建立者刪除訊息 (使用使用者驗證)。
SPACE_OWNER_VIA_APP Chat 應用程式代表聊天室管理員刪除訊息 (使用使用者驗證)。
SPACE_MEMBER 聊天室成員刪除了訊息。使用者可以刪除應用程式傳送的訊息。

對話方塊

對話方塊資訊卡主體的包裝函式。

欄位
body

Card

僅供輸入。對話方塊主體，會以模式顯示。Google Chat 應用程式不支援下列資訊卡實體：DateTimePicker、OnChangeAction。

DialogAction

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

欄位
action_status

ActionStatus

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

Dialog

僅供輸入。要求的對話方塊。

DriveDataRef

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

欄位
drive_file_id

string

雲端硬碟檔案的 ID。搭配 Drive API 使用。

DriveLinkData

Google 雲端硬碟連結的資料。

欄位
drive_data_ref

DriveDataRef

參照 Google 雲端硬碟檔案的 DriveDataRef。
mime_type

string

連結的 Google 雲端硬碟資源 MIME 類型。

表情符號

用來回應訊息的表情符號。

欄位
聯集欄位 content。必要欄位。表情符號的內容。content 只能是下列其中一項：
unicode

string

(選用步驟) 以 Unicode 字串表示的基本表情符號。
custom_emoji

CustomEmoji

自訂表情符號。

EmojiReactionSummary

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

欄位
emoji

Emoji

僅供輸出。與回應相關聯的表情符號。
reaction_count

int32

僅供輸出。使用相關聯表情符號的回應總數。

FindDirectMessageRequest

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

欄位
name

string

必要欄位。要尋找即時訊息的使用者資源名稱。

格式：users/{user}，其中 {user} 是 People API 中人員的 id，或是 Directory API 中使用者的 id。舉例來說，如果 People API 設定檔 ID 為 123456789，您可以使用 users/123456789 做為 name，找出與該人員的即時訊息。以使用者身分通過驗證後，您可以使用電子郵件做為 {user} 的別名。例如 users/example@gmail.com，其中 example@gmail.com 是 Google Chat 使用者的電子郵件地址。

FindGroupChatsRequest

根據使用者資源取得群組通訊聊天室的要求。

欄位
user[]

string

與通話使用者進行群組即時通訊的所有人類使用者資源名稱。要求中不得包含即時通訊應用程式。

格式：users/{user}，其中 {user} 是 People API 中人員的 id，或是 Directory API 中使用者的 id。舉例來說，如要找出與通話使用者和其他兩位使用者 (People API 設定檔 ID 為 123456789 和 987654321) 的所有群組對話，可以使用 users/123456789 和 users/987654321。您也可以將該電子郵件地址做為 {user} 的別名。例如 users/example@gmail.com，其中 example@gmail.com 是 Google Chat 使用者的電子郵件地址。

如果通話使用者是 Google Workspace 使用者，所有受邀使用者都必須與通話使用者屬於同一個 Google Workspace 機構。
page_size

int32

(選用步驟) 要傳回的空間數量上限。服務傳回的產品數量可能會少於這個值。

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

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

負值會傳回 INVALID_ARGUMENT 錯誤。
page_token

string

(選用步驟) 屬於接收自前一個呼叫的網頁權杖，用於尋找群組通訊。提供此參數即可擷取後續網頁。

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

SpaceView

要求的空間檢視類型。如未設定，則預設為 SPACE_VIEW_RESOURCE_NAME_ONLY。指定 SPACE_VIEW_EXPANDED 的要求必須包含允許讀取聊天室資料的範圍，例如 https://www.googleapis.com/auth/chat.spaces 或 https://www.googleapis.com/auth/chat.spaces.readonly。

FindGroupChatsResponse

回應內容包含群組對話聊天室，且聊天室成員只有通話使用者和要求的使用者。

欄位
spaces[]

Space

所要求 (或第一) 頁面中的聊天室清單。
next_page_token

string

可做為 pageToken 傳送的權杖，用於擷取後續網頁的結果。如果留空，表示沒有後續網頁。

GetAttachmentRequest

要求取得附件。

欄位
name

string

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

GetCustomEmojiRequest

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

欄位
name

string

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

格式：customEmojis/{customEmoji}

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

GetMembershipRequest

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

欄位
name

string

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

如要透過使用者驗證取得應用程式本身的會員資格，可以選擇使用 spaces/{space}/members/app。

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

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

bool

(選用步驟) 時，這個方法會使用使用者的 Google Workspace 管理員權限執行。true

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

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

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

GetMessageRequest

要求接收訊息。

欄位
name

string

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

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

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

GetSpaceEventRequest

要求訊息，用於取得聊天室活動。

欄位
name

string

必要欄位。聊天室事件的資源名稱。

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

GetSpaceNotificationSettingRequest

要求訊息以取得聊天室通知設定。僅支援取得通話使用者的通知設定。

欄位
name

string

必要欄位。格式：users/{user}/spaces/{space}/spaceNotificationSetting

  • users/me/spaces/{space}/spaceNotificationSetting，或
  • users/user@example.com/spaces/{space}/spaceNotificationSetting，或
  • users/123456789/spaces/{space}/spaceNotificationSetting。注意：路徑中只能包含呼叫者的使用者 ID 或電子郵件地址。

GetSpaceReadStateRequest

GetSpaceReadState API 的要求訊息。

欄位
name

string

必要欄位。要擷取的聊天室讀取狀態資源名稱。

僅支援取得通話使用者的讀取狀態。

如要參照呼叫使用者，請設定下列其中一項：

  • me 別名。例如 users/me/spaces/{space}/spaceReadState。

  • 他們的 Workspace 電子郵件地址。例如 users/user@example.com/spaces/{space}/spaceReadState。

  • 使用者 ID。例如 users/123456789/spaces/{space}/spaceReadState。

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

GetSpaceRequest

要求傳回單一空間。

欄位
name

string

必要欄位。聊天室的資源名稱，格式為 spaces/{space}。

格式：spaces/{space}
use_admin_access

bool

(選用步驟) 時，這個方法會使用使用者的 Google Workspace 管理員權限執行。true

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

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

GetThreadReadStateRequest

GetThreadReadStateRequest API 的要求訊息。

欄位
name

string

必要欄位。要擷取執行緒讀取狀態的資源名稱。

僅支援取得通話使用者的讀取狀態。

如要參照呼叫使用者，請設定下列其中一項：

  • me 別名。例如 users/me/spaces/{space}/threads/{thread}/threadReadState。

  • 他們的 Workspace 電子郵件地址。例如 users/user@example.com/spaces/{space}/threads/{thread}/threadReadState。

  • 使用者 ID。例如 users/123456789/spaces/{space}/threads/{thread}/threadReadState。

格式：users/{user}/spaces/{space}/threads/{thread}/threadReadState

群組

Google Chat 中的 Google 群組。

欄位
name

string

Google 群組的資源名稱。

代表 Cloud Identity Groups API 中的群組。

格式：groups/{group}

HistoryState

訊息和聊天室的記錄狀態。指定訊息和對話討論串在建立後要保留多久。

列舉
HISTORY_STATE_UNSPECIFIED 預設值。請勿使用。
HISTORY_OFF 記錄功能已關閉。訊息和對話串會保留 24 小時。
HISTORY_ON 記錄功能已開啟。機構的 Google 保管箱保留規則會指定郵件和討論串的保留時間。

ListCustomEmojisRequest

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

欄位
page_size

int32

(選用步驟) 傳回的自訂表情符號數量上限。服務傳回的自訂表情符號數量可能會少於這個值。如未指定，則預設值為 25。最大值為 200，超過 200 的值會變更為 200。
page_token

string

(選用步驟) (如果從先前的查詢繼續)。

先前列出自訂表情符號呼叫傳回的頁面權杖。提供此項目即可擷取後續網頁。

進行分頁時，篩選值應與提供網頁權杖的呼叫相符。傳遞其他值可能會導致非預期的結果。
filter

string

(選用步驟) 查詢篩選器。

支援依創作者篩選。

如要依建立者篩選，必須指定有效值。目前僅接受 creator("users/me") 和 NOT creator("users/me")，可根據自訂表情符號是否由通話使用者建立進行篩選。

舉例來說，下列查詢會傳回呼叫者建立的自訂表情符號：

creator("users/me")

系統會拒絕無效的查詢，並傳回 INVALID_ARGUMENT 錯誤。

ListCustomEmojisResponse

列出自訂表情符號的回覆。

欄位
custom_emojis[]

CustomEmoji

未排序的清單。自訂表情符號清單。
next_page_token

string

可做為 pageToken 傳送的權杖，用於擷取後續網頁的結果。如果留空，表示沒有後續網頁。

ListMembershipsRequest

要求列出會員資格的訊息。

欄位
parent

string

必要欄位。要擷取成員名單的空間資源名稱。

格式：spaces/{space}
page_size

int32

(選用步驟) 要傳回的會員方案數量上限。服務傳回的產品數量可能會少於這個值。

如未指定，最多會傳回 100 個會員方案。

值的上限為 1000。如果使用超過 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 管理員。

需要 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 messages 時收到的頁面權杖。提供此參數即可擷取後續網頁。

進行分頁時，提供的所有其他參數應與提供網頁權杖的呼叫相符。將不同值傳遞至其他參數可能會導致非預期的結果。
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 的值會變更為 200。
page_token

string

(選用步驟) (如果從先前的查詢繼續)。

先前列出回應呼叫傳回的頁面權杖。提供此項目即可擷取後續網頁。

進行分頁時，篩選值應與提供網頁權杖的呼叫相符。傳遞其他值可能會導致非預期的結果。
filter

string

(選用步驟) 查詢篩選器。

你可以依表情符號 (emoji.unicode 或 emoji.custom_emoji.uid) 和使用者 (user.name) 篩選回應。

如要依多個表情符號或使用者篩選回應，請使用 OR 運算子加入類似的欄位，例如 emoji.unicode = "🙂" OR emoji.unicode = "👍" 和 user.name = "users/AAAAAA" OR user.name = "users/BBBBBB"。

如要依表情符號和使用者篩選回應，請使用 AND 運算子，例如 emoji.unicode = "🙂" AND user.name = "users/AAAAAA"。

如果查詢同時使用 AND 和 OR，請用半形括號將兩者括起來。

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

user.name = "users/{user}"
emoji.unicode = "🙂"
emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR emoji.unicode = "👍"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" AND user.name = "users/{user}"
(emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}")
AND user.name = "users/{user}"

下列查詢無效：

emoji.unicode = "🙂" AND emoji.unicode = "👍"
emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR
user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
AND user.name = "users/{user}"

系統會拒絕無效的查詢，並傳回 INVALID_ARGUMENT 錯誤。

ListReactionsResponse

清單回應要求的回應。

欄位
reactions[]

Reaction

所要求 (或第一個) 頁面中的回應清單。
next_page_token

string

用來擷取下一頁結果的接續符記。如果是最後一頁的結果，這個值會是空白。

ListSpaceEventsRequest

要求顯示房源活動的訊息。

欄位
parent

string

必要欄位。發生事件的 Google Chat 聊天室資源名稱。

格式：spaces/{space}。
page_size

int32

(選用步驟) 傳回的即時活動數量上限。服務傳回的產品數量可能會少於這個值。

負值會傳回 INVALID_ARGUMENT 錯誤。
page_token

string

(選用步驟) 這是接收自前一個 list space events 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

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

string

必要欄位。查詢篩選器。

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

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

  • start_time：開始列出即時活動的時間戳記 (不含該時間)。你可以列出最多 28 天前發生的事件。如果未指定，系統會列出過去 28 天的空間活動。
  • end_time：列出 Space 活動的時間戳記 (含該時間)。如未指定，則會列出要求時間之前的事件。

如要指定開始或結束時間，請使用等號 = 運算子，並採用 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

(選用步驟) 這是接收自先前列出聊天室呼叫的頁面權杖。提供此參數即可擷取後續網頁。

進行分頁時，篩選值應與提供網頁權杖的呼叫相符。傳遞其他值可能會導致非預期的結果。
filter

string

(選用步驟) 查詢篩選器。

你可以依聊天室類型篩選聊天室 (space_type)。

如要依空間類型篩選，必須指定有效的列舉值，例如 SPACE 或 GROUP_CHAT (space_type 不可以是 SPACE_TYPE_UNSPECIFIED)。如要查詢多個空間類型，請使用 OR 運算子。

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

space_type = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

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

ListSpacesResponse

列出聊天室要求的回應。

欄位
spaces[]

Space

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

string

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

MatchedUrl

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

欄位
url

string

僅供輸出。相符的網址。

MeetSpaceLinkData

Meet 空間連結的資料。

欄位
meeting_code

string

連結的 Meet 空間會議代碼。
type

Type

指出 Meet 空間的類型。
huddle_status

HuddleStatus

(選用步驟) 僅供輸出。如果 Meet 是 Huddle，則會顯示 Huddle 的狀態。否則會取消設定。

HuddleStatus

群組通話狀態

列舉
HUDDLE_STATUS_UNSPECIFIED 列舉的預設值。請勿使用。
STARTED 群組通話已開始。
ENDED 群組通話已結束。屆時 Meet 空間 URI 和 ID 將失效。
MISSED 你錯過了群組通話。屆時 Meet 空間 URI 和 ID 將失效。

類型

Meet 空間類型。

列舉
TYPE_UNSPECIFIED 列舉的預設值。請勿使用。
MEETING Meet 空間就是會議。
HUDDLE Meet 空間是即時通訊群組。

成員資格

代表 Google Chat 中的成員關係，例如使用者或 Chat 應用程式是否受邀加入聊天室、是否為聊天室成員，或是否缺席。

欄位
name

string

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

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

MembershipState

僅供輸出。會員狀態。
role

MembershipRole

(選用步驟) 使用者在 Chat 聊天室中的角色，決定了他們在聊天室中可執行的動作。

這個欄位只能在 UpdateMembership 中做為輸入內容使用。
create_time

Timestamp

(選用步驟) 不可變更。成員資格的建立時間，例如成員加入或受邀加入聊天室的時間。這個欄位僅供輸出，但可用於在匯入模式聊天室中匯入過往成員。
delete_time

Timestamp

(選用步驟) 不可變更。成員資格的刪除時間，例如成員退出或從聊天室中移除的時間。這個欄位僅供輸出，但可用於在匯入模式聊天室中匯入過往成員。
聯集欄位 memberType。與這項會員方案相關聯的成員。日後可能會支援其他成員類型。memberType 只能是下列其中一項：
member

User

(選用步驟) 與成員資格對應的 Google Chat 使用者或應用程式。如果 Chat 應用程式以使用者身分驗證，輸出內容會填入 user name 和 type。
group_member

Group

(選用步驟) 成員資格對應的 Google 群組。

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

MembershipRole

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

列舉
MEMBERSHIP_ROLE_UNSPECIFIED 預設值。users：對方不是聊天室成員，但可以邀請。對於 Google Groups：一律會指派這個角色 (日後可能會使用其他列舉值)。
ROLE_MEMBER

聊天室成員。在 Chat 使用者介面中，這個角色稱為「成員」。

使用者具備基本權限，例如傳送訊息至討論空間。管理員和擁有者可以在聊天室中授予成員額外權限，包括：

  • 新增或移除成員。
  • 修改聊天室詳細資料。
  • 開啟或關閉記錄功能。
  • 使用 @all 提及聊天室中的所有人。
  • 管理聊天室中安裝的 Chat 應用程式和 Webhook。

在即時訊息和未命名的群組對話中，所有人都具備這個角色。
ROLE_MANAGER

聊天室擁有者。在即時通訊使用者介面中，這個角色稱為「擁有者」。

使用者擁有聊天室的完整權限，可管理聊天室，包括：

  • 將其他聊天室成員的角色變更為成員、管理員或擁有者。
  • 刪除聊天室。

僅支援 SpaceType.SPACE (已命名的聊天室)。

詳情請參閱「進一步瞭解聊天室擁有者或管理員角色」。
ROLE_ASSISTANT_MANAGER

聊天室管理員。在即時通訊使用者介面中，這個角色稱為「管理員」。

使用者具備 ROLE_MEMBER 的所有基本權限，且擁有者可授予部分管理權限。根據預設，管理員具備的權限和版主大致相同，差別只在於管理員無法：

  • 刪除聊天室。
  • 將其他聊天室成員設為擁有者。
  • 變更擁有者的角色。

管理員的預設權限包括但不限於：

  • 將其他成員設為管理員。
  • 刪除聊天室中的訊息。
  • 管理聊天室權限。
  • 如果管理員在聊天室設定中具備「管理成員」權限，就會收到加入聊天室的要求通知。
  • 將聊天室設為可自由加入。

僅支援 SpaceType.SPACE (已命名的聊天室)。

詳情請參閱「管理聊天室設定」。

MembershipState

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

列舉
MEMBERSHIP_STATE_UNSPECIFIED 預設值。請勿使用。
JOINED 使用者會加入聊天室，並可參與聊天室活動。
INVITED 使用者已受邀加入聊天室，但尚未加入。
NOT_A_MEMBER 使用者不屬於該聊天室，且沒有待處理的聊天室加入邀請。

MembershipBatchCreatedEventData

多個新會員的事件酬載。

活動類型：google.workspace.chat.membership.v1.batchCreated

欄位
memberships[]

MembershipCreatedEventData

新會員方案清單。

MembershipBatchDeletedEventData

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

活動類型：google.workspace.chat.membership.v1.batchDeleted

欄位
memberships[]

MembershipDeletedEventData

已刪除的會員方案清單。

MembershipBatchUpdatedEventData

多個更新會籍的事件酬載。

活動類型：google.workspace.chat.membership.v1.batchUpdated

欄位
memberships[]

MembershipUpdatedEventData

更新後的會員方案清單。

MembershipCreatedEventData

新會籍的事件酬載。

活動類型：google.workspace.chat.membership.v1.created。

欄位
membership

Membership

全新會員方案。

MembershipDeletedEventData

已刪除會員方案的事件酬載。

活動類型：google.workspace.chat.membership.v1.deleted

欄位
membership

Membership

已刪除的會員方案。只會填入 name 和 state 欄位。

MembershipUpdatedEventData

更新會員方案的事件酬載。

活動類型：google.workspace.chat.membership.v1.updated

欄位
membership

Membership

更新後的會員方案。

訊息

Google Chat 聊天室中的訊息。

欄位
name

string

ID。訊息的資源名稱。

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

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

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

User

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

Timestamp

(選用步驟) 不可變更。如果是透過 Chat 建立的聊天室，則為訊息建立時間。這個欄位僅供輸出，匯入模式聊天室除外。

如果是匯入模式的即時通訊空間，請將這個欄位設為訊息在來源中建立時的歷史時間戳記，以便保留原始建立時間。
last_update_time

Timestamp

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

Timestamp

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

string

(選用步驟) 訊息的純文字內文。系統會根據第一個圖片、影片或網頁連結產生預覽方塊。你也可以使用@號提及 Google Chat 使用者，或聊天室中的所有成員。

如要瞭解如何建立文字訊息，請參閱「傳送訊息」一文。
formatted_text

string

僅供輸出。包含訊息 text，並加入標記來傳達格式設定。這個欄位可能無法擷取 UI 中顯示的所有格式，但包含下列項目：

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

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

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

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

  • 使用星號 (*) 建立項目符號清單項目，例如 * item。

詳情請參閱「查看訊息中傳送的文字格式」一文。
cards[]
(deprecated)

Card

已淘汰：請改用 cards_v2。

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

CardWithId

(選用步驟) 資訊卡陣列。

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

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

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

開啟 Card Builder
annotations[]

Annotation

僅供輸出。註解可以與郵件的純文字內文建立關聯，也可以與連結至 Google 文件或試算表等 Google Workspace 資源的動態磚建立關聯，並使用 start_index 和 length 的 0。
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

(選用步驟) 其他訊息引用的訊息相關資訊。

建立訊息時，您可以引用同一討論串中的訊息，也可以引用根訊息來建立新的根訊息。不過，你無法引用其他討論串中的訊息回覆。

更新訊息時，你無法新增或取代 quotedMessageMetadata 欄位，但可以移除該欄位。

如需使用範例，請參閱「引用其他訊息」。
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 和 deletionMetadata 欄位。

MessageUpdatedEventData

更新訊息的事件酬載。

活動類型：google.workspace.chat.message.v1.updated

欄位
message

Message

更新後的訊息。

QuotedMessageMetadata

其他訊息引用的訊息相關資訊。

建立訊息時，您可以引用同一討論串中的訊息，也可以引用根訊息來建立新的根訊息。不過，你無法引用其他討論串中的訊息回覆。

更新訊息時，你無法新增或取代 quotedMessageMetadata 欄位，但可以移除該欄位。

如需使用範例，請參閱「引用其他訊息」。

欄位
name

string

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

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

Timestamp

必要欄位。引用的訊息建立時間或上次更新時間的時間戳記。

如果訊息經過編輯，請使用這個欄位 last_update_time。如果訊息從未經過編輯，請使用 create_time。

如果 last_update_time 與引用訊息的最新版本不符，要求就會失敗。

反應影片

對訊息的回應。

欄位
name

string

ID。回應的資源名稱。

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

User

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

Emoji

必要欄位。回應中使用的表情符號。

ReactionBatchCreatedEventData

多個新回應的事件酬載。

活動類型：google.workspace.chat.reaction.v1.batchCreated

欄位
reactions[]

ReactionCreatedEventData

新回應清單。

ReactionBatchDeletedEventData

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

活動類型：google.workspace.chat.reaction.v1.batchDeleted

欄位
reactions[]

ReactionDeletedEventData

已刪除的回應清單。

ReactionCreatedEventData

新回應的事件酬載。

活動類型：google.workspace.chat.reaction.v1.created

欄位
reaction

Reaction

新的回應。

ReactionDeletedEventData

已刪除回應的事件酬載。

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

欄位
reaction

Reaction

已刪除的回應。

RichLinkMetadata

資源的豐富連結。富連結可與郵件的純文字內文建立關聯，或代表連結至 Google 文件或試算表等 Google Workspace 資源的動態磚，且 start_index 和 length 為 0。

欄位
uri

string

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

RichLinkType

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

列舉
DRIVE_FILE Google 雲端硬碟的富連結類型。
CHAT_SPACE Chat 聊天室的豐富連結類型。例如聊天室智慧型方塊。
MEET_SPACE Meet 訊息的複合式連結類型。例如 Meet 方塊。
CALENDAR_EVENT 日曆訊息的富連結類型。例如日曆方塊。

SearchSpacesRequest

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

欄位
use_admin_access

bool

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

通話使用者必須是具備「管理即時通訊和聊天室對話」權限的 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，但驗證的使用者不同，系統會傳回錯誤。
memberships[]

Membership

(選用步驟) 要邀請加入聊天室的 Google Chat 使用者或群組。請省略通話使用者，因為系統會自動新增。

目前一組最多可有 49 個成員 (不含來電者)。

如果是人類成員，Membership.member 欄位必須包含已填入 name 的 user (格式：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 應用程式之間的一對一訊息。

欄位
name

string

ID。聊天室的資源名稱。

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

(選用步驟) 這個空間是否在 Import Mode 中建立，做為資料遷移至 Google Workspace 的一部分。匯入聊天室期間，使用者無法查看聊天室，直到匯入完成為止。

在 Import Mode 中建立空間時，需要使用者驗證。
create_time

Timestamp

(選用步驟) 不可變更。如果是透過 Chat 建立的聊天室，則為聊天室的建立時間。這個欄位僅供輸出，匯入模式聊天室除外。

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

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

Timestamp

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

bool

僅供輸出。如果是含有 Chat 應用程式的即時訊息 (DM) 聊天室，則無論聊天室是否由 Google Workspace 管理員建立，管理員可以代表機構中的使用者，安裝及設定與 Chat 應用程式的即時訊息。

如要支援管理員安裝，Chat 應用程式必須提供即時通訊功能。
membership_count

MembershipCount

僅供輸出。依據會員類型分組的加入會員人數。當 space_type 為 SPACE、DIRECT_MESSAGE 或 GROUP_CHAT 時，系統會填入這個值。
access_settings

AccessSettings

(選用步驟) 指定聊天室的存取權設定。只有在 space_type 為 SPACE 時才會填入資料。
space_uri

string

僅供輸出。使用者存取空間的 URI。
import_mode_expire_time

Timestamp

僅供輸出。如果聊天室仍處於匯入模式，系統會自動刪除聊天室的時間。

以匯入模式建立的每個聊天室，都必須在到期時間前使用 spaces.completeImport 退出此模式。

只有以匯入模式建立的聊天室才會填入這個欄位。
customer

string

(選用步驟) 不可變更。聊天室網域的客戶 ID。只有在建立具有應用程式驗證和 SpaceType 的聊天室時才需要，否則不應設定。SPACE

格式為 customers/{customer}，其中 customer 是 Admin SDK 客戶資源中的 id。私人應用程式也可以使用 customers/my_customer 別名，在與應用程式相同的 Google Workspace 機構中建立空間。

如果是即時訊息 (DM)，或是聊天室是由非 Google Workspace 使用者建立，這個欄位就不會填入資料。
聯集欄位 space_permission_settings。代表聊天室的權限設定。只有在 space_type 為 SPACE 時才會填入資料。space_permission_settings 只能是下列其中一項：
predefined_permission_settings

PredefinedPermissionSettings

(選用步驟) 僅供輸入。預先定義的聊天室權限設定，只能在建立聊天室時輸入。如果不設定這個欄位，系統會建立協作空間。建立聊天室後，系統會在 PermissionSettings 欄位中填入設定。

預先定義的權限設定支援：
permission_settings

PermissionSettings

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

讀取及更新權限設定支援：

AccessSettings

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

欄位
access_state

AccessState

僅供輸出。顯示空間的存取狀態。
audience

string

(選用步驟) 可探索、加入及預覽聊天室訊息的目標對象資源名稱。如果未設定，只有個別受邀或加入聊天室的使用者或 Google 網路論壇成員可以存取。詳情請參閱「讓目標對象能找到你的空間」。

格式：audiences/{audience}

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

讀取目標對象支援：

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

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

AccessState

代表聊天室的存取狀態。

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

聊天室管理員已授予目標對象聊天室存取權。個別新增或邀請加入聊天室的使用者或 Google 網路論壇，也能探索及存取聊天室。詳情請參閱「允許特定使用者探索聊天室」。

建立可自由加入的聊天室時，必須進行使用者驗證。

MembershipCount

代表聊天室的成員人數，並依類別分組。

欄位
joined_direct_human_user_count

int32

僅供輸出。直接加入聊天室的人類使用者人數，不包括透過加入群組而加入的使用者。
joined_group_count

int32

僅供輸出。直接加入聊天室的所有群組數量。

PermissionSetting

代表聊天室權限設定。

欄位
managers_allowed

bool

(選用步驟) 聊天室擁有者 (ROLE_MANAGER) 是否具備這項權限。
members_allowed

bool

(選用步驟) 基本聊天室成員 (ROLE_MEMBER) 是否具備這項權限。
assistant_managers_allowed

bool

(選用步驟) 聊天室管理員是否具備這項權限。ROLE_ASSISTANT_MANAGER

PermissionSettings

更新現有名稱空間時可指定的權限設定。

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

欄位
manage_members_and_groups

PermissionSetting

(選用步驟) 管理聊天室成員和群組的設定。
modify_space_details

PermissionSetting

(選用步驟) 設定更新聊天室名稱、顯示圖片、說明和規範。
toggle_history

PermissionSetting

(選用步驟) 開啟及關閉聊天室記錄的設定。
use_at_mention_all

PermissionSetting

(選用步驟) 在聊天室中使用 @號提及所有人的設定。
manage_apps

PermissionSetting

(選用步驟) 用於管理聊天室中的應用程式。
manage_webhooks

PermissionSetting

(選用步驟) 管理聊天室中的 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 兩位使用者之間，或使用者與 Chat 應用程式之間的 1:1 訊息。

類型

已淘汰：請改用 SpaceType。

列舉
TYPE_UNSPECIFIED 保留。
ROOM 兩位以上人類之間的對話。
DM 使用者與 Chat 應用程式之間的 1 對 1 即時訊息，所有訊息都是平面。請注意，這不包括兩位使用者之間的即時訊息。

SpaceBatchUpdatedEventData

針對空間的多項更新事件酬載。

活動類型：google.workspace.chat.space.v1.batchUpdated

欄位
spaces[]

SpaceUpdatedEventData

更新後的聊天室清單。

SpaceEvent

代表 Google Chat 聊天室中的變更或活動。詳情請參閱「使用 Google Chat 的事件」。

欄位
name

string

聊天室事件的資源名稱。

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

Timestamp

事件發生的時間。
event_type

string

聊天室活動類型。每種事件類型都有批次版本，代表短時間內發生的多個事件類型執行個體。如果是 spaceEvents.list() 要求，請在查詢篩選器中省略批次事件類型。根據預設，伺服器會傳回事件類型及其批次版本。

訊息支援的事件類型：

  • 新訊息：google.workspace.chat.message.v1.created
  • 更新訊息：google.workspace.chat.message.v1.updated
  • 已刪除的訊息：google.workspace.chat.message.v1.deleted
  • 多則新訊息：google.workspace.chat.message.v1.batchCreated
  • 多則更新訊息：google.workspace.chat.message.v1.batchUpdated
  • 多則已刪除的訊息：google.workspace.chat.message.v1.batchDeleted

會員支援的事件類型：

  • 新會員方案：google.workspace.chat.membership.v1.created
  • 更新會員方案：google.workspace.chat.membership.v1.updated
  • 已刪除會員資格：google.workspace.chat.membership.v1.deleted
  • 多個新會籍：google.workspace.chat.membership.v1.batchCreated
  • 多個更新的會員方案：google.workspace.chat.membership.v1.batchUpdated
  • 已刪除多個會員方案：google.workspace.chat.membership.v1.batchDeleted

支援的回應事件類型：

  • 新回應：google.workspace.chat.reaction.v1.created
  • 已刪除的回應：google.workspace.chat.reaction.v1.deleted
  • 多種新回應：google.workspace.chat.reaction.v1.batchCreated
  • 已刪除多個回應：google.workspace.chat.reaction.v1.batchDeleted

支援的空間事件類型：

  • 更新空間：google.workspace.chat.space.v1.updated
  • 多個聊天室更新：google.workspace.chat.space.v1.batchUpdated

聯集欄位 payload。

payload 只能是下列其中一項：
message_created_event_data

MessageCreatedEventData

新訊息的事件酬載。

活動類型：google.workspace.chat.message.v1.created
message_updated_event_data

MessageUpdatedEventData

更新訊息的事件酬載。

活動類型：google.workspace.chat.message.v1.updated
message_deleted_event_data

MessageDeletedEventData

已刪除訊息的事件酬載。

活動類型：google.workspace.chat.message.v1.deleted
message_batch_created_event_data

MessageBatchCreatedEventData

多則新訊息的事件酬載。

活動類型：google.workspace.chat.message.v1.batchCreated
message_batch_updated_event_data

MessageBatchUpdatedEventData

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

活動類型：google.workspace.chat.message.v1.batchUpdated
message_batch_deleted_event_data

MessageBatchDeletedEventData

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

活動類型：google.workspace.chat.message.v1.batchDeleted
space_updated_event_data

SpaceUpdatedEventData

聊天室更新的事件酬載。

活動類型：google.workspace.chat.space.v1.updated
space_batch_updated_event_data

SpaceBatchUpdatedEventData

針對空間的多項更新事件酬載。

活動類型：google.workspace.chat.space.v1.batchUpdated
membership_created_event_data

MembershipCreatedEventData

新會籍的事件酬載。

活動類型：google.workspace.chat.membership.v1.created
membership_updated_event_data

MembershipUpdatedEventData

更新會員方案的事件酬載。

活動類型：google.workspace.chat.membership.v1.updated
membership_deleted_event_data

MembershipDeletedEventData

已刪除會員方案的事件酬載。

活動類型：google.workspace.chat.membership.v1.deleted
membership_batch_created_event_data

MembershipBatchCreatedEventData

多個新會員的事件酬載。

活動類型：google.workspace.chat.membership.v1.batchCreated
membership_batch_updated_event_data

MembershipBatchUpdatedEventData

多個更新會籍的事件酬載。

活動類型：google.workspace.chat.membership.v1.batchUpdated
membership_batch_deleted_event_data

MembershipBatchDeletedEventData

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

活動類型：google.workspace.chat.membership.v1.batchDeleted
reaction_created_event_data

ReactionCreatedEventData

新回應的事件酬載。

活動類型：google.workspace.chat.reaction.v1.created
reaction_deleted_event_data

ReactionDeletedEventData

已刪除回應的事件酬載。

活動類型：google.workspace.chat.reaction.v1.deleted
reaction_batch_created_event_data

ReactionBatchCreatedEventData

多個新回應的事件酬載。

活動類型：google.workspace.chat.reaction.v1.batchCreated
reaction_batch_deleted_event_data

ReactionBatchDeletedEventData

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

活動類型：google.workspace.chat.reaction.v1.batchDeleted

SpaceNotificationSetting

使用者在聊天室中的通知設定。

欄位
name

string

ID。聊天室通知設定的資源名稱。格式：users/{user}/spaces/{space}/spaceNotificationSetting。
notification_setting

NotificationSetting

通知設定。
mute_setting

MuteSetting

聊天室通知靜音設定。

MuteSetting

聊天室通知靜音設定類型。

列舉
MUTE_SETTING_UNSPECIFIED 保留。
UNMUTED 使用者會根據通知設定，接收空間的通知。
MUTED 無論通知設定為何，使用者都不會收到任何聊天室通知。

NotificationSetting

通知設定類型，日後可能會支援其他類型。

列舉
NOTIFICATION_SETTING_UNSPECIFIED 保留。
ALL 當有人使用 @號提及你、你追蹤的討論串有新內容，或是有人在新的討論串中張貼第一則訊息時，系統就會通知你。系統會自動追蹤所有新討論串，除非使用者手動取消追蹤。
MAIN_CONVERSATIONS 當有人使用 @號提及你、你追蹤的討論串有新內容，或是有人在新的討論串中張貼第一則訊息時，系統就會通知你。不適用於 1:1 即時訊息。
FOR_YOU 當有人使用 @號提及你，或你追蹤的討論串有新內容時，系統就會發送通知。不適用於 1:1 即時訊息。
OFF 通知已關閉。

SpaceReadState

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

欄位
name

string

聊天室讀取狀態的資源名稱。

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

Timestamp

(選用步驟) 使用者空間讀取狀態的更新時間。通常這會對應到最後讀取訊息的時間戳記，或是使用者指定的時間戳記，用來標示空間中最後讀取的位置。

SpaceUpdatedEventData

更新聊天室的事件酬載。

活動類型：google.workspace.chat.space.v1.updated

欄位
space

Space

更新後的聊天室。

SpaceView

這個檢視畫面會指定要在 Space 資源上填入哪些欄位。為確保與日後發布的版本相容，建議您的程式碼納入其他值。

列舉
SPACE_VIEW_UNSPECIFIED 預設 / 未設定值。
SPACE_VIEW_RESOURCE_NAME_ONLY 只會填入聊天室資源名稱。
SPACE_VIEW_EXPANDED 填入 Space 資源欄位。注意：系統不會填入 permissionSettings 欄位。指定 SPACE_VIEW_EXPANDED 的要求必須包含允許讀取聊天室資料的範圍，例如 https://www.googleapis.com/auth/chat.spaces 或 https://www.googleapis.com/auth/chat.spaces.readonly。

討論串

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

建立訊息時，如果指定了執行緒，可以設定 messageReplyOption 欄位，決定找不到相符執行緒時的處理方式。

欄位
name

string

ID。執行緒的資源名稱。

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

string

(選用步驟) 用於建立或更新執行緒的輸入內容。否則，請僅輸出。討論串的 ID。最多可輸入 4,000 個半形字元。

這個 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 管理員。

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

UpdateMessageRequest

要求更新訊息。

欄位
message

Message

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

FieldMask

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

目前支援的欄位路徑：
allow_missing

bool

(選用步驟) 如果系統找不到 true 和訊息，就會建立新訊息並忽略 updateMask。指定的訊息 ID 必須是用戶端指派，否則要求會失敗。

UpdateSpaceNotificationSettingRequest

要求更新聊天室通知設定。僅支援更新通話使用者的通知設定。

欄位
space_notification_setting

SpaceNotificationSetting

必要欄位。聊天室通知設定的資源名稱必須以 users/{user}/spaces/{space}/spaceNotificationSetting 格式填入。只會更新 update_mask 指定的欄位。
update_mask

FieldMask

必要欄位。支援的欄位路徑：

  • notification_setting

  • mute_setting

UpdateSpaceReadStateRequest

UpdateSpaceReadState API 的要求訊息。

欄位
space_read_state

SpaceReadState

必要欄位。要更新的聊天室讀取狀態和欄位。

僅支援更新呼叫使用者的讀取狀態。

如要參照呼叫使用者，請設定下列其中一項：

  • me 別名。例如 users/me/spaces/{space}/spaceReadState。

  • 他們的 Workspace 電子郵件地址。例如 users/user@example.com/spaces/{space}/spaceReadState。

  • 使用者 ID。例如 users/123456789/spaces/{space}/spaceReadState。

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

FieldMask

必要欄位。要更新的欄位路徑。目前支援的欄位路徑：

  • last_read_time

如果 last_read_time 早於最新訊息的建立時間，聊天室在使用者介面中就會顯示為未讀。

如要將空間標示為已讀，請將 last_read_time 設為大於最新訊息建立時間的值。系統會強制將 last_read_time 設為與最新訊息的建立時間一致。請注意，聊天室的已讀狀態只會影響聊天室頂層對話中顯示的訊息已讀狀態。討論串中的回覆不受這個時間戳記影響，而是依據討論串的讀取狀態。

UpdateSpaceRequest

更新單一空間的要求。

欄位
space

Space

必要欄位。要更新欄位的空間。Space.name 必須以 spaces/{space} 的形式填入。只會更新 update_mask 指定的欄位。
update_mask

FieldMask

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

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

space_details：更新聊天室的說明和規範。您必須在更新要求中以 SpaceDetails 形式傳遞說明和規範。如果只想更新其中一個欄位，請傳遞其他欄位的現有值。

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

space_type：僅支援將 GROUP_CHAT 空間類型變更為 SPACE。在更新遮罩中一併納入 display_name 和 space_type，並確保指定空間的顯示名稱不得為空值，且空間類型為 SPACE。如果現有空間已有 SPACE 類型，更新顯示名稱時，您可選擇是否要在指定空間中加入 space_type 遮罩和 SPACE 類型。如果嘗試以其他方式更新空間類型，會導致無效引數錯誤。「space_type」不支援「useAdminAccess」。

space_history_state：開啟或關閉聊天室記錄，即可更新聊天室記錄設定。只有在 Google Workspace 機構啟用記錄設定時，系統才會支援這項功能。如要更新空間記錄狀態，您必須在要求中省略所有其他欄位遮罩。「space_history_state」不支援「useAdminAccess」。

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

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

  • 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

(選用步驟) 時，這個方法會使用使用者的 Google Workspace 管理員權限執行。true

通話使用者必須是具備「管理即時通訊和聊天室對話」權限的 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 Person 設定檔 ID 代表的人相同。

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

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

string

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

string

使用者 Google Workspace 網域的專屬 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

方法名稱用於識別表單的哪個部分觸發表單提交作業。這項資訊會回傳至 Google 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