Reports API: Laporan Penggunaan Pelanggan

Laporan penggunaan Pelanggan menggabungkan informasi penggunaan layanan Google Workspace, untuk semua pengguna, di seluruh domain. Laporan penggunaan pengguna menampilkan informasi penggunaan layanan Google Workspace di seluruh akun Anda. Informasi penggunaan ini diatur menurut jenis aplikasi yang terdiri dari parameter khusus untuk aplikasi tersebut. Jangka waktu default dan maksimum untuk setiap laporan adalah 450 hari terakhir.

Laporan penggunaan ini hanya dapat digunakan untuk tujuan yang sah sesuai dengan Perjanjian Pelanggan Anda. Selain itu, laporan ini berlaku untuk Google Workspace dan Education.

Mengambil laporan penggunaan pelanggan

Untuk mengambil laporan aktivitas akun Anda, gunakan permintaan HTTP GET berikut dan sertakan token otorisasi yang dijelaskan dalam dokumentasi otorisasi. Agar mudah dibaca, contoh berikut diformat dengan baris yang ditampilkan:

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

Nilai dates adalah tanggal penggunaan terjadi dan stempel waktu dalam format ISO 8601, yyyy-mm-dd. Sebaiknya gunakan zona waktu akun Anda untuk hal ini. Untuk mengetahui informasi selengkapnya tentang properti respons dan string kueri permintaan, lihat Referensi API dan referensi parameter laporan penggunaan pelanggan.

Contoh berikut mendapatkan laporan dengan total semua login yang berhasil ke akun Anda dalam 30 hari terakhir dan daftar aplikasi yang diotorisasi, dengan jumlah otorisasi pengguna per aplikasi, mulai 03-03-2013. String kueri maxResults menunjukkan bahwa laporan ini menampilkan dua peristiwa per halaman laporan:

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

Respons JSON untuk laporan penggunaan pelanggan

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