API Reports: rapport sur l'utilisation des clients

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

Ce rapport d'utilisation ne peut être utilisé qu'à des fins légales, conformément à votre contrat client. De plus, ces 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écrites dans la documentation sur les autorisations. Pour une meilleure lisibilité, l'exemple suivant est formaté 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 plus d'informations 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 d'utilisation client.

Dans l'exemple suivant, la requête génère un rapport indiquant le nombre total de connexions à votre compte réussies au cours des 30 derniers jours, ainsi qu'une liste d'applications autorisées, avec le nombre d'autorisations utilisateur par application, à partir du 03/03/2013. maxResults La chaîne de requête ci-dessous indique que ce rapport renvoie deux événements par page: 

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 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
      },
     ...
     ]
    }
   ]
  }
 ]
}