- 資源:訊息
- JSON 表示法
- 資訊卡
- CardHeader
- ImageStyle
- 區段
- WidgetMarkup
- TextParagraph
- 圖片
- OnClick
- FormAction
- ActionParameter
- OpenLink
- KeyValue
- 圖示
- 按鈕
- TextButton
- ImageButton
- CardAction
- CardWithId
- 資訊卡
- CardHeader
- ImageType
- 區段
- 小工具
- TextParagraph
- 圖片
- OnClick
- 動作
- ActionParameter
- LoadIndicator
- 互動
- OpenLink
- OpenAs
- OnClose
- OverflowMenu
- OverflowMenuItem
- 圖示
- MaterialIcon
- DecoratedText
- 按鈕
- 顏色
- 類型
- SwitchControl
- ControlType
- ButtonList
- TextInput
- 類型
- 建議
- SuggestionItem
- 驗證
- InputType
- SelectionInput
- SelectionType
- SelectionItem
- PlatformDataSource
- CommonDataSource
- HostAppDataSourceMarkup
- ChatClientDataSourceMarkup
- SpaceDataSource
- DateTimePicker
- DateTimePickerType
- Divider
- 格狀檢視
- GridItem
- ImageComponent
- ImageCropStyle
- ImageCropType
- BorderStyle
- BorderType
- GridItemLayout
- 欄
- 欄
- HorizontalSizeStyle
- HorizontalAlignment
- VerticalAlignment
- 小工具
- ChipList
- 版面配置
- 方塊
- CollapseControl
- DividerStyle
- CardAction
- CardFixedFooter
- DisplayStyle
- 註解
- AnnotationType
- UserMentionMetadata
- 類型
- SlashCommandMetadata
- 類型
- RichLinkMetadata
- RichLinkType
- DriveLinkData
- ChatSpaceLinkData
- 執行緒
- ActionResponse
- ResponseType
- DialogAction
- 對話方塊
- ActionStatus
- 代碼
- UpdatedWidget
- SelectionItems
- SlashCommand
- MatchedUrl
- EmojiReactionSummary
- DeletionMetadata
- DeletionType
- QuotedMessageMetadata
- AttachedGif
- AccessoryWidget
- 方法
資源:Message
Google Chat 聊天室中的訊息。
JSON 表示法 |
---|
{ "name": string, "sender": { object ( |
欄位 | |
---|---|
name |
ID。訊息的資源名稱。 格式: 其中 如果您在建立訊息時設定了自訂 ID,就可以使用這個 ID,將 |
sender |
僅供輸出。建立訊息的使用者。如果 Chat 擴充應用程式以使用者的身分進行驗證,輸出內容會填入「使用者」 |
create |
選用設定。不可變動。在 Chat 中建立的聊天室,也就是建立訊息的時間。這個欄位僅供輸出 (用於匯入模式空格時除外)。 對於匯入模式空間,請將這個欄位設為訊息在來源中建立的歷史時間戳記,以便保留原始建立時間。 |
last |
僅供輸出。使用者上次編輯訊息的時間。如果訊息從未編輯過,這個欄位就會空白。 |
delete |
僅供輸出。Google Chat 中刪除訊息的時間。如果郵件從未刪除,這個欄位會留空。 |
text |
選用設定。訊息的純文字內文。第一個連至圖片、影片或網頁的連結會產生預覽方塊。你也可以@提及 Google Chat 使用者,或是提及聊天室中的所有人。 如要瞭解如何建立簡訊,請參閱傳送訊息。 |
formatted |
僅供輸出。包含訊息
詳情請參閱「查看訊息中傳送的文字格式」 |
cards[] |
已淘汰:請改用 豐富的格式與互動式資訊卡,可用於顯示 UI 元素,例如格式化的文字、按鈕和可點擊的圖片。資訊卡通常顯示在訊息的純文字內文下方。 |
cards |
選用設定。資訊卡的陣列。 只有 Chat 應用程式可以建立資訊卡。如果 Chat 應用程式以使用者的身分進行驗證,訊息就無法包含卡片。 如要瞭解如何建立含有資訊卡的訊息,請參閱傳送訊息。 使用 Card Builder 設計及預覽資訊卡。 開啟資訊卡建立工具 |
annotations[] |
僅供輸出。與這則訊息中 |
thread |
郵件所屬的討論串。如需使用範例,請參閱「發起或回覆訊息討論串」。 |
space |
僅供輸出。如果 Chat 擴充應用程式以使用者的身分進行驗證,輸出內容只會填入「聊天室」 |
fallback |
選用設定。訊息資訊卡的純文字說明,用於實際資訊卡無法顯示時 (例如行動通知)。 |
action |
僅限輸入。Chat 應用程式可用來設定回應張貼方式的參數。 |
argument |
僅供輸出。訊息的純文字內文,已移除所有 Chat 應用程式提及內容。 |
slash |
僅供輸出。斜線指令資訊 (如適用)。 |
attachment[] |
選用設定。使用者上傳的附件。 |
matched |
僅供輸出。 |
thread |
僅供輸出。如果是 如果聊天室不支援在討論串中回覆,這個欄位一律會是 |
client |
選用設定。選用設定。訊息的自訂 ID。您可以使用欄位來識別訊息,或取得、刪除或更新訊息。如要設定自訂 ID,請在建立訊息時指定 |
emoji |
僅供輸出。訊息中的表情符號回應摘要清單。 |
private |
選用設定。不可變動。用於建立訊息的輸入內容,否則為僅限輸出。可查看訊息的使用者。設定後,訊息就會設為私密,只有指定使用者和 Chat 應用程式可看見。如要在要求中加入這個欄位,您必須使用應用程式驗證呼叫 Chat API,並省略下列項目: 詳情請參閱以私人方式傳送訊息。 |
deletion |
僅供輸出。已刪除訊息的相關資訊。設定 |
quoted |
僅供輸出。Google Chat 使用者在聊天室中引用的訊息相關資訊。Google Chat 使用者可以引用訊息來回覆。 |
attached |
僅供輸出。郵件中附加的 GIF 圖片。 |
accessory |
選用設定。顯示在訊息底部的一或多個互動小工具。您可以將配件小工具新增至含有文字、卡片或兩者皆有的訊息中。不支援含有對話方塊的訊息。詳情請參閱「在訊息底部新增互動式小工具」。 如要建立含有配件小工具的訊息,您必須完成應用程式驗證。 |
CardWithId
Google Chat 訊息中的資訊卡。
只有 Chat 應用程式可以建立資訊卡。如果即時通訊應用程式以使用者身分進行驗證,訊息就無法包含資訊卡。
使用資訊卡建構工具設計及預覽資訊卡。
開啟資訊卡建立工具JSON 表示法 |
---|
{
"cardId": string,
"card": {
object ( |
欄位 | |
---|---|
card |
如果訊息包含多張資訊卡,則為必填。訊息中卡片的專屬 ID。 |
card |
資訊卡。大小上限為 32 KB。 |
註解
僅供輸出。與郵件內文純文字相關的註解。如要為文字訊息加上基本格式設定,請參閱「格式設定文字訊息」。
純文字訊息內文範例:
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 ( |
欄位 | |
---|---|
type |
這個註解的類型。 |
length |
此註解對應的純文字訊息內文子字串長度。 |
start |
在與這個註解對應的純文字訊息內文中開始索引 (從 0 開始,含首尾)。 |
聯集欄位 metadata 。關於註解的其他中繼資料。metadata 只能是下列其中一項: |
|
user |
使用者提及的中繼資料。 |
slash |
斜線指令的中繼資料。 |
rich |
複合式連結的中繼資料。 |
AnnotationType
註解的類型。
列舉 | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
整數清單的預設值。請勿使用。 |
USER_MENTION |
已提及使用者。 |
SLASH_COMMAND |
叫用斜線指令。 |
RICH_LINK |
複合式連結註解。 |
UserMentionMetadata
使用者提及 (@) 的註解中繼資料。
JSON 表示法 |
---|
{ "user": { object ( |
欄位 | |
---|---|
user |
使用者提及。 |
type |
使用者提及的內容類型。 |
類型
列舉 | |
---|---|
TYPE_UNSPECIFIED |
列舉的預設值。請勿使用。 |
ADD |
將使用者加入聊天室。 |
MENTION |
在聊天室中提及使用者。 |
SlashCommandMetadata
斜線指令 (/) 的註解中繼資料。
JSON 表示法 |
---|
{ "bot": { object ( |
欄位 | |
---|---|
bot |
叫用指令的 Chat 應用程式。 |
type |
斜線指令的類型, |
command |
系統所叫用的斜線指令名稱。 |
command |
叫用的斜線指令的指令 ID。 |
triggers |
指出斜線指令是否適用於對話方塊。 |
類型
列舉 | |
---|---|
TYPE_UNSPECIFIED |
列舉的預設值。請勿使用。 |
ADD |
將 Chat 應用程式新增至聊天室。 |
INVOKE |
在空間中叫用斜線指令。 |
RichLinkMetadata
資源的多媒體連結。
JSON 表示法 |
---|
{ "uri": string, "richLinkType": enum ( |
欄位 | |
---|---|
uri |
這個連結的 URI。 |
rich |
複合式連結類型。 |
聯集欄位 data 。已連結資源的資料。data 只能是下列其中一項: |
|
drive |
雲端硬碟連結的資料。 |
chat |
Chat 聊天室連結的資料。 |
RichLinkType
複合式連結類型。日後可能會有更多類型。
列舉 | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED |
整數清單的預設值。請勿使用。 |
DRIVE_FILE |
Google 雲端硬碟的互動式連結類型。 |
CHAT_SPACE |
Chat 聊天室的富連結類型。例如聊天室智慧型方塊。 |
DriveLinkData
Google 雲端硬碟連結的資料。
JSON 表示法 |
---|
{
"driveDataRef": {
object ( |
欄位 | |
---|---|
drive |
參照 Google 雲端硬碟檔案的 DriveDataRef。 |
mime |
已連結 Google 雲端硬碟資源的 MIME 類型。 |
ChatSpaceLinkData
Chat 聊天室連結的資料。
JSON 表示法 |
---|
{ "space": string, "thread": string, "message": string } |
欄位 | |
---|---|
space |
已連結 Chat 聊天室資源的聊天室。 格式: |
thread |
已連結 Chat 聊天室資源的討論串。 格式: |
message |
已連結 Chat 聊天室資源的訊息。 格式: |
討論串
Google Chat 聊天室中的討論串。如需使用說明,請參閱「發起或回覆訊息串」。
如果您在建立訊息時指定討論串,可以設定 messageReplyOption
欄位,指定在沒有相符的討論串時,系統將如何處理。
JSON 表示法 |
---|
{ "name": string, "threadKey": string } |
欄位 | |
---|---|
name |
ID。執行緒的資源名稱。 範例: |
thread |
選用設定。建立或更新執行緒的輸入內容。否則只會輸出。執行緒 ID。最多可支援 4000 個半形字元。 這個 ID 是設定它的 Chat 應用程式專屬。舉例來說,如果多個 Chat 應用程式使用相同的對話串鍵建立訊息,這些訊息會發布在不同的對話串中。如要在使用者或其他 Chat 應用程式建立的討論串中回覆,請改為指定討論串 |
ActionResponse
Chat 應用程式可用來設定回應發布方式的參數。
JSON 表示法 |
---|
{ "type": enum ( |
欄位 | |
---|---|
type |
僅限輸入。Chat 應用程式回應的類型。 |
url |
僅限輸入。使用者驗證或設定的網址。(僅適用於 |
dialog |
僅限輸入。對與對話方塊相關的互動事件的回應。必須搭配 |
updated |
僅限輸入。更新小工具的回應。 |
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 ( |
欄位 | |
---|---|
action |
僅限輸入。要求叫用或提交對話方塊的狀態。視需要向使用者顯示狀態和訊息。例如發生錯誤或成功時。 |
聯集欄位 action 。要執行的動作。action 只能是下列其中一項: |
|
dialog |
僅限輸入。要求的 Dialog。 |
對話方塊
包裝對話方塊的資訊卡主體。
JSON 表示法 |
---|
{
"body": {
object ( |
欄位 | |
---|---|
body |
僅限輸入。對話方塊的內文,透過互動視窗顯示。Google Chat 應用程式不支援下列資訊卡實體: |
ActionStatus
代表叫用或提交對話方塊的要求狀態。
JSON 表示法 |
---|
{
"statusCode": enum ( |
欄位 | |
---|---|
status |
狀態碼。 |
user |
這類訊息,用於向使用者傳送要求狀態的相關資訊。如未設定,系統會傳送以 |
程式碼
gRPC API 的標準錯誤代碼。
有時可能適用多個錯誤代碼。服務應傳回最適用的特定錯誤代碼。例如,如果 OUT_OF_RANGE
與 FAILED_PRECONDITION
代碼都適用,則最好使用前者。同樣地,NOT_FOUND
或 ALREADY_EXISTS
優先於 FAILED_PRECONDITION
。
列舉 | |
---|---|
OK |
非錯誤;於成功時傳回。 HTTP 對應:200 OK |
CANCELLED |
作業已取消,一般由呼叫者取消。 HTTP 對應:499 用戶端已關閉要求 |
UNKNOWN |
發生不明錯誤,舉例來說,如果從其他位址空間收到的 HTTP 對應:500 內部伺服器錯誤 |
INVALID_ARGUMENT |
用戶端指定了無效的引數。請注意,這與 HTTP 對應:400 錯誤的要求 |
DEADLINE_EXCEEDED |
期限於作業完成之前過期。針對變更系統狀態的作業,即使作業已成功完成,也可能傳回此錯誤。例如,來自伺服器的成功回應延遲時間可能已長到足以使期限過期。 HTTP 對應:504 閘道逾時 |
NOT_FOUND |
找不到某些要求的實體 (例如檔案或目錄)。 給伺服器開發人員的注意事項:如果某個請求遭到整個使用者類別拒絕 (例如功能逐步推出或未記錄的許可清單),您可以使用 HTTP 對應:404 找不到 |
ALREADY_EXISTS |
用戶端嘗試建立的實體 (例如檔案或目錄) 已存在。 HTTP 對應:409 衝突 |
PERMISSION_DENIED |
呼叫者沒有執行指定作業的權限。對於因耗用某些資源所導致的拒絕情形,不得使用 HTTP 對應:403 禁止 |
UNAUTHENTICATED |
要求沒有作業的有效驗證憑證。 HTTP 對應:401 未授權 |
RESOURCE_EXHAUSTED |
已耗盡某些資源,或許是每位使用者的配額,或許是完整檔案系統空間不足。 HTTP 對應:429 太多要求 |
FAILED_PRECONDITION |
作業已遭拒絕,因為系統不在執行作業所需的狀態下。例如要刪除的目錄非空白、rmdir 作業套用至非目錄等。 服務實作者可以參考以下指南,決定要使用 HTTP 對應:400 錯誤的要求 |
ABORTED |
作業已取消,原因通常是排序器檢查失敗或交易取消等並行問題。 如要決定採用 HTTP 對應:409 衝突 |
OUT_OF_RANGE |
嘗試作業時超過有效範圍,例如搜尋或讀取超過檔案結尾。 與
HTTP 對應:400 錯誤的要求 |
UNIMPLEMENTED |
未實作作業或作業在此服務中不受支援/未啟用。 HTTP 對應:501 未實作 |
INTERNAL |
內部錯誤。這表示基礎系統預期的某些不變的情形已被打破。此錯誤代碼保留供嚴重錯誤使用。 HTTP 對應:500 內部伺服器錯誤 |
UNAVAILABLE |
服務目前無法使用。這很可能是暫時性問題,可透過重試輪詢來解決。請注意,重試非冪等作業不一定安全。 如要決定採用 HTTP 對應:503 服務不可用 |
DATA_LOSS |
無法復原的資料遺失或損毀。 HTTP 對應:500 內部伺服器錯誤 |
UpdatedWidget
更新版小工具的回應。用於為小工具提供自動完成選項。
JSON 表示法 |
---|
{ "widget": string, // Union field |
欄位 | |
---|---|
widget |
已更新小工具的 ID。ID 必須與觸發更新要求的小工具 ID 相符。 |
聯集欄位 updated_widget 。已根據使用者動作更新小工具。updated_widget 只能是下列其中一項: |
|
suggestions |
小工具自動完成結果清單 |
SelectionItems
小工具自動完成結果清單。
JSON 表示法 |
---|
{
"items": [
{
object ( |
欄位 | |
---|---|
items[] |
SelectionItem 物件的陣列。 |
SlashCommand
Google Chat 中的斜線指令。
JSON 表示法 |
---|
{ "commandId": string } |
欄位 | |
---|---|
command |
系統叫用的斜線指令 ID。 |
MatchedUrl
Chat 訊息中的相符網址。即時通訊應用程式可以預覽相符的網址,詳情請參閱「預覽連結」。
JSON 表示法 |
---|
{ "url": string } |
欄位 | |
---|---|
url |
僅供輸出。比對成功的網址。 |
EmojiReactionSummary
回應含有特定表情符號的訊息的使用者人數。
JSON 表示法 |
---|
{
"emoji": {
object ( |
欄位 | |
---|---|
emoji |
僅供輸出。與回應相關聯的表情符號。 |
reaction |
僅供輸出。使用相關表情符號的回應總數。 |
DeletionMetadata
已刪除訊息的相關資訊。設定 deleteTime
時,系統會刪除訊息。
JSON 表示法 |
---|
{
"deletionType": enum ( |
欄位 | |
---|---|
deletion |
顯示刪除訊息的使用者。 |
DeletionType
刪除訊息的使用者及其刪除方式。日後可能會新增更多值。
列舉 | |
---|---|
DELETION_TYPE_UNSPECIFIED |
這個值未使用。 |
CREATOR |
使用者刪除自己的訊息。 |
SPACE_OWNER |
聊天室擁有者刪除了訊息。 |
ADMIN |
Google Workspace 管理員刪除了訊息。 |
APP_MESSAGE_EXPIRY |
Chat 應用程式在訊息到期後刪除訊息。 |
CREATOR_VIA_APP |
Chat 應用程式代表使用者刪除了訊息。 |
SPACE_OWNER_VIA_APP |
Chat 應用程式代表聊天室擁有者刪除訊息。 |
QuotedMessageMetadata
引用訊息的相關資訊。
JSON 表示法 |
---|
{ "name": string, "lastUpdateTime": string } |
欄位 | |
---|---|
name |
僅供輸出。引述訊息的資源名稱。 格式: |
last |
僅供輸出。引述訊息的建立時間戳記或上次更新時間戳記。 |
AttachedGif
使用網址指定的 GIF 圖片。
JSON 表示法 |
---|
{ "uri": string } |
欄位 | |
---|---|
uri |
僅供輸出。代管 GIF 圖片的網址。 |
AccessoryWidget
顯示在訊息底部的一或多個互動小工具。詳情請參閱在訊息底部新增互動式小工具。
JSON 表示法 |
---|
{ // Union field |
欄位 | |
---|---|
聯集欄位 action 。動作類型。action 只能是下列其中一項: |
|
button |
按鈕清單。 |
方法 |
|
---|---|
|
在 Google Chat 聊天室中建立訊息。 |
|
刪除訊息。 |
|
傳回郵件的詳細資料。 |
|
列出呼叫端使用者所屬聊天室中的訊息,包括來自封鎖成員和聊天室的訊息。 |
|
更新訊息。 |
|
更新訊息。 |