資源:Subscription
訂閱項目,用於接收有關 Google Workspace 資源的事件。如要進一步瞭解訂閱項目,請參閱 Google Workspace Events API 總覽。
JSON 表示法 |
---|
{ "name": string, "uid": string, "targetResource": string, "eventTypes": [ string ], "payloadOptions": { object ( |
欄位 | |
---|---|
name |
ID。訂閱項目的資源名稱。 格式: |
uid |
僅供輸出。系統指派的訂閱專屬 ID。 |
targetResource |
必要欄位。不可變動。事件監控的 Google Workspace 資源,格式為完整資源名稱。如要瞭解目標資源,以及其支援的事件,請參閱「支援的 Google Workspace 事件」。 使用者只能授權您的應用程式為特定目標資源建立一個訂閱項目。如果應用程式嘗試使用相同的使用者憑證建立其他訂閱項目,要求會傳回 |
eventTypes[] |
必要欄位。未排序的清單。建立訂閱項目的輸入內容。否則,僅供輸出。一或多種可接收的目標資源事件類型。根據 CloudEvents 規格格式化。 支援的事件類型取決於您訂閱項目的目標資源。詳情請參閱「支援的 Google Workspace 活動」。 根據預設,您也會收到有關訂閱項目生命週期的事件。您不需要為這個欄位指定生命週期事件。 如果您指定的事件類型不存在於目標資源,要求會傳回 HTTP |
payloadOptions |
選用設定。關於要在事件酬載中包含哪些資料的選項。僅支援 Google Chat 事件。 |
notificationEndpoint |
必要欄位。不可變動。訂閱項目提交事件的端點,例如 Pub/Sub 主題。 |
state |
僅供輸出。訂閱狀態。判斷訂閱項目是否可接收事件,並將事件傳送至通知端點。 |
suspensionReason |
僅供輸出。將訂閱停權的錯誤。 如要重新啟用訂閱項目,請解決錯誤並呼叫 |
authority |
僅供輸出。授權建立訂閱項目的使用者。 格式: 對於 Google Workspace 使用者, |
createTime |
僅供輸出。訂閱項目的建立時間。 |
updateTime |
僅供輸出。上次更新訂閱項目的時間。 |
reconciling |
僅供輸出。如果是 |
etag |
選用設定。伺服器會根據其他欄位的值計算此總和檢查碼,並可能在更新要求中傳送,以確保用戶端在繼續操作前擁有最新的值。 |
聯集欄位 到期時間上限取決於訂閱項目是否在事件酬載中包含資源資料 (透過
訂閱項目到期後會自動刪除。您會在訂閱項目到期前 12 小時和 1 小時,收到 如要避免訂閱項目到期,您可以使用 |
|
expireTime |
預設值不為空白。訂閱項目到期時的時間戳記 (採用世界標準時間)。不論輸入內容為何,這項資訊一律會顯示在輸出內容中。 |
ttl |
僅限輸入。訂閱項目的存留時間 (TTL) 或時間長度。如果未指定或設為 |
PayloadOptions
關於要在事件酬載中包含哪些資料的選項。僅支援 Google Chat 事件。
JSON 表示法 |
---|
{ "includeResource": boolean, "fieldMask": string } |
欄位 | |
---|---|
includeResource |
選用設定。事件酬載是否包含已變更資源的相關資料。舉例來說,如果事件是建立 Google Chat 訊息,則酬載是否包含 |
fieldMask |
選用設定。如果 如果您指定的欄位不存在於資源中,系統會忽略該欄位。 |
NotificationEndpoint
訂閱項目傳送事件的端點。
JSON 表示法 |
---|
{ // Union field |
欄位 | |
---|---|
聯集欄位
|
|
pubsubTopic |
不可變動。接收訂閱事件的 Cloud Pub/Sub 主題。 格式: 您必須在建立此訂閱項目的 Google Cloud 專案中建立主題。 主題收到事件時,系統會將事件編碼為 Cloud Pub/Sub 訊息。詳情請參閱 CloudEvents 的 Google Cloud Pub/Sub 通訊協定繫結。 |
州
訂閱項目的可能狀態。
列舉 | |
---|---|
STATE_UNSPECIFIED |
預設值。此值未使用。 |
ACTIVE |
訂閱項目已啟用,可接收事件並將事件傳送至通知端點。 |
SUSPENDED |
訂閱項目因錯誤而無法接收事件。如要找出錯誤,請參閱 欄位。 |
DELETED |
系統會刪除訂閱項目。 |
ErrorType
訂閱項目可能發生的錯誤。
列舉 | |
---|---|
ERROR_TYPE_UNSPECIFIED |
預設值。此值未使用。 |
USER_SCOPE_REVOKED |
授權使用者已撤銷一或多個 OAuth 範圍的授予項目。如要進一步瞭解 Google Workspace 授權,請參閱「設定 OAuth 同意畫面」。 |
RESOURCE_DELETED |
訂閱項目的目標資源已不存在。 |
USER_AUTHORIZATION_FAILURE |
授權建立訂閱項目的使用者,不再擁有訂閱項目的目標資源存取權。 |
ENDPOINT_PERMISSION_DENIED |
Google Workspace 應用程式無法將事件傳送至訂閱項目的通知端點。 |
ENDPOINT_NOT_FOUND |
訂閱項目的通知端點不存在,或是無法在您建立訂閱項目的 Google Cloud 專案中找到端點。 |
ENDPOINT_RESOURCE_EXHAUSTED |
配額不足或達到頻率限制,因此訂閱項目的通知端點無法接收事件。 |
OTHER |
發生不明確的錯誤。 |
方法 |
|
---|---|
|
建立 Google Workspace 訂閱方案。 |
|
刪除 Google Workspace 訂閱方案。 |
|
取得 Google Workspace 訂閱方案的詳細資料。 |
|
列出 Google Workspace 訂閱方案。 |
|
更新或續訂 Google Workspace 訂閱。 |
|
重新啟用遭到停權的 Google Workspace 訂閱方案。 |