Method: entityUsageReports.get

• Requête HTTP
• Paramètres de chemin d'accès
• Paramètres de requête
• Corps de la requête
• Corps de la réponse
• Champs d'application des autorisations
• EntityType
• Essayer

Récupère un rapport, qui est 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 sur les 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é du rapport.
entityKey or all	string Représente la clé de l'objet à utiliser pour filtrer les données. Il s'agit d'une chaîne qui peut prendre la valeur all pour obtenir des événements d'activité pour tous les utilisateurs, ou toute autre valeur pour une entité spécifique à l'application. Pour savoir comment obtenir le entityKey d'un entityType spécifique, consultez les guides de référence sur les paramètres d'utilisation des entités.
date	string Représente la date à laquelle l'utilisation a eu lieu, en fonction de l'heure UTC-8:00 (heure normale du Pacifique). Le code temporel est au format ISO 8601, yyyy-mm-dd.

Paramètres de requête

Paramètres
customerId	string Identifiant unique du client pour lequel vous souhaitez récupérer des données.
filters	string La chaîne de requête filters est une liste de paramètres d'événement d'une application séparés par une virgule, où 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, l'opérateur <> "n'est pas égal à" est encodé 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 incluent les suivants: == : "égal à". <> : "différent de". Il est encodé au format URL (%3C%3E). < : "inférieur à". Il est encodé au format URL (%3C). <= : "inférieur ou égal à". Il est encodé au format URL (%3C=). > : "supérieur à". Il est encodé au format URL (%3E). >= : "supérieur ou égal à". Il est encodé 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 requête définit <span>maxResults=1</span> et que le rapport comporte deux activités, le rapport comporte deux pages. La propriété <span>nextPageToken</span> de la réponse contient le jeton de la deuxième page.
pageToken	string Jeton permettant de spécifier la page suivante. Un rapport comportant plusieurs pages contient une propriété nextPageToken dans la réponse. Dans la requête de suivi permettant d'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 des virgules qui affinent les résultats d'un rapport. Le paramètre est associé à une application spécifique. Les valeurs d'application du rapport sur l'utilisation des entités ne sont que gplus. Une chaîne de requête parameter se présente au format CSV sous la forme [app_name1:param_name1], [app_name2:param_name2].... Remarque:L'API n'accepte pas plusieurs valeurs d'un paramètre. Si un paramètre particulier est fourni plusieurs fois dans la requête d'API, l'API n'accepte que la dernière valeur de ce paramètre de requête. De plus, si un paramètre de requête non valide est fourni dans la requête d'API, l'API l'ignore et renvoie la réponse correspondant aux autres paramètres de requête valides. Un paramètre de requête non valide est un paramètre qui n'appartient pas à l'application. Si aucun paramètre n'est demandé, tous les paramètres sont renvoyés.

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 d'autorisation.

EntityType

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