API Reports: rapport sur l'utilisation des clients

Le rapport d'utilisation des clients rassemble des informations sur l'utilisation des services Google Workspace pour tous les utilisateurs d'un domaine. Le rapport d'utilisation utilisateur renvoie des informations sur l'utilisation des services Google Workspace pour l'ensemble de votre compte. Ces informations d'utilisation sont organisées par type d'application, et sont composées de paramètres spécifiques à cette application. La période par défaut et maximale de chaque rapport est de 450 jours.

Ce rapport ne peut être utilisé qu'à des fins légales, conformément à votre contrat client. En outre, ces rapports s'appliquent à Google Workspace et Education.

Récupérer un rapport d'utilisation client

Pour récupérer un rapport sur les activités de votre compte, utilisez la requête HTTP GET suivante et incluez le jeton d'autorisation décrit dans la documentation sur les autorisations. Pour des raisons de lisibilité, l'exemple suivant est mis en forme avec des retours à la ligne:

GET https://admin.googleapis.com/admin/reports/v1/usage/dates/yyyy-mm-dd date
?parameters=app name: usage parameter,...
&customerId=the customer's ID
&maxResults=number of events listed on each page of the report

La valeur dates correspond à la date d'utilisation. L'horodatage est au format ISO 8601 (aaaa-mm-jj). Pour cela, nous vous recommandons d'utiliser le fuseau horaire de votre compte. Pour en savoir plus sur les chaînes de requête et les propriétés de réponse de la requête, consultez la documentation de référence de l'API et la documentation de référence sur les paramètres du rapport sur l'utilisation des clients.

L'exemple suivant permet d'obtenir un rapport avec le total de toutes les connexions réussies à votre compte au cours des 30 derniers jours et une liste des applications autorisées, avec le nombre d'autorisations utilisateur par application, à partir du 03/03/2013. La chaîne de requête maxResults montre que ce rapport renvoie deux événements par page du rapport:

GET https://admin.googleapis.com/admin/reports/v1/usage/dates/2013-03-03
?parameters=accounts:num_30day_logins%2Caccounts:authorized_apps&maxResults=2

Réponse JSON pour le rapport d'utilisation du client

{
 "kind": "reports#usageReports",
 "warnings": [
    {
      "code": warning machine-readable code,
      "message": warning human-readable message,
      "data": [
        {
          "key": key for key-value pair that gives detailed warning information,
          "value": value for key-value pair giving detailed warning information
        }
      ]
    }
  ],
 "nextPageToken": "N:NNN:NNN:N:C03az79cb",
 "usageReports": [
  {
   "kind": "usageReport",
   "date": "2013-03-03",
   "entity": {
    "type": "CUSTOMER",
    "customerId": "C03az79cb"
   },
   "parameters": [
    {
     "name": "accounts:num_1day_logins",
     "intValue": "1"
    },
    {
     "name": "accounts:num_30day_logins",
     "intValue": "1"
    },
    {
     "name": "accounts:num_7day_logins",
     "intValue": "1"
    },
    {
     "name": "accounts:num_disabled_accounts",
     "intValue": "5"
    },
    {
     "name": "accounts:authorized_apps",
     "msgValue": [
      {
       "client_id": "1234.apps.googleusercontent.com",
       "client_name": "www.example.com",
       "num_users": 2
      },
      {
       "client_id": "4567.apps.googleusercontent.com",
       "client_name": "Example",
       "num_users": 1
      },
     ...
     ]
    }
   ]
  }
 ]
}