索引
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
(訊息)CreateMembershipRequest
(訊息)CreateMessageRequest
(訊息)CreateMessageRequest.MessageReplyOption
(列舉)CreateReactionRequest
(訊息)CreateSpaceRequest
(訊息)CustomEmoji
(訊息)DeleteMembershipRequest
(訊息)DeleteMessageRequest
(訊息)DeleteReactionRequest
(訊息)DeleteSpaceRequest
(訊息)DeletionMetadata
(訊息)DeletionMetadata.DeletionType
(列舉)Dialog
(訊息)DialogAction
(訊息)DriveDataRef
(訊息)DriveLinkData
(訊息)Emoji
(訊息)EmojiReactionSummary
(訊息)FindDirectMessageRequest
(訊息)GetAttachmentRequest
(訊息)GetMembershipRequest
(訊息)GetMessageRequest
(訊息)GetSpaceEventRequest
(訊息)GetSpaceReadStateRequest
(訊息)GetSpaceRequest
(訊息)GetThreadReadStateRequest
(訊息)Group
(訊息)HistoryState
(列舉)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
(訊息)SpaceReadState
(訊息)SpaceUpdatedEventData
(訊息)Thread
(訊息)ThreadReadState
(訊息)UpdateMembershipRequest
(訊息)UpdateMessageRequest
(訊息)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 平台上建構即時通訊應用程式與整合功能。
CompleteImportSpace |
---|
完成指定聊天室的匯入程序,並向使用者顯示。必須啟用應用程式驗證和全網域委派功能。詳情請參閱「授權 Google Chat 應用程式匯入資料」。
|
CreateMembership |
---|
為通話對象、即時通訊應用程式、使用者或 Google 群組建立成員資格。系統不支援為其他 Chat 擴充應用程式建立成員資格。建立成員時,如果指定成員關閉了自動接受政策,系統會向他們發出邀請,且必須先接受邀請才能加入。否則,當您建立成員資格時,系統會將成員直接新增至指定聊天室。需要使用者驗證。 如需使用範例,請參閱:
|
CreateMessage |
---|
在 Google Chat 聊天室中建立訊息。如需範例,請參閱「傳送訊息」。
下圖顯示您使用應用程式驗證功能時,Chat 如何歸因訊息。Chat 會將 Chat 應用程式顯示為訊息傳送者。訊息內容可包含文字 ( 下圖顯示當您使用使用者驗證功能時,Chat 如何歸因訊息。Chat 會將使用者顯示為訊息傳送者,並顯示即時通訊應用程式的名稱,藉此將 Chat 應用程式歸因於訊息。訊息內容只能包含文字 ( 訊息內容的大小上限為 32,000 個位元組 (含訊息內容)。
|
CreateReaction |
---|
建立回應並將其新增至訊息中。僅支援萬國碼表情符號。如需範例,請參閱「對郵件新增回應」。需要使用者驗證。
|
CreateSpace |
---|
建立具名聊天室。系統不支援依主題分組的聊天室。如需範例說明,請參閱「建立聊天室」。 如果在建立聊天室時收到 需要使用者驗證。
|
DeleteMembership |
---|
刪除會員資格。如需範例,請參閱「從聊天室中移除使用者或 Google Chat 應用程式」。 需要使用者驗證。
|
DeleteMessage |
---|
刪除訊息。如需範例,請參閱刪除郵件。 必須進行驗證。支援應用程式驗證和使用者驗證。使用應用程式驗證功能時,要求只能刪除呼叫 Chat 應用程式建立的訊息。
|
DeleteReaction |
---|
刪除對訊息的回應。僅支援萬國碼表情符號。如需範例,請參閱「刪除回應」。需要使用者驗證。
|
DeleteSpace |
---|
刪除已命名的聊天室。一律執行串聯刪除,亦即聊天室子項資源 (例如在聊天室中張貼的訊息和成員資格) 也會一併刪除。如需範例,請參閱「刪除聊天室」。需要對有權刪除聊天室的使用者進行使用者驗證。
|
FindDirectMessage |
---|
傳回含有指定使用者的現有即時訊息。如果找不到即時訊息聊天室,則傳回 使用使用者驗證時,會傳回指定使用者和已驗證使用者之間的即時訊息空間。 使用應用程式驗證時,會傳回指定使用者和發出呼叫 Chat 應用程式之間的即時訊息空間。
|
GetAttachment |
---|
取得訊息附件的中繼資料。使用媒體 API 擷取附件資料。如需範例,請參閱取得郵件附件的相關中繼資料。必須啟用應用程式驗證。
|
GetMembership |
---|
傳回會員資格詳情。舉例來說,請參閱「取得使用者或 Google Chat 應用程式會員資格的詳細資料」。
|
GetMessage |
---|
傳回郵件的詳細資料。如需範例,請參閱「取得訊息的詳細資料」。 注意:系統可能會傳回來自封鎖成員或聊天室的訊息。
|
GetSpace |
---|
傳回聊天室的詳細資料。如需範例,請參閱「取得聊天室的詳細資料」。
|
GetSpaceEvent |
---|
傳回 Google Chat 聊天室中的事件。事件酬載包含已變更資源的最新版本。舉例來說,如果您要求含有新訊息的事件,但訊息之後已更新,伺服器會在事件酬載中傳回更新過的 需要使用者驗證。如要取得活動,已驗證的使用者必須是聊天室成員。 如需範例,請參閱「取得 Google Chat 聊天室中的活動詳細資料」。
|
GetSpaceReadState |
---|
傳回使用者聊天室中讀取狀態的詳細資料,用於識別已讀和未讀訊息。舉例來說,請參閱「取得使用者的聊天室讀取狀態詳細資料」。 需要使用者驗證。
|
GetThreadReadState |
---|
傳回使用者在執行緒中讀取狀態的詳細資料,用於識別已讀和未讀郵件。如需範例,請參閱「取得使用者的執行緒讀取狀態詳細資料」。 需要使用者驗證。
|
ListMemberships |
---|
列出聊天室中的成員資格。如需範例,請參閱「列出聊天室中的使用者和 Google Chat 應用程式」。採用應用程式驗證設定的成員資格清單會列出 Chat 應用程式可存取的聊天室成員,但不含 Chat 應用程式成員資格。透過使用者驗證功能列出的成員資格,清單會列出通過驗證的使用者可存取的聊天室成員。
|
ListMessages |
---|
列出來電者所屬聊天室中的訊息,包括已封鎖的成員和聊天室的訊息。如果您從沒有訊息的聊天室中列出訊息,回應會是空白物件。使用 REST/HTTP 介面時,回應會包含空白的 JSON 物件
|
ListReactions |
---|
列出回應訊息的回應。如需範例,請參閱「列出訊息的回應」。需要使用者驗證。
|
ListSpaceEvents |
---|
列出 Google Chat 聊天室中的事件。每個事件的酬載都包含最新版本的 Chat 資源。舉例來說,如果您列出新聊天室成員的事件,伺服器會傳回 需要使用者驗證。如要列出事件,已驗證的使用者必須是聊天室成員。 如需範例,請參閱「列出 Google Chat 聊天室中的事件」。
|
ListSpaces |
---|
列出呼叫端所屬的聊天室。系統要等到第一則訊息傳送後,才會列出群組通訊和即時訊息。如需範例,請參閱「列出聊天室」。 列出呼叫端或已驗證使用者可見的聊天室。系統要等到第一則訊息傳送後,才會列出群組通訊和即時訊息。 如要列出 Google Workspace 機構的所有已命名聊天室,請改用 Workspace 管理員權限的
|
SearchSpaces |
---|
use_admin_access 設為 true 。
|
SetUpSpace |
---|
建立聊天室並將指定的使用者新增至聊天室。通話使用者會自動加入聊天室,且不應在要求中指定為成員資格。如需範例,請參閱「設定包含初始成員的聊天室」。 如要指定要新增的真人成員,請使用適當的 如要指定要新增的 Google 群組,請使用適當的 如果已命名的聊天室或群組通訊,如果來電者封鎖對象、遭到部分成員封鎖,或是沒有新增成員的權限,這些成員就不會加入建立的聊天室。 如要在發起通話的使用者和另一位真人使用者之間建立即時訊息 (DM),請指定一個代表真人使用者的成員資格。如果某位使用者封鎖另一位使用者,則該要求會失敗,系統也不會建立即時訊息。 如要在發出呼叫的使用者和呼叫應用程式之間建立即時訊息,請將 如果兩位使用者之間已經存在即時訊息,即使其中一位使用者在提出要求時封鎖另一位使用者,系統仍會傳回現有的即時訊息。 不支援含有討論串回覆的聊天室。如果在設定聊天室時收到「 需要使用者驗證。
|
UpdateMembership |
---|
更新成員資格。如需範例,請參閱「更新使用者的聊天室成員資格」。 需要使用者驗證。
|
UpdateMessage |
---|
更新訊息。 必須進行驗證。支援應用程式驗證和使用者驗證。使用應用程式驗證功能時,要求只能更新呼叫 Chat 應用程式建立的訊息。
|
UpdateSpace |
---|
更新聊天室。如需範例,請參閱「更新聊天室」。 如果要更新 需要使用者驗證。
|
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[] |
SelectItem 物件的陣列。 |
UpdatedWidget
更新小工具的回應。用於提供小工具的自動完成選項。
欄位 | |
---|---|
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 |
複合式連結的中繼資料。 |
AnnotationType
註解的類型。
列舉 | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
列舉的預設值。請勿使用。 |
USER_MENTION |
已提及使用者。 |
SLASH_COMMAND |
叫用斜線指令。 |
RICH_LINK |
複合式連結註解。 |
AttachedGif
由網址指定的 GIF 圖片。
欄位 | |
---|---|
uri |
僅供輸出。代管 GIF 圖片的網址。 |
附件
Google Chat 中的附件。
欄位 | |
---|---|
name |
附件的資源名稱,格式為 |
content_name |
僅供輸出。內容的原始檔案名稱,而非完整路徑。 |
content_type |
僅供輸出。檔案的內容類型 (MIME 類型)。 |
thumbnail_uri |
僅供輸出。縮圖網址,可用於預覽供真人使用者查看的附件。即時通訊應用程式不應使用這個網址下載附件內容。 |
download_uri |
僅供輸出。下載網址,用於允許真人使用者下載附件。即時通訊應用程式不應使用這個網址下載附件內容。 |
source |
僅供輸出。附件的來源。 |
聯集欄位 data_ref 。附件的資料參照。data_ref 只能是下列其中一項: |
|
attachment_data_ref |
附件資料的參照。這個欄位會用於媒體 API,用來下載附件資料。 |
drive_data_ref |
僅供輸出。Google 雲端硬碟附件的參照。這個欄位會搭配 Google Drive API 使用。 |
來源
附件的來源。
列舉 | |
---|---|
SOURCE_UNSPECIFIED |
預留。 |
DRIVE_FILE |
這個檔案是 Google 雲端硬碟檔案。 |
UPLOADED_CONTENT |
檔案會上傳至 Chat。 |
AttachmentDataRef
附件資料的參照。
欄位 | |
---|---|
resource_name |
連結資料的資源名稱。這個欄位會用於媒體 API,用來下載附件資料。 |
attachment_upload_token |
含有上傳附件參照的不透明權杖。由用戶端以不透明字串的形式處理,用來建立或更新含有附件的 Chat 訊息。 |
CardWithId
Google Chat 訊息中的資訊卡。
只有 Chat 應用程式可以建立資訊卡。如果 Chat 應用程式以使用者的身分進行驗證,則訊息不得包含卡片。
使用 Card Builder 設計及預覽資訊卡。
開啟資訊卡建立工具欄位 | |
---|---|
card_id |
如果訊息含有多張卡片,則為必要欄位。訊息中卡片的專屬 ID。 |
card |
資訊卡。大小上限為 32 KB。 |
ChatSpaceLinkData
Chat 聊天室連結的資料。
欄位 | |
---|---|
space |
已連結 Chat 聊天室資源的聊天室。 格式: |
thread |
已連結 Chat 聊天室資源的討論串。 格式: |
message |
已連結 Chat 聊天室資源的訊息。 格式: |
CompleteImportSpaceRequest
聊天室匯入程序的要求訊息。
欄位 | |
---|---|
name |
必要欄位。匯入模式空間的資源名稱。 格式: |
CompleteImportSpaceResponse
聊天室匯入程序的回應訊息。
欄位 | |
---|---|
space |
匯入模式空間。 |
ContextualAddOnMarkup
這個類型沒有任何欄位。
可讓開發人員指定內容相關 AddOn 內容的標記。
資訊卡
資訊卡是一種 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 |
圓形框線。 |
章節
區段包含一組按指定順序 (垂直) 顯示的小工具。在所有平台上,資訊卡的固定寬度都很窄,因此目前不需使用版面配置屬性 (例如浮動值)。
欄位 | |
---|---|
header |
區段標題。支援格式化文字。如要進一步瞭解如何設定文字格式,請參閱「設定 Google Chat 應用程式中的文字格式」和「在 Google Workspace 外掛程式中設定文字格式」。 |
widgets[] |
區段至少必須包含一個小工具。 |
CreateMembershipRequest
要求建立會員資格的訊息。
欄位 | |
---|---|
parent |
必要欄位。要建立成員資格的聊天室資源名稱。 格式:space/{space} |
membership |
必要欄位。要建立的成員關係。 |
use_admin_access |
true 時,此方法會使用使用者的 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,但該要求 ID 與其他使用者不同。在這種情況下,系統會傳回錯誤。 |
CustomEmoji
代表自訂表情符號。
欄位 | |
---|---|
uid |
僅供輸出。自訂表情符號資源的專屬金鑰。 |
DeleteMembershipRequest
要求刪除聊天室中的成員資格。
欄位 | |
---|---|
name |
必要欄位。要刪除的成員資源名稱。Chat 擴充應用程式可以刪除真人使用者或其會員資格即時通訊應用程式無法刪除其他應用程式會員功能。 刪除人工成員資格時,需要 刪除應用程式成員資格時,必須使用 格式: |
use_admin_access |
true 時,此方法會使用使用者的 Google Workspace 管理員權限執行。通話使用者必須是具備管理即時通訊和聊天室對話權限的 Google Workspace 管理員。 需要 無法使用管理員存取權刪除聊天室中的應用程式成員資格。 |
DeleteMessageRequest
要求刪除訊息。
欄位 | |
---|---|
name |
必要欄位。訊息的資源名稱。 格式: 如果您已為訊息設定自訂 ID,就可以使用「 |
force |
只有以使用者的身分進行驗證時適用。以 Chat 應用程式的身分進行驗證時沒有作用。 |
DeleteReactionRequest
刪除對訊息的回應。
欄位 | |
---|---|
name |
必要欄位。要刪除的回應名稱。 格式: |
DeleteSpaceRequest
要求刪除聊天室。
欄位 | |
---|---|
name |
必要欄位。要刪除的聊天室資源名稱。 格式: |
use_admin_access |
true 時,此方法會使用使用者的 Google Workspace 管理員權限執行。通話使用者必須是具備管理即時通訊和聊天室對話權限的 Google Workspace 管理員。 需要 |
DeletionMetadata
已刪除訊息的相關資訊。設定 delete_time
時,系統會刪除訊息。
欄位 | |
---|---|
deletion_type |
顯示刪除訊息的使用者。 |
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_status |
僅限輸入。叫用或提交對話方塊的要求狀態。視需要顯示狀態和要向使用者顯示的訊息。例如發生錯誤或成功時。 |
聯集欄位 action 。要執行的動作。action 只能是下列其中一項: |
|
dialog |
僅限輸入。要求的 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 |
必要欄位。附件的資源名稱,格式為 |
GetMembershipRequest
要求取得聊天室成員資格。
欄位 | |
---|---|
name |
必要欄位。要擷取成員資格的資源名稱。 如要利用使用者驗證機制取得應用程式本身的成員資格,您可以選擇使用 格式: 當您以使用者身分進行驗證時,您可以將使用者的電子郵件地址設為 |
use_admin_access |
true 時,此方法會使用使用者的 Google Workspace 管理員權限執行。通話使用者必須是具備管理即時通訊和聊天室對話權限的 Google Workspace 管理員。 需要 使用管理員存取權時,無法在聊天室中取得應用程式成員資格。 |
GetMessageRequest
要求取得訊息。
欄位 | |
---|---|
name |
必要欄位。訊息的資源名稱。 格式: 如果您已為訊息設定自訂 ID,就可以使用「 |
GetSpaceEventRequest
要求取得聊天室活動的訊息。
欄位 | |
---|---|
name |
必要欄位。聊天室活動的資源名稱。 格式: |
GetSpaceReadStateRequest
GetSpaceReadState API 的要求訊息。
欄位 | |
---|---|
name |
必要欄位。要擷取的聊天室讀取狀態資源名稱。 僅支援取得發出呼叫的使用者讀取狀態。 如要參照發出呼叫的使用者,請設定下列其中一項:
格式:users/{user}/spaces/{space}/spaceReadState |
GetSpaceRequest
傳回單一聊天室的要求。
欄位 | |
---|---|
name |
必要欄位。聊天室的資源名稱,格式為 格式: |
use_admin_access |
true 時,此方法會使用使用者的 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 |
開啟記錄功能。機構的保管箱資料保留規則指定郵件和討論串的保留時間長度。 |
ListMembershipsRequest
列出成員資格的訊息。
欄位 | |
---|---|
parent |
必要欄位。要擷取成員清單的聊天室資源名稱。 格式:space/{space} |
page_size |
選用設定。可退貨的會員數量上限。服務傳回的產品數量可能會少於這個值。 如未指定,最多會傳回 100 個成員資格。 值的數量上限是 1000。如果使用的值超過 1000,系統會自動將值變更為 1000。 負值會傳回 |
page_token |
選用設定。頁面符記,從先前的呼叫列出成員。提供這個參數即可擷取後續網頁。 進行分頁時,提供的所有其他參數應與提供網頁權杖的呼叫相符。將不同的值傳送至其他參數,可能會導致非預期的結果。 |
filter |
選用設定。查詢篩選器。 你可以依成員的角色 ( 如要依角色篩選,請將 如要依類型篩選,請將 如要同時依角色和類型進行篩選,請使用
舉例來說,以下查詢是有效的查詢:
以下查詢無效:
無效查詢遭到伺服器拒絕,並顯示 |
show_groups |
選用設定。執行 |
show_invited |
選用設定。變更 目前需要使用者驗證。 |
use_admin_access |
true 時,此方法會使用使用者的 Google Workspace 管理員權限執行。通話使用者必須是具備管理即時通訊和聊天室對話權限的 Google Workspace 管理員。 需要 使用管理員存取權時,無法在聊天室中列出應用程式成員。 |
ListMembershipsResponse
針對聊天室成員清單的回應。
欄位 | |
---|---|
memberships[] |
未排序的清單。要求 (或第一個) 頁面中的成員清單。 |
next_page_token |
可做為 |
ListMessagesRequest
列出指定聊天室中使用者所屬的訊息。
欄位 | |
---|---|
parent |
必要欄位。要列出訊息的來源聊天室資源名稱。 格式: |
page_size |
傳回的訊息數量上限。服務傳回的訊息可能會少於這個值。 如未指定,最多會傳回 25 個。 值的數量上限是 1000。如果使用的值超過 1000,系統會自動將值變更為 1000。 負值會傳回 |
page_token |
如果繼續執行先前的查詢,則為選用項目。 接收自先前 list 訊息呼叫的頁面符記。提供這個參數即可擷取後續網頁。 進行分頁時,提供的所有其他參數應與提供網頁權杖的呼叫相符。將不同的值傳送至其他參數,可能會導致非預期的結果。 |
filter |
查詢篩選器。 您可以按照日期 ( 如要依建立日期篩選郵件,請指定 如要依執行緒篩選,請指定格式為 如要同時依執行緒和日期進行篩選,請在查詢中使用 舉例來說,以下查詢是有效的查詢:
無效查詢遭到伺服器拒絕,並顯示 |
order_by |
如果繼續執行先前的查詢,則為選用項目。 訊息清單的排序方式。指定排序作業要排序的值。有效的排序作業值如下:
預設順序為 |
show_deleted |
是否包含已刪除的郵件。刪除的郵件會包含刪除時間以及相關刪除時間的中繼資料,但無法取得郵件內容。 |
ListMessagesResponse
列出訊息的回應訊息。
欄位 | |
---|---|
messages[] |
訊息清單。 |
next_page_token |
您可以傳送權杖為 |
ListReactionsRequest
列出回應訊息的回應。
欄位 | |
---|---|
parent |
必要欄位。使用者回應的訊息。 格式: |
page_size |
選用設定。傳回的回應數量上限。服務傳回的回應數可以少於這個值。如未指定,則預設值為 25。許可的最大值為 200;超過 200 個值會變更為 200。 |
page_token |
選用設定。(如果恢復先前的查詢)。 接收自前一個清單回應呼叫的頁面符記。提供此項目即可擷取後續網頁。 進行分頁時,篩選器值應與提供網頁權杖的呼叫相符。如果傳送不同的值,可能會導致非預期的結果。 |
filter |
選用設定。查詢篩選器。 你可以依 emoji ( 如要篩選多個表情符號或使用者的回應,請使用 如要依表情符號和使用者篩選回應,請使用 如果查詢同時使用 舉例來說,以下查詢是有效的查詢:
以下查詢無效:
無效查詢遭到伺服器拒絕,並顯示 |
ListReactionsResponse
回應清單回應要求。
欄位 | |
---|---|
reactions[] |
要求 (或第一個) 頁面中的回應清單。 |
next_page_token |
用來擷取下一頁結果的接續權杖。最後一頁搜尋結果為空白。 |
ListSpaceEventsRequest
列出聊天室事件的要求訊息。
欄位 | |
---|---|
parent |
必要欄位。發生事件的 Google Chat 聊天室資源名稱。 格式: |
page_size |
選用設定。傳回的聊天室事件數量上限。服務傳回的產品數量可能會少於這個值。 負值會傳回 |
page_token |
頁面符記,接收自前一個清單空間事件呼叫。提供此項目即可擷取後續網頁。 進行分頁時,提供給列出空間事件的所有其他參數都必須與提供網頁權杖的呼叫相符。將不同的值傳送至其他參數,可能會導致非預期的結果。 |
filter |
必要欄位。查詢篩選器。 您必須使用 您也可以選擇依開始時間 (
如要指定開始或結束時間,請在 RFC-3339 中使用等於 舉例來說,以下查詢是有效的查詢:
以下查詢無效:
無效查詢遭到伺服器拒絕,並顯示 |
ListSpaceEventsResponse
列出聊天室事件的回應訊息。
欄位 | |
---|---|
space_events[] |
系統會按照時間順序傳回結果 (由舊到新)。 |
next_page_token |
用於擷取更多事件的接續權杖。如果省略這個欄位,就不會有後續頁面。 |
ListSpacesRequest
列出呼叫端所屬聊天室的要求。
欄位 | |
---|---|
page_size |
選用設定。要傳回的聊天室數量上限。服務傳回的產品數量可能會少於這個值。 如未指定,最多會傳回 100 個空格。 值的數量上限是 1000。如果使用的值超過 1000,系統會自動將值變更為 1000。 負值會傳回 |
page_token |
選用設定。從先前的 list 空格呼叫接收的頁面符記。提供這個參數即可擷取後續網頁。 進行分頁時,篩選器值應與提供網頁權杖的呼叫相符。如果傳送不同的值,可能會導致非預期的結果。 |
filter |
選用設定。查詢篩選器。 你可以依聊天室類型 ( 如要依聊天室類型篩選,您必須指定有效的列舉值,例如 舉例來說,以下查詢是有效的查詢:
無效查詢遭到伺服器拒絕,並顯示 |
ListSpacesResponse
清單聊天室要求的回應。
欄位 | |
---|---|
spaces[] |
要求 (或第一個) 頁面中的聊天室清單。 |
next_page_token |
您可以傳送權杖為 |
MatchedUrl
Chat 訊息中的相符網址。即時通訊應用程式可以預覽相符的網址。詳情請參閱「預覽連結」一文。
欄位 | |
---|---|
url |
僅供輸出。符合的網址。 |
成員資格
代表 Google Chat 中的成員身分,例如使用者或 Chat 應用程式是否受邀加入、加入或不在聊天室中。
欄位 | |
---|---|
name |
由伺服器指派的成員資源名稱。 格式: |
state |
僅供輸出。會員狀態。 |
role |
選用設定。使用者在 Chat 聊天室中的角色,會決定他們能在聊天室中執行的動作。 這個欄位只能做為 |
create_time |
選用設定。不可變動。成員資格的建立時間,例如成員加入或受邀加入聊天室的時間。系統只會輸出此欄位,但用於在匯入模式聊天室中匯入過往成員資料時除外。 |
delete_time |
選用設定。不可變動。成員資格的刪除時間,例如成員離開聊天室或從聊天室中移除的時間。系統只會輸出此欄位,但用於在匯入模式聊天室中匯入過往成員資料時除外。 |
聯集欄位 memberType 。已取得這個會員資格的成員。日後可能會支援其他成員類型。memberType 只能是下列其中一項: |
|
member |
與成員資格對應的 Google Chat 使用者或應用程式。如果 Chat 擴充應用程式以使用者的身分進行驗證,輸出內容會填入「使用者」 |
group_member |
與成員資格對應的 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 擴充應用程式以使用者的身分進行驗證,輸出內容會填入「使用者」 |
create_time |
選用設定。不可變動。在 Chat 中建立的聊天室,也就是建立訊息的時間。這個欄位僅供輸出 (用於匯入模式空格時除外)。 如果是匯入模式聊天室,請將這個欄位設為在來源中建立訊息的過往時間戳記,以便保留原始的建立時間。 |
last_update_time |
僅供輸出。使用者上次編輯訊息的時間。如果訊息從未編輯過,這個欄位就會空白。 |
delete_time |
僅供輸出。Google Chat 中刪除訊息的時間。如果郵件從未刪除,這個欄位會留空。 |
text |
郵件的純文字內文。第一個連至圖片、影片或網頁的連結會產生預覽方塊。你也可以使用@號提及 Google Chat 使用者或聊天室中的所有成員。 如要瞭解如何建立簡訊,請參閱傳送訊息。 |
formatted_text |
僅供輸出。包含訊息
詳情請參閱查看郵件中傳送的文字格式。 |
cards[] |
已淘汰:請改用 豐富的格式與互動式資訊卡,可用於顯示 UI 元素,例如格式化的文字、按鈕和可點擊的圖片。資訊卡通常顯示在訊息的純文字內文下方。 |
cards_v2[] |
資訊卡的陣列。 只有 Chat 應用程式可以建立資訊卡。如果 Chat 應用程式以使用者的身分進行驗證,訊息就無法包含卡片。 如要瞭解如何建立含有資訊卡的訊息,請參閱傳送訊息。 使用 Card Builder 設計及預覽資訊卡。 開啟資訊卡建立工具 |
annotations[] |
僅供輸出。與這則訊息中的 |
thread |
訊息所屬的討論串。如需使用說明,請參閱「發起或回覆訊息串」。 |
space |
如果 Chat 擴充應用程式以使用者的身分進行驗證,輸出內容就會填入「聊天室」 |
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 應用程式可以傳送私人訊息,如果你的 Chat 擴充應用程式以使用者身分進行驗證來傳送訊息,就無法設為私人訊息,而且必須略過這個欄位。 詳情請參閱私人訊息。 |
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 |
回應的資源名稱。 格式: |
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 |
Chat 聊天室連結的資料。 |
RichLinkType
複合式連結類型。日後可能會有更多類型。
列舉 | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED |
列舉的預設值。請勿使用。 |
DRIVE_FILE |
Google 雲端硬碟複合式連結類型。 |
CHAT_SPACE |
Chat 聊天室複合式連結類型。例如聊天室智慧型方塊。 |
SearchSpacesRequest
要求根據查詢搜尋聊天室清單。
欄位 | |
---|---|
use_admin_access |
在 通話使用者必須是具備管理即時通訊和聊天室對話權限的 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 對話,請將 如要在真人和通話應用程式之間建立 1:1 對話,請將 如果 |
request_id |
選用設定。這項要求的專屬 ID。建議隨機產生 UUID。指定現有的要求 ID 時,系統會傳回使用該 ID 建立的聊天室,而不會建立新空間。在同一個 Chat 應用程式中指定現有要求 ID,但該要求 ID 與其他使用者不同。在這種情況下,系統會傳回錯誤。 |
memberships[] |
選用設定。要邀請加入聊天室的 Google Chat 使用者或群組。省略呼叫的使用者 (由系統自動新增)。 設定目前除了來電者以外,最多允許 20 個會員資格。 如果是人類成員資格, 如果是 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 應用程式之間的 1:1 訊息。
欄位 | |
---|---|
name |
聊天室的資源名稱。 格式: 其中 |
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 |
選用設定。將資料遷移至 Google Workspace 時,系統是否在「 |
create_time |
選用設定。不可變動。在 Chat 中建立的聊天室,是指聊天室的建立時間。這個欄位僅供輸出 (用於匯入模式空格時除外)。 如果是匯入模式聊天室,請將這個欄位設為在來源中建立聊天室的過往時間戳記,以便保留原始的建立時間。 只有在 |
last_active_time |
僅供輸出。聊天室中最後一則訊息的時間戳記。 |
admin_installed |
僅供輸出。針對採用 Chat 應用程式的即時訊息 (DM) 聊天室,無論聊天室是否由 Google Workspace 管理員建立,管理員可以代表機構使用者安裝及設定 Chat 應用程式的即時訊息。 如要支援管理員安裝功能,您的 Chat 應用程式必須提供即時訊息。 |
membership_count |
僅供輸出。會員人數按成員類型分組。在 |
access_settings |
選用設定。指定聊天室的存取權設定。只有在 |
space_uri |
僅供輸出。供使用者存取聊天室的 URI。 |
聯集欄位 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 |
這項設定代表要在聊天室中使用「@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 |
雙方的 1:1 訊息,或真人與 Chat 應用程式。 |
類型
已淘汰:請改用 SpaceType
。
列舉 | |
---|---|
TYPE_UNSPECIFIED |
預留。 |
ROOM |
兩人之間的對話。 |
DM |
1:1 即時訊息和 Chat 應用程式,其中所有訊息都是平面式。請注意,不包括兩人之間的即時訊息。 |
SpaceBatchUpdatedEventData
聊天室多次更新的事件酬載。
事件類型:google.workspace.chat.space.v1.batchUpdated
欄位 | |
---|---|
spaces[] |
已更新聊天室的清單。 |
SpaceEvent
代表 Google Chat 聊天室中變更或活動的事件。詳情請參閱「使用 Google Chat 中的活動」。
欄位 | |
---|---|
name |
聊天室事件的資源名稱。 格式: |
event_time |
事件發生的時間。 |
event_type |
聊天室事件類型。每個事件類型都有批次版本,代表在短時間內發生的多個事件類型例項。如為 messages 支援的事件類型:
會員方案支援的事件類型:
支援的回應事件類型:
支援的空格事件類型:
|
聯集欄位
|
|
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 |
多個已刪除回應的事件酬載。 事件類型: |
SpaceReadState
使用者在聊天室中的讀取狀態,用於識別已讀和未讀訊息。
欄位 | |
---|---|
name |
聊天室讀取狀態的資源名稱。 格式: |
last_read_time |
選用設定。使用者聊天室讀取狀態更新的時間。通常會對應到上次讀取訊息的時間戳記,或是使用者指定的時間戳記,以標記聊天室中最後讀取的位置。 |
SpaceUpdatedEventData
已更新空間的事件酬載。
事件類型:google.workspace.chat.space.v1.updated
欄位 | |
---|---|
space |
已更新的聊天室。 |
討論串
Google Chat 聊天室中的討論串。如需使用說明,請參閱「發起或回覆訊息串」。
如果您在建立訊息時指定討論串,可以設定 messageReplyOption
欄位,指定在沒有相符的討論串時,系統將如何處理。
欄位 | |
---|---|
name |
執行緒的資源名稱。 範例: |
thread_key |
選用設定。建立或更新執行緒的輸入內容。否則只會輸出。執行緒 ID。最多可支援 4000 個半形字元。 這個 ID 專屬於設定該 ID 的 Chat 應用程式。舉例來說,如果多個 Chat 擴充應用程式使用相同的執行緒金鑰建立訊息,系統會將訊息張貼在不同討論串中。如要在使用者或其他 Chat 應用程式建立的討論串中回覆,請改為指定討論串 |
ThreadReadState
使用者在執行緒中的讀取狀態,用來識別已讀和未讀訊息。
欄位 | |
---|---|
name |
執行緒讀取狀態的資源名稱。 格式: |
last_read_time |
更新使用者執行緒讀取狀態的時間。通常這個時間會對應到討論串中最後讀取訊息的時間戳記。 |
UpdateMembershipRequest
要求更新會員資格的訊息。
欄位 | |
---|---|
membership |
必要欄位。要更新的會員方案。系統只會更新 |
update_mask |
必要欄位。要更新的欄位路徑。請以半形逗號分隔多個值,或使用 目前支援的欄位路徑:
|
use_admin_access |
true 時,此方法會使用使用者的 Google Workspace 管理員權限執行。通話使用者必須是具備管理即時通訊和聊天室對話權限的 Google Workspace 管理員。 需要 |
UpdateMessageRequest
要求更新訊息。
欄位 | |
---|---|
message |
必要欄位。已更新欄位的訊息。 |
update_mask |
必要欄位。要更新的欄位路徑。請以半形逗號分隔多個值,或使用 目前支援的欄位路徑: |
allow_missing |
選用設定。如果 |
UpdateSpaceReadStateRequest
UpdateSpaceReadState API 的要求訊息。
欄位 | |
---|---|
space_read_state |
必要欄位。要更新的聊天室讀取狀態和欄位。 僅支援更新發出呼叫的使用者的讀取狀態。 如要參照發出呼叫的使用者,請設定下列其中一項:
格式:users/{user}/spaces/{space}/spaceReadState |
update_mask |
必要欄位。要更新的欄位路徑。目前支援的欄位路徑:
如果 如要將聊天室標示為已讀,請將 |
UpdateSpaceRequest
更新單一聊天室的要求。
欄位 | |
---|---|
space |
必要欄位。要更新欄位的聊天室。必須以 |
update_mask |
必要欄位。更新後的欄位路徑 (如有多個路徑,以半形逗號分隔)。 你可以更新聊天室的下列欄位:
|
use_admin_access |
true 時,此方法會使用使用者的 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 |
|