Method: userUsageReport.get

Recupera un report che è una raccolta di proprietà e statistiche per un insieme di utenti che utilizzano l'account. Per ulteriori informazioni, consulta la guida al Report di utilizzo degli utenti. Per ulteriori informazioni sui parametri del report utente, consulta le guide di riferimento Parametri di utilizzo degli utenti.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
userKey

string

Rappresenta l'ID profilo o l'email dell'utente per cui devono essere filtrati i dati. Può essere all per tutte le informazioni o userKey per l'ID profilo Google Workspace univoco di un utente o il suo indirizzo email principale. Non deve essere un utente eliminato. Per un utente eliminato, chiama users.list nell'API Directory con showDeleted=true, quindi utilizza ID restituito come userKey.
date

string

Rappresenta la data in cui si è verificato l'utilizzo, in base al fuso orario UTC-8:00 (Pacific Standard Time). Il timestamp è nel formato ISO 8601, yyyy-mm-dd.

Parametri di query

Parametri
customerId

string

L'ID univoco del cliente per cui recuperare i dati.
filters

string

La stringa di query filters è un elenco separato da virgole dei parametri evento di un'applicazione in cui il valore del parametro viene manipolato da un operatore relazionale. La stringa di query filters include il nome dell'applicazione di cui viene restituito l'utilizzo nel report. I valori di applicazione per il report Utilizzo utenti includono accounts, docs e gmail.

Il formato dei filtri è [application name]:[parameter name][relational operator][parameter value],....

In questo esempio, l 'operatore <> "non uguale a" è codificato in URL nella stringa di query della richiesta (%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

Gli operatori relazionali includono:

  • ==: "uguale a".
  • <>: "diverso da". È codificato in URL (%3C%3E).
  • < - "meno di". È codificato come URL (%3C).
  • <=: "minore o uguale a". Con codifica URL (%3C=).
  • >: "maggiore di". È codificato come URL (%3E).
  • >=: "maggiore o uguale a". È codificato come URL (%3E=).
maxResults

integer (uint32 format)

Determina il numero di record delle attività da mostrare in ogni pagina di risposta. Ad esempio, se la richiesta imposta maxResults=1 e il report contiene due attività, il report ha due pagine. La proprietà nextPageToken della risposta contiene il token per la seconda pagina.
La stringa di query maxResults è facoltativa.
orgUnitID

string

ID dell'unità organizzativa per cui generare il report. L'attività utente verrà mostrata solo per gli utenti che appartengono all'unità organizzativa specificata.

pageToken

string

Token per specificare la pagina successiva. Un report con più pagine ha una proprietà nextPageToken nella risposta. Nella richiesta successiva per visualizzare la pagina successiva del report, inserisci il valore nextPageToken nella stringa di query pageToken.
parameters

string

La stringa di query parameters è un elenco separato da virgole di parametri evento che perfezionano i risultati di un report. Il parametro è associato a un'applicazione specifica. I valori di applicazione per il report Utilizzo dei clienti includono accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, gplus, device_management, meet e sites.
Una stringa di query parameters è nel formato CSV di app_name1:param_name1, app_name2:param_name2.

groupIdFilter

string

ID gruppo (oscurati) separati da virgola su cui vengono filtrate le attività utente, ovvero la risposta conterrà le attività solo per gli utenti che fanno parte di almeno uno degli ID gruppo menzionati qui. Formato: "id:abc123,id:xyz456"

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di UsageReports.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autorizzazione.