REST Resource: spaces.messages

資源：Message

Google Chat 聊天室中的訊息。

JSON 表示法 
{
  "name": string,
  "sender": {
    object (User)
  },
  "createTime": string,
  "lastUpdateTime": string,
  "deleteTime": string,
  "text": string,
  "formattedText": string,
  "cards": [
    {
      object (Card)
    }
  ],
  "cardsV2": [
    {
      object (CardWithId)
    }
  ],
  "annotations": [
    {
      object (Annotation)
    }
  ],
  "thread": {
    object (Thread)
  },
  "space": {
    object (Space)
  },
  "fallbackText": string,
  "actionResponse": {
    object (ActionResponse)
  },
  "argumentText": string,
  "slashCommand": {
    object (SlashCommand)
  },
  "attachment": [
    {
      object (Attachment)
    }
  ],
  "matchedUrl": {
    object (MatchedUrl)
  },
  "threadReply": boolean,
  "clientAssignedMessageId": string,
  "emojiReactionSummaries": [
    {
      object (EmojiReactionSummary)
    }
  ],
  "privateMessageViewer": {
    object (User)
  },
  "deletionMetadata": {
    object (DeletionMetadata)
  },
  "quotedMessageMetadata": {
    object (QuotedMessageMetadata)
  },
  "attachedGifs": [
    {
      object (AttachedGif)
    }
  ],
  "accessoryWidgets": [
    {
      object (AccessoryWidget)
    }
  ]
}
欄位
name

string

ID。訊息的資源名稱。

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

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

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

object (User)

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

string (Timestamp format)

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

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

string (Timestamp format)

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

string (Timestamp format)

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

string

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

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

string

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

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

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

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

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

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

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

object (Card)

已淘汰：請改用 cardsV2。

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

object (CardWithId)

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

Chat 擴充應用程式可透過應用程式驗證建立資訊卡。如果您的 Chat 應用程式以使用者身分進行驗證，就能建立訊息卡片。這項功能是 Developer Preview Program 的一部分。如果 Chat 應用程式未加入開發人員預覽版計畫，就無法建立需要使用者驗證的資訊卡。

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

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

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

object (Annotation)

僅供輸出。註解可與郵件的純文字內容建立關聯，也可以與連結至 Google 文件或試算表等 Google Workspace 資源的動態磚建立關聯，並使用 startIndex 和 length 的 0。
thread

object (Thread)

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

object (Space)

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

string

(選用步驟) 訊息資訊卡的純文字說明，用於無法顯示實際資訊卡的情況，例如行動通知。
actionResponse

object (ActionResponse)

僅供輸入。Chat 應用程式可用來設定如何發布回覆的參數。
argumentText

string

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

object (SlashCommand)

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

object (Attachment)

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

object (MatchedUrl)

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

boolean

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

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

string

(選用步驟) 訊息的自訂 ID。你可以使用這個欄位識別訊息，或是取得、刪除或更新訊息。如要設定自訂 ID，請在建立訊息時指定 messageId 欄位。詳情請參閱「為訊息命名」。
emojiReactionSummaries[]

object (EmojiReactionSummary)

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

object (User)

(選用步驟) 不可變動。輸入內容即可建立訊息，否則只會輸出內容。可查看訊息的使用者。設定後，訊息會設為私人訊息，只有指定使用者和 Chat 應用程式能看到。如要在要求中加入這個欄位，您必須使用應用程式驗證呼叫 Chat API，並省略下列項目：

詳情請參閱「私下傳送訊息」。
deletionMetadata

object (DeletionMetadata)

僅供輸出。有關已刪除訊息的資訊。設定 deleteTime 時，系統會刪除訊息。
quotedMessageMetadata

object (QuotedMessageMetadata)

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

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

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

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

object (AttachedGif)

僅供輸出。附加至郵件的 GIF 圖片。
accessoryWidgets[]

object (AccessoryWidget)

