Method: entityUsageReports.get

Recupera un report che è una raccolta di proprietà e statistiche per le entità utilizzate dagli utenti all'interno dell'account. Per ulteriori informazioni, consulta la guida al report Utilizzo entità. Per saperne di più sui parametri del report sulle entità, consulta le guide di riferimento sui parametri di utilizzo delle entità.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
entityType

enum (EntityType)

Rappresenta il tipo di entità per il report.
entityKey

string

Rappresenta la chiave dell'oggetto con cui filtrare i dati. È una stringa che può assumere il valore all per ottenere gli eventi di attività per tutti gli utenti o qualsiasi altro valore per un'entità specifica dell'app. Per informazioni dettagliate su come ottenere il valore entityKey per un determinato entityType, consulta le guide di riferimento dei parametri di utilizzo delle entità.
date

string

Rappresenta la data in cui si è verificato l'utilizzo, in base a UTC-8:00 (fuso orario standard della costa del Pacifico). 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 il cui utilizzo viene restituito nel report. I valori dell'applicazione per il report Utilizzo entità 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/gplus_communities/all/dates/2017-12-01
?parameters=gplus:community_name,gplus:num_total_members
&filters=gplus:num_total_members%3C%3E0

Gli operatori relazionali includono:

  • ==: "uguale a".
  • <>: "non uguale a". È codificato in URL (%3C%3E).
  • < - "meno di". È codificato come URL (%3C).
  • <= - "minore o uguale a". È codificato come URL (%3C=).
  • > - "maggiore di". È codificato come URL (%3E).
  • >= - "maggiore o uguale a". Con codifica URL (%3E=).
I filtri possono essere applicati solo ai parametri numerici.
maxResults

integer (uint32 format)

Determina il numero di record delle attività da mostrare in ogni pagina di risposta. Ad esempio, se la richiesta imposta <span>maxResults=1</span> e il report ha due attività, avrà due pagine. La proprietà <span>nextPageToken</span> della risposta contiene il token per la seconda pagina.
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 di parametri evento separati da virgole che perfezionano i risultati di un report. Il parametro è associato a un'applicazione specifica. I valori dell'applicazione per il report sull'utilizzo delle entità sono solo gplus.
Una stringa di query parameter è nel formato CSV di [app_name1:param_name1], [app_name2:param_name2]....

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.

EntityType

Enum
gplus_communities Restituisce un report sulle community di Google+.