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 (所有資訊)，也可以是 userKey (使用者的專屬 Google Workspace 個人資料 ID 或主要電子郵件地址)。不得為已刪除的使用者。如要為已刪除的使用者執行這項操作，請在 Directory API 中呼叫 users.list，並使用 showDeleted=true，然後將傳回的 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」表格，然後點選附錄中所需應用程式的「Activity Events」頁面。

在下列雲端硬碟活動範例中，傳回的清單包含所有 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)。
  • <—'less than'。必須經過網址編碼 (%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
(deprecated)

string

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

以半形逗號分隔的群組 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 Groups 活動報表會傳回各種企業群組活動事件的相關資訊。
jamboard Jamboard 活動報表會傳回各種 Jamboard 活動事件的相關資訊。
login

登入應用程式的活動報表會傳回不同類型登入活動事件的帳戶資訊。
meet Meet 稽核活動報告會傳回不同類型的 Meet 稽核活動事件相關資訊。
mobile 裝置稽核活動報表會傳回不同類型的裝置稽核活動事件相關資訊。
rules

規則活動報表會傳回不同類型的規則活動事件相關資訊。
saml

SAML 活動報表會傳回不同類型的 SAML 活動事件相關資訊。
token

權杖應用程式的活動報表會傳回不同類型權杖活動事件的帳戶資訊。
user_accounts

使用者帳戶應用程式的活動報告會傳回不同類型使用者帳戶活動事件的帳戶資訊。
context_aware_access

情境感知存取權活動報表會傳回使用者因 情境感知存取權規則而遭拒存取事件的相關資訊。
chrome

Chrome 活動報告會回報 Chrome 瀏覽器和 ChromeOS 事件的相關資訊。
data_studio 數據分析活動報表會傳回各種數據分析活動事件的相關資訊。
keep Keep 應用程式的活動報告會傳回各種 Google Keep 活動事件的相關資訊。Keep 活動報表僅適用於 Google Workspace Business 和 Enterprise 客戶。
classroom Classroom 活動報表會傳回不同類型的 Classroom 活動事件相關資訊。