(選用步驟) 顯示在郵件底部的互動式小工具。您可以在含有文字、資訊卡，或同時含有文字和資訊卡的訊息中新增配件小工具。不支援含有對話方塊的訊息。詳情請參閱「在訊息底部新增互動式小工具」。

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

CardWithId

Google Chat 訊息中的資訊卡。

Chat 擴充應用程式可透過應用程式驗證建立資訊卡。如果您的 Chat 應用程式以使用者身分進行驗證，就能建立訊息卡片。這項功能是 Developer Preview Program 的一部分。如果 Chat 應用程式未加入開發人員預覽版計畫，就無法建立需要使用者驗證的資訊卡。

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

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

開啟「資訊卡建立工具」

JSON 表示法 
{
  "cardId": string,
  "card": {
    object (Card)
  }
}
欄位
cardId

string

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

object (Card)

卡片。大小上限為 32 KB。

備註

僅供輸出。註解可與郵件的純文字內文建立關聯，也可以與連結至 Google 文件或試算表等 Google Workspace 資源的動態磚建立關聯，並使用 startIndex 和 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"
   }
}]
JSON 表示法 
{
  "type": enum (AnnotationType),
  "length": integer,
  "startIndex": integer,

  "userMention": {
    object (UserMentionMetadata)
  },
  "slashCommand": {
    object (SlashCommandMetadata)
  },
  "richLinkMetadata": {
    object (RichLinkMetadata)
  },
  "customEmojiMetadata": {
    object (CustomEmojiMetadata)
  }
}
欄位
type

enum (AnnotationType)

這項註解的類型。
length

integer

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

integer

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

object (UserMentionMetadata)

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

object (SlashCommandMetadata)

斜線指令的中繼資料。
customEmojiMetadata

object (CustomEmojiMetadata)

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

AnnotationType

註解類型。

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

UserMentionMetadata

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

JSON 表示法 
{
  "user": {
    object (User)
  },
  "type": enum (Type)
}
欄位
user

object (User)

提及的使用者。
type

enum (Type)

使用者提及類型。

類型

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

SlashCommandMetadata

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

JSON 表示法 
{
  "bot": {
    object (User)
  },
  "type": enum (Type),
  "commandName": string,
  "commandId": string,
  "triggersDialog": boolean
}
欄位
bot

object (User)

叫用指令的 Chat 應用程式。
type

enum (Type)

斜線指令類型。
commandName

string

叫用的斜線指令名稱。
commandId

string (int64 format)

所叫用斜線指令的指令 ID。
triggersDialog

boolean

指出斜線指令是否用於對話方塊。

類型

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

RichLinkMetadata

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

JSON 表示法 
{
  "uri": string,
  "richLinkType": enum (RichLinkType),

  "driveLinkData": {
    object (DriveLinkData)
  },
  "chatSpaceLinkData": {
    object (ChatSpaceLinkData)
  },
  "meetSpaceLinkData": {
    object (MeetSpaceLinkData)
  },
  "calendarEventLinkData": {
    object (CalendarEventLinkData)
  }
}
欄位
uri

string

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

RichLinkType

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

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

DriveLinkData

Google 雲端硬碟連結的資料。

JSON 表示法 
{
  "driveDataRef": {
    object (DriveDataRef)
  },
  "mimeType": string
}
欄位
driveDataRef

object (DriveDataRef)

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

string

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

ChatSpaceLinkData

Chat 聊天室連結的資料。

JSON 表示法 
{
  "space": string,
  "thread": string,
  "message": string
}
欄位
space

string

連結的 Chat 聊天室資源所屬的聊天室。

格式：spaces/{space}
thread

string

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

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

string

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

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

MeetSpaceLinkData

Meet 空間連結的資料。

JSON 表示法 
{
  "meetingCode": string,
  "type": enum (Type),
  "huddleStatus": enum (HuddleStatus)
}
欄位
meetingCode

