REST Resource: spaces.messages

{
  "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)
    }
  ],
  "deletionMetadata": {
    object (DeletionMetadata)
  },
  "quotedMessageMetadata": {
    object (QuotedMessageMetadata)
  },
  "attachedGifs": [
    {
      object (AttachedGif)
    }
  ]
}

string

格式為 spaces/*/messages/* 的資源名稱。

範例：spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB

object (User)

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

string (Timestamp format)

在 Chat 中建立的聊天室是指建立訊息的時間。除非在匯入的聊天室中使用，否則這個欄位只會輸出。

string (Timestamp format)

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

string (Timestamp format)

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

string

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

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

string

僅供輸出。包含 text 訊息和為溝通格式新增的標記。這個欄位可能無法擷取 UI 中顯示的所有格式，但會加入以下內容：

• 粗體、斜體、刪除線、等寬和等寬區塊的標記語法。
• 使用者提及，格式為 <users/{user}>。
• 採用 <{url}|{rendered_text}> 格式的自訂超連結，其中第一個字串是網址，第二個字串是轉譯的文字，例如 <http://example.com|custom text>。
• 使用 :{emoji_name}: 格式的自訂表情符號，例如 :smile:。這不適用於萬國碼 (Unicode) 表情符號，例如 U+1F600 表示笑臉表情符號。

詳情請參閱「查看郵件中的文字格式」一文

object (Card)

已淘汰：請改用 cardsV2。

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

object (CardWithId)

資訊卡陣列。

只有 Chat 專用應用程式才能建立資訊卡。如果您的 Chat 應用程式是以使用者身分進行驗證，該訊息就無法包含卡片。

如要瞭解資訊卡及其建立方式，請參閱「使用資訊卡設計動態、互動且一致的 UI」。

object (Annotation)

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

object (Thread)

訊息所屬的會話串。如需使用方式範例，請參閱「建立或回覆訊息串」。

object (Space)

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

string

訊息卡片的純文字說明，當無法顯示實際資訊卡時 (例如行動裝置通知) 就會使用這種說明。

object (ActionResponse)

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

string

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

object (SlashCommand)

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

object (Attachment)

使用者上傳的附件。

object (MatchedUrl)

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

boolean

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

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

string

建立 Chat 訊息時指派的自訂名稱。開頭須為「client-」，而且只能使用小寫英文字母、數字和連字號，長度上限為 63 個字元。指定這個欄位，以便取得、更新或刪除含有指定值的訊息。指派自訂名稱可讓 Chat 應用程式回收訊息，但不會儲存建立訊息時傳回的回應主體中的訊息 name。指派自訂名稱並不會取代系統產生的 name 欄位，也就是訊息的資源名稱。而是將自訂名稱設為 clientAssignedMessageId 欄位，供您在後續處理 (例如更新或刪除訊息) 時參照。如需使用方式範例，請參閱「為已建立的訊息命名」。

object (EmojiReactionSummary)

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

object (DeletionMetadata)

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

object (QuotedMessageMetadata)

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

object (AttachedGif)

僅供輸出。訊息附加的 GIF 圖片。

{
  "cardId": string,
  "card": {
    object (Card)
  }
}

string

如果訊息含有多張資訊卡，此為必填屬性。訊息中卡片的專屬 ID。

object (Card)

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

{
  "type": enum (AnnotationType),
  "length": integer,
  "startIndex": integer,

  // Union field metadata can be only one of the following:
  "userMention": {
    object (UserMentionMetadata)
  },
  "slashCommand": {
    object (SlashCommandMetadata)
  }
  // End of list of possible types for union field metadata.
}

enum (AnnotationType)

此註解的類型。

integer

這個註解所對應純文字訊息內文中的子字串長度。

integer

這個註解所對應之純文字訊息內文中的起始索引 (從 0 開始，含首尾)。

object (UserMentionMetadata)

使用者提及的中繼資料。

object (SlashCommandMetadata)

斜線指令的中繼資料。

{
  "user": {
    object (User)
  },
  "type": enum (Type)
}

object (User)

提及的使用者。

enum (Type)

使用者提及的類型。

{
  "bot": {
    object (User)
  },
  "type": enum (Type),
  "commandName": string,
  "commandId": string,
  "triggersDialog": boolean
}

object (User)

Chat 應用程式受到叫用指令。

enum (Type)

斜線指令的類型。

string

所叫用斜線指令的名稱。

string (int64 format)

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

boolean

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

{
  "name": string,
  "threadKey": string
}

string

僅供輸出。執行緒的資源名稱。

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

string

(選填) 建立或更新執行緒的輸入內容。否則，系統只會輸出輸出的內容。執行緒 ID。長度上限為 4,000 個半形字元。

這個 ID 是設定此 ID 的 Chat 應用程式的專屬 ID。舉例來說，如有多個 Chat 應用程式使用相同的執行緒鍵建立訊息，則這些訊息會發布至不同的討論串。如要在使用者或其他 Chat 應用程式建立的討論串中回覆訊息，請改為指定討論串 name 欄位。

{
  "type": enum (ResponseType),
  "url": string,
  "dialogAction": {
    object (DialogAction)
  }
}

enum (ResponseType)

僅限輸入。Chat 應用程式回應類型。

string

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

object (DialogAction)

僅限輸入。對對話方塊相關事件的回應。必須與 ResponseType.Dialog 一併顯示。

{
  "actionStatus": {
    object (ActionStatus)
  },

  // Union field action can be only one of the following:
  "dialog": {
    object (Dialog)
  }
  // End of list of possible types for union field action.
}

object (ActionStatus)

僅限輸入。叫用或提交對話方塊的要求狀態。視需要向使用者顯示狀態和訊息。例如發生錯誤或成功時。

object (Dialog)

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

{
  "body": {
    object (Card)
  }
}

object (Card)

僅限輸入。以強制回應顯示的對話方塊內文。Google Chat 應用程式不支援下列卡片實體：DateTimePicker、OnChangeAction。

{
  "statusCode": enum (Code),
  "userFacingMessage": string
}

enum (Code)

狀態碼。

string

這是指要向使用者傳送要求狀態相關訊息的訊息。如未設定，系統會傳送根據 statusCode 的一般訊息。

{
  "commandId": string
}

string (int64 format)

叫用的斜線指令 ID。

{
  "url": string
}

string

僅供輸出。相符的網址。

{
  "emoji": {
    object (Emoji)
  },
  "reactionCount": integer
}

object (Emoji)

與回應相關聯的表情符號。

integer

使用相關聯表情符號的回應總數。

{
  "deletionType": enum (DeletionType)
}

enum (DeletionType)

顯示誰刪除了訊息。

{
  "name": string,
  "lastUpdateTime": string
}

string

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

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

string (Timestamp format)

僅供輸出。引用訊息的建立時間，或引用訊息上次更新的時間。

{
  "uri": string
}

string

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