Method: entityUsageReports.get

Mengambil laporan yang merupakan kumpulan properti dan statistik untuk entitas yang digunakan oleh pengguna dalam akun. Untuk mengetahui informasi selengkapnya, lihat panduan Laporan Penggunaan Entitas. Untuk mengetahui informasi selengkapnya tentang parameter laporan entity, lihat panduan referensi Parameter Penggunaan Entitas.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
entityType

enum (EntityType)

Mewakili jenis entitas untuk laporan.
entityKey or all

string

Menyatakan kunci objek untuk memfilter data. Ini adalah string yang dapat mengambil nilai all untuk mendapatkan peristiwa aktivitas bagi semua pengguna, atau nilai lainnya untuk entity khusus aplikasi. Guna mengetahui detail cara mendapatkan entityKey untuk entityType tertentu, lihat panduan referensi Parameter Penggunaan Entitas.
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 yang dipisahkan koma dari parameter peristiwa aplikasi tempat nilai parameter dimanipulasi oleh operator relasional. String kueri filters berisi nama aplikasi yang penggunaannya ditampilkan dalam laporan. Nilai aplikasi untuk laporan penggunaan Entitas mencakup accounts, docs, dan gmail.

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

Dalam contoh ini, operator 'tidak sama dengan' <> dienkode ke URL dalam string kueri permintaan (%3C%3E): 

GET
https://www.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-01
?parameters=gplus:community_name,gplus:num_total_members
&filters=gplus:num_total_members%3C%3E0

Operator relasional meliputi:

  • == - 'sama dengan'.
  • <> - 'tidak sama dengan'. URL ini dienkode (%3C%3E).
  • < - 'kurang dari'. URL ini dienkode (%3C).
  • <= - 'kurang dari atau sama dengan'. URL ini dienkode (%3C=).
  • > - 'lebih dari'. URL ini dienkode (%3E).
  • >= - 'lebih dari atau sama dengan'. URL ini dienkode (%3E=).
Filter hanya dapat diterapkan pada parameter numerik.
maxResults

integer (uint32 format)

Menentukan berapa banyak catatan aktivitas yang ditampilkan di setiap halaman respons. Misalnya, jika permintaan menetapkan <span>maxResults=1</span> dan laporan memiliki dua aktivitas, laporan memiliki dua halaman. Properti <span>nextPageToken</span> respons memiliki token ke halaman kedua.
pageToken

string

Token untuk menentukan halaman berikutnya. Laporan yang berisi beberapa halaman memiliki properti nextPageToken dalam responsnya. Pada permintaan berikutnya 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 entitas hanya gplus.
String kueri parameter memiliki bentuk CSV [app_name1:param_name1], [app_name2:param_name2]....

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons akan berisi instance UsageReports.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

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

Untuk informasi selengkapnya, lihat Panduan otorisasi.

EntityType

Enum
gplus_communities Menampilkan laporan tentang komunitas Google+.