擷取特定客戶的帳戶和應用程式 (例如管理控制台應用程式或 Google 雲端硬碟應用程式) 的活動清單。如需詳細資訊,請參閱管理員和 Google 雲端硬碟活動報告指南。如要進一步瞭解活動報表的參數,請參閱活動參數參考指南。
HTTP 要求
GET https://admin.googleapis.com/admin/reports/v1/activity/users/{userKey or all}/applications/{applicationName}
這個網址使用 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」 |
要求主體
要求主體必須為空白。
回應主體
活動集合的 JSON 範本。
如果成功,回應主體即會包含具有以下結構的資料:
JSON 表示法 |
---|
{
"kind": string,
"etag": string,
"items": [
{
object ( |
欄位 | |
---|---|
kind |
API 資源的類型。如果是活動報表,這個值為 |
etag |
資源的 ETag。 |
items[] |
回應中的每筆活動記錄。 |
nextPageToken |
用來擷取後續報表後續頁面的權杖, |
授權範圍
需要下列 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 和 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 客戶。 |
vault |
保管箱活動報告會傳回各種保管箱活動事件的資訊。 |
活動記錄
活動資源的 JSON 範本。
JSON 表示法 |
---|
{ "kind": string, "etag": string, "ownerDomain": string, "ipAddress": string, "events": [ { "type": string, "name": string, "parameters": [ { "messageValue": { "parameter": [ { object ( |
欄位 | |
---|---|
kind |
API 資源的類型。如果是活動報表,這個值為 |
etag |
項目的 ETag。 |
ownerDomain |
這是指受報告事件影響的網域。例如管理控制台的網域或雲端硬碟應用程式的文件擁有者。 |
ipAddress |
執行動作的使用者 IP 位址。這是使用者的 Google Workspace 登入網際網路通訊協定 (IP) 位址,這個位址不一定反映使用者的實際位置。舉例來說,IP 位址可能是使用者的 Proxy 伺服器位址,或是虛擬私人網路 (VPN) 位址。API 支援 IPv4 和 IPv6。 |
events[] |
報表中的活動事件。 |
events[].type |
事件類型。在 |
events[].name |
事件的名稱。這是 API 回報的活動具體名稱。每個
如要進一步瞭解 eventName 屬性,請參閱 applicationName 中上述各種應用程式的事件名稱清單。
|
events[].parameters[] |
各種應用程式的參數值配對。如要進一步瞭解 |
events[].parameters[].messageValue |
與此參數相關聯的巢狀參數值組合。參數的複雜值類型會以參數值清單的形式傳回。舉例來說,地址參數的值可能為 |
events[].parameters[].messageValue.parameter[] |
參數值 |
events[].parameters[].name |
參數的名稱。 |
events[].parameters[].value |
參數的字串值。 |
events[].parameters[].multiValue[] |
參數的字串值。 |
events[].parameters[].intValue |
參數的整數值。 |
events[].parameters[].multiIntValue[] |
參數的整數值。 |
events[].parameters[].boolValue |
參數的布林值。 |
events[].parameters[].multiMessageValue[] |
activity.list 的 |
events[].parameters[].multiMessageValue[].parameter[] |
參數值 |
id |
每筆活動記錄的專屬 ID。 |
id.time |
活動的發生時間。以 UNIX Epoch 紀元時間計算,以秒為單位。 |
id.uniqueQualifier |
如果多個事件具有相同時間,則使用不重複限定詞。 |
id.applicationName |
事件所屬的應用程式名稱。如要查看可能的值,請參閱上方 |
id.customerId |
Google Workspace 帳戶的專屬 ID。 |
actor |
執行動作的使用者。 |
actor.profileId |
行為人的專屬 Google Workspace 個人資料 ID。如果執行者不是 Google Workspace 使用者,或者是數字 105250506097979753968 (做為預留位置 ID),就可能缺少這個值。 |
actor.email |
執行者的主要電子郵件地址。如果發動者沒有相關聯的電子郵件地址,則可能不會顯示。 |
actor.callerType |
演員的類型。 |
actor.key |
只有在 |