Method: userUsageReport.get

Mengambil laporan yang merupakan kumpulan properti dan statistik untuk sekumpulan pengguna dengan akun. Untuk informasi selengkapnya, lihat panduan Laporan Penggunaan Pengguna. Untuk informasi selengkapnya tentang parameter laporan pengguna, lihat panduan referensi Parameter Penggunaan Pengguna.

Permintaan HTTP

GET https://admin.googleapis.com/admin/reports/v1/usage/users/{userKey or all}/dates/{date}

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
userKey

string

Merepresentasikan ID profil atau email pengguna yang datanya akan difilter. Dapat berupa all untuk semua informasi, atau userKey untuk ID profil Google Workspace unik pengguna atau alamat email utamanya. Tidak boleh pengguna yang dihapus. Untuk pengguna yang dihapus, panggil users.list di Directory API dengan showDeleted=true, lalu gunakan ID yang ditampilkan sebagai userKey.
date

string

Mewakili tanggal penggunaan terjadi, berdasarkan UTC-8:00 (Waktu Standar Pasifik). Stempel waktu dalam format ISO 8601, yyyy-mm-dd.

Parameter kueri

Parameter
customerId

string

ID unik pelanggan untuk mengambil data.
filters

string

String kueri filters adalah daftar parameter peristiwa aplikasi yang dipisahkan koma, dengan nilai parameter dimanipulasi oleh operator relasional. String kueri filters menyertakan nama aplikasi yang penggunaannya ditampilkan dalam laporan. Nilai aplikasi untuk Laporan Penggunaan Pengguna mencakup accounts, docs, dan gmail.

Filter dalam bentuk [application name]:[parameter name][relational operator][parameter value],....

Dalam contoh ini, operator <> 'not equal to' dienkode ke URL dalam string kueri permintaan (%3C%3E): 

GET
https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time
&filters=accounts:last_login_time%3C%3E2010-10-28T10:26:35.000Z

Operator relasional mencakup:

  • == - 'sama dengan'.
  • <> - 'not equal to'. URL ini dienkode (%3C%3E).
  • < - 'kurang dari'. Hal ini dienkode ke URL (%3C).
  • <= - 'kurang dari atau sama dengan'. Hal ini dienkode ke URL (%3C=).
  • > - 'lebih besar dari'. URL ini dienkode (%3E).
  • >= - 'lebih dari atau sama dengan'. URL ini dienkode ke URL (%3E=).
maxResults

integer (uint32 format)

Menentukan jumlah data aktivitas yang ditampilkan di setiap halaman respons. Misalnya, jika permintaan menetapkan maxResults=1 dan laporan memiliki dua aktivitas, laporan ini akan memiliki dua halaman. Properti nextPageToken respons memiliki token ke halaman kedua.
String kueri maxResults bersifat opsional.
orgUnitID

string

ID unit organisasi yang akan dilaporkan. Aktivitas pengguna hanya akan ditampilkan untuk pengguna yang termasuk dalam unit organisasi yang ditentukan.

pageToken

string

Token untuk menentukan halaman berikutnya. Laporan dengan beberapa halaman memiliki properti nextPageToken dalam respons. Dalam permintaan lanjutan untuk mendapatkan halaman berikutnya dari laporan, masukkan nilai nextPageToken dalam string kueri pageToken.
parameters

string

String kueri parameters adalah daftar parameter peristiwa yang dipisahkan koma yang menyaring hasil laporan. Parameter ini dikaitkan dengan aplikasi tertentu. Nilai aplikasi untuk laporan Penggunaan Pelanggan mencakup accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, gplus, device_management, meet, dan sites.
String kueri parameters dalam bentuk CSV app_name1:param_name1, app_name2:param_name2.

groupIdFilter

string

ID grup yang dipisahkan koma (di-obfuscate) tempat aktivitas pengguna difilter, yaitu respons hanya akan berisi aktivitas untuk pengguna yang merupakan bagian dari setidaknya satu ID grup yang disebutkan di sini. Format: "id:abc123,id:xyz456"

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat instance UsageReports.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/admin.reports.usage.readonly

Untuk informasi selengkapnya, lihat Panduan otorisasi.