「客戶使用情形」報告匯總了整個網域中所有使用者的 Google Workspace 服務使用情形資訊。使用者使用情形報告會傳回您帳戶的 Google Workspace 服務使用情形資訊。 這些使用資訊是按應用程式類型整理,由該應用程式專屬的參數組成。每份報表的預設時間範圍和最長的時間範圍為最近 450 天。
您只能依照《客戶協議》的規定使用這類用量報表。而且這些報告亦適用於 Google Workspace 和 Google Workspace。
擷取客戶使用情形報表
如要擷取帳戶活動的報表,請使用下列 GET
HTTP 要求,並加入授權說明文件中所述的授權權杖。為了方便閱讀,以下範例採用換行格式:
GET https://admin.googleapis.com/admin/reports/v1/usage/dates/yyyy-mm-dd date ?parameters=app name: usage parameter,... &customerId=the customer's ID &maxResults=number of events listed on each page of the report
dates
值代表使用情況發生的日期,且時間戳記採用 ISO 8601 格式 (yyyy-mm-dd)。建議您使用帳戶的時區。如要進一步瞭解要求的查詢字串和回應屬性,請參閱 API 參考資料和客戶使用情形報表參數參考資料。
以下範例會取得一份報表,內容包含過去 30 天內所有成功登入您帳戶的使用者總數,以及授權應用程式清單,其中包含每個應用程式的使用者授權數量 (2013 年 3 月 3 日開始)。maxResults
查詢字串顯示,這份報表會在每個報表頁面傳回兩個事件:
GET https://admin.googleapis.com/admin/reports/v1/usage/dates/2013-03-03 ?parameters=accounts:num_30day_logins%2Caccounts:authorized_apps&maxResults=2
客戶使用情形報表的 JSON 回應
{ "kind": "reports#usageReports", "warnings": [ { "code": warning machine-readable code, "message": warning human-readable message, "data": [ { "key": key for key-value pair that gives detailed warning information, "value": value for key-value pair giving detailed warning information } ] } ], "nextPageToken": "N:NNN:NNN:N:C03az79cb", "usageReports": [ { "kind": "usageReport", "date": "2013-03-03", "entity": { "type": "CUSTOMER", "customerId": "C03az79cb" }, "parameters": [ { "name": "accounts:num_1day_logins", "intValue": "1" }, { "name": "accounts:num_30day_logins", "intValue": "1" }, { "name": "accounts:num_7day_logins", "intValue": "1" }, { "name": "accounts:num_disabled_accounts", "intValue": "5" }, { "name": "accounts:authorized_apps", "msgValue": [ { "client_id": "1234.apps.googleusercontent.com", "client_name": "www.example.com", "num_users": 2 }, { "client_id": "4567.apps.googleusercontent.com", "client_name": "Example", "num_users": 1 }, ... ] } ] } ] }