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 Entity. Untuk mendapatkan informasi selengkapnya tentang parameter laporan entitas, 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)

Menampilkan jenis entitas untuk laporan.
entityKey

string

Merepresentasikan kunci objek yang akan digunakan untuk memfilter data. Ini adalah string yang dapat menggunakan nilai all untuk mendapatkan peristiwa aktivitas bagi semua pengguna, atau nilai lain untuk entitas khusus aplikasi. Untuk mengetahui detail tentang cara mendapatkan entityKey untuk entityType tertentu, lihat panduan referensi Parameter Penggunaan Entitas.
date

string

Menggambarkan 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 yang datanya akan diambil.
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 Entity mencakup accounts, docs, dan gmail.

Filter berbentuk [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 mencakup:

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

integer (uint32 format)

Menentukan jumlah data aktivitas yang ditampilkan di setiap halaman respons. Misalnya, jika permintaan menetapkan <span>maxResults=1</span> dan laporan memiliki dua aktivitas, laporan ini akan memiliki dua halaman. Properti <span>nextPageToken</span> respons memiliki token ke halaman kedua.
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 dikaitkan dengan aplikasi tertentu. Nilai aplikasi untuk laporan penggunaan Entity hanya gplus.
String kueri parameter dibuat dalam bentuk CSV [app_name1:param_name1], [app_name2:param_name2]....

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.

EntityType

Enum
gplus_communities Menampilkan laporan tentang komunitas Google+.