Reports API:雲端硬碟活動報告

當使用者在 Google Workspace 中透過 Google 雲端硬碟管理、修改及共用檔案時,雲端硬碟活動報表會提供相關活動資訊。舉例來說,您可以使用雲端硬碟活動報表,取得特定使用者在指定日期範圍內建立的所有新雲端硬碟文件清單。您可以利用這項資訊,進一步瞭解如何改善內容管理和可能發生的資料外洩問題。如要取得報表,您可以使用基本報表端點要求,並搭配報表專屬參數,例如使用者電子郵件地址或特定類型的 Google 雲端硬碟變更。報表最多可納入過去 180 天的資料。

只有已指派授權的帳戶,才能將 Google 雲端硬碟活動報告用於合法用途。

如需要求的查詢字串和回應屬性的相關資訊,請參閱 API 參考資料。如要瞭解與 Google 雲端硬碟相關的特定事件,請參閱「雲端硬碟事件名稱」。

擷取網域的 Google 雲端硬碟事件

您可以使用雲端硬碟活動報告列出雲端硬碟文件的相關資訊。舉例來說,您可以要求取得報表,列出帳戶最近 25 筆 Drive 事件,最多可涵蓋 180 天。如要取得這份報表,請按照授權指南的說明取得授權權杖,然後使用下列 HTTP GET 要求:

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/drive?maxResults=25

您可以查看此 API 呼叫的回應範例

以下範例會擷取過去 180 天 (最長期間) 內所有 Google 雲端硬碟事件的報表。

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/drive

依使用者擷取 Google 雲端硬碟事件

如要擷取特定使用者的 Google 雲端硬碟活動報表,請使用 HTTP GET 要求,並附上授權指南中所述的授權權杖。userKey 欄位是報表中使用者的電子郵件地址,all 則是所有使用者的電子郵件地址。

以下範例會擷取報表,列出指定使用者所做的所有變更。如需 API 回應範例,請參閱JSON 回應範例

GET https://admin.googleapis.com/admin/reports/v1/activity/users/kim@example.com
/applications/drive

擷取共用雲端硬碟的 Google 雲端硬碟事件

您可以使用 HTTP GET 要求,搭配授權指南中所述的授權權杖,擷取特定共用雲端硬碟的 Google 雲端硬碟活動報表。在 userKey 欄位中指定要為其執行報表的使用者電子郵件地址,或是指定 all 為所有使用者執行報表。

以下範例會擷取特定共用雲端硬碟的所有變更記錄。如需 API 回應範例,請參閱JSON 回應範例

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/drive?filters=shared_drive_id==<id of shared drive>

如要擷取共用雲端硬碟的事件,請使用 doc_type 進行篩選。以下範例會擷取影響所有共用雲端硬碟的事件:

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/drive?filters=doc_type=shared_drive

如要擷取會員資格變更事件,請指定 shared_drive_membership_change 事件。以下範例會擷取所有新增至共用雲端硬碟的成員:

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/drive?evetName=shared_drive_membership_change&
filters=membership_change_type==add_to_shared_drive

依事件類型擷取 Google 雲端硬碟事件

如要擷取特定事件類型 (例如建立或編輯文件) 的所有例項報表,請使用 HTTP GET 要求,並附上「授權指南」中所述的授權權杖。userKey 欄位是報表中使用者的電子郵件地址,all 則是所有使用者的電子郵件地址。

以下範例會擷取所有帳戶文件建立活動的報表。如需 API 回應範例,請參閱JSON 回應範例

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/drive?eventName=create

範例 JSON 回應

向 API 提出 HTTP GET 要求時,成功的回應會傳回 HTTP 200 狀態碼。除了狀態碼外,回應還會傳回 Drive 的報表。這些報表也能在管理控制台中查看。詳情請參閱 Google Workspace 管理員說明中心。如需 eventName 相關資訊,請參閱 雲端硬碟事件名稱參考資料。如要進一步瞭解要求的查詢字串和回應屬性,請參閱 API 參考資料

{
 "kind": "reports#auditActivities",
 "nextPageToken": "next page's token",
 "items": [
  {
   "kind": "audit#activity",
   "id": {
    "time": "2014-03-17T15:39:18.460Z",
    "uniqQualifier": "report's unique ID",
    "applicationName": "drive",
    "customerId": "ABC123xyz"
   },
   "actor": {
   "callerType": "USER",
   "email": "[email protected]",
   "profileId": "user's unique Google Workspace profile ID",
   "key": "consumer key of requestor in an OAuth 2LO request"
   },
   "ownerDomain": "domain of the source owner",
   "ipAddress": "user's IP address",
   "events": [
    {
     "type": "access",
     "name": "edit",
     "parameters": [
      {
        "name": "primary_event",
        "boolValue": true
      },
      {
        "name": "owner_is_shared_drive",
        "boolValue": false
      },      {
        "name": "doc_id",
        "value": "1DWuYM3ot_sAyEQqOz0xWJ9bVMSYzOmRNeBqbgtSwuK8"
      },
      {
        "name": "doc_title",
        "value": "Meeting notes"
      },
      {
        "name": "doc_type",
        "value": "document"
      },
      {
        "name": "owner",
        "value": "[email protected]"
      }
      ]
     }
    ]
   },
  ]
 }