- 資源:Message
- JSON 表示法
- 資訊卡
- CardHeader
- ImageStyle
- Section
- WidgetMarkup
- TextParagraph
- 圖片
- OnClick
- FormAction
- ActionParameter
- OpenLink
- KeyValue
- 圖示
- 按鈕
- TextButton
- ImageButton
- CardAction
- CardWithId
- 資訊卡
- CardHeader
- ImageType
- Section
- 小工具
- TextParagraph
- TextSyntax
- 圖片
- OnClick
- 動作
- ActionParameter
- LoadIndicator
- 互動
- OpenLink
- OpenAs
- OnClose
- OverflowMenu
- OverflowMenuItem
- 圖示
- MaterialIcon
- DecoratedText
- VerticalAlignment
- 按鈕
- 顏色
- 類型
- 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
- 版面配置
- 晶片
- 輪轉介面
- CarouselCard
- NestedWidget
- CollapseControl
- DividerStyle
- CardAction
- CardFixedFooter
- DisplayStyle
- 註解
- AnnotationType
- UserMentionMetadata
- 類型
- SlashCommandMetadata
- 類型
- RichLinkMetadata
- RichLinkType
- DriveLinkData
- ChatSpaceLinkData
- CustomEmojiMetadata
- 執行緒
- 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,即可在要求中指定訊息,方法是將 |
sender |
僅供輸出。建立訊息的使用者。如果 Chat 應用程式以使用者身分進行驗證,輸出內容會填入 user |
createTime |
(選用步驟) 不可變更。如果是透過 Chat 建立的聊天室,則為訊息建立時間。這個欄位只能輸出,匯入模式聊天室除外。 如果是匯入模式的即時通訊空間,請將這個欄位設為訊息在來源中建立時的歷史時間戳記,以便保留原始建立時間。 |
lastUpdateTime |
僅供輸出。使用者上次編輯訊息的時間。如果訊息從未經過編輯,這個欄位會留空。 |
deleteTime |
僅供輸出。訊息在 Google Chat 中遭到刪除的時間。如果訊息不會刪除,這個欄位會是空白。 |
text |
(選用步驟) 訊息的純文字內文。系統會為圖片、影片或網頁的第一個連結生成預覽方塊。你也可以使用@提及 Google Chat 使用者,或聊天室中的所有成員。 如要瞭解如何建立文字訊息,請參閱「傳送訊息」。 |
formattedText |
僅供輸出。包含訊息
詳情請參閱「查看訊息中傳送的文字格式」一文。 |
cards[] |
已淘汰:請改用 您可以使用格式豐富的互動式資訊卡,顯示格式化文字、按鈕和可點選圖片等 UI 元素。資訊卡通常會顯示在郵件的純文字內文下方。 |
cardsV2[] |
(選用步驟) cards 陣列。 只有 Chat 應用程式可以建立資訊卡。如果即時通訊應用程式以使用者身分進行驗證,訊息就無法包含資訊卡。 如要瞭解如何建立含有資訊卡的訊息,請參閱「傳送訊息」。 使用資訊卡建構工具設計及預覽資訊卡。 開啟「資訊卡建立工具」 |
annotations[] |
僅供輸出。與這則訊息中的 |
thread |
郵件所屬的討論串。如需使用範例,請參閱「發起或回覆訊息討論串」。 |
space |
僅供輸出。如果 Chat 應用程式以使用者身分進行驗證,輸出內容只會填入 space |
fallbackText |
(選用步驟) 訊息資訊卡的純文字說明,用於無法顯示實際資訊卡的情況,例如行動通知。 |
actionResponse |
僅限輸入。Chat 應用程式可用來設定如何發布回覆的參數。 |
argumentText |
僅供輸出。訊息的純文字內文,已移除所有 Chat 應用程式提及內容。 |
slashCommand |
僅供輸出。斜線指令資訊 (如適用)。 |
attachment[] |
(選用步驟) 使用者上傳的附件。 |
matchedUrl |
僅供輸出。 |
threadReply |
僅供輸出。如果顯示 如果該空間不支援在討論串中回覆,這個欄位一律為 |
clientAssignedMessageId |
(選用步驟) 訊息的自訂 ID。你可以使用這個欄位識別訊息,或是取得、刪除或更新訊息。如要設定自訂 ID,請在建立訊息時指定 |
emojiReactionSummaries[] |
僅供輸出。訊息中表情符號回應摘要的清單。 |
privateMessageViewer |
(選用步驟) 不可變更。輸入內容,用於建立訊息,否則只會輸出內容。可查看訊息的使用者。設定後,訊息會設為私人訊息,只有指定使用者和 Chat 應用程式能看到。如要在要求中加入這個欄位,您必須使用應用程式驗證呼叫 Chat API,並省略下列項目: 詳情請參閱「私下傳送訊息」。 |
deletionMetadata |
僅供輸出。有關已刪除訊息的資訊。設定 |
quotedMessageMetadata |
僅供輸出。Google Chat 使用者在聊天室中引用訊息的相關資訊。Google Chat 使用者可以引用訊息來回覆。 |
attachedGifs[] |
僅供輸出。附加至郵件的 GIF 圖片。 |
accessoryWidgets[] |
(選用步驟) 顯示在郵件底部的互動式小工具。您可以在含有文字、資訊卡,或同時含有文字和資訊卡的訊息中新增配件小工具。不支援含有對話方塊的訊息。詳情請參閱「在訊息底部新增互動式小工具」。 如要建立含有配件小工具的訊息,必須驗證應用程式。 |
CardWithId
Google Chat 訊息中的資訊卡。
只有 Chat 應用程式可以建立資訊卡。如果即時通訊應用程式以使用者身分進行驗證,訊息就不能包含資訊卡。
使用資訊卡建構工具設計及預覽資訊卡。
開啟「資訊卡建立工具」JSON 表示法 |
---|
{
"cardId": string,
"card": {
object ( |
欄位 | |
---|---|
cardId |
如果訊息包含多張資訊卡,則為必填。郵件中卡片的專屬 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 |
此註解對應的純文字訊息內文子字串長度。 |
startIndex |
此註解對應的純文字訊息內文中的起始索引 (從 0 開始,含該索引)。 |
聯集欄位 metadata 。註解的其他中繼資料。metadata 只能是下列其中一項: |
|
userMention |
使用者提及的中繼資料。 |
slashCommand |
斜線指令的中繼資料。 |
richLinkMetadata |
複合式連結的中繼資料。 |
customEmojiMetadata |
自訂表情符號的中繼資料。 |
AnnotationType
註解類型。
列舉 | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
列舉的預設值。請勿使用。 |
USER_MENTION |
提及使用者。 |
SLASH_COMMAND |
系統會叫用斜線指令。 |
RICH_LINK |
豐富連結註解。 |
CUSTOM_EMOJI |
自訂表情符號註解。 |
UserMentionMetadata
使用者提及 (@) 的註解中繼資料。
JSON 表示法 |
---|
{ "user": { object ( |
欄位 | |
---|---|
user |
提及的使用者。 |
type |
使用者提及類型。 |
類型
列舉 | |
---|---|
TYPE_UNSPECIFIED |
列舉的預設值。請勿使用。 |
ADD |
將使用者新增至聊天室。 |
MENTION |
在聊天室中提及使用者。 |
SlashCommandMetadata
斜線指令 (/) 的註解中繼資料。
JSON 表示法 |
---|
{ "bot": { object ( |
欄位 | |
---|---|
bot |
叫用指令的 Chat 應用程式。 |
type |
斜線指令類型。 |
commandName |
所呼叫斜線指令的名稱。 |
commandId |
所叫用斜線指令的指令 ID。 |
triggersDialog |
指出斜線指令是否用於對話方塊。 |
類型
列舉 | |
---|---|
TYPE_UNSPECIFIED |
列舉的預設值。請勿使用。 |
ADD |
將 Chat 應用程式新增至聊天室。 |
INVOKE |
在聊天室中叫用斜線指令。 |
RichLinkMetadata
資源的豐富連結。
JSON 表示法 |
---|
{ "uri": string, "richLinkType": enum ( |
欄位 | |
---|---|
uri |
這個連結的 URI。 |
richLinkType |
複合式連結類型。 |
聯集欄位 data 。連結資源的資料。data 只能是下列其中一項: |
|
driveLinkData |
雲端硬碟連結的資料。 |
chatSpaceLinkData |
聊天室連結的資料。 |
RichLinkType
複合式連結類型。日後可能會新增更多類型。
列舉 | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED |
列舉的預設值。請勿使用。 |
DRIVE_FILE |
Google 雲端硬碟的富連結類型。 |
CHAT_SPACE |
Chat 聊天室的富連結類型。例如聊天室智慧型方塊。 |
DriveLinkData
Google 雲端硬碟連結的資料。
JSON 表示法 |
---|
{
"driveDataRef": {
object ( |
欄位 | |
---|---|
driveDataRef |
參照 Google 雲端硬碟檔案的 DriveDataRef。 |
mimeType |
連結的 Google 雲端硬碟資源 MIME 類型。 |
ChatSpaceLinkData
Chat 聊天室連結的資料。
JSON 表示法 |
---|
{ "space": string, "thread": string, "message": string } |
欄位 | |
---|---|
space |
連結的 Chat 聊天室資源所屬的聊天室。 格式: |
thread |
連結的 Chat 聊天室資源討論串。 格式: |
message |
連結的 Chat 聊天室資源訊息。 格式: |
CustomEmojiMetadata
自訂表情符號的註解中繼資料。
JSON 表示法 |
---|
{
"customEmoji": {
object ( |
欄位 | |
---|---|
customEmoji |
自訂表情符號。 |
討論串
Google Chat 聊天室中的對話串。如需使用範例,請參閱「發起或回覆訊息討論串」。
建立訊息時,如果指定了執行緒,可以設定 messageReplyOption
欄位,決定找不到相符執行緒時的處理方式。
JSON 表示法 |
---|
{ "name": string, "threadKey": string } |
欄位 | |
---|---|
name |
ID。執行緒的資源名稱。 範例: |
threadKey |
(選用步驟) 用於建立或更新執行緒的輸入內容。否則,僅供輸出。執行緒的 ID。最多可輸入 4,000 個半形字元。 這個 ID 專屬於設定該 ID 的 Google Chat 應用程式。舉例來說,如果多個 Chat 應用程式使用相同的討論串鍵建立訊息,這些訊息就會發布在不同的討論串中。如要回覆使用者或另一個 Chat 應用程式建立的討論串,請改為指定 |
ActionResponse
Chat 應用程式可用來設定如何發布回覆的參數。
JSON 表示法 |
---|
{ "type": enum ( |
欄位 | |
---|---|
type |
僅限輸入。Chat 應用程式的回應類型。 |
url |
僅限輸入。使用者驗證或設定的網址。(僅適用於 |
dialogAction |
|
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 |
僅限輸入。要求叫用或提交對話方塊的狀態。視需要向使用者顯示狀態和訊息。例如發生錯誤或成功時。 |
聯集欄位 action 。要執行的動作。action 只能是下列其中一項: |
|
dialog |
僅限輸入。要求的對話方塊。 |
對話方塊
對話方塊的資訊卡主體周圍的包裝函式。
JSON 表示法 |
---|
{
"body": {
object ( |
欄位 | |
---|---|
body |
僅限輸入。對話方塊主體,會以模式顯示。Google Chat 應用程式不支援下列資訊卡實體: |
ActionStatus
代表叫用或提交對話方塊的要求狀態。
JSON 表示法 |
---|
{
"statusCode": enum ( |
欄位 | |
---|---|
statusCode |
狀態碼。 |
userFacingMessage |
要傳送給使用者的訊息,說明要求狀態。如果未設定,系統會根據 |
程式碼
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
如果是 selectionInput
小工具,則會傳回多選選單的自動完成建議。
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 } |
欄位 | |
---|---|
commandId |
斜線指令的 ID。 |
MatchedUrl
Chat 訊息中相符的網址。即時通訊應用程式可以預覽相符的網址。詳情請參閱「預覽連結」。
JSON 表示法 |
---|
{ "url": string } |
欄位 | |
---|---|
url |
僅供輸出。相符的網址。 |
EmojiReactionSummary
使用特定表情符號回應訊息的人數。
JSON 表示法 |
---|
{
"emoji": {
object ( |
欄位 | |
---|---|
emoji |
僅供輸出。與回應相關聯的表情符號。 |
reactionCount |
僅供輸出。使用相關表情符號回應的總次數。 |
DeletionMetadata
有關已刪除訊息的資訊。設定 deleteTime
時,系統會刪除訊息。
JSON 表示法 |
---|
{
"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
有關引用訊息的資訊。
JSON 表示法 |
---|
{ "name": string, "lastUpdateTime": string } |
欄位 | |
---|---|
name |
僅供輸出。所引用訊息的資源名稱。 格式: |
lastUpdateTime |
僅供輸出。引用的訊息建立時間或上次更新時間的時間戳記。 |
AttachedGif
由網址指定的 GIF 圖片。
JSON 表示法 |
---|
{ "uri": string } |
欄位 | |
---|---|
uri |
僅供輸出。代管 GIF 圖片的網址。 |
AccessoryWidget
顯示在郵件底部的互動式小工具。詳情請參閱「在訊息底部新增互動式小工具」。
JSON 表示法 |
---|
{ // Union field |
欄位 | |
---|---|
聯集欄位 action 。動作類型。action 只能是下列其中一項: |
|
buttonList |
按鈕清單。 |
方法 |
|
---|---|
|
在 Google Chat 聊天室中建立訊息。 |
|
刪除訊息。 |
|
傳回訊息的詳細資料。 |
|
列出通話者所屬聊天室中的訊息,包括來自遭封鎖成員和聊天室的訊息。 |
|
更新訊息。 |
|
更新訊息。 |