API Laporan: Laporan Penggunaan Pengguna

Laporan penggunaan pengguna menampilkan informasi penggunaan layanan Google Workspace untuk pengguna tertentu di domain Anda. Laporan ini dapat disesuaikan dan difilter untuk informasi penggunaan tertentu. Jangka waktu default dan maksimum untuk setiap laporan adalah 450 hari terakhir.

Laporan penggunaan pengguna ini hanya dapat digunakan untuk tujuan yang sah sesuai dengan Perjanjian Pelanggan Anda. Laporan ini juga berlaku untuk Google Workspace dan Education.

Mengambil semua aktivitas penggunaan pengguna

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

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/yyyy-mm-dd date
?parameters=application: user usage parameter,...
&filters=application: user usage parameter relational operator usage parameter's value,...
&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. Untuk informasi selengkapnya tentang parameter string kueri dan properti respons, lihat Referensi API. Untuk mendapatkan informasi tentang parameter laporan penggunaan pengguna, lihat Referensi Parameter Penggunaan Pengguna.

Contoh berikut mendapatkan laporan tentang semua aktivitas pengguna untuk akun.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all
/dates/2013-03-03?maxResults=2

Contoh berikut mendapatkan laporan tentang semua aktivitas pengguna untuk akun pelanggan tertentu.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all
/dates/2013-03-03?customerId=C03az79cb

Contoh berikut mendapatkan laporan tentang stempel waktu login terakhir pengguna di akun. Untuk contoh respons API, lihat contoh respons JSON.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time&maxResults=2

Contoh berikut mendapatkan laporan tentang stempel waktu login terakhir pengguna di akun, yang difilter menurut pengguna yang login setelah jangka waktu tertentu. Untuk contoh respons API, lihat contoh respons JSON.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time&filters=accounts:last_login_time
>2010-10-28T10:26:35.000Z"

Contoh berikut mendapatkan laporan tentang stempel waktu login terakhir dan status penangguhan pengguna di akun. Untuk contoh respons API, lihat contoh respons JSON.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time,accounts:is_disabled"

Mengambil aktivitas penggunaan dari pengguna tertentu

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

GET https://admin.googleapis.com/admin/reports/v1/usage/users/userKey/dates/yyyy-mm-dd date
?parameters=application: user usage parameter,...
&filters=application: user usage parameter relational operator usage parameter's value,...
&maxResults=number of events listed on each page of the report

userKey dapat berupa alamat email utama pengguna di laporan atau profileId Google Workspace unik pengguna. Nilai dates adalah tanggal penggunaan terjadi dan stempel waktu dalam format ISO 8601, yyyy-mm-dd. Untuk informasi selengkapnya tentang parameter string kueri dan properti respons, lihat Referensi API. Untuk mendapatkan informasi tentang parameter laporan penggunaan pengguna, lihat Referensi Parameter Penggunaan Pengguna.

Contoh berikut mendapatkan laporan penggunaan untuk john@example.com.

https://admin.googleapis.com/admin/reports/v1/usage/users/john@example.com/dates/2013-03-03

Contoh respons JSON laporan penggunaan

Respons yang berhasil akan menampilkan kode status HTTP 200. Bersama dengan kode status, respons akan menampilkan laporan.

Respons JSON untuk laporan pengguna

{
 "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": "USER",
    "customerId": "C03az79cb",
    "userEmail": "liz@example.com",
    "profileId": "user's unique Google Workspace ID"
   },
   "parameters": [
    {
      "name": "accounts:is_disabled",
      "boolValue": false
     },
    {
     "name": "accounts:disabled_reason",
     "stringValue": "reason description"
    },
    {
     "name": "accounts:first_name",
     "stringValue": "Liz"
    },
    {
     "name": "accounts:is_2sv_enforced",
     "boolValue": false
    },
    {
     "name": "accounts:is_2sv_enrolled",
     "boolValue": false
    },
    {
     "name": "accounts:last_name",
     "stringValue": "Smith"
    },
    {
     "name": "accounts:creation_time",
     "datetimeValue": "2010-10-28T10:26:35.000Z"
    },
    {
     "name": "accounts:last_login_time",
     "datetimeValue": "1970-01-01T00:00:00.000Z"
    },
    {
     "name": "accounts:last_sso_time",
     "datetimeValue": "1970-01-01T00:00:00.000Z"
    }
   ]
  }
 ]
}