API Reports: rapport sur l'utilisation des entités

Le rapport d'utilisation des entités affiche les activités des services Google Workspace liées aux entités utilisés par les utilisateurs de votre compte. Vous pouvez personnaliser et filtrer ces rapports pour une utilisation spécifique des informations. Des données sont disponibles pour les 30 derniers jours.

Le rapport d'utilisation des entités ne peut être utilisé qu'à des fins légales dans conformément à votre Contrat client. Ces rapports s'appliquent également Google Workspace et Education.

Récupérer toutes les activités d'utilisation des entités

Actuellement, le seul type d'entité compatible avec cette API est les communautés Google+. Pour récupérer un de toutes les activités liées aux entités d'application de votre compte, utilisez GET et inclure le jeton d'autorisation décrit dans la documents d'autorisation. Pour lisibilité, l'exemple suivant est mis en forme avec des retours à la ligne:

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

La valeur date correspond à la date à laquelle l'utilisation a eu lieu et l'horodatage se trouve au Format ISO 8601, aaaa-mm-jj. Nous vous recommandons utilisez pour cela le fuseau horaire de votre compte. Pour en savoir plus sur les paramètres de chaîne de requête et de réponse, consultez les API Documentation de référence. Pour en savoir plus sur les paramètres du rapport d'utilisation des entités, consultez les Paramètres d'utilisation des entités référence.

applicationParameters est une liste de paramètres à récupérer, séparés par une virgule. Chaque paramètre est au format application:parameter_name. Par exemple : gplus:community_name Les paramètres disponibles sont décrits dans la Paramètres d'utilisation des entités référence. Si aucun paramètre n'est spécifié, tous sont renvoyés.

parameterFilters est une liste de filtres à appliquer aux résultats, séparés par une virgule. Chaque Le filtre a le format suivant : application:parameter_name[relational_operator]parameter_value Par exemple, filtrer gplus:num_total_members>100 filtre les résultats pour qu'ils ne contiennent que les résultats où le paramètre gplus:num_total_members a une valeur supérieure à 100.

maxResults correspond au nombre maximal de résultats à renvoyer en une seule extraction. Si la valeur de résultats est supérieur à cette valeur, la réponse est tronquée et un nextPageToken sera inclus (consultez les exemple de réponse JSON ci-dessous).

Exemples

Dans l'exemple suivant, la requête récupère un rapport contenant tous les paramètres. pour toutes les entités gplus_communities.

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

Dans l'exemple suivant, la requête récupère un rapport contenant le paramètre community_name. pour toutes les entités gplus_communities.

GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all
/dates/2017-12-11?parameters=gplus:community_name

L'exemple suivant permet d'obtenir un rapport de community_name et num_total_members pour chaque entité gplus_communities, filtrée par communautés comptant plus de 100 membres. Pour obtenir un exemple de réponse de l'API, consultez la Exemple de réponse 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": [],
}