Method: activities.watch

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

HTTP 要求

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

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

路徑參數

參數
userKey or all

string

代表要篩選資料的設定檔 ID 或使用者電子郵件。可以是所有資訊的 all，也可以為使用者的專屬 Google Workspace 個人資料 ID 或主要電子郵件地址設為 userKey。不可為已刪除的使用者。如果是已刪除的使用者，請使用 showDeleted=true 呼叫 Directory API 中的 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: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 活動報告會傳回各種即時通訊活動事件的資訊。
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 客戶。