API Reports: report Utilizzo entità

Il report sull'utilizzo delle entità restituisce le attività del servizio Google Workspace relative alle entità utilizzati dagli utenti del tuo account. Questi report possono essere personalizzati e filtrati per utilizzo specifico informazioni. I dati sono disponibili per gli ultimi 30 giorni.

Il report sull'utilizzo delle entità può essere usato solo per scopi legittimi in in conformità con il Contratto con il cliente. Questi report si applicano anche Google Workspace ed Education.

Recupera le attività di utilizzo di tutte le entità

Attualmente, l'unico tipo di entità supportato da questa API sono le community Google+. Per recuperare un di tutte le attività relative alle entità dell'app nel tuo account, usa quanto segue GET Richiesta HTTP e includi il token di autorizzazione descritto nell' documentazione sull'autorizzazione. Per la leggibilità, l'esempio seguente è formattato con i ritorni a capo:

GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/date
?parameters=applicationParameters
&filters=parameterFilters
&maxResults=maxResults

Il valore date è la data in cui si è verificato l'utilizzo e il timestamp si trova nella Formato ISO 8601, aaaa-mm-gg. Ti consigliamo utilizza il fuso orario del tuo account. Per ulteriori informazioni sui parametri della stringa di query e proprietà della risposta, consulta le Riferimento. Per informazioni sui parametri dei report sull'utilizzo delle entità, consulta Parametri di utilizzo delle entità riferimento.

applicationParameters è un elenco di parametri separati da virgole che vuoi recuperare. Ogni parametro ha il formato application:parameter_name, ad esempio gplus:community_name. I parametri disponibili sono documentati in Parametri di utilizzo delle entità riferimento. Se non viene specificato nessun parametro, vengono restituiti tutti i parametri.

parameterFilters è un elenco di filtri separati da virgole da applicare ai risultati. Ciascuna il filtro è formattato come application:parameter_name[relational_operator]parameter_value. Ad esempio, filtro gplus:num_total_members>100 filtra i risultati in modo che contengano solo 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 totale di risultati è maggiore di questo valore, la risposta verrà troncata Verranno inclusi nextPageToken (vedi il 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 di community_name num_total_members per ogni entità gplus_communities, filtrato in base a community con più di 100 membri. Per un esempio di risposta dell'API, consulta 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

GET https://admin.googleapis.com/admin/reports/v1/gplus_communities/entityKey/dates/date
?parameters=applicationParameters
&filters=parameterFilters
&maxResults=maxResults

https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/1234/dates/2017-12-11

{
 "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
    },
   ]
  }
 ]
}

{
 "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": [],
}