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

詳情請參閱授權指南。
CreateMessagePin

rpc CreateMessagePin(CreateMessagePinRequest) returns (MessagePin)

建立訊息釘選。

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

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

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

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

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

詳情請參閱授權指南。
CreateSection

rpc CreateSection(CreateSectionRequest) returns (Section)

在 Google Chat 建立區段。使用者可以透過區段將群組對話分組，並自訂 Chat 導覽面板中顯示的聊天室清單。只能建立 CUSTOM_SECTION 類型的區段。詳情請參閱「在 Google Chat 中建立及管理區段」。

需要使用者驗證，並具備授權範圍：

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

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。
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 群組。
  • 從聊天室移除 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

詳情請參閱授權指南。
DeleteMessagePin

rpc DeleteMessagePin(DeleteMessagePinRequest) returns (Empty)

刪除訊息固定。

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

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

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

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

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

詳情請參閱授權指南。
DeleteSection

rpc DeleteSection(DeleteSectionRequest) returns (Empty)

刪除 CUSTOM_SECTION 類型的區段。

如果該區段含有聊天室等項目，這些項目會移至 Google Chat 的預設區段，不會遭到刪除。

詳情請參閱「在 Google Chat 中建立及管理區段」。

需要使用者驗證，並具備授權範圍：

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

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。
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.users 中指定的使用者。系統只支援已加入對話的成員。如需範例，請參閱「尋找群組通訊」。

如果發出呼叫的使用者封鎖了某些使用者，或遭到某些使用者封鎖，且找不到包含所有指定使用者的聊天室，這個方法會傳回不含封鎖或封鎖使用者的聊天室。

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

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

  • 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)

取得郵件附件的中繼資料。系統會使用 Media API 擷取附件資料。如需範例，請參閱「取得郵件附件的中繼資料」。

需要應用程式驗證，並具備授權範圍：

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

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。
GetAvailability

rpc GetAvailability(GetAvailabilityRequest) returns (Availability)

傳回 Google Chat 中真人使用者的有空與否資訊。舉例來說，這項功能可用於檢查使用者是否在線上或不在座位上，或擷取他們的自訂狀態訊息。

這個方法只會擷取已驗證使用者的有空狀態。

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

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

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

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

詳情請參閱授權指南。
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.spaces.readonly
    • https://www.googleapis.com/auth/chat.app.messages.readonly
    • https://www.googleapis.com/auth/chat.app.memberships
    • https://www.googleapis.com/auth/chat.app.memberships.readonly

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

    • 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.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.app.spaces.readonly
  • https://www.googleapis.com/auth/chat.app.all.messages.readonly
  • https://www.googleapis.com/auth/chat.app.all.spaces.readonly
  • https://www.googleapis.com/auth/chat.app.all.memberships.readonly
  • 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

詳情請參閱授權指南。
ListMessagePins

rpc ListMessagePins(ListMessagePinsRequest) returns (ListMessagePinsResponse)

列出聊天室中的訊息釘選。使用者可以將重要訊息釘選在聊天室中，方便日後查看。詳情請參閱「在 Google Chat 中固定或取消固定對話」。

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

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

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

  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces.pins.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.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

詳情請參閱授權指南。
ListSectionItems

rpc ListSectionItems(ListSectionItemsRequest) returns (ListSectionItemsResponse)

列出某個區段中的項目。

只有聊天室可以做為區塊項目。詳情請參閱「在 Google Chat 中建立及管理區段」。

需要使用者驗證，並具備授權範圍：

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

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

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

詳情請參閱授權指南。
ListSections

rpc ListSections(ListSectionsRequest) returns (ListSectionsResponse)

列出 Chat 使用者可用的區段。使用者可以透過區段將對話分組，並自訂 Chat 導覽面板中顯示的聊天室清單。詳情請參閱「在 Google Chat 中建立及管理區段」。

需要使用者驗證，並具備授權範圍：

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

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

  • https://www.googleapis.com/auth/chat.users.sections
  • https://www.googleapis.com/auth/chat.users.sections.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.spaces.readonly
    • https://www.googleapis.com/auth/chat.app.messages.readonly
    • https://www.googleapis.com/auth/chat.app.memberships
    • https://www.googleapis.com/auth/chat.app.memberships.readonly

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

    • 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.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.app.spaces.readonly
  • https://www.googleapis.com/auth/chat.app.all.messages.readonly
  • https://www.googleapis.com/auth/chat.app.all.spaces.readonly
  • https://www.googleapis.com/auth/chat.app.all.memberships.readonly
  • 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 機構列出所有已命名的聊天室，請改用 spaces.search() 方法，並使用 Workspace 管理員權限。

授權範圍

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

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

詳情請參閱授權指南。
MarkAsActive

rpc MarkAsActive(MarkAsActiveRequest) returns (Availability)

在 Google Chat 中將使用者標示為ACTIVE。

將使用者的有空與否狀態設為 ACTIVE。ACTIVE 狀態會持續到指定到期日，屆時使用者的狀態會變成 AWAY。請注意，如果使用者正在使用 Chat，ACTIVE 狀態的持續時間可能會超過提供的到期時間。

這個方法只會更新已驗證使用者的有空狀態。

需要使用者驗證，並具備授權範圍：

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

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。
MarkAsAway

rpc MarkAsAway(MarkAsAwayRequest) returns (Availability)

在 Google Chat 中將使用者標示為AWAY。

將使用者的狀態設為「離開」，且不受使用者活動影響。

這個方法只會更新已驗證使用者的有空狀態。

需要使用者驗證，並具備授權範圍：

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

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。
MarkAsDoNotDisturb

rpc MarkAsDoNotDisturb(MarkAsDoNotDisturbRequest) returns (Availability)

在 Google Chat 中將使用者標示為DO_NOT_DISTURB。

將使用者的有空狀態設為 DO_NOT_DISTURB，直到指定到期時間為止。在DO_NOT_DISTURB模式下，使用者通常不會收到通知。

這個方法只會更新已驗證使用者的有空狀態。

需要使用者驗證，並具備授權範圍：

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

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。
MoveSectionItem

rpc MoveSectionItem(MoveSectionItemRequest) returns (MoveSectionItemResponse)

將項目從某個區段移至另一個區段。舉例來說，如果某個部分包含聊天室，您可以使用這個方法將聊天室移至其他部分。詳情請參閱「在 Google Chat 中建立及管理區段」。

需要使用者驗證，並具備授權範圍：

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

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。
PositionSection

rpc PositionSection(PositionSectionRequest) returns (PositionSectionResponse)

變更區塊的排列順序。詳情請參閱「在 Google Chat 中建立及管理區段」。

需要使用者驗證，並具備授權範圍：

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

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。
ReplaceMessageCards

rpc ReplaceMessageCards(ReplaceMessageCardsRequest) returns (ReplaceMessageCardsResponse)

取代訊息中的資訊卡。

只有在使用者建立的訊息已包含資訊卡，且資訊卡是由 Chat 應用程式建立時，Chat 應用程式才能取代資訊卡。

如果應用程式將卡片替換為空白清單，卡片就會移除。移除資訊卡後，應用程式無法將資訊卡加回訊息。

需要使用授權範圍進行應用程式驗證：- https://www.googleapis.com/auth/chat.bot

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。
SearchMessages

rpc SearchMessages(SearchMessagesRequest) returns (SearchMessagesResponse)

在 Google Chat 中搜尋呼叫使用者有權存取的訊息。傳回符合搜尋條件的訊息清單。

如要搜尋使用者有權存取的所有聊天室，請將 parent 設為 spaces/-。如果 parent 使用任何其他值，會導致 INVALID_ARGUMENT 錯誤。傳回的訊息會在其 name 欄位中填入完整資源名稱，其中包含訊息所在的特定 space。

這個 API 不會傳回所有訊息類型。回覆中不含下列類型的訊息。使用 ListMessages 列出所有訊息。

  • 只有通過驗證的使用者才能查看的私人訊息。
  • Chat 擴充應用程式在聊天室或群組通訊中張貼的訊息。
  • Chat 擴充應用程式即時訊息中的訊息。
  • 封鎖對象傳送的訊息。
  • 來電者已設為靜音的聊天室訊息。

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

  • 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

