開始接收帳戶活動通知。詳情請參閱接收推播通知。
HTTP 要求
POST https://admin.googleapis.com/admin/reports/v1/activity/users/{userKey or all}/applications/{applicationName}/watch
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
userKey or all |
代表要篩選資料的設定檔 ID 或使用者電子郵件。可以是所有資訊的 |
applicationName |
要擷取事件的應用程式名稱。 |
查詢參數
參數 | |
---|---|
actorIpAddress |
執行事件的主機的網際網路通訊協定 (IP) 位址。還有另一個方法,就是根據系統回報活動的使用者 IP 位址篩選報表摘要。這個 IP 位址不一定會反映使用者的實際位置。舉例來說,IP 位址可能是使用者的 Proxy 伺服器位址,或是虛擬私人網路 (VPN) 位址。這個參數支援 IPv4 和 IPv6 位址版本。 |
customerId |
要擷取資料的客戶專屬 ID。 |
endTime |
設定報表顯示時間範圍的結束時間。日期必須採用 RFC 3339 格式,例如 2010-10-28T10:26:35.000Z。預設值為 API 要求的約略時間。API 報表有三個基本概念:
endTime ,報表會傳回 startTime 到目前時間為止的所有活動;如果 startTime 超過 180 天以前,報表會傳回最近 180 天的所有活動。
|
eventName |
API 查詢的事件名稱。每個 |
filters |
這些事件參數與特定 在以下雲端硬碟活動範例中,傳回的清單會包含所有
注意:API 不接受同一個參數的多個值。如果在 API 要求中提供了多次參數,API 只會接受該參數的最後一個值。此外,如果在 API 要求中提供無效的參數,API 會忽略該參數,並傳回與其餘有效參數對應的回應。如果沒有請求參數,則會傳回所有參數。 |
maxResults |
這項設定會決定每個回應頁面顯示的活動記錄數量。舉例來說,如果要求設定 |
orgUnitID |
要製作報表的機構單位 ID。系統只會針對指定機構單位中的使用者顯示活動記錄。 |
pageToken |
要指定下一頁的符記。有多個網頁的報表在回應中有一個 |
startTime |
設定報表顯示時間範圍的開始時間。日期必須採用 RFC 3339 格式,例如 2010-10-28T10:26:35.000Z。報表會傳回 |
groupIdFilter |
指定要用於篩選使用者活動的群組 ID (經過模糊處理),也就是說,回應只會包含屬於此處所列至少一個群組 ID 的使用者活動。格式:「id:abc123,id:xyz456」 |
要求主體
要求主體包含 SubscriptionChannel
的例項。
回應主體
用來監控資源變更的通知管道。
如果成功,回應主體即會包含具有以下結構的資料:
JSON 表示法 |
---|
{ "id": string, "token": string, "expiration": string, "type": string, "address": string, "payload": boolean, "params": { string: string, ... }, "resourceId": string, "resourceUri": string, "kind": string } |
欄位 | |
---|---|
id |
UUID 或類似的不重複字串,用於識別這個頻道。 |
token |
透過此管道傳送每則通知,傳送至目標地址的任意字串。選用。 |
expiration |
通知管道到期的日期和時間,以 Unix 時間戳記 (以毫秒為單位) 表示。選用。 |
type |
此管道使用的放送機制類型。政策的值應設為 |
address |
接收這個頻道通知的地址。 |
payload |
表示是否想要酬載的布林值。酬載是在 HTTP POST、PUT 或 PATCH 訊息內文中傳送的資料,內含要求的重要資訊。選用。 |
params |
控制放送管道行為的其他參數。選用。 這個物件中包含 |
resourceId |
不透明 ID,用於識別這個頻道的觀看資源。在不同 API 版本之間穩定。 |
resourceUri |
已觀看資源的版本專屬 ID。 |
kind |
將其視為用於監控資源變更的通知管道,即「 |
授權範圍
需要下列 OAuth 範圍:
https://www.googleapis.com/auth/admin.reports.audit.readonly
詳情請參閱授權指南。
ApplicationName
要擷取事件的應用程式名稱。
列舉 | |
---|---|
access_transparency |
Google Workspace 資料存取透明化控管機制活動報告會傳回各種資料存取透明化控管機制活動事件的相關資訊。 |
admin |
管理控制台應用程式的活動報告會傳回各類管理員活動事件的帳戶資訊。 |
calendar |
Google 日曆應用程式的活動報告會傳回各種日曆活動的相關資訊。 |
chat |
Chat 活動報告會傳回各種即時通訊活動事件的資訊。 |
drive |
Google 雲端硬碟應用程式的活動報告會傳回各種 Google 雲端硬碟活動事件的相關資訊。雲端硬碟活動報告僅適用於 Google Workspace Business 和 Google Workspace Enterprise 客戶。 |
gcp |
Google Cloud Platform 應用程式的活動報表會傳回各種 GCP 活動事件的相關資訊。 |
gplus |
Google+ 應用程式的活動報告會傳回各種 Google+ 活動的相關資訊。 |
groups |
Google 網路論壇應用程式的活動報告會傳回各種網路論壇活動事件的相關資訊。 |
groups_enterprise |
企業群組活動報告會傳回各種企業群組活動事件的相關資訊。 |
jamboard |
Jamboard 活動報告會傳回各種 Jamboard 活動事件的相關資訊。 |
login |
登入應用程式的活動報告會傳回不同類型的登入活動事件的帳戶資訊。 |
meet |
Meet 稽核活動報告會傳回不同類型的 Meet 稽核活動事件相關資訊。 |
mobile |
裝置稽核活動報告會傳回各種裝置稽核活動事件的相關資訊。 |
rules |
規則活動報表會傳回各種規則活動事件類型的相關資訊。 |
saml |
SAML 活動報告會傳回各種 SAML 活動事件類型的相關資訊。 |
token |
權杖應用程式的活動報告會傳回不同類型的權杖活動事件的帳戶資訊。 |
user_accounts |
「使用者帳戶」應用程式的活動報告會傳回各種使用者帳戶活動事件的帳戶資訊。 |
context_aware_access |
情境感知存取權活動報表可根據 情境感知存取權規則,傳回使用者存取遭拒事件的相關資訊。 |
chrome |
Chrome 活動報告會傳回 Chrome 瀏覽器和 Chrome 作業系統事件的相關資訊。 |
data_studio |
數據分析活動報表會傳回各種數據分析活動事件的相關資訊。 |
keep |
Keep 應用程式的活動報告會傳回各種 Google Keep 活動事件的相關資訊。Keep 活動報告僅適用於 Google Workspace Business 和 Enterprise 客戶。 |