string

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

enum (Type)

指出 Meet 空間的類型。
huddleStatus

enum (HuddleStatus)

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

類型

Meet 空間類型。

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

HuddleStatus

群組通話狀態

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

CalendarEventLinkData

日曆活動連結的資料。

JSON 表示法 
{
  "calendarId": string,
  "eventId": string
}
欄位
calendarId

string

已連結日曆的日曆 ID。
eventId

string

連結日曆活動的活動 ID。

CustomEmojiMetadata

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

JSON 表示法 
{
  "customEmoji": {
    object (CustomEmoji)
  }
}
欄位
customEmoji

object (CustomEmoji)

自訂表情符號。

討論串

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

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

JSON 表示法 
{
  "name": string,
  "threadKey": string
}
欄位
name

string

ID。執行緒的資源名稱。

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

string

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

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

ActionResponse

Chat 應用程式可用來設定如何發布回覆的參數。

JSON 表示法 
{
  "type": enum (ResponseType),
  "url": string,
  "dialogAction": {
    object (DialogAction)
  },
  "updatedWidget": {
    object (UpdatedWidget)
  }
}
欄位
type

enum (ResponseType)

僅供輸入。Chat 應用程式的回應類型。
url

string

僅供輸入。使用者驗證或設定的網址。(僅適用於 REQUEST_CONFIG 回覆類型)。
dialogAction

object (DialogAction)

僅供輸入。與對話方塊相關的互動事件回應。必須一併提供 ResponseType.Dialog。
updatedWidget