詳情請參閱授權指南。
SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

傳回 Google Workspace 機構中的聊天室清單。如需範例，請參閱「搜尋及管理聊天室」。

如果將 use_admin_access 設為 false，結果只會顯示呼叫使用者已加入的聊天室。如要使用管理員權限搜尋，請將 use_admin_access 設為 true。

支援下列驗證類型：

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

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

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

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

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

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • 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 組織中現有的聊天室可能已使用這個顯示名稱。

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

  • 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

詳情請參閱授權指南。
UpdateAvailability

rpc UpdateAvailability(UpdateAvailabilityRequest) returns (Availability)

更新人類使用者的有空與否資訊。這個方法只能更新 custom_status 欄位。

這個方法只會更新已驗證使用者的有空狀態。

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

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

需要下列 OAuth 範圍：

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

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

詳情請參閱授權指南。
UpdateSection

rpc UpdateSection(UpdateSectionRequest) returns (Section)

更新區段。只能更新 CUSTOM_SECTION 類型的部分。詳情請參閱「在 Google Chat 中建立及管理區段」。

需要使用者驗證，並具備授權範圍：

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

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。
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 Workspace 資源 (例如 Google 文件或試算表) 的方塊建立關聯，其中 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 為基準，包含 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 斜線指令。使用者在即時通訊訊息中傳送指令。
QUICK_COMMAND 快速指令。使用者從訊息回覆區的 Chat 選單中選取指令。
MESSAGE_ACTION 訊息動作。使用者在 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

僅供輸出。縮圖網址，用於向真人使用者預覽附件。Chat 擴充應用程式不應使用這個網址下載附件內容。
download_uri

string

僅供輸出。下載網址，用於讓真人使用者下載附件。Chat 擴充應用程式不應使用這個網址下載附件內容。
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

(選用步驟) 不透明權杖，包含上傳附件的參照。用戶端會將其視為不透明字串，並用於建立或更新含有附件的即時通訊訊息。

目標對象

Google Chat 中的目標對象。目標對象是指 Google Workspace 組織內的一群使用者，由管理員定義。目標對象可用來設定資源的存取權和瀏覽權限，例如讓特定使用者群組可搜尋到聊天室。

詳情請參閱「目標對象」和「讓目標對象可搜尋到聊天室」。

欄位
name

string

可搜尋或加入聊天室的目標對象資源名稱。詳情請參閱「讓目標對象可搜尋聊天室」。格式：audiences/{audience}

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

可用性

代表使用者在 Google Chat 中的目前狀態資訊，包括狀態 (例如「線上」、「離開」、「請勿打擾」) 和任何自訂狀態。

欄位
name

string

ID。使用者有空狀態的資源名稱。

格式：users/{user}/availability

{user} 是 People API 或 Admin SDK Directory API 中的使用者 ID。例如：users/123456789。

使用者的電子郵件地址或 me 也可以做為別名，用來指稱呼叫端。例如 users/user@example.com 或 users/me。
state

State

僅供輸出。使用者目前的空閒狀態。
custom_status

CustomStatus

(選用步驟) 使用者的自訂狀態。
聯集欄位 state_metadata。與使用者有空狀態相關聯的其他中繼資料。state_metadata 只能是下列其中一項：
do_not_disturb_metadata

DoNotDisturbMetadata

僅供輸出。使用者狀態設為 DO_NOT_DISTURB 時的中繼資料。

州

代表使用者目前的有空與否狀態。

列舉
STATE_UNSPECIFIED 預設值。未指定狀態。
ACTIVE 根據近期活動，使用者目前處於活躍狀態。
IDLE 使用者目前處於閒置狀態。這個狀態表示裝置在「運作中」後閒置了一段時間，可能即將轉換為「外出」。
AWAY 使用者目前不在。這項設定可在 ACTIVE 或 IDLE 狀態下閒置一段時間後自動設定，也可由使用者手動設定。透過 MarkAsAway 手動設定時，無論使用者活動為何，此狀態都會持續。
DO_NOT_DISTURB 使用者處於手動設定的「零打擾」狀態。

CalendarEventLinkData

日曆活動連結的資料。

欄位
calendar_id

string

連結日曆的日曆 ID。
event_id

string

連結日曆活動的事件 ID。

CardWithId

Google Chat 即時通訊訊息中的資訊卡。

Chat 擴充應用程式可透過應用程式驗證建立資訊卡。在開發人員預覽版計畫中，如果 Chat 應用程式以使用者身分驗證，就能建立資訊卡訊息。如果 Chat 擴充應用程式未加入開發人員預覽版計畫，就無法建立需要使用者驗證的資訊卡。

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

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

開啟資訊卡建立工具

欄位
card_id

string

如果訊息包含多張資訊卡，則為必填。訊息中資訊卡的專屬 ID。
card

Card

一張卡片。大小上限為 32 KB。
owner_user

User

僅供輸出。擁有資訊卡的應用程式。

ChatSpaceLinkData

Chat 聊天室連結的資料。

欄位
space

string

連結的 Chat 聊天室資源。

格式：spaces/{space}
thread

string

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

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

string

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

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

引用內容

引用內容是內嵌參考資料，可為使用者提供更詳細的資訊。訊息文字中應有對應的內文引用，並採用 <chat-citation data-id="{id}">{text}</chat-citation> 標記格式。只有在訊息的 markup_syntax 設為 MARKDOWN 時，才支援引用。

Elements.citations 中未參照的引用內容 (即郵件內文中沒有相符 <chat-citation> 標記的引用內容) 會遭到忽略，且不會導致郵件遭到拒絕。

欄位
id

string

必填。應用程式定義的 ID。只能使用 ASCII 字母和數字，且長度不得超過 63 個字元。
cited_sources[]

CitedSource

(選用步驟) 與引用內容相關的來源清單。來源會顯示在引用內容懸浮資訊卡中。

CitedSource

資訊來源的參考資料。

欄位
title

string

必填。CitedSource 的純文字標題。這個欄位不支援格式設定。
uri

string

必填。指向這個 CitedSource 參照資源的 URI。
snippet

Snippet

(選用步驟) 直接從來源擷取資訊的摘要。
footer

Footer

(選用步驟) 以頁尾形式與摘要一併顯示的額外資訊。

來源的頁尾，用於標示出處。

欄位
text

string

(選用步驟) 要在頁尾顯示的文字。

文字片段

代表較大語料庫摘錄內容的程式碼片段物件。

欄位
text

string

(選用步驟) 直接從語料庫擷取的簡短明文摘錄，可能會在即時通訊中顯示。不支援 Markdown 格式。
image_preview

ElementsImage

(選用步驟) 建立引用內容時，系統會根據輸入內容提供圖片預覽。

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 圓形邊框。

區段

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

欄位
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 中使用者的 id，或是 Directory API 中使用者的 id。舉例來說，如果 user@example.com 的 People API 個人資料 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

(選用步驟) 如果 true，系統會使用使用者的 Google Workspace 管理員權限執行方法。

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

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

管理員存取權不支援建立應用程式成員資格，或為管理員 Google Workspace 機構以外的使用者建立成員資格。

CreateMessageNotificationOptions

訊息發布時的通知行為選項。

欄位
notification_type

NotificationType

訊息的通知類型。

NotificationType

訊息的通知類型選項。

列舉
NOTIFICATION_TYPE_NONE 預設行為。通知行為與人類使用者透過 Chat UI 傳送訊息時類似：系統不會傳送通知給人類傳送者。
NOTIFICATION_TYPE_FORCE_NOTIFY

強制通知收件者。這會略過使用者的聊天室通知設定和 Chat 零打擾設定。這個選項不會略過裝置層級的「零打擾」設定。

需要應用程式驗證。
NOTIFICATION_TYPE_SILENT

不通知收件者，也不將郵件標示為未讀取。這與使用者將對話設為靜音或啟用 Chat 零打擾模式的效果類似。

需要應用程式驗證。

CreateMessagePinRequest

建立訊息 PIN 碼的要求訊息。

欄位
parent

string

