Method: userUsageReport.get

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

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
userKey

string

Représente l'ID de profil ou l'adresse e-mail de l'utilisateur pour lequel les données doivent être filtrées. Peut être all pour toutes les informations ou userKey pour l'ID de profil Google Workspace unique ou l'adresse e-mail principale d'un utilisateur. Ne doit pas s'agir d'un utilisateur supprimé. Pour un utilisateur supprimé, appelez users.list dans l'API Directory avec showDeleted=true, puis utilisez le ID renvoyé comme userKey.
date

string

Représente la date à laquelle l'utilisation a eu lieu, en fonction de l'heure normale du Pacifique (UTC-8:00). 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 récupérer les 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 des virgules, 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 pour le rapport sur l'utilisation des utilisateurs 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/users/all/dates/2013-03-03
?parameters=accounts:last_login_time
&filters=accounts:last_login_time%3C%3E2010-10-28T10:26:35.000Z

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=).
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 maxResults=1 et que le rapport comporte deux activités, le rapport comporte deux pages. La propriété nextPageToken de la réponse contient le jeton de la deuxième page.
La chaîne de requête maxResults est facultative.
orgUnitID

string

ID de l'unité organisationnelle à inclure dans le rapport. L'activité des utilisateurs ne s'affiche que pour les utilisateurs appartenant à l'unité organisationnelle spécifiée.

pageToken

string

Jeton pour 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 "Utilisation par les clients" incluent accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, gplus, device_management, meet et sites.
Une chaîne de requête parameters se présente au format CSV sous la forme app_name1:param_name1, app_name2:param_name2.

groupIdFilter

string

ID de groupe séparés par une virgule (obscurcis) sur lesquels les activités des utilisateurs sont filtrées. Par exemple, la réponse ne contiendra que les activités des utilisateurs qui font partie d'au moins un des identifiants de groupe mentionnés ici. Format: "id:abc123,id:xyz456"

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.