Method: activities.watch

開始接收帳戶活動通知。詳情請參閱「接收推播通知」。

HTTP 要求

POST https://admin.googleapis.com/admin/reports/v1/activity/users/{userKey or all}/applications/{applicationName}/watch

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
userKey

string

代表應篩選資料的個人資料 ID 或使用者電子郵件。可以是 all (所有資訊)，或是 userKey (使用者專屬的 Google Workspace 個人資料 ID 或主要電子郵件地址)。不得為已刪除的使用者。針對已刪除的使用者，請在 Directory API 中透過 showDeleted=true 呼叫 users.list，然後使用傳回的 ID 做為 userKey。
applicationName

enum (ApplicationName)

要擷取事件的應用程式名稱。

查詢參數

參數
actorIpAddress

string

事件發生主機的網際網路通訊協定位址 (IP)。這是另一種篩選報表摘要的方法，可根據活動記錄使用者的 IP 位址篩選報表摘要。這個 IP 位址可能會反映使用者的實際位置，也可能不會。舉例來說，IP 位址可能是使用者 Proxy 伺服器的位址，也可能是虛擬私人網路 (VPN) 位址。這個參數支援 IPv4 和 IPv6 位址版本。
customerId

string

要擷取資料的客戶專屬 ID。
endTime

string

設定報表中顯示的時間範圍結束時間。日期採用 RFC 3339 格式，例如 2010-10-28T10:26:35.000Z。預設值是 API 要求的預估時間。API 報表有三個基本時間概念：

  • API 要求報表的日期：API 建立及擷取報表的日期。
  • 報表的開始時間：報表中顯示的時間範圍起始時間。startTime 必須在 endTime (如果有指定) 和要求的目前時間之前，否則 API 會傳回錯誤。
  • 報表的結束時間：報表中顯示的時間範圍結束時間。舉例來說，報表中列出的事件時間範圍可以從 4 月開始，到 5 月結束，而報表本身則可在 8 月要求。
如未指定 endTime，報表會傳回 startTime 到目前時間之前的所有活動；如果 startTime 超過過去 180 天，則報表會傳回最近 180 天的所有活動。
eventName

string

API 要查詢的事件名稱。每項 eventName 都與特定 Google Workspace 服務或功能相關，這類 API 會依照事件類型分類。例如管理控制台應用程式報表中的 Google 日曆事件。日曆設定 type 結構包含 API 回報的所有日曆 eventName 活動。當管理員變更日曆設定時，API 會在「日曆設定」type 和 eventName 參數中回報這項活動。如要進一步瞭解 eventName 查詢字串和參數，請參閱 applicationName 中各個應用程式的事件名稱清單。
filters

string