必填。要建立訊息釘選的上層聊天室。格式：spaces/{space}
message_pin

MessagePin

必填。要建立的 MessagePin。

CreateMessageRequest

建立訊息。

欄位
parent

string

必填。要建立訊息的聊天室資源名稱。

格式：spaces/{space}
message

Message

必填。郵件內文。
thread_key
(deprecated)

string

(選用步驟) 已淘汰：請改用 thread.thread_key。討論串的 ID。最多可輸入 4000 個半形字元。如要發起或加入討論串，請建立訊息並指定 threadKey 或 thread.name。如需使用範例，請參閱「發起或回覆訊息討論串」。
request_id

string

(選用步驟) 這項要求的專屬 ID。建議使用隨機 UUID。指定要求 ID 可讓要求具有冪等性，確保具有相同要求 ID 的多個相同要求只會建立一則訊息。如果後續要求使用相同 ID，系統會傳回現有訊息，不會更新訊息，即使要求詳細資料與目前狀態不同也一樣。

如要有效使用這個欄位，請按照下列指示操作：

  • 請確保後續要求與原始要求相同，並使用相同的驗證憑證。
  • 如果已使用提供的要求 ID 建立訊息，要求會傳回該訊息。請注意，傳回的訊息可能不完整；API 會在要求中回應訊息，並填入系統指派的資源名稱。如要擷取訊息的最新中繼資料，請呼叫 GetMessage。
  • 如果重複使用現有要求 ID，但驗證的使用者不同，就會發生錯誤。
message_reply_option

MessageReplyOption

(選用步驟) 指定訊息是要發起討論串，還是回覆討論串。僅支援已命名的聊天室。

回應使用者互動時，系統會忽略這個欄位。如果是在討論串中互動，回覆會建立在同一個討論串中。否則，系統會將回覆建立為新討論串。
message_id

string

(選用步驟) 訊息的自訂 ID。允許 Chat 擴充應用程式取得、更新或刪除訊息，不需將系統指派的 ID 儲存在訊息的資源名稱 (以訊息 name 欄位表示)。

這個欄位的值必須符合下列規定：

  • 開頭為 client-。舉例來說，client-custom-name 是有效的自訂 ID，但 custom-name 不是。
  • 長度最多 63 個字元，只能使用小寫英文字母、數字和連字號。
  • 在聊天室中不得重複。Chat 擴充應用程式無法為不同訊息使用相同的自訂 ID。

詳情請參閱「為訊息命名」。
create_message_notification_options

CreateMessageNotificationOptions

(選用步驟) 控制訊息發布時的通知行為。詳情請參閱「強制顯示通知或傳送靜音訊息」。

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

必填。要建立的回應。

CreateSectionRequest

建立章節的要求訊息。

欄位
parent

string

必填。建立區段的父項資源名稱。

格式：users/{user}
section

Section

必填。要建立的區段。

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 的相同要求只會建立一個聊天室。如果後續要求使用相同 ID，系統會傳回現有聊天室，不會更新聊天室，即使要求詳細資料與目前狀態不同也一樣。

如要有效使用這個欄位，請按照下列指示操作：

  • 請確保後續要求與原始要求相同，並使用相同的驗證憑證。
  • 如果已使用提供的要求 ID 建立聊天室，要求會傳回該聊天室。請注意，傳回的聊天室可能不完整；API 會在要求中回傳聊天室，並填入系統指派的資源名稱。如要擷取聊天室的最新中繼資料，請呼叫 GetSpace。
  • 如果重複使用現有要求 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

自訂表情符號。

CustomStatus

代表使用者在 Google Chat 中的自訂狀態。包括使用者設定的簡短文字訊息和選用表情符號，可提供更多有關其空檔的背景資訊。

欄位
text

string

必填。自訂狀態的文字。這會是長度不超過 64 的字串。
emoji

Emoji

必填。自訂狀態的表情符號。僅支援 Unicode 表情符號，不支援自訂表情符號。
聯集欄位 expiration。自訂狀態的到期時間。您可以指定絕對時間戳記或存留時間長度。expiration 只能是下列其中一項：
expire_time

Timestamp

自訂狀態到期的時間戳記。
ttl

Duration

僅限輸入。自訂狀態的存留時間。

DeleteCustomEmojiRequest

要求刪除自訂表情符號。

欄位
name

string

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

格式：customEmojis/{customEmoji}

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

DeleteMembershipRequest

要求刪除聊天室成員。

欄位
name

string

必填。要刪除的成員資格資源名稱。Chat 擴充應用程式可以刪除真人使用者或自己的成員資格。Chat 擴充應用程式無法刪除其他應用程式的成員資格。

刪除真人成員時，必須使用使用者驗證和 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

(選用步驟) 如果 true，系統會使用使用者的 Google Workspace 管理員權限執行方法。

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

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

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

DeleteMessagePinRequest

刪除訊息 PIN 碼的要求訊息。

欄位
name

string

必填。要移除的訊息釘選資源名稱，格式：spaces/{space}/messagePins/{message_pin}

DeleteMessageRequest

要求刪除訊息。

欄位
name

string

必填。訊息的資源名稱。

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

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

bool

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

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

DeleteReactionRequest

刪除訊息的回應。

欄位
name

string

必填。要刪除的回應名稱。

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

DeleteSectionRequest

刪除區段的要求訊息。

欄位
name

string

必填。要刪除的區段名稱。

格式：users/{user}/sections/{section}

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

刪除訊息的使用者和刪除方式。日後可能會新增更多值。如要瞭解何時可以刪除訊息，請參閱「編輯或刪除 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

僅限輸入。要求的對話。

DoNotDisturbMetadata

與 DO_NOT_DISTURB 可用性狀態相關聯的中繼資料，指定狀態何時到期。

欄位
expiration_time

Timestamp

僅供輸出。使用者應標示為 DO_NOT_DISTURB 的時間戳記。最多可設為未來 1 年。

DriveDataRef

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

欄位
drive_file_id

string

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

DriveLinkData

Google 雲端硬碟連結的資料。

欄位
drive_data_ref

DriveDataRef

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

string

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

元素

元素是額外元件，不一定與建立訊息時提供的訊息文字相關聯。

欄位
cited_sources[]

CitedSource

在訊息下方顯示為頁尾連結的來源清單。這些不會內嵌參照。如要使用內嵌參考資料，請使用 citations。
citations[]

Citation

訊息文字中引用的內嵌引用清單 (透過 <chat-citation> 標記)，會顯示為互動式懸浮資訊卡。

ElementsImage

這個物件會封裝圖片的不同表示方式。目前支援的表示法：- 從 URI 擷取的圖片。日後可能會支援其他表示法。

欄位
聯集欄位 image。必填。其中一種支援的圖片表示法。image 只能是下列其中一項：
image_uri

string

必填。可公開存取的圖片 URI。

表情符號

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

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

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

欄位
users[]

string

(選用步驟) 與通話使用者進行群組通訊的所有真人使用者資源名稱。要求中不得包含 Chat 擴充應用程式。

單一要求中可指定的使用者人數上限為 49。

格式：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 使用者的電子郵件地址。
page_size

int32

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

如未指定，最多會傳回 10 個聊天室。

值的上限為 30。如果輸入的值大於 30，系統會自動變更為 30。

如果輸入負值，則會傳回 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 傳送的權杖，用於擷取下一頁結果。如果這個欄位留空，表示沒有後續網頁。

ForwardedMetadata

訊息轉寄來源聊天室的中繼資料。

欄位
space

string

僅供輸出。來源聊天室的資源名稱。格式：spaces/{space}
space_display_name

string

僅供輸出。轉寄時來源聊天室或即時訊息的顯示名稱。如果是 SPACE，這會是聊天室名稱。如果是DIRECT_MESSAGE，則為其他參與者的名稱 (例如「使用者 A」)。GROUP_CHAT：系統會根據成員的名字生成名稱，最多 5 個 (包括創作者)，例如「使用者 A、使用者 B」。

GetAttachmentRequest

要求取得附件。

欄位
name

string

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

GetAvailabilityRequest

GetAvailability 方法的要求訊息。

欄位
name

string

必填。要擷取的供應情形資源名稱。

