Mengambil laporan yang merupakan kumpulan properti dan statistik untuk kumpulan 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}
Menampilkan ID profil atau email pengguna yang datanya harus difilter. Dapat berupa all untuk semua informasi, atau userKey untuk ID profil Google Workspace unik pengguna atau alamat email utama mereka. Bukan 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
Menyatakan tanggal penggunaan terjadi, berdasarkan UTC-8.00 (Waktu Standar Pasifik). Stempel waktu menggunakan format ISO 8601, yyyy-mm-dd.
Parameter kueri
Parameter
customerId
string
ID unik pelanggan yang datanya akan diambil.
filters
string
String kueri filters adalah daftar parameter peristiwa aplikasi yang dipisahkan koma, tempat nilai parameter dimanipulasi oleh operator relasional. String kueri filters berisi nama aplikasi yang penggunaannya ditampilkan dalam laporan. Nilai aplikasi untuk Laporan Penggunaan Pengguna mencakup accounts, docs, dan gmail.
Filter berbentuk [application name]:[parameter
name][relational operator][parameter value],....
Dalam contoh ini, <> 'tidak sama dengan' operator 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 meliputi:
== - 'sama dengan'.
<> - 'tidak sama dengan'. Hal ini dienkode ke URL (%3C%3E).
< - 'kurang dari'. Hal ini dienkode ke URL (%3C).
<= - 'kurang dari atau sama dengan'. Hal ini dienkode ke URL (%3C=).
> - 'lebih dari'. URL ini dienkode ke URL (%3E).
>= - 'lebih dari atau sama dengan'. URL ini dienkode ke URL (%3E=).
Menentukan berapa banyak catatan 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. Sebuah laporan dengan beberapa halaman memiliki properti nextPageToken dalam responsnya. Dalam permintaan selanjutnya untuk mendapatkan halaman laporan berikutnya, 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 dibuat 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 akan berisi aktivitas hanya untuk pengguna yang merupakan bagian dari setidaknya salah 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.