filters 查詢字串是以半形逗號分隔的清單，由關係運算子操控的事件參數組成。事件參數的格式為 {parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...

這些事件參數與特定 eventName 相關聯。如果要求的參數不屬於 eventName，系統會傳回空白報表。如要進一步瞭解各個應用程式可用的 eventName 欄位及其相關參數，請前往「ApplicationName」表格，然後點選附錄中所需應用程式的「活動事件」頁面。

在以下雲端硬碟活動範例中，傳回的清單包含所有 edit 事件，其中 doc_id 參數值符合關係運算子定義的條件。在第一個範例中，要求會傳回所有編輯過的文件，其 doc_id 值等於 12345。在第二個範例中，報表會傳回任何已編輯的文件，其中 doc_id 值不等於 98765。<> 運算子會在要求的查詢字串 (%3C%3E) 中進行網址編碼：

GET...&eventName=edit&filters=doc_id==12345
GET...&eventName=edit&filters=doc_id%3C%3E98765

filters 查詢支援下列關聯運算子：

  • ==：等於。
  • <>—不等於」。必須使用網址編碼 (%3C%3E)。
  • <：代表「小於」。必須採用網址編碼 (%3C)。
  • <=：小於或等於。必須採用網址編碼 (%3C=)。
  • >：「大於」。必須使用網址編碼 (%3E)。
  • >=：大於或等於。必須使用網址編碼 (%3E=)。

注意：API 不接受同一個參數的多個值。如果 API 要求中提供的參數不只一個，API 只會接受該參數的最後一個值。此外，如果 API 要求中提供無效參數，API 會忽略該參數，並傳回與其餘有效參數相對應的回應。如果未要求任何參數，系統會傳回所有參數。
maxResults

integer

決定每個回應頁面顯示的活動記錄數量。舉例來說，如果要求設定 maxResults=1，且報表有兩項活動，則報表會有兩個頁面。回應的 nextPageToken 屬性含有前往第二頁的符記。在要求中，maxResults 查詢字串為選用項目。預設值為 1000。
orgUnitID
(deprecated)

string

Deprecated。這個欄位已淘汰，不再受到支援。

要回報的機構單位 ID。系統只會向所屬機構單位的使用者顯示活動記錄。
pageToken

string

用來指定下一頁的符記。如果報表包含多個網頁，在回應中會包含 nextPageToken 屬性。在後續要求中，請在 pageToken 查詢字串中輸入 nextPageToken 值。
startTime

string

設定報表時間範圍的開始時間。日期須採用 RFC 3339 格式，例如 2010-10-28T10:26:35.000Z。報表會傳回 startTime 到 endTime 的所有活動。startTime 必須在 endTime (如果有指定) 和要求的目前時間之前，否則 API 會傳回錯誤。
groupIdFilter

string

以半形逗號分隔的群組 ID (經過模糊處理)，系統會根據這些群組 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

string

用來識別此頻道的 UUID 或類似專屬字串。
token

string

系統會將任意字串傳送至目標地址，並透過這個管道傳送每則通知。選填。
expiration

string (int64 format)

通知管道到期日期和時間，以 Unix 時間戳記 (以毫秒為單位) 表示。選填。
type

string

這個管道使用的放送機制類型。值應設為 "web_hook"。
address

string

這個管道會將通知傳送至這個位址。
payload

boolean

布林值，用於指出是否需要酬載。酬載是指在 HTTP POST、PUT 或 PATCH 訊息主體中傳送的資料，其中包含要求的重要資訊。選填。
params

map (key: string, value: string)

控制放送管道行為的其他參數。選填。

這個物件中包含 "key": value 組合的清單，範例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
resourceId

string

這個不易解讀的 ID 可識別這個管道中正在監控的資源。適用於不同 API 版本。
resourceUri

string

受監控資源的版本專屬 ID。
kind

string

識別此通知管道，用於監控資源變更，也就是「api#channel」。

授權範圍

需要下列 OAuth 範圍：

  • https://www.googleapis.com/auth/admin.reports.audit.readonly

詳情請參閱授權指南。

ApplicationName

要擷取事件的應用程式名稱。

列舉
access_transparency

Google Workspace 資料存取透明化活動報表會傳回不同類型的資料存取透明化活動事件相關資訊。
admin

管理控制台應用程式的活動報表會傳回不同類型的管理員活動事件帳戶資訊。
calendar

Google 日曆應用程式的活動報表會傳回各種日曆活動事件的相關資訊。
chat Chat 活動報告會傳回各種 Chat 活動事件的相關資訊。
drive

Google 雲端硬碟應用程式的活動報告會傳回各種 Google 雲端硬碟活動事件的相關資訊。雲端硬碟活動報告僅適用於 Google Workspace Business 和 Google Workspace Enterprise 客戶。
gcp Google Cloud Platform 應用程式的活動報表會傳回各種 GCP 活動事件的相關資訊。
gplus Google+ 應用程式的活動報告會傳回各種 Google+ 活動事件的相關資訊。
groups

Google 網路論壇應用程式的活動報告會傳回各種網路論壇活動事件的相關資訊。
groups_enterprise

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 客戶。