格式：users/{user}/availability

{user} 是 People API 或 Admin SDK Directory API 中的使用者 ID。例如：users/123456789。

使用者的電子郵件地址或 me 也可以做為別名，用來指稱呼叫端。例如 users/user@example.com 或 users/me。

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}。詳情請參閱「為訊息命名」。
markup_syntax

MarkupSyntax

(選用步驟) 指定即時通訊訊息 formatted_text 欄位的輸出語法。

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

(選用步驟) 如果 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 的值會變更為 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

(選用步驟) 如果 true，系統會使用使用者的 Google Workspace 管理員權限執行方法。

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

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

使用管理員存取權時，無法列出聊天室中的應用程式成員。

ListMembershipsResponse

列出聊天室成員資格的回應。

欄位
memberships[]

Membership

未排序的清單。所要求 (或第一個) 頁面中的成員資格清單。
next_page_token

string

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

ListMessagePinsRequest

列出訊息圖釘的要求訊息。

欄位
parent

string

必填。擁有固定項目集合的父項聊天室，格式：spaces/{space}
page_size

int32

(選用步驟) 傳回的訊息圖釘數量上限。服務傳回的訊息數量可能會少於這個值。最大值為 100。如果輸入的值大於 100，系統會自動變更為 100。如未指定，最多會傳回 100 個訊息圖釘。如果輸入負值，則會傳回 INVALID_ARGUMENT 錯誤。
page_token

string

(選用步驟) 從先前 list message pins 呼叫收到的頁面權杖。提供這項參數即可擷取後續網頁。

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

ListMessagePinsResponse

列出訊息圖釘的回應訊息。

欄位
message_pins[]

MessagePin

指定聊天室中的置頂訊息。
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) 篩選訊息。

如要依建立日期篩選訊息，請以 RFC-3339 格式指定 create_time，並加上時間戳記和雙引號。例如 "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

(選用步驟) 是否要包含已刪除的訊息。已刪除的訊息會包含刪除時間和刪除相關中繼資料，但無法查看訊息內容。
markup_syntax

MarkupSyntax

(選用步驟) 指定即時通訊訊息 formatted_text 欄位的輸出語法。

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

用於擷取下一頁結果的接續權杖。如果是最後一頁結果，則會留空。

ListSectionItemsRequest

列出區段項目的要求訊息。

欄位
parent

string

必填。父項，即擁有這個專區項目集合的專區資源名稱。僅支援列出呼叫使用者的區段項目。

依聊天室篩選時，請使用萬用字元 - 搜尋所有部分。例如：users/{user}/sections/-。

格式：users/{user}/sections/{section}
page_size

int32

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

如未指定，最多會傳回 10 個專區項目。

最大值為 100。如果輸入的值大於 100，系統會自動變更為 100。

如果輸入負值，則會傳回 INVALID_ARGUMENT 錯誤。
page_token

string

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

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

string

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

目前僅支援依聊天室篩選。

例如 space = spaces/{space}。

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

ListSectionItemsResponse

列出區段項目的回應訊息。

欄位
section_items[]

SectionItem

指定版面中的版面項目。
next_page_token

string

可做為 page_token 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。

ListSectionsRequest

列出區段的要求訊息。

欄位
parent

string

必填。父項，即擁有這個區段集合的使用者資源名稱。僅支援列出呼叫使用者的區段。如要參照呼叫使用者，請設定下列其中一項：

  • me 別名。例如：users/me。

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

  • 使用者 ID。例如 users/123456789。

格式：users/{user}
page_size

int32

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

如未指定，最多會傳回 10 個部分。

最大值為 100。如果輸入的值大於 100，系統會自動變更為 100。

如果輸入負值，則會傳回 INVALID_ARGUMENT 錯誤。
page_token

string

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

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

ListSectionsResponse

列出區段的回應訊息。

欄位
sections[]

Section

指定使用者的區段。
next_page_token

string

可做為 page_token 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。

ListSpaceEventsRequest

列出聊天室事件的要求訊息。

欄位
parent

string

必填。事件發生所在的 Google Chat 聊天室資源名稱。

格式：spaces/{space}。
page_size

int32

(選用步驟) 傳回的聊天室事件數量上限。服務傳回的產品數量可能會少於這個值。

如果輸入負值，則會傳回 INVALID_ARGUMENT 錯誤。
page_token

string

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

進行分頁時，提供至 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 spaces 呼叫的網頁權杖。提供這項參數即可擷取後續網頁。

進行分頁時，篩選器值應與提供網頁權杖的呼叫相符。傳遞其他值可能會導致非預期的結果。
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 傳送，擷取下一頁結果。如果這個欄位留空，表示沒有後續網頁。

MarkAsActiveRequest

MarkAsActive 方法的要求訊息。

欄位
name

string

必填。要標示為有效的供應情形資源名稱。格式：users/{user}/availability

{user} 是 People API 或 Admin SDK Directory API 中的使用者 ID。例如：users/123456789。

使用者的電子郵件地址或 me 也可以做為別名，用來指稱呼叫端。例如 users/user@example.com 或 users/me。
聯集欄位 expiration。「有效」可用性狀態的到期時間。到期後，系統會將使用者標示為「不在位置上」。如未提供到期時間，ACTIVE 狀態會在目前時間的 30 分鐘後到期。expiration 只能是下列其中一項：
expire_time

Timestamp

ACTIVE 狀態到期的絕對時間戳記。
ttl

Duration

從目前時間到 ACTIVE 狀態到期的時間長度。使用較短的存留時間，可有效重設使用者狀態，在短暫時間後根據活動進行調整。

MarkAsAwayRequest

MarkAsAway 方法的要求訊息。

欄位
name

string

必填。要標示為不在辦公室的空檔資源名稱。格式：users/{user}/availability

{user} 是 People API 或 Admin SDK Directory API 中的使用者 ID。例如：users/123456789。

使用者的電子郵件地址或 me 也可以做為別名，用來指稱呼叫端。例如 users/user@example.com 或 users/me。

MarkAsDoNotDisturbRequest

MarkAsDoNotDisturb 方法的要求訊息。

欄位
name

string

必填。要標示為「零打擾」的有空狀態資源名稱。格式：users/{user}/availability

{user} 是 People API 或 Admin SDK Directory API 中的使用者 ID。例如：users/123456789。

使用者的電子郵件地址或 me 也可以做為別名，用來指稱呼叫端。例如 users/user@example.com 或 users/me。
聯集欄位 expiration。必填。「零干擾」可用狀態的到期時間。到期後，系統會將使用者標示為「不在位置上」。最多可設為從目前時間算起 1 年。expiration 只能是下列其中一項：
expire_time

Timestamp

勿擾模式到期的絕對時間戳記。
ttl

Duration

從目前時間到零干擾狀態到期的時間長度。

MarkupSyntax

指定用於設定即時通訊訊息文字格式的標記語法。適用於 Message 資源的 text 欄位。

列舉
MARKUP_SYNTAX_UNSPECIFIED 代表未指定的值。
MARKUP_SYNTAX_CHAT 使用 Google Chat 的標記語法。詳情請參閱 https://developers.google.com/workspace/chat/format-messages#format-texts。
MARKUP_SYNTAX_MARKDOWN 使用 Markdown 語法。這個語法是以 CommonMark 規格為基礎，並提供額外擴充功能。詳情請參閱 https://developers.google.com/workspace/chat/format-messages#format-texts。

MatchedUrl

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

欄位
url

string

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

MeetSpaceLinkData

Meet 會議室連結的資料。

欄位
meeting_code

string

連結的 Meet 會議室會議代碼。
type

Type

指出 Meet 會議空間的類型。
huddle_status

HuddleStatus

(選用步驟) 僅供輸出。如果 Meet 是群組通話，則會指出群組通話的狀態。否則，此值為未設定。

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

(選用步驟) 不可變動。成員資格的刪除時間，例如成員離開或從聊天室中移除的時間。這個欄位僅供輸出，除非用於在匯入模式聊天室中匯入歷來成員。
affiliation

Affiliation

