Method: entityUsageReports.get

Récupère un rapport sous la forme d'un ensemble de propriétés et de statistiques pour les entités utilisées par les utilisateurs du compte. Pour en savoir plus, consultez le guide du rapport sur l'utilisation des entités. Pour en savoir plus sur les paramètres du rapport sur les entités, consultez les guides de référence Paramètres d'utilisation des entités.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
entityType

enum (EntityType)

Représente le type d'entité pour le rapport.
entityKey or all

string

Représente la clé de l'objet avec lequel filtrer les données. Il s'agit d'une chaîne qui peut utiliser la valeur all pour obtenir les événements d'activité de tous les utilisateurs, ou toute autre valeur pour une entité spécifique à une application. Pour savoir comment obtenir le entityKey pour un entityType particulier, consultez les guides de référence Paramètres d'utilisation des entités.
date

string

Représente la date d'utilisation, sur la base de UTC-8:00 (heure normale du Pacifique). L'horodatage est au format ISO 8601, yyyy-mm-dd.

Paramètres de requête

Paramètres
customerId

string

Identifiant unique du client pour lequel récupérer les données.
filters

string

La chaîne de requête filters est une liste des paramètres d'événement d'une application séparés par une virgule, dans laquelle la valeur du paramètre est manipulée par un opérateur relationnel. La chaîne de requête filters inclut le nom de l'application dont l'utilisation est renvoyée dans le rapport. Les valeurs d'application du rapport sur l'utilisation des entités incluent accounts, docs et gmail.

Les filtres sont au format [application name]:[parameter name][relational operator][parameter value],....

Dans cet exemple, la valeur <> est "différente de" est codé en URL dans la chaîne de requête de la requête (%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

Les opérateurs relationnels sont les suivants:

  • == : 'égal à'.
  • <> - 'différent de'. Elle est encodée au format URL (%3C%3E).
  • < - "inférieur à". Il est encodé au format URL (%3C).
  • <= - 'inférieur ou égal à'. Elle est encodée au format URL (%3C=).
  • > - "supérieur à". Elle est encodée au format URL (%3E).
  • >= - 'supérieur ou égal à'. Elle est encodée au format URL (%3E=).
Les filtres ne peuvent être appliqués qu'aux paramètres numériques.
maxResults

integer (uint32 format)

Détermine le nombre d'enregistrements d'activité affichés sur chaque page de réponse. Par exemple, si la demande définit <span>maxResults=1</span> et que le rapport comporte deux activités, il comporte deux pages. La propriété <span>nextPageToken</span> de la réponse contient le jeton de la deuxième page.
pageToken

string

Jeton pour spécifier la page suivante. Un rapport comportant plusieurs pages comporte une propriété nextPageToken dans la réponse. Dans votre demande de suivi visant à obtenir la page suivante du rapport, saisissez la valeur nextPageToken dans la chaîne de requête pageToken.
parameters

string

La chaîne de requête parameters est une liste de paramètres d'événement séparés par une virgule qui affinent les résultats d'un rapport. Le paramètre est associé à une application spécifique. Les valeurs d'application pour le rapport d'utilisation des entités ne sont que gplus.
Une chaîne de requête parameter se présente au format CSV de [app_name1:param_name1], [app_name2:param_name2]....

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de UsageReports.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez le Guide relatif aux autorisations.

EntityType

Enums
gplus_communities Affiche un rapport sur les communautés Google+.