object (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 查詢小工具文字自動完成選項。

DialogAction

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

JSON 表示法 
{
  "actionStatus": {
    object (ActionStatus)
  },

  "dialog": {
    object (Dialog)
  }
}
欄位
actionStatus

object (ActionStatus)

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

object (Dialog)

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

對話方塊

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

JSON 表示法 
{
  "body": {
    object (Card)
  }
}
欄位
body

object (Card)

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

ActionStatus

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

JSON 表示法 
{
  "statusCode": enum (Code),
  "userFacingMessage": string
}
欄位
statusCode

enum (Code)

狀態碼。
userFacingMessage

string

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

程式碼

gRPC API 的標準錯誤代碼。

有時可能適用多個錯誤代碼。服務應傳回最適用的特定錯誤代碼。例如，如果 OUT_OF_RANGE 與 FAILED_PRECONDITION 代碼都適用，則最好使用前者。同樣地，NOT_FOUND 或 ALREADY_EXISTS 的使用順序應高於 FAILED_PRECONDITION。

列舉
OK

非錯誤；於成功時傳回。

HTTP 對應：200 OK
CANCELLED

作業已取消，一般由呼叫者取消。

HTTP 對應：499 用戶端已關閉要求
UNKNOWN

發生不明錯誤，舉例來說，當從其他位址空間收到的 Status 值屬於這個位址空間中不明的錯誤空間時，就可能傳回此錯誤；由 API 發出但未傳回充分錯誤資訊的錯誤，也可能會轉換為此錯誤。

HTTP 對應：500 內部伺服器錯誤
INVALID_ARGUMENT

用戶端指定了無效的引數。請注意，這與 FAILED_PRECONDITION 不同。INVALID_ARGUMENT 表示引數有問題，無論系統狀態為何皆是如此 (例如檔案名稱格式錯誤)。

HTTP 對應：400 錯誤的要求
DEADLINE_EXCEEDED

期限於作業完成之前過期。針對變更系統狀態的作業，即使作業已成功完成，也可能傳回此錯誤。例如，來自伺服器的成功回應延遲時間可能已長到足以使期限過期。

HTTP 對應：504 閘道逾時
NOT_FOUND

找不到某些要求的實體 (例如檔案或目錄)。

伺服器開發人員注意事項：如果系統拒絕整類使用者 (例如逐步推出功能或未記錄的允許清單) 的要求，可以使用 NOT_FOUND。如果拒絕部分使用者 (例如使用者型存取控制) 的要求，則必須使用 PERMISSION_DENIED。

HTTP 對應：404 找不到
ALREADY_EXISTS

用戶端嘗試建立的實體 (例如檔案或目錄) 已存在。

HTTP 對應：409 衝突
PERMISSION_DENIED

呼叫者沒有執行指定作業的權限。對於因耗用某些資源所導致的拒絕情形，不得使用 PERMISSION_DENIED (請針對這些錯誤改用 RESOURCE_EXHAUSTED)。如果無法識別呼叫者，不得使用 PERMISSION_DENIED (請針對這些錯誤改用 UNAUTHENTICATED)。此錯誤代碼並不表示要求有效，或是要求的實體已存在或是滿足其他先決條件。

HTTP 對應：403 禁止
UNAUTHENTICATED

要求沒有作業的有效驗證憑證。

HTTP 對應：401 未授權
RESOURCE_EXHAUSTED

已耗盡某些資源，或許是每位使用者的配額，或許是完整檔案系統空間不足。

HTTP 對應：429 太多要求
FAILED_PRECONDITION

作業已遭拒絕，因為系統不在執行作業所需的狀態下。例如要刪除的目錄非空白、rmdir 作業套用至非目錄等。

服務實作者可以根據下列指引，決定要使用 FAILED_PRECONDITION、ABORTED 還是 UNAVAILABLE：(a) 如果用戶端只能重試失敗的呼叫，請使用 UNAVAILABLE。(b) 如果用戶端應在較高層級重試，請使用 ABORTED。舉例來說，當用戶端指定的「test-and-set」失敗時，表示用戶端應重新開始「read-modify-write」序列。(c) 如果用戶端不應在系統狀態明確修正完畢之前重試，請使用 FAILED_PRECONDITION。舉例來說，如果「rmdir」因目錄不是空白而失敗，則應傳回 FAILED_PRECONDITION，因為用戶端必須等到目錄中的檔案都刪除之後才重試。

HTTP 對應：400 錯誤的要求
ABORTED

作業已取消，原因通常是排序器檢查失敗或交易取消等並行問題。

如要決定採用 FAILED_PRECONDITION、ABORTED 還是 UNAVAILABLE，請參閱以上指南。

HTTP 對應：409 衝突
OUT_OF_RANGE

嘗試作業時超過有效範圍，例如搜尋或讀取超過檔案結尾。

與 INVALID_ARGUMENT 不同，此錯誤表示如果系統狀態變更則可修正的問題。舉例來說，如果要求在 [0,2^32-1] 範圍以外的偏移量讀取資料，32 位元檔案系統會產生 INVALID_ARGUMENT，但如果要求從超出目前檔案大小的偏移量讀取資料，則會產生 OUT_OF_RANGE。

FAILED_PRECONDITION 與 OUT_OF_RANGE 之間有不少重疊的地方。我們建議您在適用時使用 OUT_OF_RANGE (較為特定的錯誤)，這樣在空間中進行迭代作業的呼叫者就可以在完成時輕鬆找到要偵測的 OUT_OF_RANGE 錯誤。

HTTP 對應：400 錯誤的要求
UNIMPLEMENTED

未實作作業或作業在此服務中不受支援/未啟用。

HTTP 對應：501 未實作
INTERNAL

內部錯誤。這表示基礎系統預期的某些不變的情形已被打破。此錯誤代碼保留供嚴重錯誤使用。

HTTP 對應：500 內部伺服器錯誤
UNAVAILABLE

服務目前無法使用。這很可能是暫時性問題，可透過重試輪詢來解決。請注意，重試非等冪作業並不一定安全。

如要決定採用 FAILED_PRECONDITION、ABORTED 還是 UNAVAILABLE，請參閱以上指南。

HTTP 對應：503 服務不可用
DATA_LOSS

無法復原的資料遺失或損毀。

HTTP 對應：500 內部伺服器錯誤

UpdatedWidget

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

JSON 表示法 
{
  "widget": string,

  "suggestions": {
    object (SelectionItems)
  }
}
欄位
widget

string

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

object (SelectionItems)

小工具自動完成結果清單

SelectionItems

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

JSON 表示法 
{
  "items": [
    {
      object (SelectionItem)
    }
  ]
}
欄位
items[]

object (SelectionItem)

SelectionItem 物件的陣列。

SlashCommand

Google Chat 中斜線指令的中繼資料。

JSON 表示法 
{
  "commandId": string
}
欄位
commandId

string (int64 format)

斜線指令的 ID。

MatchedUrl

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

JSON 表示法 
{
  "url": string
}
欄位
url

string

僅供輸出。相符的網址。

EmojiReactionSummary

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

JSON 表示法 
{
  "emoji": {
    object (Emoji)
  },
  "reactionCount": integer
}
欄位
emoji

object (Emoji)

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

integer

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

DeletionMetadata

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

JSON 表示法 
{
  "deletionType": enum (DeletionType)
}
欄位
deletionType

enum (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 聊天室成員刪除了訊息。使用者可以刪除應用程式傳送的訊息。

QuotedMessageMetadata

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

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

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

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

JSON 表示法 
{
  "name": string,
  "lastUpdateTime": string,
  "quoteType": enum (QuoteType),
  "quotedMessageSnapshot": {
    object (QuotedMessageSnapshot)
  },
  "forwardedMetadata": {
    object (ForwardedMetadata)
  }
}
欄位
name

string

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

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

string (Timestamp format)

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

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

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

enum (QuoteType)

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

object (QuotedMessageSnapshot)

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

object (ForwardedMetadata)

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

QuoteType

所引用訊息的引用類型。

列舉
QUOTE_TYPE_UNSPECIFIED 保留。這個值不會使用。
REPLY

如果 quoteType 為 REPLY，您可以執行下列操作：

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

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

無法引用其他討論串中的訊息回覆。

QuotedMessageSnapshot

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

JSON 表示法 
{
  "sender": string,
  "text": string,
  "formattedText": string,
  "annotations": [
    {
      object (Annotation)
    }
  ],
  "attachments": [
    {
      object (Attachment)
    }
  ]
}
欄位
sender

string

僅供輸出。引言訊息的作者名稱。適用於「REPLY」和「FORWARD」兩種引文類型。
text

string

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

string

僅供輸出。包含引用的訊息 text，並加入標記以支援超連結、自訂表情符號、標記等豐富格式。僅適用於 FORWARD 引用類型。
annotations[]

object (Annotation)

僅供輸出。從引述郵件的內文剖析的註解。僅針對 FORWARD 報價類型填入。
attachments[]

object (Attachment)

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

ForwardedMetadata

轉寄郵件的來源空間中繼資料。

JSON 表示法 
{
  "space": string,
  "spaceDisplayName": string
}
欄位
space

string

僅供輸出。來源空間的資源名稱。格式：spaces/{space}
spaceDisplayName

string

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

AttachedGif

網址指定的 GIF 圖片。

JSON 表示法 
{
  "uri": string
}
欄位
uri

string

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

AccessoryWidget

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

JSON 表示法 
{

  "buttonList": {
    object (ButtonList)
  }
}
欄位
聯集欄位 action。動作類型。action 只能是下列其中一項：
buttonList

object (ButtonList)

按鈕清單。

方法

create

 在 Google Chat 聊天室中建立訊息。

delete

 刪除訊息。

get

 傳回訊息的詳細資料。

list

 列出通話者所屬聊天室中的訊息，包括來自遭封鎖成員和聊天室的訊息。

patch

 更新訊息。

replaceCards

 取代郵件中包含的資訊卡。

update

 更新訊息。