僅供輸出。使用者與擁有聊天室的 Workspace 機構之間的關係。在個人帳戶擁有的聊天室中，所有成員的隸屬關係都是EXTERNAL。
聯集欄位 memberType。與這項會籍相關聯的會員。日後可能會支援其他成員類型。memberType 只能是下列其中一項：
member

User

(選用步驟) 成員資格對應的 Google Chat 使用者或應用程式。如果 Chat 應用程式以使用者身分驗證，輸出內容只會填入內部和外部使用者的使用者 name 和 type 欄位，除非他們是聊天室成員，或與呼叫使用者有先前的關係，例如即時訊息 (DM) 對話。
group_member

Group

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

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

聯盟

代表使用者與擁有聊天室的 Google Workspace 機構之間的關係。這個列舉日後可能會新增更多值。

列舉
AFFILIATION_UNSPECIFIED 預設值。這個值不會用到。
INTERNAL 由擁有聊天室的 Google Workspace 組織管理的帳戶。
EXTERNAL 不屬於擁有聊天室的 Google Workspace 組織的帳戶 (例如個人帳戶，或由其他 Workspace 組織管理的帳戶)。
MANAGED_EXTERNAL 由擁有聊天室的 Workspace 組織管理，但佈建給組織外部使用者的帳戶 (例如訪客使用者)。如要進一步瞭解訪客，請參閱 https://support.google.com/chat/answer/16997417。

MembershipRole

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

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

聊天室成員。在 Chat UI 中，這個角色稱為「成員」。

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

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

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

聊天室擁有者。在 Chat UI 中，這個角色稱為「擁有者」。

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

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

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

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

聊天室管理員。在 Chat UI 中，這個角色稱為「管理員」。

使用者擁有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，則可使用這個 ID 在要求中指定訊息，方法是將 {message} 替換為 clientAssignedMessageId 欄位中的值。例如 spaces/AAAAAAAAAAA/messages/client-custom-name。詳情請參閱「為訊息命名」。
sender

User

僅供輸出。建立訊息的使用者。如果 Chat 應用程式以使用者身分驗證，輸出內容只會填入內部和外部使用者的使用者 name 和 type 欄位，除非他們是聊天室成員，或與呼叫使用者有先前的關係，例如即時訊息 (DM) 對話。
create_time

Timestamp

(選用步驟) 不可變動。在 Chat 中建立的聊天室，訊息建立時間。這個欄位僅供輸出，除非用於匯入模式聊天室。

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

Timestamp

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

Timestamp

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

string

(選用步驟) 郵件的純文字內文。第一個指向圖片、影片或網頁的連結會產生預覽方塊。您也可以使用@號提及 Google Chat 使用者，或聊天室中的所有人。

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

string

僅供輸出。包含訊息 text，並加入標記來傳達格式。這個欄位可能不會擷取使用者介面中顯示的所有格式，但會包含下列項目：

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

  • 使用者提及，格式為 <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 擴充應用程式可透過應用程式驗證建立資訊卡。在開發人員預覽版計畫中，如果 Chat 應用程式以使用者身分驗證，就能建立資訊卡訊息。如果 Chat 擴充應用程式未加入開發人員預覽版計畫，就無法建立需要使用者驗證的資訊卡。

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

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

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

Annotation

僅供輸出。註解可以與郵件的純文字內文建立關聯，也可以與連結至 Google Workspace 資源 (例如 Google 文件或試算表) 的方塊建立關聯，其中 start_index 和 length 為 0。
thread

Thread

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

Space

僅供輸出。如果 Chat 應用程式以使用者身分驗證，輸出內容只會填入聊天室 name。
fallback_text

string

(選用步驟) 訊息資訊卡的純文字說明，在無法顯示實際資訊卡時使用，例如行動裝置通知。
action_response

ActionResponse

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

string

僅供輸出。訊息的純文字內文，已移除所有 Chat 擴充應用程式提及內容。
slash_command

SlashCommand

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

Attachment

(選用步驟) 使用者上傳的附件。
matched_url

MatchedUrl

僅供輸出。即時通訊訊息 text 欄位中的網址符合連結預覽模式。詳情請參閱「預覽連結」。
thread_reply

bool

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

如果聊天室不支援討論串回覆，這個欄位一律為 false。
silent

bool

僅供輸出。這是否為靜音訊息。靜音訊息是指 Chat 不會向收件者傳送推播通知的訊息。
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

(選用步驟) 一或多個互動式小工具，會顯示在訊息底部。您可以將附屬小工具新增至包含文字、資訊卡或兩者的訊息。不支援含有對話方塊的訊息。詳情請參閱「在訊息底部新增互動式小工具」。

如要建立含有附屬小工具的訊息，必須驗證應用程式。
elements

Elements

(選用步驟) 元素是建立訊息時提供的額外元件，不一定與訊息文字的特定部分相關聯。這與註解不同，註解僅供輸出，並提供與訊息片段或整個訊息文字相關的補充資訊。
markup_syntax

MarkupSyntax

(選用步驟) 指定伺服器如何解讀訊息 text 欄位內容。

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 欄位。

MessagePin

即時通訊訊息上的圖釘。詳情請參閱「置頂訊息」。

欄位
name

string

ID。訊息圖釘的資源名稱。格式：spaces/{space}/messagePins/{message_pin} 資源 ID 元件與訊息的資源 ID 元件相符。舉例來說，spaces/AAA/messages/bbb.ccc 的訊息對應到資源名稱為 spaces/AAA/messagePins/bbb.ccc 的訊息圖釘。
message

string

必填。不可變動。置頂訊息的資源名稱。格式：spaces/{space}/messages/{message}

MessageUpdatedEventData

更新訊息的事件酬載。

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

欄位
message

Message

更新後的訊息。

MoveSectionItemRequest

要求訊息，用於跨區段移動區段項目。

欄位
name

string

必填。要移動的區段項目資源名稱。

格式：users/{user}/sections/{section}/items/{item}
target_section

string

必填。要將區段項目移至哪個區段，請提供該區段的資源名稱。

格式：users/{user}/sections/{section}

MoveSectionItemResponse

移動區段項目的回應訊息。

欄位
section_item

SectionItem

更新後的區段項目。

PositionSectionRequest

要求訊息，用於定位區段。

欄位
name

string

必填。要定位的區段資源名稱。

格式：users/{user}/sections/{section}
聯集欄位 position。必填。章節的新位置。position 只能是下列其中一項：
sort_order

int32

(選用步驟) 區段在區段清單中的絕對位置。位置必須大於 0。如果位置大於區段數量，系統會將區段附加至清單結尾。這項作業會在指定位置插入區段，並將該位置的原有區段和其下方的區段移至下一個位置。
relative_position

Position

(選用步驟) 區段在區段清單中的相對位置。

位置

環節的位置。

列舉
POSITION_UNSPECIFIED 未指定位置。
START 各節清單的開頭。
END 各節清單結尾。

PositionSectionResponse

定位區段的回應訊息。

欄位
section

Section

更新後的區段。

QuotedMessageMetadata

另一則訊息引用的訊息相關資訊。

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

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

欄位
name

string

必填。引用訊息的資源名稱。

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

Timestamp

必填。引用訊息的建立時間或上次更新時間。

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

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

QuoteType

(選用步驟) 指定報價類型。如未設定，訊息讀取/寫入路徑預設為 REPLY，以確保回溯相容性。
quoted_message_snapshot

QuotedMessageSnapshot

僅供輸出。引用訊息內容的快照。
forwarded_metadata

ForwardedMetadata

僅供輸出。引用訊息來源聊天室的中繼資料。僅在 FORWARD 報價類型中填入。

QuoteType

引用訊息的引用類型。

列舉
QUOTE_TYPE_UNSPECIFIED Reserved. 這個值不會用到。
REPLY

當 quote_type 為 REPLY 時，您可以執行下列操作：

  • 在討論串中回覆時，可以引用該討論串中的其他訊息。

  • 建立根訊息時，可以引用該聊天室中的其他根訊息。
FORWARD

當 quote_type 為 FORWARD 時，您可以引用：

  • 來自其他聊天室的訊息。

  • 同一聊天室中不同討論串的訊息回覆。

QuotedMessageSnapshot

