REST Resource: spaces.messages

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

object (User)

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

string (Timestamp format)

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

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

string (Timestamp format)

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

string (Timestamp format)

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

string

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

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

string

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

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

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

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

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

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

詳情請參閱「查看訊息中的文字格式」

object (Card)

已淘汰：請改用 cardsV2。

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

object (CardWithId)

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

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

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

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

object (Annotation)

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

object (Thread)

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

object (Space)

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

string

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

object (ActionResponse)

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

string

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

object (SlashCommand)

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

object (Attachment)

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

object (MatchedUrl)

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

boolean

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

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

boolean

僅供輸出。這是否為靜音訊息。靜音訊息是指 Chat 不會向收件者傳送推播通知的訊息。

string

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

object (EmojiReactionSummary)

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

object (User)

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

• 附件

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

object (DeletionMetadata)

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

object (QuotedMessageMetadata)

(選用步驟) 另一則訊息引用的訊息相關資訊。

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

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

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

object (AttachedGif)

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

object (AccessoryWidget)

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

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

object (Elements)

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

enum (MarkupSyntax)

(選用步驟) 指定伺服器在建立訊息或更新訊息的 text 欄位時，如何解讀訊息 text 欄位內容。

呼叫 messages.patch 時，請在 Message 資源上設定 markupSyntax 和 text，並在 updateMask 中加入 text (而非 markupSyntax)。