API Báo cáo: Báo cáo mức sử dụng của khách hàng

Báo cáo về mức sử dụng của khách hàng tổng hợp thông tin về mức sử dụng dịch vụ của Google Workspace (đối với tất cả người dùng) trên toàn bộ miền. Báo cáo mức sử dụng của người dùng trả về thông tin về mức sử dụng dịch vụ của Google Workspace trên tài khoản của bạn. Thông tin về mức sử dụng này được sắp xếp theo loại ứng dụng và bao gồm các tham số dành riêng cho ứng dụng đó. Khoảng thời gian mặc định và tối đa cho mỗi báo cáo là 450 ngày qua.

Bạn chỉ được sử dụng những báo cáo sử dụng này cho các mục đích hợp pháp theo Thoả thuận khách hàng của bạn. Ngoài ra, các báo cáo này cũng áp dụng cho Google Workspace và Education.

Truy xuất báo cáo mức sử dụng của khách hàng

Để truy xuất báo cáo về hoạt động tài khoản của bạn, hãy sử dụng yêu cầu HTTP GET sau và bao gồm mã thông báo uỷ quyền được mô tả trong tài liệu uỷ quyền. Để dễ đọc, ví dụ sau được định dạng bằng phương thức trả về dòng:

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

Giá trị dates là ngày sử dụng và dấu thời gian ở định dạng ISO 8601, yyyy-mm-dd. Bạn nên sử dụng múi giờ trong tài khoản của mình cho việc này. Để biết thêm thông tin về chuỗi truy vấn và thuộc tính phản hồi của yêu cầu, hãy xem Tài liệu tham khảo APItài liệu tham khảo về tham số báo cáo sử dụng của khách hàng.

Ví dụ sau đây nhận một báo cáo với tổng số lần đăng nhập thành công vào tài khoản của bạn trong 30 ngày qua và danh sách các ứng dụng được uỷ quyền, kèm theo số lượt uỷ quyền của người dùng trên mỗi ứng dụng, bắt đầu từ ngày 3/3/2013. Chuỗi truy vấn maxResults cho thấy báo cáo này trả về 2 sự kiện cho mỗi trang báo cáo:

GET https://admin.googleapis.com/admin/reports/v1/usage/dates/2013-03-03
?parameters=accounts:num_30day_logins%2Caccounts:authorized_apps&maxResults=2

Phản hồi JSON cho báo cáo mức sử dụng của khách hàng

{
 "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
      },
     ...
     ]
    }
   ]
  }
 ]
}