提供引用或轉寄時，引用訊息內容的快照

欄位
sender

string

僅供輸出。引用訊息的作者名稱。系統會為「REPLY」和「FORWARD」這兩種引用類型填入這個值。
text

string

僅供輸出。引用訊息的文字內容快照。
formatted_text

string

僅供輸出。包含引用的訊息 text，並加上標記，支援超連結、自訂表情符號、標記等 RTF 格式。只有在引用類型為 FORWARD 時，才會填入這個欄位。
annotations[]

Annotation

僅供輸出。從引用訊息內文剖析出的註解。僅在 FORWARD 報價類型中填入。
attachments[]

Attachment

僅供輸出。引用郵件中的附件。這些是引用郵件附件中繼資料的副本。僅在 FORWARD 報價類型中填入。

回應

對訊息的回應。

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

已刪除的回應。

ReplaceMessageCardsRequest

ReplaceMessageCards API 方法的要求訊息。

欄位
name

string

必填。訊息的資源名稱。

格式：spaces/{space}/messages/{message}
cards_v2[]

CardWithId

(選用步驟) 要加入訊息的資訊卡陣列。這些資訊卡會取代訊息現有的資訊卡。如果留空，系統會清除訊息中的原始資訊卡。

ReplaceMessageCardsResponse

這個類型沒有任何欄位。

ReplaceMessageCards API 的回應訊息。

RichLinkMetadata

資源的豐富連結。豐富連結可與訊息的純文字內文建立關聯，或代表連結至 Google Workspace 資源 (例如 Google 文件或試算表) 的方塊，其中 start_index 和 length 為 0。

欄位
uri

string

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

RichLinkType

RTF 連結類型。日後可能會新增更多類型。

列舉
DRIVE_FILE Google 雲端硬碟豐富連結類型。
CHAT_SPACE Chat 聊天室多媒體連結類型。例如聊天室智慧型方塊。
GMAIL_MESSAGE Gmail 郵件多媒體連結類型。具體來說，就是「分享到 Chat」中的 Gmail 晶片。這個 API 僅支援讀取含有 GMAIL_MESSAGE 複合式連結的訊息。
MEET_SPACE Meet 訊息多媒體連結類型。例如 Meet 晶片。
CALENDAR_EVENT 日曆訊息複合式連結類型。例如「日曆」方塊。

SearchMessageResult

訊息搜尋結果中的單一項目。

欄位
message

Message

相符的訊息。
space_mute_setting

MuteSetting

呼叫使用者在訊息張貼聊天室中的靜音設定。呼叫端應用程式可根據使用者是否將聊天室設為靜音，決定如何處理訊息。

只有在要求檢視畫面為 SEARCH_MESSAGES_VIEW_FULL，且呼叫憑證包含下列授權範圍時，系統才會傳回：

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

bool

指出呼叫使用者是否已讀取相符的訊息。

只有在要求檢視畫面為 SEARCH_MESSAGES_VIEW_FULL，且呼叫憑證包含下列其中一個授權範圍時，系統才會傳回：

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

SearchMessagesRequest

搜尋訊息的要求訊息。

欄位
parent

string

必填。要搜尋的聊天室資源名稱。

如要搜尋使用者有權存取的所有聊天室，請將這個欄位設為 spaces/-。如果 parent 使用任何其他值，會導致 INVALID_ARGUMENT 錯誤。

如要將搜尋範圍限制在一或多個聊天室，請在 filter 中使用 space.name 或 space.display_name。
filter

string

必填。搜尋查詢。

查詢可以指定一或多個搜尋關鍵字，用於篩選結果，

您也可以使用下列訊息欄位篩選結果：

  • create_time：接受 RFC-3339 格式的時間戳記，支援的比較運算子為 < 和 >=。
  • sender.name：寄件者的資源名稱 (users/{user})。僅支援 =。你可以將這個電子郵件地址做為 {user} 的別名。例如 users/example@gmail.com，其中 example@gmail.com 是 Google Chat 使用者的電子郵件地址。
  • space.name：訊息張貼所在聊天室的資源名稱。(spaces/{space})。僅支援 =。如未設定這項篩選條件，系統會搜尋使用者以聊天室成員身分，有權存取的所有即時訊息和聊天室。
  • space.display_name：支援運算子 : (包含)，並根據顯示名稱的部分相符項目篩選聊天室。結果最多只會顯示前五個相符的聊天室。舉例來說，space.display_name:Project 會在顯示名稱含有「Project」一詞的前五個聊天室中搜尋訊息。
  • space.space_type：聊天室類型。僅支援「=」。例如，space.space_type="DIRECT_MESSAGE" 只會傳回即時訊息。可能的值為 DIRECT_MESSAGE、GROUP_CHAT 和 SPACE。
  • attachment：支援運算子 :* (包含任何)，可用於檢查是否有附件。如果指定 attachment:*，系統只會傳回至少有一個附件的訊息。
  • annotations.user_mentions.user.name：提及使用者的資源名稱 (users/{user})。僅支援 : (有)。例如：annotations.user_mentions.user.name:"users/1234567890" 只會傳回提及指定使用者的訊息。或者，您也可以使用別名 me 篩選提及呼叫端使用者的訊息，例如：annotations.user_mentions.user.name:users/me。您也可以將電子郵件地址做為 {user} 的別名，例如 users/example@gmail.com。

如需進階篩選，也可以使用下列函式：

  • has_link()：只傳回郵件內文中至少有一個超連結的郵件。
  • is_unread()：篩除呼叫使用者已讀取的訊息。

如要使用 space.display_name 或 space.space_type 篩選器，呼叫憑證必須包含下列其中一個授權範圍：

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

如要使用 is_unread() 篩選器，呼叫憑證必須包含下列其中一個授權範圍：

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

不同欄位之間僅支援 AND 運算子。有效範例為 sender.name = "users/1234567890" AND is_unread()。AND 這個字詞為選用，如果省略，則會隱含。例如，sender.name = "users/1234567890" is_unread() 是有效值，且等同於前一個範例。sender.name = "users/1234567890" OR is_unread() 是無效範例，因為不同欄位之間不支援 OR。

在相同領域中：

  • create_time 僅支援 AND，且只能用於表示時間間隔，例如 create_time >= "2022-01-01T00:00:00+00:00" AND create_time < "2023-01-01T00:00:00+00:00"。
  • sender.name 僅支援 OR 運算子，例如：sender.name = "users/1234567890" OR sender.name = "users/0987654321"。
  • space.name 僅支援 OR 運算子，例如：space.name = "spaces/ABCDEFGH" OR space.name = "spaces/QWERTYUI"。
  • space.display_name 支援 AND 和 OR 運算子，但不能混用。例如：space.display_name:Project AND space.display_name:Tasks 會傳回聊天室顯示名稱同時包含 Project 和 Tasks 的訊息，而 space.display_name:Project OR space.display_name:Tasks 則會傳回聊天室顯示名稱包含 Project 或 Tasks (或兩者皆有) 的訊息。
  • space.space_type 僅支援 OR 運算子，例如：space.space_type = "DIRECT_MESSAGE" OR space.space_type = "GROUP_CHAT"。
  • annotations.user_mentions.user.name 支援 AND 和 OR 運算子，但不能混用。例如：annotations.user_mentions.user.name:"users/1234567890" AND annotations.user_mentions.user.name:"users/0987654321" 只會傳回提及這兩位使用者的訊息，而 annotations.user_mentions.user.name:"users/1234567890" OR annotations.user_mentions.user.name:"users/0987654321" 則會傳回提及其中一位或兩位使用者的訊息。

在同一查詢中合併 AND 和 OR 運算子時，必須使用括號來釐清運算子優先順序。例如：(sender.name="users/me" OR sender.name="users/123456") AND is_unread()。否則，括號為選用。

以下是有效的查詢範例：

"Pending reports" AND create_time >= "2023-01-01T00:00:00Z"

sender.name = "users/example@gmail.com"

annotations.user_mentions.user.name:"users/0987654321"

attachment:* AND space.name = "spaces/ABCDEFGH"

tasks AND is_unread() AND sender.name = "users/1234567890"

