索引
ChatService
(介面)AccessoryWidget
(訊息)ActionResponse
(訊息)ActionResponse.ResponseType
(列舉)ActionResponse.SelectionItems
(訊息)ActionResponse.UpdatedWidget
(訊息)ActionStatus
(訊息)Annotation
(訊息)AnnotationType
(列舉)AttachedGif
(訊息)Attachment
(訊息)Attachment.Source
(列舉)AttachmentDataRef
(訊息)CardWithId
(訊息)ChatSpaceLinkData
(訊息)CompleteImportSpaceRequest
(訊息)CompleteImportSpaceResponse
(訊息)ContextualAddOnMarkup
(訊息)ContextualAddOnMarkup.Card
(訊息)ContextualAddOnMarkup.Card.CardAction
(訊息)ContextualAddOnMarkup.Card.CardHeader
(訊息)ContextualAddOnMarkup.Card.CardHeader.ImageStyle
(列舉)ContextualAddOnMarkup.Card.Section
(訊息)CreateCustomEmojiRequest
(訊息)CreateMembershipRequest
(訊息)CreateMessageRequest
(訊息)CreateMessageRequest.MessageReplyOption
(列舉)CreateReactionRequest
(訊息)CreateSpaceRequest
(訊息)CustomEmoji
(訊息)CustomEmoji.CustomEmojiPayload
(訊息)DeleteCustomEmojiRequest
(訊息)DeleteMembershipRequest
(訊息)DeleteMessageRequest
(訊息)DeleteReactionRequest
(訊息)DeleteSpaceRequest
(訊息)DeletionMetadata
(訊息)DeletionMetadata.DeletionType
(列舉)Dialog
(訊息)DialogAction
(訊息)DriveDataRef
(訊息)DriveLinkData
(訊息)Emoji
(訊息)EmojiReactionSummary
(訊息)FindDirectMessageRequest
(訊息)GetAttachmentRequest
(訊息)GetCustomEmojiRequest
(訊息)GetMembershipRequest
(訊息)GetMessageRequest
(訊息)GetSpaceEventRequest
(訊息)GetSpaceNotificationSettingRequest
(訊息)GetSpaceReadStateRequest
(訊息)GetSpaceRequest
(訊息)GetThreadReadStateRequest
(訊息)Group
(訊息)HistoryState
(列舉)ListCustomEmojisRequest
(訊息)ListCustomEmojisResponse
(訊息)ListMembershipsRequest
(訊息)ListMembershipsResponse
(訊息)ListMessagesRequest
(訊息)ListMessagesResponse
(訊息)ListReactionsRequest
(訊息)ListReactionsResponse
(訊息)ListSpaceEventsRequest
(訊息)ListSpaceEventsResponse
(訊息)ListSpacesRequest
(訊息)ListSpacesResponse
(訊息)MatchedUrl
(訊息)Membership
(訊息)Membership.MembershipRole
(列舉)Membership.MembershipState
(列舉)MembershipBatchCreatedEventData
(訊息)MembershipBatchDeletedEventData
(訊息)MembershipBatchUpdatedEventData
(訊息)MembershipCreatedEventData
(訊息)MembershipDeletedEventData
(訊息)MembershipUpdatedEventData
(訊息)Message
(訊息)MessageBatchCreatedEventData
(訊息)MessageBatchDeletedEventData
(訊息)MessageBatchUpdatedEventData
(訊息)MessageCreatedEventData
(訊息)MessageDeletedEventData
(訊息)MessageUpdatedEventData
(訊息)QuotedMessageMetadata
(訊息)Reaction
(訊息)ReactionBatchCreatedEventData
(訊息)ReactionBatchDeletedEventData
(訊息)ReactionCreatedEventData
(訊息)ReactionDeletedEventData
(訊息)RichLinkMetadata
(訊息)RichLinkMetadata.RichLinkType
(列舉)SearchSpacesRequest
(訊息)SearchSpacesResponse
(訊息)SetUpSpaceRequest
(訊息)SlashCommand
(訊息)SlashCommandMetadata
(訊息)SlashCommandMetadata.Type
(列舉)Space
(訊息)Space.AccessSettings
(訊息)Space.AccessSettings.AccessState
(列舉)Space.MembershipCount
(訊息)Space.PermissionSetting
(訊息)Space.PermissionSettings
(訊息)Space.PredefinedPermissionSettings
(列舉)Space.SpaceDetails
(訊息)Space.SpaceThreadingState
(列舉)Space.SpaceType
(列舉)Space.Type
(列舉)SpaceBatchUpdatedEventData
(訊息)SpaceEvent
(訊息)SpaceNotificationSetting
(訊息)SpaceNotificationSetting.MuteSetting
(列舉)SpaceNotificationSetting.NotificationSetting
(列舉)SpaceReadState
(訊息)SpaceUpdatedEventData
(訊息)Thread
(訊息)ThreadReadState
(訊息)UpdateMembershipRequest
(訊息)UpdateMessageRequest
(訊息)UpdateSpaceNotificationSettingRequest
(訊息)UpdateSpaceReadStateRequest
(訊息)UpdateSpaceRequest
(訊息)User
(訊息)User.Type
(列舉)UserMentionMetadata
(訊息)UserMentionMetadata.Type
(列舉)WidgetMarkup
(訊息)WidgetMarkup.Button
(訊息)WidgetMarkup.FormAction
(訊息)WidgetMarkup.FormAction.ActionParameter
(訊息)WidgetMarkup.Icon
(列舉)WidgetMarkup.Image
(訊息)WidgetMarkup.ImageButton
(訊息)WidgetMarkup.KeyValue
(訊息)WidgetMarkup.OnClick
(訊息)WidgetMarkup.OpenLink
(訊息)WidgetMarkup.TextButton
(訊息)WidgetMarkup.TextParagraph
(訊息)
ChatService
可讓開發人員在 Google Chat 平台上建構 Chat 應用程式和整合功能。
CompleteImportSpace |
---|
完成指定聊天室的匯入程序,並讓使用者查看。 需要應用程式驗證和全網域委派。詳情請參閱「授權 Google Chat 應用程式匯入資料」。
|
CreateCustomEmoji |
---|
需要使用者驗證。
|
CreateMembership |
---|
為通話 Chat 應用程式、使用者或 Google 群組建立會員資格。不支援為其他 Chat 應用程式建立會員。建立會員資格時,如果指定成員已停用自動接受政策,則他們會收到邀請,必須接受空間邀請才能加入。否則,建立會員資格會直接將成員新增至指定的聊天室。 支援下列類型的驗證: 如需使用範例,請參閱:
|
CreateMessage |
---|
在 Google Chat 聊天室中建立訊息。如需範例,請參閱「傳送訊息」一文。
下圖說明使用應用程式驗證功能時,Chat 如何歸屬訊息。Chat 會將 Chat 應用程式顯示為訊息寄件者。訊息內容可包含文字 ( 下圖顯示使用者驗證功能時,Chat 如何歸屬訊息。Chat 會將使用者顯示為訊息傳送者,並顯示 Chat 應用程式的名稱,以便將訊息歸屬給該應用程式。訊息內容只能包含文字 ( 郵件大小 (包括郵件內容) 的上限為 32,000 個位元組。
|
CreateReaction |
---|
建立回應並新增至訊息。系統僅支援 Unicode 表情符號。如需範例,請參閱「新增訊息回應」。 需要使用者驗證。
|
CreateSpace |
---|
建立聊天室。可用於在 支援下列類型的驗證: 以應用程式身分進行驗證時,請務必在要求中設定 建立聊天室時的聊天室成員資格,取決於聊天室是在
如果在建立聊天室時收到
|
DeleteCustomEmoji |
---|
需要使用者驗證。
|
DeleteMembership |
---|
刪除會員資格。如需範例,請參閱「從聊天室中移除使用者或 Google Chat 應用程式」。 支援下列類型的驗證:
|
DeleteMessage |
---|
刪除訊息。如需範例,請參閱「刪除訊息」。 支援下列類型的驗證: 使用應用程式驗證時,要求只能刪除由呼叫的 Chat 應用程式建立的訊息。
|
DeleteReaction |
---|
刪除訊息的回應。系統僅支援 Unicode 表情符號。如需範例,請參閱「刪除回應」。 需要使用者驗證。
|
DeleteSpace |
---|
刪除已命名的聊天室。系統一律會執行連鎖刪除作業,也就是說,聊天室的子項資源 (例如在聊天室中發布的訊息和聊天室成員資格) 也會一併刪除。如需範例,請參閱「刪除聊天室」。 支援下列類型的驗證:
|
FindDirectMessage |
---|
傳回與指定使用者互傳的現有即時訊息。如果找不到直接訊息空間,就會傳回 使用應用程式驗證時,會傳回指定使用者與呼叫的 Chat 應用程式之間的即時訊息聊天室。 搭配使用者驗證,會傳回指定使用者與已驗證使用者之間的即時訊息空間。 // 支援下列類型的驗證:
|
GetAttachment |
---|
取得郵件附件的中繼資料。系統會使用 media API 擷取附件資料。如需範例,請參閱「取得郵件附件的中繼資料」一文。需要應用程式驗證。
|
GetCustomEmoji |
---|
需要使用者驗證。
|
GetMembership |
---|
傳回會籍的詳細資料。如需範例,請參閱「取得使用者或 Google Chat 應用程式會籍的詳細資料」。 支援下列類型的驗證:
|
GetMessage |
---|
傳回訊息的詳細資料。如需範例,請參閱「取得訊息詳細資料」。 支援下列類型的驗證: 注意:可能會傳回來自已封鎖成員或聊天室的訊息。
|
GetSpace |
---|
傳回聊天室的詳細資料。如需範例說明,請參閱「取得聊天室詳細資料」。 支援下列類型的驗證:
|
GetSpaceEvent |
---|
傳回 Google Chat 聊天室中的事件。事件酬載包含已變更資源的最新版本。舉例來說,如果您要求有關新訊息的事件,但該訊息稍後已更新,伺服器會在事件酬載中傳回已更新的 注意:系統不會在此要求的 Space 事件資料的 Space 物件中傳回 需要使用者驗證。如要取得事件,經過驗證的使用者必須是聊天室的成員。 如需範例,請參閱「取得 Google Chat 聊天室事件的詳細資料」。
|
GetSpaceNotificationSetting |
---|
需要使用者驗證。
|
GetSpaceReadState |
---|
傳回使用者在聊天室中的已讀狀態詳細資料,用於識別已讀和未讀訊息。如需範例,請參閱「取得使用者空間讀取狀態的詳細資料」。 需要使用者驗證。
|
GetThreadReadState |
---|
傳回使用者在會話串中讀取狀態的詳細資料,用於識別已讀和未讀的訊息。如需範例,請參閱「取得使用者會話讀取狀態的詳細資料」。 需要使用者驗證。
|
ListCustomEmojis |
---|
需要使用者驗證。
|
ListMemberships |
---|
列出聊天室中的會員。如需範例,請參閱「在聊天室中列出使用者和 Google Chat 應用程式」。使用應用程式驗證功能列出會籍時,系統會列出 Chat 應用程式可存取的聊天室會籍,但會排除 Chat 應用程式會籍 (包括 Chat 應用程式本身的會籍)。使用使用者驗證功能列出會員資格,系統會列出已驗證使用者可存取的聊天室會員資格。 支援下列類型的驗證:
|
ListMessages |
---|
列出呼叫端是成員的聊天室中的訊息,包括來自封鎖成員和聊天室的訊息。如果您列出沒有任何訊息的聊天室中的訊息,回應會是空白物件。使用 REST/HTTP 介面時,回應會包含空白的 JSON 物件 需要使用者驗證。
|
ListReactions |
---|
列出訊息的回應。如需範例,請參閱「列出訊息的回應」。 需要使用者驗證。
|
ListSpaceEvents |
---|
列出 Google Chat 聊天室中的事件。每個事件的酬載都包含最新版本的 Chat 資源。舉例來說,如果您列出新聊天室成員的事件,伺服器會傳回包含最新會員詳細資料的 需要使用者驗證。如要列出活動,已驗證的使用者必須是聊天室的成員。 如需範例,請參閱「列出 Google Chat 聊天室中的事件」。
|
ListSpaces |
---|
列出呼叫端的聊天室成員。群組通訊和即時訊息必須先傳送第一則訊息,系統才會列出相關資訊。如需範例,請參閱「列出聊天室」。 支援下列類型的驗證: 如要依 Google Workspace 機構列出所有命名空間,請改用
|
SearchSpaces |
---|
根據管理員的搜尋內容,傳回 Google Workspace 機構中的聊天室清單。 需要具備管理員權限的使用者驗證。在要求中,將
|
SetUpSpace |
---|
建立聊天室並新增指定使用者。系統會自動將呼叫使用者新增至聊天室,因此請勿在要求中將其指定為成員。如需範例,請參閱「設定聊天室並邀請初始成員」。 如要指定要新增的人類成員,請使用適當的 如要指定要新增的 Google 群組,請使用適當的 如果是已命名的聊天室或群組通訊,如果發起者封鎖或遭部分成員封鎖,或是沒有新增部分成員的權限,系統就不會將這些成員加入已建立的聊天室。 如要建立呼叫使用者與其他使用者之間的即時訊息 (DM),請指定一個代表使用者的會員資格。如果使用者互相封鎖,要求就會失敗,系統也不會建立訊息。 如要在呼叫使用者和呼叫應用程式之間建立 DM,請將 如果兩位使用者之間已存在私訊,即使在使用者提出要求時,其中一方使用者封鎖對方,系統仍會傳回現有的私訊。 不支援含有分支回覆的聊天室。如果在設定聊天室時收到 需要使用者驗證。
|
UpdateMembership |
---|
更新會員資格。如需範例,請參閱「更新使用者在聊天室中的成員資格」。 支援下列類型的驗證:
|
UpdateMessage |
---|
更新訊息。 支援下列類型的驗證: 使用應用程式驗證時,要求只能更新由呼叫的 Chat 應用程式所建立的訊息。
|
UpdateSpace |
---|
更新聊天室。如需範例,請參閱「更新聊天室」。 如果您更新 支援下列類型的驗證:
|
UpdateSpaceNotificationSetting |
---|
需要使用者驗證。
|
UpdateSpaceReadState |
---|
更新使用者在聊天室中的已讀狀態,用於識別已讀和未讀訊息。如需範例,請參閱「更新使用者的聊天室讀取狀態」。 需要使用者驗證。
|
AccessoryWidget
一或多個互動小工具,會顯示在訊息底部。詳情請參閱「在訊息底部新增互動式小工具」。
欄位 | |
---|---|
聯集欄位 action 。動作類型。action 只能是下列其中一項: |
|
button_ |
按鈕清單。 |
ActionResponse
Chat 應用程式可用來設定回應發布方式的參數。
欄位 | |
---|---|
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 |
小工具文字自動完成選項查詢。 |
SelectionItems
小工具自動完成結果清單。
欄位 | |
---|---|
items[] |
SelectionItem 物件的陣列。 |
UpdatedWidget
更新版小工具的回應。用於為小工具提供自動完成選項。
欄位 | |
---|---|
widget |
已更新的小工具 ID。ID 必須與觸發更新要求的小工具 ID 相符。 |
聯集欄位 updated_widget 。小工具會根據使用者動作更新。updated_widget 只能是下列其中一項: |
|
suggestions |
小工具自動完成結果清單 |
ActionStatus
代表要求叫用或提交對話方塊的狀態。
欄位 | |
---|---|
status_ |
狀態碼。 |
user_ |
傳送給使用者的訊息,說明要求狀態。如果未設定,系統會傳送以 |
註解
僅供輸出。與郵件純文字內文相關的註解。如要為文字訊息加上基本格式設定,請參閱「格式設定文字訊息」。
純文字訊息內文範例:
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"
}
}]
欄位 | |
---|---|
type |
這個註解的類型。 |
length |
這個註解對應的純文字訊息內文子字串長度。 |
start_ |
此註解對應的純文字訊息內文中,起始索引 (從 0 開始,包含起始索引)。 |
聯集欄位 metadata 。註解的其他中繼資料。metadata 只能是下列其中一項: |
|
user_ |
使用者提及的中繼資料。 |
slash_ |
斜線指令的中繼資料。 |
rich_ |
複合式連結的中繼資料。 |
AnnotationType
註解類型。
列舉 | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
整數清單的預設值。請勿使用。 |
USER_MENTION |
提及使用者。 |
SLASH_COMMAND |
系統會叫用斜線指令。 |
RICH_LINK |
豐富連結註解。 |
AttachedGif
透過網址指定的 GIF 圖片。
欄位 | |
---|---|
uri |
僅供輸出。代管 GIF 圖片的網址。 |
附件
Google Chat 中的附件。
欄位 | |
---|---|
name |
選用設定。附件的資源名稱,格式為 |
content_ |
僅供輸出。內容的原始檔案名稱,而非完整路徑。 |
content_ |
僅供輸出。檔案的內容類型 (MIME 類型)。 |
thumbnail_ |
僅供輸出。應用於向使用者預覽附件的縮圖網址。聊天應用程式不應使用這個網址下載附件內容。 |
download_ |
僅供輸出。下載網址,應用於讓使用者下載附件。聊天應用程式不應使用這個網址下載附件內容。 |
source |
僅供輸出。附件的來源。 |
聯集欄位 data_ref 。附件的資料參照。data_ref 只能是下列其中一項: |
|
attachment_ |
選用設定。附件資料的參照。這個欄位可用於建立或更新附件訊息,或使用媒體 API 下載附件資料。 |
drive_ |
僅供輸出。Google 雲端硬碟附件的參照。這個欄位可搭配 Google 雲端硬碟 API 使用。 |
來源
附件的來源。
列舉 | |
---|---|
SOURCE_UNSPECIFIED |
保留。 |
DRIVE_FILE |
檔案是 Google 雲端硬碟檔案。 |
UPLOADED_CONTENT |
檔案會上傳至 Chat。 |
AttachmentDataRef
附件資料的參照。
欄位 | |
---|---|
resource_ |
選用設定。附件資料的資源名稱。這個欄位可搭配媒體 API 使用,用於下載附件資料。 |
attachment_ |
選用設定。不透明權杖,其中包含已上傳附件的參照。客戶端會將其視為不透明字串,用於建立或更新附件 Chat 訊息。 |
CardWithId
Google Chat 訊息中的資訊卡。
只有 Chat 應用程式可以建立資訊卡。如果即時通訊應用程式以使用者身分進行驗證,訊息就無法包含資訊卡。
使用資訊卡建構工具設計及預覽資訊卡。
開啟資訊卡建立工具欄位 | |
---|---|
card_ |
如果訊息包含多張資訊卡,則為必填。訊息中卡片的專屬 ID。 |
card |
資訊卡。大小上限為 32 KB。 |
ChatSpaceLinkData
Chat 聊天室連結的資料。
欄位 | |
---|---|
space |
已連結的 Chat 聊天室資源的聊天室。 格式: |
thread |
已連結 Chat 聊天室資源的討論串。 格式: |
message |
已連結 Chat 聊天室資源的訊息。 格式: |
CompleteImportSpaceRequest
完成聊天室匯入程序的要求訊息。
欄位 | |
---|---|
name |
必要欄位。匯入模式聊天室的資源名稱。 格式: |
CompleteImportSpaceResponse
完成聊天室匯入程序的回應訊息。
欄位 | |
---|---|
space |
匯入模式聊天室。 |
ContextualAddOnMarkup
這個類型沒有任何欄位。
開發人員用來指定內容相關 AddOn 內容的標記。
資訊卡
資訊卡是可包含文字和圖片等 UI 小工具的 UI 元素。
欄位 | |
---|---|
header |
資訊卡的標頭。標題通常會包含標題和圖片。 |
sections[] |
各個部分以分隔線分隔。 |
card_ |
這張資訊卡的動作。 |
name |
資訊卡的名稱。 |
CardAction
資訊卡動作是指與資訊卡相關的動作。月結單資訊卡的常見操作包括:刪除月結單、傳送月結單電子郵件或在瀏覽器中開啟月結單。
Google Chat 應用程式不支援這項功能。
欄位 | |
---|---|
action_ |
用於顯示在動作選單項目中的標籤。 |
on_ |
這個動作項目的 onclick 動作。 |
CardHeader
欄位 | |
---|---|
title |
必須指定標題。標題的高度固定:如果您同時指定標題和副標題,每個標題都會佔用一行。如果只指定標題,系統會將標題放在兩行。 |
subtitle |
資訊卡標題的副標題。 |
image_ |
圖片類型 (例如正方形邊框或圓形邊框)。 |
image_ |
資訊卡標題中的圖片網址。 |
ImageStyle
列舉 | |
---|---|
IMAGE_STYLE_UNSPECIFIED |
|
IMAGE |
方形邊框。 |
AVATAR |
圓形邊框。 |
章節
一個區段包含一組小工具,這些小工具會依照指定的順序 (垂直) 算繪。在所有平台上,資訊卡的固定寬度都很窄,因此目前不需要版面配置屬性 (例如浮動)。
欄位 | |
---|---|
header |
專區的標題。系統支援格式化的文字。如要進一步瞭解如何設定文字格式,請參閱「在 Google Chat 應用程式中設定文字格式」和「在 Google Workspace 外掛程式中設定文字格式」。 |
widgets[] |
一個區段至少必須包含一個小工具。 |
CreateCustomEmojiRequest
建立自訂表情符號的要求。
欄位 | |
---|---|
custom_ |
必要欄位。要建立的自訂表情符號。 |
CreateMembershipRequest
建立會員資格的要求訊息。
欄位 | |
---|---|
parent |
必要欄位。要建立會籍的聊天室資源名稱。 格式:spaces/{space} |
membership |
必要欄位。要建立的成員關係。
當 Chat 應用程式為真人使用者建立會員關係時,必須使用特定授權範圍,並為特定欄位設定特定值:
邀請外部使用者加入擁有聊天室的 Workspace 機構時,必須進行使用者驗證。 當 Chat 應用程式為自己建立會員關係時,必須以使用者身分進行驗證,並使用 |
use_ |
選用設定。當 撥打的使用者必須是具備「管理即時通訊和聊天室對話」權限的 Google Workspace 管理員。 需要 使用管理員存取權建立應用程式會員資格,或為管理員 Google Workspace 機構以外的使用者建立會員資格,目前不支援這類操作。 |
CreateMessageRequest
建立訊息。
欄位 | |
---|---|
parent |
必要欄位。建立訊息的聊天室資源名稱。 格式: |
message |
必要欄位。訊息內文。 |
thread_key |
選用設定。已淘汰:請改用 |
request_ |
選用設定。此訊息的專屬要求 ID。指定現有要求 ID 會傳回使用該 ID 建立的訊息,而不會建立新訊息。 |
message_ |
選用設定。指定訊息是發起討論串還是回覆討論串。僅支援在已命名的聊天室中使用。 回應使用者互動時,系統會忽略這個欄位。如果是討論串內的互動,回覆會建立在同一討論串中。否則,系統會將回覆內容建立為新討論串。 |
message_ |
選用設定。訊息的自訂 ID。讓 Chat 應用程式能夠取得、更新或刪除訊息,而無須將系統指派的 ID 儲存在訊息的資源名稱 (在訊息的 這個欄位的值必須符合下列規定:
詳情請參閱「命名訊息」。 |
MessageReplyOption
指定回覆訊息的方式。日後可能會新增更多州別。
列舉 | |
---|---|
MESSAGE_REPLY_OPTION_UNSPECIFIED |
預設。啟動新執行緒。使用這個選項會忽略任何包含的 thread ID 或 。 |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD |
建立訊息,用於回覆 thread ID 或 指定的會話串。如果失敗,則訊息會改為啟動新的執行緒。 |
REPLY_MESSAGE_OR_FAIL |
建立訊息,用於回覆 thread ID 或 指定的會話串。如果使用新的 thread_key ,系統就會建立新的執行緒。如果訊息建立作業失敗,系統會改為傳回 NOT_FOUND 錯誤。 |
CreateReactionRequest
建立訊息回應。
欄位 | |
---|---|
parent |
必要欄位。建立回應的訊息。 格式: |
reaction |
必要欄位。要建立的回應。 |
CreateSpaceRequest
建立沒有成員的命名聊天室的要求。
欄位 | |
---|---|
space |
必要欄位。必須填入 如果收到 空間 |
request_ |
選用設定。此要求的專屬 ID。建議使用隨機 UUID。指定現有要求 ID 會傳回使用該 ID 建立的聊天室,而不是建立新的聊天室。使用不同的已驗證使用者,指定相同 Chat 應用程式中的現有要求 ID 會傳回錯誤。 |
CustomEmoji
代表自訂表情符號。
欄位 | |
---|---|
name |
ID。伺服器指派的自訂表情符號資源名稱。 格式: |
uid |
僅供輸出。自訂表情符號資源的專屬鍵。 |
emoji_ |
選用設定。不可變動。使用者提供的自訂表情符號名稱,在機構內不重複。 建立自訂表情符號時必須提供,否則僅供輸出。 表情符號名稱開頭和結尾必須為冒號,且只能使用小寫英數字元、連字號和底線。連字號和底線可用於分隔字詞,但不能連續使用。 示例: |
temporary_ |
僅供輸出。自訂表情符號的圖片網址,有效時間至少 10 分鐘。請注意,建立自訂表情符號時,回應中不會填入這個值。 |
payload |
選用設定。僅限輸入。酬載資料。建立自訂表情符號時必須提供。 |
CustomEmojiPayload
自訂表情符號的酬載資料。
欄位 | |
---|---|
file_ |
必要欄位。僅限輸入。自訂表情符號使用的圖片。 酬載大小必須小於 256 KB,且圖片尺寸必須介於 64 和 500 像素之間。限制條件可能會有所變動。 |
filename |
必要欄位。僅限輸入。圖片檔案名稱。 支援的檔案副檔名: |
DeleteCustomEmojiRequest
要求刪除自訂表情符號。
欄位 | |
---|---|
name |
必要欄位。要刪除的自訂表情符號資源名稱。 格式: 您可以使用表情符號名稱做為 |
DeleteMembershipRequest
要求刪除聊天室成員資格。
欄位 | |
---|---|
name |
必要欄位。要刪除的會員資格的資源名稱。即時通訊應用程式可以刪除使用者或自己的會員資格。即時通訊應用程式無法刪除其他應用程式的會員資格。 刪除使用者會員資格時,需要 刪除應用程式會員資格時,需要 格式: |
use_ |
選用設定。當 撥打的使用者必須是具備「管理即時通訊和聊天室對話」權限的 Google Workspace 管理員。 需要 管理員存取權不支援刪除聊天室中的應用程式會員資格。 |
DeleteMessageRequest
要求刪除訊息。
欄位 | |
---|---|
name |
必要欄位。訊息的資源名稱。 格式: 如果您為訊息設定了自訂 ID,可以使用 |
force |
選用設定。 只有在以使用者身分驗證時才適用。以 Chat 應用程式身分驗證時,這項設定不會有任何作用。 |
DeleteReactionRequest
刪除訊息的回應。
欄位 | |
---|---|
name |
必要欄位。要刪除的回應名稱。 格式: |
DeleteSpaceRequest
要求刪除聊天室。
欄位 | |
---|---|
name |
必要欄位。要刪除的聊天室資源名稱。 格式: |
use_ |
選用設定。當 撥打的使用者必須是具備「管理即時通訊和聊天室對話」權限的 Google Workspace 管理員。 需要 |
DeletionMetadata
已刪除訊息的相關資訊。設定 delete_time
時,系統會刪除訊息。
欄位 | |
---|---|
deletion_ |
指出誰刪除了訊息。 |
DeletionType
誰刪除訊息,以及刪除方式。日後可能會新增更多值。
列舉 | |
---|---|
DELETION_TYPE_UNSPECIFIED |
此值未使用。 |
CREATOR |
使用者刪除自己的訊息。 |
SPACE_OWNER |
聊天室擁有者已刪除訊息。 |
ADMIN |
訊息已由 Google Workspace 管理員刪除。 |
APP_MESSAGE_EXPIRY |
Chat 應用程式在訊息到期後刪除訊息。 |
CREATOR_VIA_APP |
Chat 應用程式代表使用者刪除訊息。 |
SPACE_OWNER_VIA_APP |
Chat 應用程式代表聊天室擁有者刪除訊息。 |
對話方塊
包裝對話方塊的資訊卡主體。
欄位 | |
---|---|
body |
僅限輸入。對話方塊的內容,會以模態顯示。Google Chat 應用程式不支援下列資訊卡實體: |
DialogAction
包含對話框和要求狀態碼。
欄位 | |
---|---|
action_ |
僅限輸入。要求叫用或提交對話方塊的狀態。視需要向使用者顯示狀態和訊息。例如在發生錯誤或成功時。 |
聯集欄位 action 。要執行的動作。action 只能是下列其中一項: |
|
dialog |
僅限輸入。要求的 對話方塊。 |
DriveDataRef
參照 Drive 附件的資料。
欄位 | |
---|---|
drive_ |
雲端硬碟檔案的 ID。與 Drive API 搭配使用。 |
DriveLinkData
Google 雲端硬碟連結的資料。
欄位 | |
---|---|
drive_ |
參照 Google 雲端硬碟檔案的 DriveDataRef。 |
mime_ |
已連結 Google 雲端硬碟資源的 MIME 類型。 |
Emoji
用於回應訊息的表情符號。
欄位 | |
---|---|
聯集欄位 content 。必要欄位。表情符號的內容。content 只能是下列其中一項: |
|
unicode |
選用設定。以萬國碼字串表示的基本表情符號。 |
custom_ |
僅供輸出。自訂表情符號。 |
EmojiReactionSummary
使用特定表情符號回應訊息的使用者人數。
欄位 | |
---|---|
emoji |
僅供輸出。與回應相關聯的表情符號。 |
reaction_ |
僅供輸出。使用相關表情符號的回應總數。 |
FindDirectMessageRequest
根據使用者資源取得即時訊息聊天室的要求。
欄位 | |
---|---|
name |
必要欄位。要尋找即時訊息的使用者資源名稱。 格式: |
GetAttachmentRequest
要求取得附件。
欄位 | |
---|---|
name |
必要欄位。附件的資源名稱,格式為 |
GetCustomEmojiRequest
要求傳回單一自訂表情符號。
欄位 | |
---|---|
name |
必要欄位。自訂表情符號的資源名稱。 格式: 您可以使用表情符號名稱做為 |
GetMembershipRequest
要求加入聊天室。
欄位 | |
---|---|
name |
必要欄位。要擷取的會員資源名稱。 如要使用使用者驗證取得應用程式本身的成員資格,您可以選擇使用 格式: 您可以使用使用者的電子郵件地址做為 |
use_ |
選用設定。當 撥打的使用者必須是具備「管理即時通訊和聊天室對話」權限的 Google Workspace 管理員。 需要 使用管理員存取權時,系統不支援在聊天室中取得應用程式會員資格。 |
GetMessageRequest
要求取得訊息。
欄位 | |
---|---|
name |
必要欄位。訊息的資源名稱。 格式: 如果您已為訊息設定自訂 ID,可以使用 |
GetSpaceEventRequest
用於取得聊天室事件的請求訊息。
欄位 | |
---|---|
name |
必要欄位。聊天室事件的資源名稱。 格式: |
GetSpaceNotificationSettingRequest
要求訊息,以便取得聊天室通知設定。僅支援取得來電使用者的通知設定。
欄位 | |
---|---|
name |
必要欄位。格式:users/{user}/spaces/{space}/spaceNotificationSetting
|
GetSpaceReadStateRequest
GetSpaceReadState API 的要求訊息。
欄位 | |
---|---|
name |
必要欄位。要擷取的聊天室讀取狀態資源名稱。 僅支援取得呼叫使用者的讀取狀態。 如要參照呼叫使用者,請設定下列其中一個項目:
格式:users/{user}/spaces/{space}/spaceReadState |
GetSpaceRequest
要求傳回單一空格。
欄位 | |
---|---|
name |
必要欄位。聊天室的資源名稱,格式為 格式: |
use_ |
選用設定。當 撥打的使用者必須是具備「管理即時通訊和聊天室對話」權限的 Google Workspace 管理員。 需要 |
GetThreadReadStateRequest
GetThreadReadStateRequest API 的要求訊息。
欄位 | |
---|---|
name |
必要欄位。要擷取的執行緒讀取狀態資源名稱。 僅支援取得呼叫使用者的讀取狀態。 如要參照呼叫使用者,請設定下列其中一個項目:
格式:users/{user}/spaces/{space}/threads/{thread}/threadReadState |
群組
Google Chat 中的 Google 網路論壇。
欄位 | |
---|---|
name |
Google 群組的資源名稱。 代表 Cloud Identity Groups API 中的群組。 格式:groups/{group} |
HistoryState
訊息和聊天室的記錄狀態。指定訊息和對話串建立後的保留時間。
列舉 | |
---|---|
HISTORY_STATE_UNSPECIFIED |
預設值。請勿使用。 |
HISTORY_OFF |
記錄關閉。訊息和對話串會保留 24 小時。 |
HISTORY_ON |
記錄功能已開啟。貴機構的保管箱資料保留規則會指定郵件和會話串保留的時間長度。 |
ListCustomEmojisRequest
要求傳回自訂表情符號清單。
欄位 | |
---|---|
page_ |
選用設定。傳回的自訂表情符號數量上限。服務傳回的自訂表情符號可能少於這個值。如未指定,則預設值為 25。許可的最大值為 200;超出的數值將一律指定為 200。 |
page_ |
選用設定。(如果是從先前的查詢繼續執行)。 從先前呼叫的列出自訂表情符號傳回的頁面權杖。提供此項目即可擷取後續網頁。 進行分頁時,篩選器值應與提供網頁權杖的呼叫相符。傳遞其他值可能會導致非預期的結果。 |
filter |
選用設定。查詢篩選器。 支援依創作者篩選。 如要依創作者篩選,您必須指定有效的值。目前只有 舉例來說,下列查詢會傳回呼叫端建立的自訂表情符號:
伺服器會拒絕無效的查詢,並傳回 |
ListCustomEmojisResponse
回應自訂表情符號清單。
欄位 | |
---|---|
custom_ |
未排序的清單。要求 (或第一個) 頁面中的自訂表情符號清單。 |
next_ |
可做為 |
ListMembershipsRequest
要求列出會員資格訊息。
欄位 | |
---|---|
parent |
必要欄位。要擷取成員名單的聊天室資源名稱。 格式:spaces/{space} |
page_ |
選用設定。要傳回的會員數量上限。服務傳回的產品數量可能會少於這個值。 如未指定,最多會傳回 100 個會員。 值的上限為 1000。如果您使用的值超過 1000,系統會自動將其變更為 1000。 負值會傳回 |
page_ |
選用設定。從先前呼叫的清單會員資格傳回的頁面權杖。提供這個參數即可擷取後續網頁。 進行分頁時,提供的所有其他參數都必須與提供網頁權杖的呼叫相符。將不同值傳遞至其他參數可能會導致意外結果。 |
filter |
選用設定。查詢篩選器。 你可以依成員的角色 ( 如要依角色篩選,請將 如要依類型篩選,請將 如要同時依角色和類型篩選,請使用 將 舉例來說,以下查詢有效:
以下查詢無效:
伺服器會拒絕無效的查詢,並傳回 |
show_ |
選用設定。在 |
show_ |
選用設定。當 目前需要使用者驗證。 |
use_ |
選用設定。當 撥打的使用者必須是具備「管理即時通訊和聊天室對話」權限的 Google Workspace 管理員。 需要 使用管理員存取權時,系統不支援在聊天室中列出應用程式成員資格。 |
ListMembershipsResponse
回覆聊天室成員清單。
欄位 | |
---|---|
memberships[] |
未排序的清單。要求 (或第一個) 網頁中的會員清單。 |
next_ |
可做為 |
ListMessagesRequest
列出使用者所屬指定聊天室中的訊息。
欄位 | |
---|---|
parent |
必要欄位。要列出訊息的空間資源名稱。 格式: |
page_ |
選用設定。要傳回的訊息數量上限。服務傳回的訊息可能會少於這個值。 如未指定,最多會傳回 25 個。 值的上限為 1000。如果您使用的值超過 1000,系統會自動將其變更為 1000。 負值會傳回 |
page_ |
選用設定。從先前 list 訊息呼叫傳回的頁面權杖。提供這個參數即可擷取後續網頁。 進行分頁時,提供的所有其他參數都必須與提供網頁權杖的呼叫相符。將不同值傳遞至其他參數可能會導致意外結果。 |
filter |
選用設定。查詢篩選器。 您可以依日期 ( 如要依建立日期篩選訊息,請使用 RFC-3339 格式和雙引號,指定含有時間戳記的 如要依據執行緒篩選,請指定 如要同時依據會話串和日期篩選,請在查詢中使用 舉例來說,以下查詢有效:
伺服器會拒絕無效的查詢,並傳回 |
order_ |
選用設定。訊息清單的排序方式。指定要依照排序作業排序的值。有效的排序作業值如下:
預設排序為 |
show_ |
選用設定。是否要納入已刪除的訊息。已刪除的郵件會顯示刪除時間和相關中繼資料,但無法提供郵件內容。 |
ListMessagesResponse
回覆訊息,用於回覆列表訊息。
欄位 | |
---|---|
messages[] |
訊息清單。 |
next_ |
您可以傳送符記做為 |
ListReactionsRequest
列出訊息的回應。
欄位 | |
---|---|
parent |
必要欄位。使用者回應的訊息。 格式: |
page_ |
選用設定。傳回的回應數量上限。服務傳回的回應數量可能會少於這個值。如未指定,則預設值為 25。許可的最大值為 200;超出的數值將一律指定為 200。 |
page_ |
選用設定。(如果是從先前的查詢繼續執行)。 先前列出反應呼叫傳回的頁面權杖。提供此項目即可擷取後續網頁。 進行分頁時,篩選器值應與提供網頁權杖的呼叫相符。傳遞其他值可能會導致非預期的結果。 |
filter |
選用設定。查詢篩選器。 你可以依表情符號 ( 如要篩選多個表情符號或使用者的回應,請使用 如要依表情符號和使用者篩選回應,請使用 如果查詢同時使用 舉例來說,以下查詢有效:
以下查詢無效:
伺服器會拒絕無效的查詢,並傳回 |
ListReactionsResponse
回應清單回應要求。
欄位 | |
---|---|
reactions[] |
在要求的 (或第一個) 頁面中,列出回應清單。 |
next_ |
用來擷取下一頁結果的接續符記。最後一頁的結果為空白。 |
ListSpaceEventsRequest
要求訊息,用於列出空間事件。
欄位 | |
---|---|
parent |
必要欄位。發生事件的 Google Chat 聊天室資源名稱。 格式: |
page_ |
選用設定。傳回的空格事件數量上限。服務傳回的產品數量可能會少於這個值。 負值會傳回 |
page_ |
選用設定。從先前 list space events 呼叫收到的頁面權杖。提供此項目即可擷取後續網頁。 進行分頁時,提供至清單空間事件的所有其他參數,都必須與提供網頁權杖的呼叫相符。將不同值傳遞至其他參數可能會導致意外結果。 |
filter |
必要欄位。查詢篩選器。 您必須使用 has 您也可以依開始時間 (
如要指定開始或結束時間,請使用等於 舉例來說,以下查詢有效:
以下查詢無效:
伺服器會拒絕無效的查詢,並傳回 |
ListSpaceEventsResponse
回應訊息,用於列出聊天室活動。
欄位 | |
---|---|
space_ |
結果會依時間順序傳回 (最早的事件會列在最前面)。注意:清單要求不會在 Space 物件中傳回 |
next_ |
用於擷取更多事件的接續權杖。如果省略這個欄位,就不會有後續頁面。 |
ListSpacesRequest
要求列出呼叫端所屬的聊天室。
欄位 | |
---|---|
page_ |
選用設定。要傳回的空格數量上限。服務傳回的產品數量可能會少於這個值。 如未指定,最多會傳回 100 個空間。 值的上限為 1000。如果您使用的值超過 1000,系統會自動將其變更為 1000。 負值會傳回 |
page_ |
選用設定。接收自先前 list spaces 呼叫的頁面權杖。提供這個參數即可擷取後續網頁。 進行分頁時,篩選器值應與提供網頁權杖的呼叫相符。傳遞其他值可能會導致非預期的結果。 |
filter |
選用設定。查詢篩選器。 您可以依據聊天室類型 ( 如要依空間類型篩選,您必須指定有效的列舉值,例如 舉例來說,以下查詢有效:
伺服器會拒絕無效的查詢,並傳回 |
ListSpacesResponse
清單聊天室要求的回應。
欄位 | |
---|---|
spaces[] |
要求 (或第一個) 頁面中的聊天室清單。注意:清單要求不會在 Space 物件中傳回 |
next_ |
您可以傳送符記做為 |
MatchedUrl
Chat 訊息中的相符網址。Chat 應用程式可以預覽相符的網址。詳情請參閱「預覽連結」。
欄位 | |
---|---|
url |
僅供輸出。比對成功的網址。 |
成員資格
代表 Google Chat 中的會員關係,例如使用者或 Chat 應用程式是否已受邀加入聊天室、是否已加入聊天室或是否已離開聊天室。
欄位 | |
---|---|
name |
ID。由伺服器指派的會員資源名稱。 格式: |
state |
僅供輸出。會員資格狀態。 |
role |
選用設定。使用者在 Chat 聊天室中的角色,決定他們在聊天室中可執行的動作。 這個欄位只能在 |
create_ |
選用設定。不可變動。會員建立時間,例如成員加入或獲邀加入聊天室的時間。這個欄位只會輸出資料,除非用於匯入模式聊天室匯入過往會員資料。 |
delete_ |
選用設定。不可變動。刪除會員資格的時間,例如成員離開或從聊天室中移除的時間。這個欄位只會輸出資料,除非用於匯入模式聊天室匯入過往會員資料。 |
聯集欄位 memberType 。與此會員資格相關聯的成員。日後可能會支援其他會員類型。memberType 只能是下列其中一項: |
|
member |
選用設定。會員所對應的 Google Chat 使用者或應用程式。如果 Chat 應用程式以使用者身分進行驗證,輸出內容就會填入 user |
group_ |
選用設定。會員資格對應的 Google 群組。 如要讀取或變更 Google 群組的成員資格,您必須驗證使用者身分。 |
MembershipRole
代表使用者在 Chat 聊天室中允許的動作。日後可能會新增更多列舉值。
列舉 | |
---|---|
MEMBERSHIP_ROLE_UNSPECIFIED |
預設值。users :他們不是聊天室成員,但可以邀請加入。Google Groups :一律會指派此角色 (日後可能會使用其他列舉值)。 |
ROLE_MEMBER |
聊天室成員。使用者具備基本權限,例如傳送訊息至聊天室。在 1:1 和未命名的群組對話中,每個人都具備這個角色。 |
ROLE_MANAGER |
聊天室管理員。使用者擁有所有基本權限,以及管理權限,可用於管理聊天室,例如新增或移除成員。僅支援 SpaceType.SPACE 。 |
MembershipState
指定成員與聊天室的關係。日後可能會支援其他會員狀態。
列舉 | |
---|---|
MEMBERSHIP_STATE_UNSPECIFIED |
預設值。請勿使用。 |
JOINED |
使用者會加入聊天室,並可參與聊天室。 |
INVITED |
使用者已獲邀加入聊天室,但尚未加入。 |
NOT_A_MEMBER |
使用者不屬於該聊天室,且沒有待處理的邀請。 |
MembershipBatchCreatedEventData
多個新會籍的事件酬載。
事件類型:google.workspace.chat.membership.v1.batchCreated
欄位 | |
---|---|
memberships[] |
新會員清單。 |
MembershipBatchDeletedEventData
多個已刪除會員的事件酬載。
事件類型:google.workspace.chat.membership.v1.batchDeleted
欄位 | |
---|---|
memberships[] |
已刪除的會員資格清單。 |
MembershipBatchUpdatedEventData
多個更新會籍的事件酬載。
事件類型:google.workspace.chat.membership.v1.batchUpdated
欄位 | |
---|---|
memberships[] |
已更新會員的清單。 |
MembershipCreatedEventData
新會員的事件酬載。
事件類型:google.workspace.chat.membership.v1.created
。
欄位 | |
---|---|
membership |
新會員方案。 |
MembershipDeletedEventData
已刪除會員資格的事件酬載。
事件類型:google.workspace.chat.membership.v1.deleted
欄位 | |
---|---|
membership |
已刪除的會籍。系統只會填入 |
MembershipUpdatedEventData
更新會員資格的事件酬載。
事件類型:google.workspace.chat.membership.v1.updated
欄位 | |
---|---|
membership |
更新後的成員資格。 |
訊息
Google Chat 聊天室中的訊息。
欄位 | |
---|---|
name |
ID。訊息的資源名稱。 格式: 其中 如果您在建立訊息時設定自訂 ID,可以使用這個 ID 在要求中指定訊息,方法是將 |
sender |
僅供輸出。建立訊息的使用者。如果 Chat 應用程式以使用者身分進行驗證,輸出內容就會填入 user |
create_ |
選用設定。不可變動。如果是在 Chat 中建立的聊天室,則為訊息建立時間。這個欄位只會輸出,除非用於匯入模式聊天室。 對於匯入模式空間,請將這個欄位設為訊息在來源中建立的歷史時間戳記,以便保留原始建立時間。 |
last_ |
僅供輸出。使用者上次編輯訊息的時間。如果訊息從未經過編輯,這個欄位會留空。 |
delete_ |
僅供輸出。訊息在 Google Chat 中遭到刪除的時間。如果訊息從未刪除,這個欄位會留空。 |
text |
選用設定。訊息的純文字內文。第一個圖片、影片或網頁連結會產生預覽方塊。你也可以@提及 Google Chat 使用者,或是聊天室中的所有人。 如要瞭解如何建立文字訊息,請參閱「傳送訊息」。 |
formatted_ |
僅供輸出。包含訊息
詳情請參閱「查看訊息中傳送的文字格式」 |
cards[] |
已淘汰:請改用 您可以使用富格式和互動式資訊卡來顯示 UI 元素,例如格式文字、按鈕和可點選圖片。資訊卡通常會顯示在郵件純文字內文下方。 |
cards_ |
選用設定。cards 陣列。 只有 Chat 應用程式可以建立資訊卡。如果即時通訊應用程式以使用者身分進行驗證,訊息就無法包含資訊卡。 如要瞭解如何建立含有資訊卡的訊息,請參閱「傳送訊息」。 使用資訊卡建構工具設計及預覽資訊卡。 開啟資訊卡建立工具 |
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_ |
選用設定。一或多個互動小工具,會顯示在訊息底部。您可以在含有文字、資訊卡或文字和資訊卡的訊息中加入附屬小工具。不支援含有對話方塊的訊息。詳情請參閱「在訊息底部新增互動式小工具」。 如要建立含有配件小工具的訊息,您必須驗證應用程式。 |
MessageBatchCreatedEventData
多則新訊息的事件酬載。
事件類型:google.workspace.chat.message.v1.batchCreated
欄位 | |
---|---|
messages[] |
新訊息清單。 |
MessageBatchDeletedEventData
多個已刪除訊息的事件酬載。
事件類型:google.workspace.chat.message.v1.batchDeleted
欄位 | |
---|---|
messages[] |
已刪除的訊息清單。 |
MessageBatchUpdatedEventData
多則更新訊息的事件酬載。
事件類型:google.workspace.chat.message.v1.batchUpdated
欄位 | |
---|---|
messages[] |
已更新的訊息清單。 |
MessageCreatedEventData
新訊息的事件酬載。
事件類型:google.workspace.chat.message.v1.created
欄位 | |
---|---|
message |
新訊息。 |
MessageDeletedEventData
已刪除訊息的事件酬載。
事件類型:google.workspace.chat.message.v1.deleted
欄位 | |
---|---|
message |
已刪除的訊息。系統只會填入 |
MessageUpdatedEventData
更新訊息的事件酬載。
事件類型:google.workspace.chat.message.v1.updated
欄位 | |
---|---|
message |
更新後的訊息。 |
QuotedMessageMetadata
引述訊息的相關資訊。
欄位 | |
---|---|
name |
僅供輸出。引述訊息的資源名稱。 格式: |
last_ |
僅供輸出。引述訊息的建立時間戳記或上次更新時間戳記。 |
反應影片
對訊息的回應。
欄位 | |
---|---|
name |
ID。反應的資源名稱。 格式: |
user |
僅供輸出。建立回應的使用者。 |
emoji |
必要欄位。回應中使用的表情符號。 |
ReactionBatchCreatedEventData
多個新回應的事件酬載。
事件類型:google.workspace.chat.reaction.v1.batchCreated
欄位 | |
---|---|
reactions[] |
新回應清單。 |
ReactionBatchDeletedEventData
多個已刪除的回應事件酬載。
事件類型:google.workspace.chat.reaction.v1.batchDeleted
欄位 | |
---|---|
reactions[] |
已刪除的回應清單。 |
ReactionCreatedEventData
新回應的事件酬載。
事件類型:google.workspace.chat.reaction.v1.created
欄位 | |
---|---|
reaction |
新的回應。 |
ReactionDeletedEventData
已刪除的回應事件酬載。
類型:google.workspace.chat.reaction.v1.deleted
欄位 | |
---|---|
reaction |
已刪除的回應。 |
RichLinkMetadata
資源的多媒體連結。
欄位 | |
---|---|
uri |
這個連結的 URI。 |
rich_ |
複合式連結類型。 |
聯集欄位 data 。已連結資源的資料。data 只能是下列其中一項: |
|
drive_ |
雲端硬碟連結的資料。 |
chat_ |
Chat 聊天室連結的資料。 |
RichLinkType
複合式連結類型。日後可能會新增更多類型。
列舉 | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED |
整數清單的預設值。請勿使用。 |
DRIVE_FILE |
Google 雲端硬碟的互動式連結類型。 |
CHAT_SPACE |
Chat 聊天室的富連結類型。例如聊天室智慧型方塊。 |
SearchSpacesRequest
根據查詢要求搜尋聊天室清單。
欄位 | |
---|---|
use_ |
當 撥打的使用者必須是具備「管理即時通訊和聊天室對話」權限的 Google Workspace 管理員。 需要 這個方法目前僅支援管理員存取權,因此這個欄位只接受 |
page_ |
要傳回的空格數量上限。服務傳回的產品數量可能會少於這個值。 如未指定,最多會傳回 100 個空間。 值的上限為 1000。如果您使用的值超過 1000,系統會自動將其變更為 1000。 |
page_ |
從先前搜尋空間呼叫收到的符記。提供這個參數即可擷取後續網頁。 進行分頁時,提供的所有其他參數都必須與提供網頁權杖的呼叫相符。將不同值傳遞至其他參數可能會導致意外結果。 |
query |
必要欄位。搜尋查詢。 您可以使用下列參數進行搜尋:
在不同欄位中,系統僅支援 在同一個欄位中, 以下查詢範例有效:
|
order_ |
選用設定。聊天室清單的排序方式。 可用來排序的支援屬性如下:
有效的排序作業值如下:
支援的語法如下:
|
SearchSpacesResponse
回應,其中包含與搜尋聊天室要求相對應的聊天室清單。
欄位 | |
---|---|
spaces[] |
要求的聊天室頁面。 |
next_ |
可用於擷取後續網頁的符記。如果這個欄位留空,表示沒有後續網頁。 |
total_ |
在所有網頁中,符合查詢的空白總數。如果結果超過 10,000 個空格,這個值就是預估值。 |
SetUpSpaceRequest
要求建立聊天室,並將指定使用者加進其中。
欄位 | |
---|---|
space |
必要欄位。 如要建立聊天室,請將 如要建立群組通訊,請將 如要建立人與人之間的 1:1 對話,請將 如要建立人與呼叫 Chat 應用程式之間的 1:1 對話,請將 如果 |
request_ |
選用設定。此要求的專屬 ID。建議使用隨機 UUID。指定現有要求 ID 會傳回使用該 ID 建立的聊天室,而不是建立新的聊天室。使用不同的已驗證使用者,指定相同 Chat 應用程式中的現有要求 ID 會傳回錯誤。 |
memberships[] |
選用設定。邀請加入聊天室的 Google Chat 使用者或群組。請省略呼叫使用者,因為系統會自動加入該使用者。 目前此集合允許最多 20 個會員 (除了呼叫端)。 針對人類會員, 針對 Google 群組會員資格, 將 將 當您將 建立人與呼叫 Chat 應用程式之間的 1:1 對話時,必須為空白 (將 |
SlashCommand
Google Chat 中的斜線指令。
欄位 | |
---|---|
command_ |
系統叫用的斜線指令 ID。 |
SlashCommandMetadata
斜線指令 (/) 的註解中繼資料。
欄位 | |
---|---|
bot |
叫用指令的 Chat 應用程式。 |
type |
斜線指令的類型。 |
command_ |
系統所叫用的斜線指令名稱。 |
command_ |
已叫用的斜線指令指令 ID。 |
triggers_ |
指出斜線指令是否適用於對話方塊。 |
類型
列舉 | |
---|---|
TYPE_UNSPECIFIED |
整數清單的預設值。請勿使用。 |
ADD |
將 Chat 應用程式新增至聊天室。 |
INVOKE |
在聊天室中叫用斜線指令。 |
空格
Google Chat 中的聊天室。聊天室是指兩人以上使用者之間的對話,或使用者與 Chat 應用程式之間的一對一訊息。
欄位 | |
---|---|
name |
ID。聊天室的資源名稱。 格式: 其中 |
type |
僅供輸出。已淘汰:請改用 |
space_ |
選用設定。聊天室類型。建立聊天室或更新聊天室類型時必須提供。僅供其他用途使用。 |
single_ |
選用設定。聊天室是否為 Chat 應用程式與單一使用者之間的 DM。 |
threaded |
僅供輸出。已淘汰:請改用 |
display_ |
選用設定。聊天室的顯示名稱。使用 對於即時訊息,這個欄位可能會為空白。 最多支援 128 個半形字元。 |
external_ |
選用設定。不可變動。這個聊天室是否允許任何 Google Chat 使用者成為成員。在 Google Workspace 機構中建立聊天室時輸入。在下列情況下建立聊天室時,請省略這個欄位:
對於現有的聊天室,這個欄位僅供輸出。 |
space_ |
僅供輸出。Chat 聊天室中的討論串狀態。 |
space_ |
選用設定。聊天室的詳細資料,包括說明和規則。 |
space_ |
選用設定。這個聊天室中訊息和討論串的訊息記錄狀態。 |
import_ |
選用設定。這個聊天室是在 您必須通過使用者驗證,才能在 |
create_ |
選用設定。不可變動。如果是在 Chat 中建立的聊天室,則為聊天室建立的時間。這個欄位只會輸出,除非用於匯入模式聊天室。 如果是匯入模式聊天室,請將這個欄位設為來源中建立聊天室的歷史時間戳記,以便保留原始建立時間。 只有在 |
last_ |
僅供輸出。聊天室中最後一則訊息的時間戳記。 |
admin_ |
僅供輸出。針對使用 Chat 應用程式的即時訊息 (DM) 聊天室,請指出聊天室是由 Google Workspace 管理員建立。管理員可以代表機構中的使用者安裝 Chat 應用程式,並設定即時訊息。 如要支援管理員安裝功能,您的 Chat 應用程式必須提供即時訊息功能。 |
membership_ |
僅供輸出。已加入會員資格的次數,並按會員類型分組。當 |
access_ |
選用設定。指定聊天室的存取權設定。只有在 |
space_ |
僅供輸出。使用者存取聊天室的 URI。 |
import_ |
僅供輸出。如果聊天室仍處於匯入模式,系統會自動刪除聊天室。 在匯入模式中建立的每個聊天室,都必須在這個到期時間前使用 這個欄位只會在使用匯入模式建立的聊天室中填入資料。 |
customer |
選用設定。不可變動。聊天室網域的客戶 ID。只有在使用應用程式驗證建立聊天室,且 格式為 對於即時訊息,這個欄位不會填入任何內容。 |
聯集欄位 需要使用者驗證。 |
|
predefined_ |
選用設定。僅限輸入。預先定義的聊天室權限設定,僅在建立聊天室時輸入。如果未設定這個欄位,系統會建立協作空間。建立聊天室後,系統會在 |
permission_ |
選用設定。現有聊天室的聊天室權限設定。用於更新確切的聊天室權限設定,取代現有的權限設定。輸出內容會列出目前的權限設定。 |
AccessSettings
代表聊天室的存取權設定。
欄位 | |
---|---|
access_ |
僅供輸出。用於表示空間的存取狀態。 |
audience |
選用設定。目標對象的資源名稱,這些使用者可以探索聊天室、加入聊天室,以及預覽聊天室中的訊息。如果未設定,只有個別邀請或新增至聊天室的使用者或 Google 網路論壇成員才能存取聊天室。詳情請參閱「讓目標對象能夠輕鬆找到聊天室」。 格式: 如要使用 Google Workspace 機構的預設目標對象,請將值設為 讀取目標對象支援: 如果使用 設定目標對象時,需要進行使用者驗證。 |
AccessState
代表聊天室的存取狀態。
列舉 | |
---|---|
ACCESS_STATE_UNSPECIFIED |
這個 API 不支援或無法判斷存取狀態。 |
PRIVATE |
只有其他使用者或 Google Workspace 管理員個別新增或邀請的使用者或 Google 網路論壇群組,才能探索及存取聊天室。 |
DISCOVERABLE |
聊天室管理員已授予目標對象聊天室存取權。已個別新增或邀請加入聊天室的使用者或 Google 群組,也可以探索及存取聊天室。詳情請參閱「讓特定使用者可自由加入聊天室」。 建立可自由加入的聊天室時,必須進行使用者驗證。 |
MembershipCount
代表聊天室成員人數,並分為不同類別。
欄位 | |
---|---|
joined_ |
僅供輸出。直接加入聊天室的使用者人數,不含透過加入群組而加入聊天室的使用者。 |
joined_ |
僅供輸出。直接加入聊天室的所有群組數量。 |
PermissionSetting
代表聊天室權限設定。
欄位 | |
---|---|
managers_ |
選用設定。聊天室管理員是否具備這項權限。 |
members_ |
選用設定。非管理員成員是否具備這項權限。 |
PermissionSettings
您可以在更新現有命名聊天室時指定的權限設定。
如要在建立空間時設定權限,請在要求中指定 PredefinedPermissionSettings
欄位。
欄位 | |
---|---|
manage_ |
選用設定。管理聊天室成員和群組的設定。 |
modify_ |
選用設定。設定聊天室名稱、顯示圖片、說明和規範的更新方式。 |
toggle_ |
選用設定。用於開啟或關閉聊天室記錄的設定。 |
use_ |
選用設定。在聊天室中使用 @all 的設定。 |
manage_ |
選用設定。用於管理聊天室中應用程式的設定。 |
manage_ |
選用設定。用於管理聊天室中的 Webhook 設定。 |
post_ |
僅供輸出。在聊天室中張貼訊息的設定。 |
reply_ |
選用設定。回覆聊天室中訊息的設定。 |
PredefinedPermissionSettings
預先定義的權限設定,您只能在建立命名聊天室時指定。日後可能會新增更多設定。如要進一步瞭解命名聊天室的權限設定,請參閱「瞭解聊天室」。
列舉 | |
---|---|
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED |
不明。請勿使用。 |
COLLABORATION_SPACE |
設定,將聊天室設為協作聊天室,讓所有成員都能發布訊息。 |
ANNOUNCEMENT_SPACE |
將聊天室設為公告聊天室,只有聊天室管理員可以張貼訊息。 |
SpaceDetails
聊天室的詳細資料,包括說明和規則。
欄位 | |
---|---|
description |
選用設定。聊天室說明。例如說明聊天室的討論主題、功能用途或參與者。 最多支援 150 個半形字元。 |
guidelines |
選用設定。聊天室的規則、期望和禮儀。 最多支援 5,000 個半形字元。 |
SpaceThreadingState
指定 Chat 聊天室中的討論串狀態類型。
列舉 | |
---|---|
SPACE_THREADING_STATE_UNSPECIFIED |
保留。 |
THREADED_MESSAGES |
支援訊息會話串的命名空間。使用者回覆訊息時,可以直接在對話串中回覆,讓回覆內容保留在原始訊息的上下文中。 |
GROUPED_MESSAGES |
依對話主題分類的命名聊天室。主題和回覆會歸入同一個群組。 |
UNTHREADED_MESSAGES |
兩人之間的即時訊息 (DM),以及 3 人以上參與者的群組對話。 |
SpaceType
聊天室類型。建立或更新聊天室時必須提供。僅供其他用途使用。
列舉 | |
---|---|
SPACE_TYPE_UNSPECIFIED |
保留。 |
SPACE |
可讓使用者傳送訊息、共用檔案及協同合作。SPACE 可包含 Chat 應用程式。 |
GROUP_CHAT |
3 人以上參與者的群組對話。GROUP_CHAT 可包含 Chat 應用程式。 |
DIRECT_MESSAGE |
兩人之間或人與 Chat 應用程式之間的 1:1 訊息。 |
類型
已淘汰:請改用 SpaceType
。
列舉 | |
---|---|
TYPE_UNSPECIFIED |
保留。 |
ROOM |
兩人以上使用者之間的對話。 |
DM |
使用者與 Chat 應用程式之間的 1 對 1 即時訊息,所有訊息都是平面訊息。請注意,這項功能不包含兩位使用者之間的即時訊息。 |
SpaceBatchUpdatedEventData
用於空間多項更新的事件酬載。
事件類型:google.workspace.chat.space.v1.batchUpdated
欄位 | |
---|---|
spaces[] |
已更新的聊天室清單。 |
SpaceEvent
代表 Google Chat 聊天室中的變更或活動的事件。詳情請參閱「使用 Google Chat 事件」。
欄位 | |
---|---|
name |
聊天室事件的資源名稱。 格式: |
event_ |
事件發生的時間。 |
event_ |
聊天室事件類型。每個事件類型都有一個批次版本,代表在短時間內發生的多個事件類型例項。針對 訊息支援的事件類型:
會員支援的事件類型:
回應支援的事件類型:
聊天室支援的事件類型:
|
聯集欄位
|
|
message_ |
新訊息的事件酬載。 事件類型: |
message_ |
更新訊息的事件酬載。 事件類型: |
message_ |
已刪除訊息的事件酬載。 事件類型: |
message_ |
多則新訊息的事件酬載。 事件類型: |
message_ |
多則更新訊息的事件酬載。 事件類型: |
message_ |
多個已刪除訊息的事件酬載。 事件類型: |
space_ |
聊天室更新事件酬載。 事件類型: |
space_ |
用於空間多項更新的事件酬載。 事件類型: |
membership_ |
新會員的事件酬載。 事件類型: |
membership_ |
更新會員資格的事件酬載。 事件類型: |
membership_ |
已刪除會員資格的事件酬載。 事件類型: |
membership_ |
多個新會籍的事件酬載。 事件類型: |
membership_ |
多個更新會籍的事件酬載。 事件類型: |
membership_ |
多個已刪除會員的事件酬載。 事件類型: |
reaction_ |
新回應的事件酬載。 事件類型: |
reaction_ |
已刪除的回應事件酬載。 事件類型: |
reaction_ |
多個新回應的事件酬載。 事件類型: |
reaction_ |
多個已刪除的回應事件酬載。 事件類型: |
SpaceNotificationSetting
使用者在聊天室中的通知設定。
欄位 | |
---|---|
name |
ID。聊天室通知設定的資源名稱。格式: |
notification_ |
通知設定。 |
mute_ |
聊天室通知靜音設定。 |
MuteSetting
聊天室通知靜音設定類型。
列舉 | |
---|---|
MUTE_SETTING_UNSPECIFIED |
保留。 |
UNMUTED |
使用者會根據通知設定收到聊天室通知。 |
MUTED |
無論通知設定為何,使用者都不會收到任何聊天室通知。 |
NotificationSetting
通知設定類型。
列舉 | |
---|---|
NOTIFICATION_SETTING_UNSPECIFIED |
保留。 |
ALL |
系統會在收到使用 @號提及的訊息、你追蹤的討論串,以及新討論串的第一則訊息時發出通知。除非使用者手動取消追蹤,否則系統會自動追蹤所有新討論串。 |
MAIN_CONVERSATIONS |
系統會在收到使用 @號提及的訊息、你追蹤的討論串,或是新討論串的第一則訊息時觸發通知。不適用於 1:1 即時訊息。 |
FOR_YOU |
系統會在收到使用 @號提及你的訊息,或是你追蹤的討論串時觸發通知。不適用於 1:1 即時訊息。 |
OFF |
通知已關閉。 |
SpaceReadState
使用者在聊天室中的已讀狀態,用於識別已讀和未讀訊息。
欄位 | |
---|---|
name |
聊天室讀取狀態的資源名稱。 格式: |
last_ |
選用設定。更新使用者空間讀取狀態的時間。通常會對應至上次讀取訊息的時間戳記,或是使用者指定的時間戳記,用於標記聊天室中的最後讀取位置。 |
SpaceUpdatedEventData
更新空間的事件酬載。
事件類型:google.workspace.chat.space.v1.updated
欄位 | |
---|---|
space |
更新後的聊天室。 |
討論串
Google Chat 聊天室中的討論串。如需使用範例,請參閱「發起或回覆訊息討論串」。
如果在建立訊息時指定會話串,您可以設定 messageReplyOption
欄位,決定在找不到相符的會話串時要採取的動作。
欄位 | |
---|---|
name |
ID。執行緒的資源名稱。 範例: |
thread_ |
選用設定。建立或更新主題的輸入內容。否則,僅供輸出。執行緒的 ID。最多支援 4000 個半形字元。 這個 ID 是設定它的 Chat 應用程式專屬。舉例來說,如果多個 Chat 應用程式使用相同的對話串鍵建立訊息,這些訊息會發布在不同的對話串中。如要在使用者或其他 Chat 應用程式建立的討論串中回覆,請改為指定討論串 |
ThreadReadState
使用者在會話串中的已讀狀態,用於識別已讀和未讀的訊息。
欄位 | |
---|---|
name |
執行緒讀取狀態的資源名稱。 格式: |
last_ |
更新使用者執行緒讀取狀態的時間。通常會對應至對話串中最後一則已讀取訊息的時間戳記。 |
UpdateMembershipRequest
要求更新會員資格的訊息。
欄位 | |
---|---|
membership |
必要欄位。要更新的會員方案。只有 |
update_ |
必要欄位。要更新的欄位路徑。請使用半形逗號分隔多個值,或使用 目前支援的欄位路徑:
|
use_ |
選用設定。當 撥打的使用者必須是具備「管理即時通訊和聊天室對話」權限的 Google Workspace 管理員。 需要 |
UpdateMessageRequest
要求更新訊息。
欄位 | |
---|---|
message |
必要欄位。訊息已更新欄位。 |
update_ |
必要欄位。要更新的欄位路徑。請使用半形逗號分隔多個值,或使用 目前支援的欄位路徑: |
allow_ |
選用設定。如果找不到 |
UpdateSpaceNotificationSettingRequest
要求更新聊天室通知設定。僅支援更新來電使用者的通知設定。
欄位 | |
---|---|
space_ |
必要欄位。聊天室通知設定的資源名稱必須以 |
update_ |
必要欄位。支援的欄位路徑:- |
UpdateSpaceReadStateRequest
UpdateSpaceReadState API 的要求訊息。
欄位 | |
---|---|
space_ |
必要欄位。聊天室讀取狀態和要更新的欄位。 僅支援更新呼叫使用者的讀取狀態。 如要參照呼叫使用者,請設定下列其中一個項目:
格式:users/{user}/spaces/{space}/spaceReadState |
update_ |
必要欄位。要更新的欄位路徑。目前支援的欄位路徑:
如果 如要將此空間標示為已讀取,請將 |
UpdateSpaceRequest
要求更新單一聊天室。
欄位 | |
---|---|
space |
必要欄位。含有要更新欄位的聊天室。 |
update_ |
必要欄位。更新後的欄位路徑,如果有多個欄位,請以半形逗號分隔。 您可以更新下列空間欄位:
|
use_ |
選用設定。當 撥打的使用者必須是具備「管理即時通訊和聊天室對話」權限的 Google Workspace 管理員。 需要 使用管理員存取權時,系統不支援部分 |
使用者
Google Chat 中的使用者。如果 Chat 應用程式以使用者身分進行驗證,並將要求的輸出內容傳回,User
資源的輸出內容只會填入使用者的 name
和 type
。
欄位 | |
---|---|
name |
Google Chat 格式: 對於
|
display_ |
僅供輸出。使用者的顯示名稱。 |
domain_ |
使用者 Google Workspace 網域的專屬 ID。 |
type |
使用者類型。 |
is_ |
僅供輸出。如果 |
類型
列舉 | |
---|---|
TYPE_UNSPECIFIED |
列舉的預設值。請勿使用。 |
HUMAN |
真人使用者。 |
BOT |
Chat 應用程式使用者。 |
UserMentionMetadata
使用者提及 (@) 的註解中繼資料。
欄位 | |
---|---|
user |
提及的使用者。 |
type |
提及使用者的類型。 |
類型
列舉 | |
---|---|
TYPE_UNSPECIFIED |
整數清單的預設值。請勿使用。 |
ADD |
將使用者加入聊天室。 |
MENTION |
在聊天室中提及使用者。 |
WidgetMarkup
小工具是用來顯示文字和圖片的 UI 元素。
欄位 | |
---|---|
buttons[] |
按鈕清單。按鈕也是 |
聯集欄位 data 。WidgetMarkup 只能包含下列其中一個項目。您可以使用多個 WidgetMarkup 欄位來顯示更多項目。data 只能是下列其中一項: |
|
text_ |
在這個小工具中顯示文字段落。 |
image |
在這個小工具中顯示圖片。 |
key_ |
在這個小工具中顯示鍵值項目。 |
按鈕
按鈕。可以是文字按鈕或圖片按鈕。
欄位 | |
---|---|
聯集欄位
|
|
text_ |
含文字和 |
image_ |
含有圖片和 |
FormAction
表單動作會說明表單提交時的行為。舉例來說,您可以叫用 Apps Script 來處理表單。
欄位 | |
---|---|
action_ |
方法名稱可用於識別表單的哪個部分觸發表單提交作業。這項資訊會作為資訊卡點擊事件的一部分,回傳至 Chat 應用程式。您可以為觸發常見行為的多個元素使用相同的方法名稱。 |
parameters[] |
動作參數清單。 |
ActionParameter
在叫用動作方法時要提供的字串參數清單。舉例來說,請考慮三個延遲按鈕:立即延遲、延遲一天、延遲一週。您可以使用 action method = snooze()
,在字串參數清單中傳遞貪睡類型和貪睡時間。
欄位 | |
---|---|
key |
動作指令碼的參數名稱。 |
value |
參數的值。 |
圖示
支援的圖示組合。
列舉 | |
---|---|
ICON_UNSPECIFIED |
|
AIRPLANE |
|
BOOKMARK |
|
BUS |
|
CAR |
|
CLOCK |
|
CONFIRMATION_NUMBER_ICON |
|
DOLLAR |
|
DESCRIPTION |
|
EMAIL |
|
EVENT_PERFORMER |
|
EVENT_SEAT |
|
FLIGHT_ARRIVAL |
|
FLIGHT_DEPARTURE |
|
HOTEL |
|
HOTEL_ROOM_TYPE |
|
INVITE |
|
MAP_PIN |
|
MEMBERSHIP |
|
MULTIPLE_PEOPLE |
|
OFFER |
|
PERSON |
|
PHONE |
|
RESTAURANT_ICON |
|
SHOPPING_CART |
|
STAR |
|
STORE |
|
TICKET |
|
TRAIN |
|
VIDEO_CAMERA |
|
VIDEO_PLAY |
圖片
透過網址指定的圖片,可執行 onclick
動作。
欄位 | |
---|---|
image_ |
圖片的網址。 |
on_ |
|
aspect_ |
圖片的顯示比例 (寬度和高度)。這個欄位可讓您在等待圖片載入時,預留正確的圖片高度。這並非用來覆寫圖片內建的顯示比例。如果未設定,伺服器會透過預先擷取圖片來填入。 |
ImageButton
含有 onclick
動作的圖片按鈕。
欄位 | |
---|---|
on_ |
|
name |
這個 |
聯集欄位 icons 。您可以使用 Icon enum 或網址指定圖示。icons 只能是下列其中一個: |
|
icon |
由 |
icon_ |
由網址指定的圖示。 |
KeyValue
UI 元素包含一個鍵 (標籤) 和一個值 (內容)。這個元素也可以包含某些動作,例如 onclick
按鈕。
欄位 | |
---|---|
top_ |
頂端標籤的文字。支援格式化文字。如要進一步瞭解如何設定文字格式,請參閱「在 Google Chat 應用程式中設定文字格式」和「在 Google Workspace 外掛程式中設定文字格式」。 |
content |
內容文字。系統支援格式化文字,且必須使用格式化文字。如要進一步瞭解如何設定文字格式,請參閱「在 Google Chat 應用程式中設定文字格式」和「在 Google Workspace 外掛程式中設定文字格式」。 |
content_ |
內容是否應為多行。 |
bottom_ |
底部標籤的文字。支援格式化文字。如要進一步瞭解如何設定文字格式,請參閱「在 Google Chat 應用程式中設定文字格式」和「在 Google Workspace 外掛程式中設定文字格式」。 |
on_ |
|
聯集欄位 icons 。必須定義至少一個圖示 (top_label 和 bottom_label )。icons 只能是下列其中一項: |
|
icon |
Chat API 會將此列舉值替換為相應的圖示圖片。 |
icon_ |
由網址指定的圖示。 |
聯集欄位 control 。控制小工具。您可以選擇設定 button 或 switch_widget ,但不能同時設定兩者。control 只能是下列其中一項: |
|
button |
可點按觸發動作的按鈕。 |
OnClick
onclick
動作 (例如開啟連結)。
欄位 | |
---|---|
聯集欄位
|
|
action |
如果指定了這個 |
open_ |
如果指定,這個 |
OpenLink
開啟新視窗的連結。
欄位 | |
---|---|
url |
要開啟的網址。 |
TextButton
含文字和 onclick
動作的按鈕。
欄位 | |
---|---|
text |
按鈕文字。 |
on_ |
按鈕的 |
TextParagraph
一段文字。支援格式化文字。如要進一步瞭解如何設定文字格式,請參閱「在 Google Chat 應用程式中設定文字格式」和「在 Google Workspace 外掛程式中設定文字格式」。
欄位 | |
---|---|
text |
|