Il report sull'utilizzo delle entità restituisce le attività di servizio di Google Workspace correlate alle entità utilizzate dagli utenti del tuo account. Questi report possono essere personalizzati e filtrati in base a informazioni specifiche sull'utilizzo. I dati sono disponibili per gli ultimi 30 giorni.
Il report sull'utilizzo delle entità può essere utilizzato solo per scopi legali in conformità con il Contratto con il cliente. Questi report si applicano anche a Google Workspace ed Education.
Recupera tutte le attività di utilizzo delle entità
Attualmente, l'unico tipo di entità supportato da questa API sono le community Google+. Per recuperare un
report di tutte le attività relative alle entità app nel tuo account, utilizza la seguente
richiesta HTTP GET e includi il token di autorizzazione descritto nella
documentazione relativa all'autorizzazione. Per una migliore leggibilità, l'esempio seguente è formattato con ritorni a riga:
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/date ?parameters=applicationParameters &filters=parameterFilters &maxResults=maxResults
Il valore date indica la data in cui si è verificato l'utilizzo e il timestamp è nel formato ISO 8601, aaaa-mm-gg. Ti consigliamo di utilizzare il fuso orario del tuo account. Per ulteriori informazioni sui parametri della stringa di query e sulle proprietà della risposta, consulta la documentazione di riferimento API. Per informazioni sui parametri del report Utilizzo delle entità, consulta la documentazione di riferimento sui parametri di utilizzo delle entità.
applicationParameters è un elenco separato da virgole di parametri da recuperare.
Ogni parametro ha il formato application:parameter_name, ad esempio
gplus:community_name. I parametri disponibili sono documentati nel riferimento sui parametri di utilizzo delle entità. Se non vengono specificati parametri, vengono restituiti tutti.
parameterFilters è un elenco di filtri separati da virgole da applicare ai risultati. Ogni
filtro è formattato come
application:parameter_name[relational_operator]parameter_value. Ad esempio, il filtro gplus:num_total_members>100 filtra i risultati in modo che contengano solo i risultati in cui il parametro gplus:num_total_members ha un valore maggiore di 100.
maxResults è il numero massimo di risultati da restituire in un singolo recupero. Se il numero totale di risultati è maggiore di questo valore, la risposta verrà troncata e verrà incluso un valore nextPageToken (vedi l'esempio di risposta JSON di seguito).
Esempi
L'esempio seguente restituisce un report contenente tutti i parametri per tutte le entità gplus_communities.
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all /dates/2017-12-11
L'esempio seguente restituisce un report contenente il parametro community_name
per tutte le entità gplus_communities.
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all /dates/2017-12-11?parameters=gplus:community_name
L'esempio seguente restituisce un report relativo a community_name e
num_total_members per ogni entità gplus_communities, filtrata in base
alle community con più di 100 membri. Per un esempio di risposta dell'API, vedi l'esempio di risposta JSON.
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-11 ?parameters=gplus:community_name,gplus:num_total_members&filters=gplus:num_total_members>100
Recuperare un report per un'entità specifica
Per recuperare un report per un'entità specifica, utilizza la seguente richiesta HTTP GET e includi il token di autorizzazione descritto nella documentazione relativa all'autorizzazione. Per la leggibilità, l'esempio seguente è formattato con ritorni a riga.
GET https://admin.googleapis.com/admin/reports/v1/gplus_communities/entityKey/dates/date ?parameters=applicationParameters &filters=parameterFilters &maxResults=maxResults
entityKey è un identificatore di entità specifico per l'applicazione in cui si trova l'entità. Consulta la documentazione di riferimento API per i dettagli su come ottenere entityKey per la specifica entità che ti interessa. Gli altri parametri sono documentati sopra in Recuperare tutte le attività di utilizzo delle entità.
Per ulteriori informazioni sui parametri della stringa di query e sulle proprietà delle risposte, consulta la documentazione di riferimento API. Per informazioni sui parametri del report di utilizzo delle entità, consulta la documentazione di riferimento sui parametri di utilizzo delle entità.
Esempi
L'esempio seguente restituisce il report sulle entità per un'entità gplus_community con
entityKey "1234".
https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/1234/dates/2017-12-11
Esempio di risposta JSON nel report sull'utilizzo
Una risposta corretta restituisce un codice di stato HTTP 200. Insieme al codice di stato, la risposta restituisce un report. Alcuni parametri nella risposta sono stati omessi per motivi di leggibilità.
Esempio di risposta JSON per il report sulle entità
{
"kind": "reports#usageReports",
"nextPageToken": "NjQ1OTgwODk0MzkxNDAwNjQ0OA",
"usageReports": [
{
"kind": "admin#reports#usageReport",
"date": "2017-12-11",
"entity": {
"type": "OBJECT",
"customerId": "C03az79cb",
"objectType": "GPLUS_COMMUNITY",
"objectId": "1234",
},
"parameters": [
{
"name": "gplus:community_name",
"stringValue": "My Community"
},
{
"name": "gplus:num_total_members",
"intValue": 37
},
{
"name": "gplus:num_7day_active_members",
"intValue": 12
},
{
"name": "gplus:num_30day_active_members",
"intValue": 17
},
]
}
]
}
Esempio di risposta JSON per il report sulle entità con avvisi
Se la richiesta non può essere soddisfatta, è possibile che vengano restituiti uno o più avvisi nella risposta. In questo esempio, il report non è disponibile nel momento in cui viene effettuata la richiesta.{
"kind": "reports#usageReports",
"warnings": [
{
"code": "PARTIAL_DATA_AVAILABLE"
"message": "Data for date 2017-12-11 for application gplus is not available right now, please try again after a few hours."
"data": [
{
"key": "date"
"value": "2017-12-11"
}
]
}
],
"usageReports": [],
}
Ogni voce nell'array warnings contiene i seguenti parametri:
code: codice di avviso leggibile dal computermessage: messaggio di avviso leggibiledata: elenco di coppie chiave/valore che forniscono informazioni di avviso dettagliate