"things to do" "urgent"

(sender.name = "users/1234567890")
AND (create_time < "2023-05-01T00:00:00Z")

tasks AND space.name = "spaces/ABCDEFGH" AND has_link()

"project one" is_unread()

space.display_name:Project tasks

查詢長度上限為 1,000 個字元。

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

int32

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

如未指定，最多會傳回 25 個。

最大值為 100。如果輸入的值大於 100，系統會自動變更為 100。
page_token

string

(選用步驟) 接收自前一個搜尋訊息呼叫的權杖。提供這項參數即可擷取後續網頁。

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

string

(選用步驟) 結果清單的排序方式。

支援的排序屬性如下：

預設排序為 create_time desc。每項查詢僅支援單一順序 (create_time 或 relevance)。僅支援遞減順序 (desc)，且必須在 order 屬性後方指定。
markup_syntax

MarkupSyntax

(選用步驟) 指定即時通訊訊息 formatted_text 欄位的輸出語法。
view

SearchMessagesView

(選用步驟) 指定要傳回的搜尋結果檢視畫面類型。預設為 SEARCH_MESSAGES_VIEW_BASIC。

SearchMessagesView

部分搜尋結果支援的檢視畫面類型。

列舉
SEARCH_MESSAGES_VIEW_UNSPECIFIED 預設 / 未設定的值。API 預設會採用 BASIC 檢視畫面。
SEARCH_MESSAGES_VIEW_BASIC 結果只會包含相符的訊息，不含額外中繼資料。這是預設值。
SEARCH_MESSAGES_VIEW_FULL 包含搜尋結果中的所有內容：相符的訊息和額外中繼資料。

SearchMessagesResponse

搜尋訊息的回應訊息。

欄位
results[]

SearchMessageResult

符合查詢的搜尋結果清單。
next_page_token

string

可用於擷取下一頁的權杖。如果這個欄位留空，表示沒有後續頁面。

SearchSpacesRequest

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

欄位
use_admin_access

bool

如果 true，系統會使用使用者的 Google Workspace 管理員權限執行方法。

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

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

int32

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

如未指定，最多會傳回 100 個聊天室。

如果 useAdminAccess 設為 true，最大值為 1000。否則，最大值為 100。如果輸入的值超過上限，系統會自動變更為上限值。
page_token

string

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

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

string

必填。搜尋查詢。

當 useAdminAccess 設為 true 時，您可以使用下列參數進行搜尋：

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

useAdminAccess 設為 false 時：

  • display_name
  • external_user_allowed
  • space_type

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

useAdminAccess 設為 true 時，必須提供 customer，用於指出要從哪位客戶擷取聊天室。customers/my_customer 是唯一支援的值。

display_name 僅接受 HAS (:) 運算子。系統會先將要比對的文字切分為詞元，然後不區分大小寫，獨立比對每個詞元是否為聊天室 display_name 中任何子字串的前置字元。舉例來說，Fun Eve 與 Fun event 或 The evening was fun 相符，但與 notFun event 或 even 不符。如果 useAdminAccess 設為 false，則必須提供 display_name 才能擷取有意義的結果。否則，預設行為是傳回空白回應。

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"。

useAdminAccess 設為 true 時，下列查詢範例有效：

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")

useAdminAccess 設為 false 時，下列查詢範例有效：

display_name:"Hello World" AND space_type = "SPACE"

(display_name:"Hello" OR display_name:"Fun") AND space_type = "SPACE"

(external_user_allowed = "true" AND space_type = "SPACE") // Returns an
empty response.

(external_user_allowed = "true" AND display_name:"Hello" AND space_type =
"SPACE")

查詢長度上限為 1,000 個字元。

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

string

(選用步驟) 聊天室清單的排序方式。

支援的排序屬性如下：

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

useAdminAccess 為 false 時，僅支援 create_time 和 relevance 排序。在非管理員搜尋中，這些欄位僅支援 DESC。

有效的排序作業值如下：

  • ASC 表示遞增。預設值。

  • DESC：遞減。

useAdminAccess 設為 true 時，支援的語法如下：

  • 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

useAdminAccess 設為 false 時：

SearchSpacesResponse

回應，其中包含與搜尋聊天室要求對應的聊天室清單。

欄位
spaces[]
(deprecated)

Space

已淘汰：請改用新的 results 欄位。所要求聊天室的頁面。只有在 useAdminAccess 設為 true 時，系統才會填入這個欄位，並已淘汰，改用新的 results 欄位。
next_page_token

string

可用於擷取下一頁的權杖。如果這個欄位留空，表示沒有後續頁面。

只有在 useAdminAccess 設為 true 時，系統才會填入資料。
total_size

int32

所有頁面中符合查詢條件的聊天室總數。如果結果超過 10,000 個聊天室，這個值就是預估值。

只有在 useAdminAccess 設為 true 時，系統才會填入資料。
results[]

SearchSpaceResult

僅供輸出。與查詢相符的搜尋結果清單。

SearchSpaceResult

聊天室搜尋結果中的單一項目。

欄位
space

Space

僅供輸出。相符的聊天室。

區段

代表 Google Chat 中的區段。使用者可以利用區段整理聊天室。版面分為兩種類型：

  1. 系統區段：由 Google Chat 管理的預先定義區段。這些資源的名稱固定不變，無法建立、刪除或修改 display_name。例如：

    • users/{user}/sections/default-direct-messages
    • users/{user}/sections/default-spaces
    • users/{user}/sections/default-apps

  2. 自訂版面：由使用者建立及管理。使用 CreateSection 建立自訂版面時，必須提供 display_name。您可以使用 UpdateSection 更新自訂版面，並使用 DeleteSection 刪除。

欄位
name

string

ID。區段的資源名稱。

系統區段的區段 ID 是常數字串：

  • DEFAULT_DIRECT_MESSAGES: users/{user}/sections/default-direct-messages
  • DEFAULT_SPACES: users/{user}/sections/default-spaces
  • DEFAULT_APPS: users/{user}/sections/default-apps

格式：users/{user}/sections/{section}
display_name

string

(選用步驟) 區段的顯示名稱。只有 CUSTOM_SECTION 類型的區段會填入資料。最多可輸入 80 個半形字元。建立 CUSTOM_SECTION 時必須提供。
sort_order

int32

僅供輸出。該區段相對於其他區段的順序。sort_order 值較低的區段會顯示在值較高的區段之前。
type

SectionType

必填。區段類型。

SectionType

區段類型。

列舉
SECTION_TYPE_UNSPECIFIED 未指定版面類型。
CUSTOM_SECTION 自訂版面。
DEFAULT_DIRECT_MESSAGES 預設版面，包含兩位使用者之間的 DIRECT_MESSAGE，或不屬於任何自訂版面的 GROUP_CHAT 聊天室。
DEFAULT_SPACES 不屬於任何自訂版面的預設聊天室。
DEFAULT_APPS 預設部分，包含使用者安裝的應用程式。

SectionItem

使用者定義的區段項目。這可用來代表分組在某個區段下的區段項目，例如聊天室。

欄位
name

string

ID。區段項目的資源名稱。

格式：users/{user}/sections/{section}/items/{item}
聯集欄位 item。必填。區段項目。item 只能是下列其中一項：
space

string

(選用步驟) 聊天室資源名稱。

格式：spaces/{space}

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 的相同要求只會建立一個聊天室。如果後續要求使用相同 ID，系統會傳回現有聊天室，不會更新聊天室，即使要求詳細資料與目前狀態不同也一樣。

如要有效使用這個欄位，請按照下列指示操作：

  • 請確保後續要求與原始要求相同，並使用相同的驗證憑證。
  • 如果已使用提供的要求 ID 建立聊天室，要求會傳回該聊天室。請注意，傳回的聊天室可能不完整；API 會在要求中回傳聊天室，並填入系統指派的資源名稱。如要擷取聊天室的最新中繼資料，請呼叫 GetSpace。
  • 如果重複使用現有要求 ID，但驗證的使用者不同，就會發生錯誤。
memberships[]

Membership

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

目前最多可允許 49 個成員資格 (不含呼叫端)。

