索引
ChatService
(介面)AccessoryWidget
(訊息)ActionResponse
(訊息)ActionResponse.ResponseType
(列舉)ActionResponse.SelectionItems
(訊息)ActionResponse.UpdatedWidget
(訊息)ActionStatus
(訊息)Annotation
(訊息)AnnotationType
(列舉)AppCommandMetadata
(訊息)AppCommandMetadata.AppCommandType
(列舉)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
(訊息)CustomEmojiMetadata
(訊息)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 |
---|
建立自訂表情符號。 自訂表情符號僅適用於 Google Workspace 帳戶,且管理員必須為機構啟用自訂表情符號。詳情請參閱「瞭解 Google Chat 中的自訂表情符號」和「管理自訂表情符號權限」。
|
CreateMembership |
---|
為通話 Chat 應用程式、使用者或 Google 群組建立成員資格。目前不支援為其他 Chat 應用程式建立成員資格。建立成員時,如果指定成員關閉了自動接受政策,系統會傳送邀請給對方,且對方必須接受邀請才能加入。否則,建立成員資格會直接將成員新增至指定聊天室。 支援下列類型的驗證:
應用程式驗證不支援下列用途:
如需使用範例,請參閱:
|
CreateMessage |
---|
在 Google Chat 聊天室中建立訊息。如需範例,請參閱「傳送訊息」。 支援下列類型的驗證:
Chat 會根據您在要求中使用的驗證類型,以不同方式歸因訊息寄件者。 下圖顯示使用應用程式驗證時,Chat 如何將訊息歸因於應用程式。Chat 會將 Chat 應用程式顯示為訊息傳送者。訊息內容可包含文字 ( 下圖說明使用使用者驗證時,Chat 如何為訊息加上屬性。Chat 會將使用者顯示為訊息傳送者,並顯示 Chat 應用程式的名稱,將訊息歸給該應用程式。訊息內容只能包含文字 ( 郵件大小上限為 32,000 個位元組,包括郵件內容。 如果是 Webhook 要求,回應不會包含完整訊息。除了要求中的資訊外,回應只會填入
|
CreateReaction |
---|
建立回應並新增至訊息。如需範例,請參閱「對訊息新增回應」。
|
CreateSpace |
---|
建立聊天室。可用於在 支援下列類型的驗證:
以應用程式身分驗證時,必須在要求中設定 以應用程式身分驗證時,Chat 應用程式會新增為聊天室成員。不過,與人工驗證不同的是,系統不會將 Chat 應用程式新增為聊天室管理員。根據預設,所有聊天室成員都能從聊天室中移除 Chat 應用程式。如要只允許聊天室管理員從聊天室移除應用程式,請將 建立聊天室時的成員資格取決於聊天室是否在
如果在建立聊天室時收到
|
DeleteCustomEmoji |
---|
刪除自訂表情符號。根據預設,使用者只能刪除自己建立的自訂表情符號。管理員指派的表情符號管理員可以刪除機構中的任何自訂表情符號。請參閱「瞭解 Google Chat 中的自訂表情符號」。 自訂表情符號僅適用於 Google Workspace 帳戶,且管理員必須為機構啟用自訂表情符號。詳情請參閱「瞭解 Google Chat 中的自訂表情符號」和「管理自訂表情符號權限」。
|
DeleteMembership |
---|
刪除會員資格。如需範例,請參閱「從聊天室中移除使用者或 Google Chat 應用程式」。 支援下列類型的驗證:
應用程式驗證不支援下列用途:
如要刪除聊天室管理員的成員資格,要求者必須是聊天室管理員。如果使用應用程式驗證,Chat 應用程式必須是聊天室建立者。
|
DeleteMessage |
---|
刪除訊息。如需範例,請參閱「刪除訊息」一文。 支援下列類型的驗證:
使用應用程式驗證時,要求只能刪除呼叫的 Chat 應用程式建立的訊息。
|
DeleteReaction |
---|
刪除訊息的回應。如需範例,請參閱刪除回應。
|
DeleteSpace |
---|
刪除具名空間。一律執行連鎖刪除作業,也就是一併刪除聊天室的子項資源,例如聊天室中發布的訊息和聊天室成員。如需範例,請參閱「刪除聊天室」。 支援下列類型的驗證:
|
FindDirectMessage |
---|
傳回與指定使用者現有的即時訊息。如果找不到任何直接訊息空間,則會傳回 透過應用程式驗證,傳回指定使用者與發出呼叫的 Chat 應用程式之間的即時訊息空間。 透過使用者驗證,傳回指定使用者和已驗證使用者之間的即時訊息空間。 支援下列類型的驗證:
|
GetAttachment |
---|
取得郵件附件的中繼資料。附件資料是使用媒體 API 擷取。如需範例,請參閱「取得郵件附件的中繼資料」。
|
GetCustomEmoji |
---|
傳回自訂表情符號的詳細資料。 自訂表情符號僅適用於 Google Workspace 帳戶,且管理員必須為機構啟用自訂表情符號。詳情請參閱「瞭解 Google Chat 中的自訂表情符號」和「管理自訂表情符號權限」。
|
GetMembership |
---|
傳回會員方案的詳細資料。如需範例,請參閱「取得使用者或 Google Chat 應用程式的成員資格詳細資料」。 支援下列類型的驗證:
|
GetMessage |
---|
傳回訊息的詳細資料。如需範例,請參閱「取得訊息詳細資料」。 支援下列類型的驗證:
注意:系統可能會傳回已封鎖成員或聊天室的訊息。
|
GetSpace |
---|
傳回聊天室的詳細資料。如需範例,請參閱「取得空間詳細資料」。 支援下列類型的驗證:
應用程式驗證有下列限制:
|
GetSpaceEvent |
---|
從 Google Chat 聊天室傳回事件。事件酬載包含變更資源的最新版本。舉例來說,如果您要求取得有關新訊息的事件,但該訊息稍後更新,伺服器會在事件酬載中傳回更新後的 注意:這項要求的空間事件資料空間物件不會傳回 需要使用者驗證,並提供適當的授權範圍,才能讀取所要求的資料:
如要取得活動,通過驗證的使用者必須是聊天室成員。 如需範例,請參閱「從 Google Chat 聊天室取得活動詳細資料」。
|
GetSpaceNotificationSetting |
---|
取得聊天室通知設定。如需範例,請參閱「取得來電者的空間通知設定」。
|
GetSpaceReadState |
---|
傳回使用者在聊天室中的已讀狀態詳細資料,用於識別已讀和未讀訊息。如需範例,請參閱「取得使用者空間讀取狀態的詳細資料」。
|
GetThreadReadState |
---|
傳回有關執行緒中使用者讀取狀態的詳細資料,用於識別已讀和未讀訊息。如需範例,請參閱「取得使用者討論串讀取狀態的詳細資料」。
|
ListCustomEmojis |
---|
列出已驗證使用者可見的自訂表情符號。 自訂表情符號僅適用於 Google Workspace 帳戶,且管理員必須為機構啟用自訂表情符號。詳情請參閱「瞭解 Google Chat 中的自訂表情符號」和「管理自訂表情符號權限」。
|
ListMemberships |
---|
列出聊天室中的成員。如需範例,請參閱「列出聊天室中的使用者和 Google Chat 應用程式」。使用應用程式驗證列出成員資格時,系統會列出 Chat 應用程式有權存取的聊天室成員資格,但會排除 Chat 應用程式成員資格 (包括應用程式本身的成員資格)。使用「使用者驗證」列出成員資格:列出已驗證使用者可存取空間的成員資格。 支援下列類型的驗證:
|
ListMessages |
---|
列出通話者所屬聊天室中的訊息,包括來自已封鎖成員和聊天室的訊息。如果列出沒有訊息的聊天室訊息,回應會是空白物件。使用 REST/HTTP 介面時,回應會包含空白的 JSON 物件
|
ListReactions |
---|
列出訊息的回應。如需範例,請參閱「列出訊息的回應」。
|
ListSpaceEvents |
---|
列出 Google Chat 聊天室的事件。每個事件的酬載都包含 Chat 資源的最新版本。舉例來說,如果您列出有關新空間成員的事件,伺服器會傳回包含最新成員詳細資料的 需要使用者驗證,並提供適當的授權範圍,才能讀取所要求的資料:
如要列出活動,已驗證的使用者必須是該空間的成員。 如需範例,請參閱「列出 Google Chat 聊天室中的活動」。
|
ListSpaces |
---|
列出呼叫者所屬的聊天室。系統不會列出群組對話和即時訊息,直到傳送第一則訊息為止。如需範例,請參閱「列出聊天室」。 支援下列類型的驗證:
如要列出 Google Workspace 機構的所有具名空間,請改用具有 Workspace 管理員權限的
|
SearchSpaces |
---|
根據管理員的搜尋條件,傳回 Google Workspace 機構中的空間清單。 需要具備管理員權限的使用者驗證,以及下列其中一個授權範圍:
在要求中,將
|
SetUpSpace |
---|
建立聊天室並新增指定使用者。系統會自動將通話使用者新增至聊天室,因此不應在要求中指定成員資格。如需範例,請參閱「設定含有初始成員的聊天室」。 如要指定要新增的人類成員,請新增適當 如要指定要新增的 Google 群組,請使用適當的 如果是具名聊天室或群組對話,如果通話者封鎖或遭到部分成員封鎖,或是沒有權限新增部分成員,系統就不會將這些成員加入建立的聊天室。 如要在通話使用者與另一位真人使用者之間建立即時訊息 (DM),請指定正好一個成員資格來代表真人使用者。如果其中一位使用者封鎖另一位,要求就會失敗,系統也不會建立私訊。 如要在呼叫使用者和呼叫應用程式之間建立私訊,請將 如果兩位使用者之間已有私訊,即使其中一位使用者在提出要求時封鎖另一位,系統仍會傳回現有私訊。 不支援含有串聯回覆的即時通訊空間。如果在設定空間時收到
|
UpdateMembership |
---|
更新會員方案。如需範例,請參閱「更新使用者在聊天室中的成員資格」。 支援下列類型的驗證:
|
UpdateMessage |
---|
更新訊息。 支援下列類型的驗證:
使用應用程式驗證時,要求只能更新呼叫 Chat 應用程式建立的訊息。
|
UpdateSpace |
---|
更新聊天室。如需範例,請參閱「更新空間」。 如果更新 支援下列類型的驗證:
應用程式驗證有下列限制:
|
UpdateSpaceNotificationSetting |
---|
更新聊天室通知設定。如需範例,請參閱「更新來電者的空間通知設定」。
|
UpdateSpaceReadState |
---|
更新聊天室中使用者訊息的已讀狀態,用於識別已讀和未讀訊息。如需範例,請參閱「更新使用者的聊天室讀取狀態」。
|
AccessoryWidget
顯示在郵件底部的互動式小工具。詳情請參閱「在訊息底部新增互動式小工具」。
欄位 | |
---|---|
聯集欄位 action 。動作類型。action 只能是下列其中一項: |
|
button_list |
按鈕清單。 |
ActionResponse
Chat 應用程式可用來設定如何發布回覆的參數。
欄位 | |
---|---|
type |
僅限輸入。Chat 應用程式的回應類型。 |
url |
僅限輸入。使用者驗證或設定的網址。(僅適用於 |
dialog_action |
|
updated_widget |
僅限輸入。更新後的小工具回應。 |
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
如果是 selectionInput
小工具,則會傳回多選選單的自動完成建議。
欄位 | |
---|---|
widget |
更新後的小工具 ID。ID 必須與觸發更新要求的的小工具 ID 相符。 |
聯集欄位 updated_widget 。小工具已更新,以回應使用者動作。updated_widget 只能是下列其中一項: |
|
suggestions |
小工具自動完成結果清單 |
ActionStatus
代表叫用或提交對話方塊的要求狀態。
欄位 | |
---|---|
status_code |
狀態碼。 |
user_facing_message |
要傳送給使用者的訊息,說明要求狀態。如果未設定,系統會根據 |
備註
僅供輸出。與郵件純文字內文相關的註解。如要為訊息加上基本格式設定,請參閱「設定訊息格式」。
純文字訊息內文範例:
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_index |
此註解對應的純文字訊息內文中的起始索引 (從 0 開始,含該索引)。 |
聯集欄位 metadata 。註解的其他中繼資料。metadata 只能是下列其中一項: |
|
user_mention |
使用者提及的中繼資料。 |
slash_command |
斜線指令的中繼資料。 |
rich_link_metadata |
複合式連結的中繼資料。 |
custom_emoji_metadata |
自訂表情符號的中繼資料。 |
AnnotationType
註解類型。
列舉 | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
列舉的預設值。請勿使用。 |
USER_MENTION |
提及使用者。 |
SLASH_COMMAND |
系統會叫用斜線指令。 |
RICH_LINK |
豐富連結註解。 |
CUSTOM_EMOJI |
自訂表情符號註解。 |
AppCommandMetadata
Chat 擴充應用程式指令的中繼資料。
欄位 | |
---|---|
app_command_id |
Chat API 設定中指定的指令 ID。 |
app_command_type |
Chat 應用程式指令的類型。 |
AppCommandType
Chat 應用程式指令的類型。詳情請參閱「Chat 擴充應用程式指令類型」。
列舉 | |
---|---|
APP_COMMAND_TYPE_UNSPECIFIED |
預設值。未指明 |
SLASH_COMMAND |
斜線指令。使用者在 Chat 訊息中傳送指令。 |
QUICK_COMMAND |
快速指令。使用者在訊息回覆區的 Chat 選單中選取指令。 |
AttachedGif
由網址指定的 GIF 圖片。
欄位 | |
---|---|
uri |
僅供輸出。代管 GIF 圖片的網址。 |
附件
Google Chat 中的附件。
欄位 | |
---|---|
name |
(選用步驟) 附件的資源名稱,格式為 |
content_name |
僅供輸出。內容的原始檔案名稱,而非完整路徑。 |
content_type |
僅供輸出。檔案的內容類型 (MIME 類型)。 |
thumbnail_uri |
僅供輸出。應使用的縮圖網址,供真人使用者預覽附件。聊天應用程式不應使用這個網址下載附件內容。 |
download_uri |
僅供輸出。下載網址,供使用者下載附件。聊天應用程式不應使用這個網址下載附件內容。 |
source |
僅供輸出。附件來源。 |
聯集欄位 data_ref 。附件的資料參照。data_ref 只能是下列其中一項: |
|
attachment_data_ref |
(選用步驟) 附件資料的參照。這個欄位用於建立或更新含有附件的訊息,或使用 Media API 下載附件資料。 |
drive_data_ref |
僅供輸出。Google 雲端硬碟附件的參照。這個欄位會與 Google 雲端硬碟 API 一併使用。 |
來源
附件來源。
列舉 | |
---|---|
SOURCE_UNSPECIFIED |
保留。 |
DRIVE_FILE |
檔案是 Google 雲端硬碟檔案。 |
UPLOADED_CONTENT |
檔案會上傳到 Chat。 |
AttachmentDataRef
附件資料的參照。
欄位 | |
---|---|
resource_name |
(選用步驟) 附件資料的資源名稱。這個欄位會與 Media API 搭配使用,下載附件資料。 |
attachment_upload_token |
(選用步驟) 不透明符記,內含上傳附件的參照。用戶端會將其視為不透明的字串,並用於建立或更新含有附件的 Chat 訊息。 |
CardWithId
Google Chat 訊息中的資訊卡。
只有 Chat 應用程式可以建立資訊卡。如果即時通訊應用程式以使用者身分進行驗證,訊息就不能包含資訊卡。
使用資訊卡建構工具設計及預覽資訊卡。
開啟「資訊卡建立工具」欄位 | |
---|---|
card_id |
如果訊息包含多張資訊卡,則為必填。郵件中卡片的專屬 ID。 |
card |
卡片。大小上限為 32 KB。 |
ChatSpaceLinkData
Chat 聊天室連結的資料。
欄位 | |
---|---|
space |
連結的 Chat 聊天室資源所屬的聊天室。 格式: |
thread |
連結的 Chat 聊天室資源討論串。 格式: |
message |
連結的 Chat 聊天室資源訊息。 格式: |
CompleteImportSpaceRequest
要求訊息,用於完成聊天室的匯入程序。
欄位 | |
---|---|
name |
必要欄位。匯入模式聊天室的資源名稱。 格式: |
CompleteImportSpaceResponse
完成聊天室匯入程序後的回覆訊息。
欄位 | |
---|---|
space |
匯入模式聊天室。 |
ContextualAddOnMarkup
這個類型沒有任何欄位。
開發人員可使用標記指定情境式外掛程式的內容。
資訊卡
資訊卡是一種 UI 元素,可包含文字和圖片等 UI 小工具。
欄位 | |
---|---|
header |
資訊卡的標題。標題通常包含標題和圖片。 |
sections[] |
各節之間以分隔線區隔。 |
card_actions[] |
這張資訊卡的動作。 |
name |
資訊卡的名稱。 |
CardAction
資訊卡動作是指與資訊卡相關聯的動作。如果是月結單卡片,常見動作包括:刪除月結單、透過電子郵件傳送月結單,或在瀏覽器中開啟月結單。
Google Chat 應用程式不支援這項功能。
欄位 | |
---|---|
action_label |
這個標籤過去會顯示在動作選單項目中。 |
on_click |
這個動作項目的 onclick 動作。 |
CardHeader
欄位 | |
---|---|
title |
必須指定標題。標題的高度固定,如果同時指定標題和副標題,兩者各佔一行。如果只指定標題,標題會佔用兩行。 |
subtitle |
資訊卡標題的副標題。 |
image_style |
圖片類型 (例如正方形或圓形邊框)。 |
image_url |
資訊卡標題中的圖片網址。 |
ImageStyle
列舉 | |
---|---|
IMAGE_STYLE_UNSPECIFIED |
|
IMAGE |
方形邊框。 |
AVATAR |
圓形邊框。 |
區段
一個區段包含一組小工具,這些小工具會按照指定順序 (垂直) 顯示。在所有平台上,資訊卡的寬度都是固定的,因此目前不需要版面配置屬性 (例如 float)。
欄位 | |
---|---|
header |
該部分的標題。系統支援格式化文字。如要進一步瞭解如何設定文字格式,請參閱「在 Google Chat 應用程式中設定文字格式」和「在 Google Workspace 外掛程式中設定文字格式」。 |
widgets[] |
每個區段至少要包含一個小工具。 |
CreateCustomEmojiRequest
建立自訂表情符號的要求。
欄位 | |
---|---|
custom_emoji |
必要欄位。要建立的自訂表情符號。 |
CreateMembershipRequest
建立會員資格的要求訊息。
欄位 | |
---|---|
parent |
必要欄位。要建立成員的空間資源名稱。 格式:spaces/{space} |
membership |
必要欄位。要建立的成員關係。
當 Chat 應用程式為真人使用者建立成員關係時,必須使用特定授權範圍,並為特定欄位設定特定值:
邀請 Workspace 機構外部使用者加入聊天室時,必須驗證使用者身分。 當 Chat 應用程式為自己建立成員關係時,必須以使用者身分進行驗證,並使用 |
use_admin_access |
(選用步驟) 時,這個方法會使用使用者的 Google Workspace 管理員權限執行。 通話使用者必須是具備「管理即時通訊和聊天室對話」權限的 Google Workspace 管理員。 需要 管理員無法使用管理員存取權,為應用程式建立成員資格,或為管理員 Google Workspace 機構以外的使用者建立成員資格。 |
CreateMessageRequest
建立訊息。
欄位 | |
---|---|
parent |
必要欄位。要在其中建立訊息的聊天室資源名稱。 格式: |
message |
必要欄位。郵件內文。 |
thread_key |
(選用步驟) 已淘汰:請改用 |
request_id |
(選用步驟) 這則訊息的專屬要求 ID。指定現有要求 ID 會傳回以該 ID 建立的訊息,而不是建立新訊息。 |
message_reply_option |
(選用步驟) 指定訊息是發起討論串還是回覆討論串。僅支援已命名的聊天室。 回應使用者互動時,系統會忽略這個欄位。如果是討論串中的互動,回覆會建立在同一討論串中。否則系統會將回覆內容建立為新討論串。 |
message_id |
(選用步驟) 郵件的自訂 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 |
(選用步驟) 這項要求的專屬 ID。建議使用隨機 UUID。指定現有要求 ID 時,系統會傳回以該 ID 建立的聊天室,而不是建立新聊天室。如果指定來自相同 Chat 應用程式的現有要求 ID,但驗證使用者不同,系統會傳回錯誤。 |
CustomEmoji
代表自訂表情符號。
欄位 | |
---|---|
name |
ID。伺服器指派的自訂表情符號資源名稱。 格式: |
uid |
僅供輸出。自訂表情符號資源的專屬鍵。 |
emoji_name |
(選用步驟) 不可變更。使用者提供的自訂表情符號名稱,在機構內不得重複。 建立自訂表情符號時必須提供,否則僅供輸出。 表情符號名稱開頭和結尾必須是半形冒號,且只能包含小寫英數字元、連字號和底線。連字號和底線可用於分隔字詞,但不能連續使用。 範例: |
temporary_image_uri |
僅供輸出。自訂表情符號的臨時圖片網址,效期至少 10 分鐘。請注意,建立自訂表情符號時,回應中不會填入這項資訊。 |
payload |
(選用步驟) 僅限輸入。酬載資料。建立自訂表情符號時必須提供。 |
CustomEmojiPayload
自訂表情符號的酬載資料。
欄位 | |
---|---|
file_content |
必要欄位。僅限輸入。自訂表情符號使用的圖片。 酬載大小必須小於 256 KB,且圖片尺寸必須為正方形,介於 64 至 500 像素之間。這些限制可能會有所變動。 |
filename |
必要欄位。僅限輸入。圖片檔名。 支援的副檔名: |
CustomEmojiMetadata
自訂表情符號的註解中繼資料。
欄位 | |
---|---|
custom_emoji |
自訂表情符號。 |
DeleteCustomEmojiRequest
要求刪除自訂表情符號。
欄位 | |
---|---|
name |
必要欄位。要刪除的自訂表情符號資源名稱。 格式: 你可以使用表情符號名稱做為 |
DeleteMembershipRequest
要求刪除聊天室中的成員。
欄位 | |
---|---|
name |
必要欄位。要刪除的會員方案資源名稱,即時通訊應用程式可以刪除人類使用者或自己的成員資格。即時通訊應用程式無法刪除其他應用程式的成員資格。 刪除使用者成員時,需要 刪除應用程式成員時,需要 格式: |
use_admin_access |
(選用步驟) 時,這個方法會使用使用者的 Google Workspace 管理員權限執行。 通話使用者必須是具備「管理即時通訊和聊天室對話」權限的 Google Workspace 管理員。 需要 系統不支援使用管理員存取權刪除聊天室中的應用程式成員資格。 |
DeleteMessageRequest
要求刪除訊息。
欄位 | |
---|---|
name |
必要欄位。訊息的資源名稱。 格式: 如果您已為訊息設定自訂 ID,可以將 |
force |
(選用步驟) 僅適用於以使用者身分進行驗證。以 Chat 應用程式身分驗證時,這個方法不會起任何作用。 |
DeleteReactionRequest
刪除訊息的回應。
欄位 | |
---|---|
name |
必要欄位。要刪除的回應名稱。 格式: |
DeleteSpaceRequest
要求刪除聊天室。
欄位 | |
---|---|
name |
必要欄位。要刪除的聊天室資源名稱。 格式: |
use_admin_access |
(選用步驟) 時,這個方法會使用使用者的 Google Workspace 管理員權限執行。 通話使用者必須是具備「管理即時通訊和聊天室對話」權限的 Google Workspace 管理員。 需要 |
DeletionMetadata
有關已刪除訊息的資訊。設定 delete_time
時,系統會刪除訊息。
欄位 | |
---|---|
deletion_type |
指出刪除訊息的使用者。 |
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 |
聊天室成員刪除了訊息。使用者可以刪除應用程式傳送的訊息。 |
對話方塊
對話方塊的資訊卡主體周圍的包裝函式。
欄位 | |
---|---|
body |
僅限輸入。對話方塊主體,會以模式顯示。Google Chat 應用程式不支援下列資訊卡實體: |
DialogAction
包含對話方塊和要求狀態碼。
欄位 | |
---|---|
action_status |
僅限輸入。要求叫用或提交對話方塊的狀態。視需要向使用者顯示狀態和訊息。例如發生錯誤或成功時。 |
聯集欄位 action 。要執行的動作。action 只能是下列其中一項: |
|
dialog |
僅限輸入。要求的對話方塊。 |
DriveDataRef
參照雲端硬碟附件的資料。
欄位 | |
---|---|
drive_file_id |
雲端硬碟檔案的 ID。搭配 Drive API 使用。 |
DriveLinkData
Google 雲端硬碟連結的資料。
欄位 | |
---|---|
drive_data_ref |
參照 Google 雲端硬碟檔案的 DriveDataRef。 |
mime_type |
連結的 Google 雲端硬碟資源 MIME 類型。 |
Emoji
用來回應訊息的表情符號。
欄位 | |
---|---|
聯集欄位 content 。必要欄位。表情符號的內容。content 只能是下列其中一項: |
|
unicode |
(選用步驟) 以 Unicode 字串表示的基本表情符號。 |
custom_emoji |
自訂表情符號。 |
EmojiReactionSummary
使用特定表情符號回應訊息的人數。
欄位 | |
---|---|
emoji |
僅供輸出。與回應相關聯的表情符號。 |
reaction_count |
僅供輸出。使用相關表情符號回應的總次數。 |
FindDirectMessageRequest
根據使用者資源取得即時訊息空間的要求。
欄位 | |
---|---|
name |
必要欄位。要尋找即時訊息的使用者資源名稱。 格式: |
GetAttachmentRequest
要求取得附件。
欄位 | |
---|---|
name |
必要欄位。附件的資源名稱,格式為 |
GetCustomEmojiRequest
要求傳回單一自訂表情符號。
欄位 | |
---|---|
name |
必要欄位。自訂表情符號的資源名稱。 格式: 你可以使用表情符號名稱做為 |
GetMembershipRequest
要求取得聊天室的成員資格。
欄位 | |
---|---|
name |
必要欄位。要擷取的會員資格資源名稱。 如要透過使用者驗證取得應用程式的成員資格,您可以選擇使用 格式: 您可以將使用者的電子郵件地址做為 |
use_admin_access |
(選用步驟) 時,這個方法會使用使用者的 Google Workspace 管理員權限執行。 通話使用者必須是具備「管理即時通訊和聊天室對話」權限的 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_admin_access |
(選用步驟) 時,這個方法會使用使用者的 Google Workspace 管理員權限執行。 通話使用者必須是具備「管理即時通訊和聊天室對話」權限的 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 |
記錄功能已開啟。機構的 Google 保管箱保留規則會指定郵件和討論串的保留時間。 |
ListCustomEmojisRequest
要求傳回自訂表情符號清單。
欄位 | |
---|---|
page_size |
(選用步驟) 傳回的自訂表情符號數量上限。服務傳回的自訂表情符號數量可能會少於這個值。如未指定,則預設值為 25。最大值為 200;超過 200 的值會變更為 200。 |
page_token |
(選用步驟) (如果從先前的查詢繼續)。 先前列出自訂表情符號呼叫傳回的頁面權杖。提供此項目即可擷取後續網頁。 進行分頁時,篩選值應與提供網頁權杖的呼叫相符。傳遞其他值可能會導致非預期的結果。 |
filter |
(選用步驟) 查詢篩選器。 支援依創作者篩選。 如要依建立者篩選,必須指定有效值。目前僅接受 舉例來說,下列查詢會傳回呼叫者建立的自訂表情符號:
系統會拒絕無效的查詢,並傳回 |
ListCustomEmojisResponse
列出自訂表情符號的回覆。
欄位 | |
---|---|
custom_emojis[] |
未排序的清單。自訂表情符號清單。 |
next_page_token |
可做為 |
ListMembershipsRequest
要求訊息,列出會員資格。
欄位 | |
---|---|
parent |
必要欄位。要擷取成員名單的空間資源名稱。 格式:spaces/{space} |
page_size |
(選用步驟) 要傳回的會員人數上限。服務傳回的產品數量可能會少於這個值。 如未指定,最多會傳回 100 個會員方案。 值的上限為 1000。如果使用超過 1000 的值,系統會自動變更為 1000。 負值會傳回 |
page_token |
(選用步驟) 這是從先前列出會員的呼叫中收到的頁面權杖。提供此參數即可擷取後續網頁。 進行分頁時,提供的所有其他參數應與提供網頁權杖的呼叫相符。將不同值傳遞至其他參數可能會導致非預期的結果。 |
filter |
(選用步驟) 查詢篩選器。 你可以依成員的角色 ( 如要依角色篩選,請將 如要依類型篩選,請將 如要同時依角色和類型篩選,請使用 如果 舉例來說,下列查詢皆有效:
下列查詢無效:
伺服器會拒絕無效查詢,並傳回 |
show_groups |
(選用步驟) 除了其他類型的會員資格, |
show_invited |
(選用步驟) 如果 目前需要使用者驗證。 |
use_admin_access |
(選用步驟) 時,這個方法會使用使用者的 Google Workspace 管理員權限執行。 通話使用者必須是具備「管理即時通訊和聊天室對話」權限的 Google Workspace 管理員。 需要 使用管理員存取權時,系統不支援列出聊天室中的應用程式成員。 |
ListMembershipsResponse
回應聊天室成員名單。
欄位 | |
---|---|
memberships[] |
未排序的清單。所要求 (或第一) 頁面的會員清單。 |
next_page_token |
可做為 |
ListMessagesRequest
列出使用者所屬指定聊天室中的訊息。
欄位 | |
---|---|
parent |
必要欄位。要列出訊息的空間資源名稱。 格式: |
page_size |
(選用步驟) 傳回的訊息數量上限。服務傳回的訊息數量可能會少於這個值。 如未指定,最多會傳回 25 個。 值的上限為 1000。如果使用超過 1000 的值,系統會自動變更為 1000。 負值會傳回 |
page_token |
(選用步驟) 先前呼叫 list messages 時收到的頁面權杖。提供此參數即可擷取後續網頁。 進行分頁時,提供的所有其他參數應與提供網頁權杖的呼叫相符。將不同值傳遞至其他參數可能會導致非預期的結果。 |
filter |
(選用步驟) 查詢篩選器。 你可以依日期 ( 如要依郵件建立日期篩選郵件,請指定 如要依執行緒篩選,請指定 如要同時依討論串和日期篩選,請在查詢中使用 舉例來說,下列查詢皆有效:
伺服器會拒絕無效查詢,並傳回 |
order_by |
(選用步驟) 訊息清單的排序方式。指定值,以便依排序作業排序。有效的排序作業值如下:
預設排序方式為 |
show_deleted |
(選用步驟) 是否要包含已刪除的訊息。已刪除的郵件包括刪除時間和刪除相關中繼資料,但無法查看郵件內容。 |
ListMessagesResponse
列出訊息的回應訊息。
欄位 | |
---|---|
messages[] |
訊息清單。 |
next_page_token |
您可以將權杖做為 |
ListReactionsRequest
列出訊息的回應。
欄位 | |
---|---|
parent |
必要欄位。使用者回覆的訊息。 格式: |
page_size |
(選用步驟) 傳回的表情符號數量上限。服務傳回的反應數量可能會少於這個值。如未指定,則預設值為 25。最大值為 200;超過 200 的值會變更為 200。 |
page_token |
(選用步驟) (如果從先前的查詢繼續)。 先前列出回應呼叫傳回的頁面權杖。提供此項目即可擷取後續網頁。 進行分頁時,篩選值應與提供網頁權杖的呼叫相符。傳遞其他值可能會導致非預期的結果。 |
filter |
(選用步驟) 查詢篩選器。 你可以依表情符號 ( 如要依多個表情符號或使用者篩選回應,請使用 如要依表情符號和使用者篩選回應,請使用 如果查詢同時使用 舉例來說,下列查詢皆有效:
下列查詢無效:
系統會拒絕無效的查詢,並傳回 |
ListReactionsResponse
清單回應要求的回應。
欄位 | |
---|---|
reactions[] |
所要求 (或第一) 頁面中的回應清單。 |
next_page_token |
用來擷取下一頁結果的接續符記。如果是最後一頁的結果,這個值會是空白。 |
ListSpaceEventsRequest
要求訊息,列出空間活動。
欄位 | |
---|---|
parent |
必要欄位。發生事件的 Google Chat 聊天室資源名稱。 格式: |
page_size |
(選用步驟) 傳回的空間事件數量上限。服務傳回的產品數量可能會少於這個值。 負值會傳回 |
page_token |
(選用步驟) 這是接收自前一個 list space events 呼叫的網頁權杖。提供此項目即可擷取後續網頁。 進行分頁時,提供至清單空間事件的所有其他參數,須與提供網頁權杖的呼叫相符。將不同值傳遞至其他參數可能會導致非預期的結果。 |
filter |
必要欄位。查詢篩選器。 您必須使用 has 你也可以選擇依開始時間 (
如要指定開始或結束時間,請使用等號 舉例來說,下列查詢皆有效:
下列查詢無效:
伺服器會拒絕無效查詢,並傳回 |
ListSpaceEventsResponse
列出聊天室活動的回覆訊息。
欄位 | |
---|---|
space_events[] |
系統會依時間順序傳回結果 (最舊的事件在前)。注意:清單要求不會在 Space 物件中傳回 |
next_page_token |
用來擷取更多事件的接續權杖。如果省略這個欄位,就不會有後續頁面。 |
ListSpacesRequest
要求列出呼叫者所屬的空間。
欄位 | |
---|---|
page_size |
(選用步驟) 要傳回的空間數量上限。服務傳回的產品數量可能會少於這個值。 如未指定,最多將傳回 100 個空間。 值的上限為 1000。如果使用超過 1000 的值,系統會自動變更為 1000。 負值會傳回 |
page_token |
(選用步驟) 屬於接收自前一個 list spaces 呼叫的網頁權杖。提供此參數即可擷取後續網頁。 進行分頁時,篩選值應與提供網頁權杖的呼叫相符。傳遞其他值可能會導致非預期的結果。 |
filter |
(選用步驟) 查詢篩選器。 你可以依聊天室類型篩選聊天室 ( 如要依空間類型篩選,必須指定有效的列舉值,例如 舉例來說,下列查詢皆有效:
伺服器會拒絕無效查詢,並傳回 |
ListSpacesResponse
列出聊天室要求的回應。
欄位 | |
---|---|
spaces[] |
所要求 (或第一) 頁面中的聊天室清單。注意:清單要求不會在 Space 物件中傳回 |
next_page_token |
您可以將權杖做為 |
MatchedUrl
Chat 訊息中相符的網址。即時通訊應用程式可以預覽相符的網址。詳情請參閱「預覽連結」。
欄位 | |
---|---|
url |
僅供輸出。相符的網址。 |
會員制
代表 Google Chat 中的成員關係,例如使用者或 Chat 應用程式是否受邀加入聊天室、是否為聊天室成員,或是否缺席。
欄位 | |
---|---|
name |
ID。伺服器指派的會員資源名稱。 格式: |
state |
僅供輸出。會員狀態。 |
role |
(選用步驟) 使用者在 Chat 聊天室中的角色,決定了他們在聊天室中可執行的動作。 這個欄位只能在 |
create_time |
(選用步驟) 不可變更。成員資格的建立時間,例如成員加入或受邀加入聊天室的時間。這個欄位僅供輸出,但可用於在匯入模式聊天室中匯入過往成員。 |
delete_time |
(選用步驟) 不可變更。成員資格的刪除時間,例如成員離開或從聊天室中移除的時間。這個欄位僅供輸出,但可用於在匯入模式聊天室中匯入過往成員。 |
聯集欄位 memberType 。與這項會員方案相關聯的成員。日後可能會支援其他成員類型。memberType 只能是下列其中一項: |
|
member |
(選用步驟) 與成員資格對應的 Google Chat 使用者或應用程式。如果 Chat 應用程式以使用者身分進行驗證,輸出內容會填入 user |
group_member |
(選用步驟) 成員資格對應的 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,即可在要求中指定訊息,方法是將 |
sender |
僅供輸出。建立訊息的使用者。如果 Chat 應用程式以使用者身分進行驗證,輸出內容會填入 user |
create_time |
(選用步驟) 不可變更。如果是透過 Chat 建立的聊天室,則為訊息建立時間。這個欄位只能輸出,匯入模式聊天室除外。 如果是匯入模式的即時通訊空間,請將這個欄位設為訊息在來源中建立時的歷史時間戳記,以便保留原始建立時間。 |
last_update_time |
僅供輸出。使用者上次編輯訊息的時間。如果訊息從未經過編輯,這個欄位會留空。 |
delete_time |
僅供輸出。訊息在 Google Chat 中遭到刪除的時間。如果訊息不會刪除,這個欄位會是空白。 |
text |
(選用步驟) 訊息的純文字內文。系統會為圖片、影片或網頁的第一個連結生成預覽方塊。你也可以使用@提及 Google Chat 使用者,或聊天室中的所有成員。 如要瞭解如何建立文字訊息,請參閱「傳送訊息」。 |
formatted_text |
僅供輸出。包含訊息
詳情請參閱「查看訊息中傳送的文字格式」一文。 |
cards[] |
已淘汰:請改用 您可以使用格式豐富的互動式資訊卡,顯示格式化文字、按鈕和可點選圖片等 UI 元素。資訊卡通常會顯示在郵件的純文字內文下方。 |
cards_v2[] |
(選用步驟) cards 陣列。 只有 Chat 應用程式可以建立資訊卡。如果即時通訊應用程式以使用者身分進行驗證,訊息就無法包含資訊卡。 如要瞭解如何建立含有資訊卡的訊息,請參閱「傳送訊息」。 使用資訊卡建構工具設計及預覽資訊卡。 開啟「資訊卡建立工具」 |
annotations[] |
僅供輸出。與這則訊息中的 |
thread |
郵件所屬的討論串。如需使用範例,請參閱「發起或回覆訊息討論串」。 |
space |
僅供輸出。如果 Chat 應用程式以使用者身分進行驗證,輸出內容只會填入 space |
fallback_text |
(選用步驟) 訊息資訊卡的純文字說明,用於無法顯示實際資訊卡的情況,例如行動通知。 |
action_response |
僅限輸入。Chat 應用程式可用來設定如何發布回覆的參數。 |
argument_text |
僅供輸出。訊息的純文字內文,已移除所有 Chat 應用程式提及內容。 |
slash_command |
僅供輸出。斜線指令資訊 (如適用)。 |
attachment[] |
(選用步驟) 使用者上傳的附件。 |
matched_url |
僅供輸出。 |
thread_reply |
僅供輸出。如果顯示 如果該空間不支援在討論串中回覆,這個欄位一律為 |
client_assigned_message_id |
(選用步驟) 訊息的自訂 ID。你可以使用這個欄位識別訊息,或是取得、刪除或更新訊息。如要設定自訂 ID,請在建立訊息時指定 |
emoji_reaction_summaries[] |
僅供輸出。訊息中表情符號回應摘要的清單。 |
private_message_viewer |
(選用步驟) 不可變更。輸入內容,用於建立訊息,否則只會輸出內容。可查看訊息的使用者。設定後,訊息會設為私人訊息,只有指定使用者和 Chat 應用程式能看到。如要在要求中加入這個欄位,您必須使用應用程式驗證呼叫 Chat API,並省略下列項目: 詳情請參閱「私下傳送訊息」。 |
deletion_metadata |
僅供輸出。有關已刪除訊息的資訊。設定 |
quoted_message_metadata |
僅供輸出。Google Chat 使用者在聊天室中引用訊息的相關資訊。Google Chat 使用者可以引用訊息來回覆。 |
attached_gifs[] |
僅供輸出。附加至郵件的 GIF 圖片。 |
accessory_widgets[] |
(選用步驟) 顯示在郵件底部的互動式小工具。您可以在含有文字、資訊卡,或同時含有文字和資訊卡的訊息中新增配件小工具。不支援含有對話方塊的訊息。詳情請參閱「在訊息底部新增互動式小工具」。 如要建立含有配件小工具的訊息,必須驗證應用程式。 |
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_update_time |
僅供輸出。引用的訊息建立時間或上次更新時間的時間戳記。 |
反應影片
對訊息的回應。
欄位 | |
---|---|
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_link_type |
複合式連結類型。 |
聯集欄位 data 。連結資源的資料。data 只能是下列其中一項: |
|
drive_link_data |
雲端硬碟連結的資料。 |
chat_space_link_data |
聊天室連結的資料。 |
RichLinkType
複合式連結類型。日後可能會新增更多類型。
列舉 | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED |
列舉的預設值。請勿使用。 |
DRIVE_FILE |
Google 雲端硬碟的富連結類型。 |
CHAT_SPACE |
Chat 聊天室的富連結類型。例如聊天室智慧型方塊。 |
SearchSpacesRequest
要求根據查詢搜尋聊天室清單。
欄位 | |
---|---|
use_admin_access |
時,這個方法會使用使用者的 Google Workspace 管理員權限執行。 通話使用者必須是具備「管理即時通訊和聊天室對話」權限的 Google Workspace 管理員。 需要 這個方法目前僅支援管理員存取權,因此這個欄位只接受 |
page_size |
要傳回的空間數量上限。服務傳回的產品數量可能會少於這個值。 如未指定,最多將傳回 100 個空間。 值的上限為 1000。如果使用超過 1000 的值,系統會自動變更為 1000。 |
page_token |
這是從先前的搜尋空間呼叫接收到的權杖。提供此參數即可擷取後續網頁。 進行分頁時,提供的所有其他參數應與提供網頁權杖的呼叫相符。將不同值傳遞至其他參數可能會導致非預期的結果。 |
query |
必要欄位。搜尋查詢。 您可以使用下列參數進行搜尋:
不同欄位之間僅支援 在同一個欄位中, 以下是有效的查詢範例:
|
order_by |
(選用步驟) 聊天室清單的排序方式。 支援的排序依據屬性如下:
有效的排序作業值如下:
支援的語法如下:
|
SearchSpacesResponse
回應,其中包含與搜尋聊天室要求相應的聊天室清單。
欄位 | |
---|---|
spaces[] |
所要求空間的頁面。 |
next_page_token |
可用於擷取下一頁的權杖。如果這個欄位留空,表示沒有後續網頁。 |
total_size |
所有頁面中符合查詢條件的空間總數。如果結果超過 10,000 個空格,這個值就是估計值。 |
SetUpSpaceRequest
要求建立聊天室,並在其中新增指定使用者。
欄位 | |
---|---|
space |
必要欄位。 如要建立空間,請將 如要建立群組通訊,請將 如要建立人與人之間的 1:1 對話,請將 如要建立人與通話 Chat 應用程式之間的 1:1 對話,請將 如果 |
request_id |
(選用步驟) 這項要求的專屬 ID。建議使用隨機 UUID。指定現有要求 ID 時,系統會傳回以該 ID 建立的聊天室,而不是建立新聊天室。如果指定來自相同 Chat 應用程式的現有要求 ID,但驗證使用者不同,系統會傳回錯誤。 |
memberships[] |
(選用步驟) 要邀請加入聊天室的 Google Chat 使用者或群組。請省略通話使用者,因為系統會自動新增。 目前這組成員最多可有 49 人 (不含來電者)。 如果是人類成員, 如果是 Google 群組成員, 將 將 如果將 在建立人與通話 Chat 應用程式之間的 1:1 對話時,必須為空白 (將 |
SlashCommand
Google Chat 中斜線指令的中繼資料。
欄位 | |
---|---|
command_id |
斜線指令的 ID。 |
SlashCommandMetadata
斜線指令 (/) 的註解中繼資料。
欄位 | |
---|---|
bot |
叫用指令的 Chat 應用程式。 |
type |
斜線指令類型。 |
command_name |
所呼叫斜線指令的名稱。 |
command_id |
所叫用斜線指令的指令 ID。 |
triggers_dialog |
指出斜線指令是否用於對話方塊。 |
類型
列舉 | |
---|---|
TYPE_UNSPECIFIED |
列舉的預設值。請勿使用。 |
ADD |
將 Chat 應用程式新增至聊天室。 |
INVOKE |
在聊天室中叫用斜線指令。 |
空格
Google Chat 聊天室。聊天室是兩名以上使用者之間的對話,或是使用者與 Chat 應用程式之間的一對一訊息。
欄位 | |
---|---|
name |
ID。聊天室的資源名稱。 格式: 其中 |
type |
僅供輸出。已淘汰:請改用 |
space_type |
(選用步驟) 空間類型。建立聊天室或更新聊天室類型時必須提供,僅供輸出,不得用於其他用途。 |
single_user_bot_dm |
(選用步驟) 聊天室是否為 Chat 應用程式與單一人類之間的即時訊息。 |
threaded |
僅供輸出。已淘汰:請改用 |
display_name |
(選用步驟) 聊天室的顯示名稱。使用 如果是即時訊息,這個欄位可能會空白。 最多可使用 128 個半形字元。 |
external_user_allowed |
(選用步驟) 不可變更。這個聊天室是否允許任何 Google Chat 使用者加入。在 Google Workspace 機構中建立聊天室時輸入。在下列情況下建立聊天室時,請省略這個欄位:
如果是現有聊天室,這個欄位僅供輸出。 |
space_threading_state |
僅供輸出。Chat 聊天室中的討論串狀態。 |
space_details |
(選用步驟) 聊天室詳細資料,包括說明和規則。 |
space_history_state |
(選用步驟) 這個聊天室中訊息和討論串的訊息記錄狀態。 |
import_mode |
(選用步驟) 這個空間是否在 在 |
create_time |
(選用步驟) 不可變更。如果是透過 Chat 建立的聊天室,則為聊天室的建立時間。這個欄位只能輸出,匯入模式聊天室除外。 如果是匯入模式的空間,請將這個欄位設為空間在來源中建立時的歷史時間戳記,以便保留原始建立時間。 只有在 |
last_active_time |
僅供輸出。聊天室中最後一則訊息的時間戳記。 |
admin_installed |
僅供輸出。如果是含有 Chat 應用程式的即時訊息 (DM) 聊天室,則無論聊天室是否由 Google Workspace 管理員建立,管理員可以代表機構中的使用者安裝及設定與 Chat 應用程式的即時訊息。 如要支援管理員安裝,Chat 應用程式必須具備即時通訊功能。 |
membership_count |
僅供輸出。依成員類型分組的加入會員人數。當 |
access_settings |
(選用步驟) 指定聊天室的存取權設定。只有在 |
space_uri |
僅供輸出。使用者存取空間的 URI。 |
import_mode_expire_time |
僅供輸出。如果聊天室仍處於匯入模式,系統會自動刪除聊天室的時間。 以匯入模式建立的每個聊天室,都必須在到期時間前使用 只有以匯入模式建立的聊天室才會填入這個欄位。 |
customer |
(選用步驟) 不可變更。聊天室網域的客戶 ID。只有在建立具有應用程式驗證的聊天室,且 格式為 如果是即時訊息,這個欄位不會填入任何內容。 |
聯集欄位 space_permission_settings 。代表聊天室的權限設定。只有在 space_type 為 SPACE 時才會填入資料。space_permission_settings 只能是下列其中一項: |
|
predefined_permission_settings |
(選用步驟) 僅限輸入。預先定義的聊天室權限設定,只能在建立聊天室時輸入。如果不設定這個欄位,系統會建立協作空間。建立空間後,系統會在 設定預先定義的權限設定支援: |
permission_settings |
(選用步驟) 現有聊天室的聊天室權限設定。輸入內容,更新確切的空間權限設定,取代現有的權限設定。輸出內容會列出目前的權限設定。 讀取及更新權限設定支援: |
AccessSettings
代表聊天室的存取權設定。
欄位 | |
---|---|
access_state |
僅供輸出。顯示空間的存取狀態。 |
audience |
(選用步驟) 可探索、加入聊天室及預覽聊天室訊息的目標對象資源名稱。如果未設定,只有個別受邀或加入聊天室的使用者或 Google 網路論壇可以存取。詳情請參閱「讓目標對象能找到你的空間」。 格式: 如要使用 Google Workspace 機構的預設目標對象,請設為 讀取目標對象支援: 使用 設定目標對象時,需要使用者驗證。 |
AccessState
代表聊天室的存取狀態。
列舉 | |
---|---|
ACCESS_STATE_UNSPECIFIED |
這個 API 不支援或無法判斷存取狀態。 |
PRIVATE |
只有其他使用者或 Google Workspace 管理員個別新增或邀請的使用者或 Google 群組,才能探索及存取聊天室。 |
DISCOVERABLE |
聊天室管理員已授予目標對象聊天室存取權。個別新增或受邀加入聊天室的使用者或 Google 網路論壇,也可以探索及存取聊天室。詳情請參閱「允許特定使用者探索聊天室」。 建立可自由加入的聊天室需要使用者驗證。 |
MembershipCount
代表聊天室的成員人數,並依類別分組。
欄位 | |
---|---|
joined_direct_human_user_count |
僅供輸出。直接加入聊天室的使用者人數,不包括透過加入群組而加入的使用者。 |
joined_group_count |
僅供輸出。直接加入聊天室的所有群組數量。 |
PermissionSetting
代表空間權限設定。
欄位 | |
---|---|
managers_allowed |
(選用步驟) 聊天室管理員是否具備這項權限。 |
members_allowed |
(選用步驟) 非管理員成員是否具備這項權限。 |
PermissionSettings
更新現有名稱空間時可指定的權限設定。
如要在建立空間時設定權限,請在要求中指定 PredefinedPermissionSettings
欄位。
欄位 | |
---|---|
manage_members_and_groups |
(選用步驟) 管理聊天室成員和群組的設定。 |
modify_space_details |
(選用步驟) 設定更新聊天室名稱、顯示圖片、說明和規範。 |
toggle_history |
(選用步驟) 開啟及關閉聊天室記錄的設定。 |
use_at_mention_all |
(選用步驟) 在聊天室中使用 @號提及所有人的設定。 |
manage_apps |
(選用步驟) 用於管理聊天室中的應用程式。 |
manage_webhooks |
(選用步驟) 用於管理聊天室中的 Webhook。 |
post_messages |
僅供輸出。在聊天室中張貼訊息的設定。 |
reply_messages |
(選用步驟) 設定聊天室訊息的回覆方式。 |
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_time |
事件發生的時間。 |
event_type |
聊天室事件類型。每種事件類型都有批次版本,代表短時間內發生的多個事件類型例項。如果是 支援的訊息事件類型:
會員支援的事件類型:
支援的回應事件類型:
支援的空間事件類型:
|
聯集欄位
|
|
message_created_event_data |
新訊息的事件酬載。 活動類型: |
message_updated_event_data |
更新訊息的事件酬載。 活動類型: |
message_deleted_event_data |
已刪除訊息的事件酬載。 活動類型: |
message_batch_created_event_data |
多則新訊息的事件酬載。 活動類型: |
message_batch_updated_event_data |
多則更新訊息的事件酬載。 活動類型: |
message_batch_deleted_event_data |
多則已刪除郵件的事件酬載。 活動類型: |
space_updated_event_data |
聊天室更新的事件酬載。 活動類型: |
space_batch_updated_event_data |
針對空間的多項更新事件酬載。 活動類型: |
membership_created_event_data |
新會籍的事件酬載。 活動類型: |
membership_updated_event_data |
更新會員方案的事件酬載。 活動類型: |
membership_deleted_event_data |
已刪除會員方案的事件酬載。 活動類型: |
membership_batch_created_event_data |
多個新會員的事件酬載。 活動類型: |
membership_batch_updated_event_data |
多個更新會籍的事件酬載。 活動類型: |
membership_batch_deleted_event_data |
多個已刪除會員方案的事件酬載。 活動類型: |
reaction_created_event_data |
新回應的事件酬載。 活動類型: |
reaction_deleted_event_data |
已刪除回應的事件酬載。 活動類型: |
reaction_batch_created_event_data |
多個新回應的事件酬載。 活動類型: |
reaction_batch_deleted_event_data |
多個已刪除回應的事件酬載。 活動類型: |
SpaceNotificationSetting
使用者在聊天室中的通知設定。
欄位 | |
---|---|
name |
ID。聊天室通知設定的資源名稱。格式: |
notification_setting |
通知設定。 |
mute_setting |
聊天室通知靜音設定。 |
MuteSetting
聊天室通知靜音設定類型。
列舉 | |
---|---|
MUTE_SETTING_UNSPECIFIED |
保留。 |
UNMUTED |
使用者會根據通知設定,接收空間的通知。 |
MUTED |
無論通知設定為何,使用者都不會收到任何聊天室通知。 |
NotificationSetting
通知設定類型,日後可能會支援其他類型。
列舉 | |
---|---|
NOTIFICATION_SETTING_UNSPECIFIED |
保留。 |
ALL |
當有人使用 @號提及你、你追蹤的討論串有新內容,或是有人在新的討論串中張貼第一則訊息時,系統就會通知你。系統會自動追蹤所有新討論串,除非使用者手動取消追蹤。 |
MAIN_CONVERSATIONS |
當有人使用 @號提及你、你追蹤的討論串有新內容,或是有人在新的討論串中張貼第一則訊息時,系統就會通知你。不適用於 1:1 即時訊息。 |
FOR_YOU |
當有人使用 @號提及你,或你追蹤的討論串有新訊息時,系統就會發送通知。不適用於 1:1 即時訊息。 |
OFF |
通知已關閉。 |
SpaceReadState
使用者在聊天室中的已讀狀態,用於識別已讀和未讀訊息。
欄位 | |
---|---|
name |
聊天室讀取狀態的資源名稱。 格式: |
last_read_time |
(選用步驟) 使用者空間讀取狀態的更新時間。這通常對應於最後讀取訊息的時間戳記,或是使用者指定的時間戳記,用來標示空間中最後讀取的位置。 |
SpaceUpdatedEventData
更新聊天室的事件酬載。
活動類型:google.workspace.chat.space.v1.updated
欄位 | |
---|---|
space |
更新後的聊天室。 |
討論串
Google Chat 聊天室中的對話串。如需使用範例,請參閱「發起或回覆訊息討論串」。
建立訊息時,如果指定了執行緒,可以設定 messageReplyOption
欄位,決定找不到相符執行緒時的處理方式。
欄位 | |
---|---|
name |
ID。執行緒的資源名稱。 範例: |
thread_key |
(選用步驟) 用於建立或更新執行緒的輸入內容。否則,僅供輸出。執行緒的 ID。最多可輸入 4,000 個半形字元。 這個 ID 專屬於設定該 ID 的 Google Chat 應用程式。舉例來說,如果多個 Chat 應用程式使用相同的討論串鍵建立訊息,這些訊息就會發布在不同的討論串中。如要回覆使用者或另一個 Chat 應用程式建立的討論串,請改為指定 |
ThreadReadState
使用者在討論串中的已讀狀態,用於識別已讀和未讀訊息。
欄位 | |
---|---|
name |
執行緒讀取狀態的資源名稱。 格式: |
last_read_time |
使用者更新執行緒讀取狀態的時間。這通常對應至對話串中最後一則已讀訊息的時間戳記。 |
UpdateMembershipRequest
要求更新會員方案的訊息。
欄位 | |
---|---|
membership |
必要欄位。要更新的成員資格。只會更新 |
update_mask |
必要欄位。要更新的欄位路徑。以半形逗號分隔多個值,或使用 目前支援的欄位路徑:
|
use_admin_access |
(選用步驟) 時,這個方法會使用使用者的 Google Workspace 管理員權限執行。 通話使用者必須是具備「管理即時通訊和聊天室對話」權限的 Google Workspace 管理員。 需要 |
UpdateMessageRequest
要求更新訊息。
欄位 | |
---|---|
message |
必要欄位。已更新欄位的訊息。 |
update_mask |
必要欄位。要更新的欄位路徑。以半形逗號分隔多個值,或使用 目前支援的欄位路徑: |
allow_missing |
(選用步驟) 如果找不到 |
UpdateSpaceNotificationSettingRequest
要求更新聊天室通知設定。僅支援更新通話使用者的通知設定。
欄位 | |
---|---|
space_notification_setting |
必要欄位。聊天室通知設定的資源名稱必須以 |
update_mask |
必要欄位。支援的欄位路徑:
|
UpdateSpaceReadStateRequest
UpdateSpaceReadState API 的要求訊息。
欄位 | |
---|---|
space_read_state |
必要欄位。要更新的聊天室讀取狀態和欄位。 僅支援更新呼叫使用者的讀取狀態。 如要參照呼叫使用者,請設定下列其中一項:
格式:users/{user}/spaces/{space}/spaceReadState |
update_mask |
必要欄位。要更新的欄位路徑。目前支援的欄位路徑:
如果 如要將空間標示為已讀,請將 |
UpdateSpaceRequest
更新單一空間的要求。
欄位 | |
---|---|
space |
必要欄位。要更新欄位的空間。 |
update_mask |
必要欄位。更新後的欄位路徑,如有多個路徑,請以半形逗號分隔。 您可以更新下列空間欄位:
|
use_admin_access |
(選用步驟) 時,這個方法會使用使用者的 Google Workspace 管理員權限執行。 通話使用者必須是具備「管理即時通訊和聊天室對話」權限的 Google Workspace 管理員。 需要 管理員存取權不支援部分 |
使用者
Google Chat 使用者。如果 Chat 應用程式以使用者身分進行驗證,當要求傳回做為輸出內容時,User
資源的輸出內容只會填入使用者的 name
和 type
。
欄位 | |
---|---|
name |
Google Chat 格式: 對於
|
display_name |
僅供輸出。使用者的顯示名稱。 |
domain_id |
使用者 Google Workspace 網域的專屬 ID。 |
type |
使用者類型。 |
is_anonymous |
僅供輸出。 |
類型
列舉 | |
---|---|
TYPE_UNSPECIFIED |
列舉的預設值。請勿使用。 |
HUMAN |
真人使用者。 |
BOT |
Chat 擴充應用程式使用者。 |
UserMentionMetadata
使用者提及 (@) 的註解中繼資料。
欄位 | |
---|---|
user |
提及的使用者。 |
type |
使用者提及類型。 |
類型
列舉 | |
---|---|
TYPE_UNSPECIFIED |
列舉的預設值。請勿使用。 |
ADD |
將使用者新增至聊天室。 |
MENTION |
在聊天室中提及使用者。 |
WidgetMarkup
小工具是顯示文字和圖片的 UI 元素。
欄位 | |
---|---|
buttons[] |
按鈕清單。按鈕也是 |
聯集欄位 data 。WidgetMarkup 只能包含下列其中一個項目。您可以使用多個 WidgetMarkup 欄位來顯示更多項目。data 只能是下列其中一項: |
|
text_paragraph |
在這個小工具中顯示一段文字。 |
image |
在這個小工具中顯示圖片。 |
key_value |
在這個小工具中顯示鍵值項目。 |
按鈕
按鈕。可以是文字按鈕或圖片按鈕。
欄位 | |
---|---|
聯集欄位
|
|
text_button |
含有文字和 |
image_button |
含有圖片和 |
FormAction
表單動作說明表單提交時的行為。舉例來說,您可以叫用 Apps Script 來處理表單。
欄位 | |
---|---|
action_method_name |
方法名稱用於識別表單的哪個部分觸發表單提交。這項資訊會以資訊卡點擊事件的形式,回傳至 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_url |
圖片的網址。 |
on_click |
|
aspect_ratio |
這張圖片的長寬比 (寬度和高度)。這個欄位可讓您在等待圖片載入時,預留圖片的正確高度。這項屬性並非用來覆寫圖片的內建長寬比。如未設定,伺服器會預先擷取圖片,並填入這項屬性。 |
ImageButton
含有 onclick
動作的圖片按鈕。
欄位 | |
---|---|
on_click |
|
name |
這個 |
聯集欄位 icons 。圖示可由 Icon enum 或網址指定。icons 只能是下列其中一項: |
|
icon |
|
icon_url |
網址指定的圖示。 |
KeyValue
UI 元素包含鍵 (標籤) 和值 (內容)。這個元素也可以包含一些動作,例如 onclick
按鈕。
欄位 | |
---|---|
top_label |
頂端標籤的文字。支援格式化文字。如要進一步瞭解如何設定文字格式,請參閱「在 Google Chat 應用程式中設定文字格式」和「在 Google Workspace 外掛程式中設定文字格式」。 |
content |
內容的文字。支援格式化文字,且一律為必填。如要進一步瞭解如何設定文字格式,請參閱「在 Google Chat 應用程式中設定文字格式」和「在 Google Workspace 外掛程式中設定文字格式」。 |
content_multiline |
如果內容應為多行。 |
bottom_label |
底部標籤的文字。支援格式化文字。如要進一步瞭解如何設定文字格式,請參閱「在 Google Chat 應用程式中設定文字格式」和「在 Google Workspace 外掛程式中設定文字格式」。 |
on_click |
|
聯集欄位 icons 。至少須定義圖示、top_label 和 bottom_label 其中一項。icons 只能是下列其中一項: |
|
icon |
這個列舉值會由 Chat API 替換為相應的圖示圖片。 |
icon_url |
網址指定的圖示。 |
聯集欄位 control 。控制小工具。你可以設定 button 或 switch_widget ,但不能同時設定兩者。control 只能是下列其中一項: |
|
button |
可點選的按鈕,用於觸發動作。 |
OnClick
onclick
動作 (例如開啟連結)。
欄位 | |
---|---|
聯集欄位
|
|
action |
如果指定了這項 |
open_link |
如果指定了開啟連結動作,這項 |
OpenLink
開啟新視窗的連結。
欄位 | |
---|---|
url |
要開啟的網址。 |
TextButton
含有文字和 onclick
動作的按鈕。
欄位 | |
---|---|
text |
按鈕文字。 |
on_click |
按鈕的 |
TextParagraph
一段文字。支援格式化文字。如要進一步瞭解如何設定文字格式,請參閱「在 Google Chat 應用程式中設定文字格式」和「在 Google Workspace 外掛程式中設定文字格式」。
欄位 | |
---|---|
text |
|