REST Resource: spaces.messages

{
  "name": string,
  "sender": {
    object (User)
  },
  "createTime": string,
  "lastUpdateTime": string,
  "deleteTime": string,
  "text": 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)
  }
}

string

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

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

object (User)

僅供輸出。建立訊息的使用者。

string (Timestamp format)

僅供輸出。在 Google Chat 伺服器中建立訊息的時間。

string (Timestamp format)

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

string (Timestamp format)

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

string

訊息的純文字。圖片、影片、網頁或其他可預覽項目的第一個連結會產生預覽方塊。

object (Card)

已淘汰：請改用 cardsV2。

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

object (CardWithId)

格式豐富的互動式資訊卡，可以顯示 UI 元素和可編輯的小工具，例如：

• 格式化的文字
• 按鈕
• 可點擊圖片
• 核取方塊
• 圓形按鈕
• 輸入小工具。

資訊卡通常會在 Chat 訊息的文字內文下方顯示，但有時可能會顯示在其他位置，例如對話方塊。每張卡片的大小上限為 32 KB。

cardId 是同一訊息中卡片專屬 ID 的專屬識別碼，用於識別使用者輸入值。

目前支援的小工具包括：

• TextParagraph
• DecoratedText
• Image
• ButtonList
• Divider
• TextInput
• SelectionInput
• Grid

object (Annotation)

僅供輸出。與此訊息中的文字相關聯的註解。

object (Thread)

郵件所屬的會話串。如需使用範例，請參閱開始或回覆郵件串。

object (Space)

郵件所屬的聊天室。透過使用者驗證存取時，只會填入聊天室名稱。

string

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

object (ActionResponse)

只能輸入。即時通訊應用程式用來設定回應回應方式的參數。

string

僅供輸出。訊息文字的純文字，其中所有 Chat 應用程式皆已提及。

object (SlashCommand)

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

object (Attachment)

使用者上傳的附件。

object (MatchedUrl)

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

boolean

僅供輸出。true 時，訊息是回覆執行緒中的回應。以 false 的形式，聊天室的頂層訊息會顯示該則訊息，包括對話串的首則訊息，或是不含對話串回覆的訊息。

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

string

在建立訊息時指派的 Chat 訊息自訂名稱。開頭必須是 client-，且只能包含小寫英文字母、數字和連字號，長度上限為 63 個字元。指定這個欄位，即可取得、更新或刪除具有指定值的訊息。如需使用範例，請參閱為已建立的郵件命名一文。

object (EmojiReactionSummary)

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

object (DeletionMetadata)

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

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

string

對 cardsV2 訊息而言為必填。此小工具的即時通訊應用程式指定識別碼。在某封郵件的範圍內。

object (Card)

資訊卡支援定義的版面配置、按鈕等互動式 UI 元素，以及圖片等互動式多媒體元素。這張資訊卡可顯示詳細資訊、收集使用者資訊，並引導使用者採取後續行動。

{
  "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。如要開始新增或新增至執行緒，請建立訊息並指定 threadKey 或 thread.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)

表示刪除郵件的使用者。