如果是真人成員，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 擴充應用程式之間的一對一訊息。

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

(選用步驟) 聊天室的顯示名稱。建立聊天室時，如果 spaceType 為 SPACE，則必須提供這個欄位。如果在建立聊天室或更新 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 擴充應用程式的即時訊息聊天室，無論是否由 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

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

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

AccessPermissionSetting

存取權限設定。

欄位
principals[]

Principal

(選用步驟) 未排序的清單。這項權限允許的主體。

AccessPermissionSettings

存取聊天室的權限設定。

欄位
discover_space_setting

AccessPermissionSetting

(選用步驟) 設定聊天室搜尋權限。
join_space_setting

AccessPermissionSetting

(選用步驟) 加入聊天室的存取權限設定。
view_space_membership_setting

AccessPermissionSetting

(選用步驟) 查看聊天室成員資格的存取權限設定。更新可查看聊天室成員資格的使用者時，必須在更新遮罩和要求主體中與 PermissionSettings.view_space_membership 一併指定。授予目標對象檢視權限時，您也必須在同一要求中授予所有成員 PermissionSettings.view_space_membership。如要移除現有的目標對象 (例如，將檢視權限限制為僅限聊天室管理員或助理管理員)，請指定空白的 AccessPermissionSetting (不含 principals)。

AccessSettings

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

欄位
access_state

AccessState

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

string

(選用步驟) 目標對象的資源名稱，這類對象可搜尋及加入聊天室，並預覽聊天室中的訊息。如未設定，則只有個別受邀或加入聊天室的使用者或 Google 群組可以存取。詳情請參閱「讓目標對象可搜尋聊天室」。

格式：audiences/{audience}

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

讀取目標對象支援：

使用 chat.bot 範圍和應用程式驗證時，這個欄位不會填入資料。

設定目標對象時，必須驗證使用者。
access_permission_settings

AccessPermissionSettings

(選用步驟) 存取聊天室的權限設定。

如要在建立聊天室時設定目標對象，請在要求中指定 accessSettings.audience 欄位。

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

(選用步驟) 在聊天室中使用 @all 的設定。
manage_apps

PermissionSetting

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

PermissionSetting

(選用步驟) 管理聊天室中 Webhook 的設定。
post_messages

PermissionSetting

僅供輸出。在聊天室中張貼訊息的設定。
reply_messages

PermissionSetting

(選用步驟) 在聊天室中回覆訊息的設定。
view_space_membership

PermissionSetting

(選用步驟) 查看聊天室成員的設定。更新可查看聊天室成員資格的使用者時，必須在更新遮罩和要求主體中與 AccessPermissionSettings.view_space_membership_setting 一併指定。如要限制只有特定角色 (例如聊天室管理員或助理管理員) 才能查看，請在這裡指定所需角色權限，並在同一要求中提供空白的 AccessPermissionSettings.view_space_membership_setting。如果在AccessPermissionSettings.view_space_membership_setting中設定了目標對象，則必須將這項設定授予所有成員。

PredefinedPermissionSettings

預先定義的權限設定，只能在建立具名聊天室時指定。我們日後可能會新增更多設定。如要進一步瞭解具名聊天室的權限設定，請參閱「瞭解聊天室」。

列舉
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED 未指定。請勿使用。
COLLABORATION_SPACE 將聊天室設為協作空間，讓所有成員都能張貼訊息。
ANNOUNCEMENT_SPACE 將聊天室設為公告聊天室，只有聊天室管理員可以張貼訊息。

主體

代表已獲授予存取權實體的主體。

欄位
聯集欄位 principal_type。主體類型。principal_type 只能是下列其中一項：
audience

Audience

目標對象。

SpaceDetails

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

欄位
description

string

(選用步驟) 空間說明。例如，說明聊天室的討論主題、功能用途或參與者。

最多 4,096 個半形字元。
guidelines

string

(選用步驟) 聊天室的規則、期望和禮儀。

最多支援 5,000 個字元。

SpaceThreadingState

指定 Chat 聊天室中的討論串狀態類型。

列舉
SPACE_THREADING_STATE_UNSPECIFIED 保留。
THREADED_MESSAGES 支援訊息討論串的聊天室。使用者回覆訊息時，可以在討論串中回覆，這樣回覆內容就會保留在原始訊息的上下文中。
GROUPED_MESSAGES 依主題分類對話的具名聊天室。主題和回覆會歸在一組。
UNTHREADED_MESSAGES

不支援訊息討論串的聊天室。這個聊天室討論串狀態僅適用於特殊情況，包括：

  • 刻意關閉討論串功能的常設會議即時通訊。
  • 2022 年前建立的舊版群組對話。

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 填入聊天室資源欄位。注意：系統不會填入 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。最多可輸入 4000 個半形字元。

這個 ID 專屬於設定該 ID 的 Chat 擴充應用程式。舉例來說，如果多個 Chat 擴充應用程式使用相同的討論串金鑰建立訊息，訊息會發布在不同的討論串中。如要回覆使用者或其他 Chat 擴充應用程式建立的討論串，請改為指定討論串 name 欄位。

ThreadReadState

使用者在討論串中的已讀狀態，用於識別已讀和未讀訊息。

欄位
name

string

討論串讀取狀態的資源名稱。

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

Timestamp

使用者討論串已讀狀態的更新時間。通常會對應至討論串中最後一則已讀訊息的時間戳記。

UpdateAvailabilityRequest

UpdateAvailability 方法的要求訊息。

欄位
availability

Availability

必填。是否可更新。
update_mask

FieldMask

必填。要更新的欄位清單。唯一可更新的欄位是 custom_status。

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 必須由用戶端指派，否則要求會失敗。

UpdateSectionRequest

更新區段的要求訊息。

欄位
section

Section

必填。要更新的區段。
update_mask

FieldMask

必填。指定要更新哪些欄位的遮罩。

目前支援的欄位路徑：

  • display_name

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。

access_settings.access_permission_settings：更新存取權限設定，指定哪些使用者可以探索及加入 spaceType 欄位為 SPACE 的聊天室。允許加入聊天室的主體也必須能搜尋到聊天室。如要更新聊天室的存取權限設定，驗證使用者必須是聊天室管理員或助理管理員，並在要求中省略所有其他欄位遮罩。如果聊天室處於匯入模式，則無法更新這個欄位。詳情請參閱「讓特定使用者可搜尋聊天室」。access_settings.access_permission_settings不支援useAdminAccess。支援的欄位遮罩包括：

  • access_settings.access_permission_settings.discoverSpaceSetting
  • access_settings.access_permission_settings.joinSpaceSetting
  • access_settings.access_permission_settings.viewSpaceMembershipSetting

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

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

bool

(選用步驟) 如果 true，系統會使用使用者的 Google Workspace 管理員權限執行方法。

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

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

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

使用者

Google Chat 中的使用者。

如果 Chat 擴充應用程式以使用者身分驗證，則在要求傳回輸出內容時，User 資源 (例如訊息和成員資格 API) 的輸出內容只會填入內部和外部使用者的 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

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

應用程式驗證和使用者驗證都會填入這項資訊。如果是透過應用程式驗證提出的要求，系統一律會填入這個欄位。使用使用者驗證呼叫 Messages 和 Memberships API 時，系統會為訊息的 sender、annotations 內的使用者 (例如使用者提及) 和 Membership 資源內的內外部使用者填入這個欄位，前提是使用者為聊天室成員，或與呼叫端使用者具有關聯。
avatar_url

string

僅供輸出。使用者的顯示圖片網址。

使用使用者驗證呼叫 Messages 和 Memberships API 時，系統會為訊息的 sender、annotations 內的使用者 (例如使用者提及) 和 Membership 資源內的內外部使用者填入這個欄位，前提是使用者為聊天室成員，或與呼叫端使用者具有關聯。
email

string

僅供輸出。使用者的電子郵件地址。

使用使用者驗證呼叫 Messages 和 Memberships API 時，系統會為訊息的 sender、annotations 內的使用者 (例如使用者提及) 和 Membership 資源內的內外部使用者填入這個欄位，前提是使用者為聊天室成員，或與呼叫端使用者具有關聯。
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