Le rapport sur l'utilisation comporte des informations sur l'utilisation des services Google Workspace pour un utilisateur donné de votre domaine. Vous pouvez personnaliser ces rapports et les filtrer en fonction d'informations d'utilisation spécifiques. La période par défaut et maximale de chaque rapport est de 450 jours.
Ces rapports ne peuvent être utilisés qu'à des fins légales, conformément à votre contrat client. Ces rapports s'appliquent à Google Workspace et Education.
Récupérer toutes les activités d'utilisation des utilisateurs
Pour récupérer un rapport sur toutes les activités de l'utilisateur dans 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/users/all/dates/yyyy-mm-dd date ?parameters=application: user usage parameter,... &filters=application: user usage parameter relational operator usage parameter's value,... &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 plus d'informations sur les paramètres de chaîne de requête et les propriétés de réponse, consultez la documentation de référence de l'API. Pour en savoir plus sur les paramètres du rapport sur l'utilisation de l'utilisateur, consultez la documentation de référence sur les paramètres d'utilisation de l'utilisateur.
Dans l'exemple suivant, la requête permet d'obtenir un rapport sur toutes les activités des utilisateurs du compte.
GET https://admin.googleapis.com/admin/reports/v1/usage/users/all /dates/2013-03-03?maxResults=2
Dans l'exemple suivant, la requête permet de générer un rapport sur toutes les activités des utilisateurs d'un compte client spécifique.
GET https://admin.googleapis.com/admin/reports/v1/usage/users/all /dates/2013-03-03?customerId=C03az79cb
Dans l'exemple suivant, la requête permet de générer un rapport sur les codes temporels des dernières connexions des utilisateurs du compte. Pour obtenir un exemple de réponse d'API, consultez l'exemple de réponse JSON.
GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03 ?parameters=accounts:last_login_time&maxResults=2
L'exemple suivant permet d'obtenir un rapport sur les codes temporels des dernières connexions des utilisateurs du compte, après filtrage des utilisateurs qui se sont connectés après un certain délai. Pour obtenir un exemple de réponse d'API, consultez l'exemple de réponse JSON.
GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03 ?parameters=accounts:last_login_time&filters=accounts:last_login_time >2010-10-28T10:26:35.000Z"
L'exemple suivant permet d'obtenir un rapport sur l'horodatage des dernières connexions et l'état "Suspendu" des utilisateurs du compte. Pour obtenir un exemple de réponse d'API, consultez l'exemple de réponse JSON.
GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03 ?parameters=accounts:last_login_time,accounts:is_disabled"
Récupérer les activités d'utilisation d'un utilisateur spécifique
Pour récupérer un rapport sur les activités d'un utilisateur spécifique dans 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/users/userKey/dates/yyyy-mm-dd date ?parameters=application: user usage parameter,... &filters=application: user usage parameter relational operator usage parameter's value,... &maxResults=number of events listed on each page of the report
Le userKey peut être l'adresse e-mail principale de l'utilisateur dans le rapport ou son identifiant Google Workspace profileId unique. La valeur dates correspond à la date d'utilisation. L'horodatage est au format ISO 8601 (aaaa-mm-jj). Pour plus d'informations sur les paramètres de chaîne de requête et les propriétés de réponse, consultez la documentation de référence de l'API. Pour en savoir plus sur les paramètres du rapport sur l'utilisation de l'utilisateur, consultez la documentation de référence sur les paramètres d'utilisation de l'utilisateur.
Dans l'exemple suivant, la requête permet d'obtenir le rapport d'utilisation pour john@example.com.
https://admin.googleapis.com/admin/reports/v1/usage/users/john@example.com/dates/2013-03-03
Exemple de réponse JSON de rapport sur l'utilisation
Les appels réussis renvoient un code d'état HTTP 200. Avec le code d'état, la réponse renvoie un rapport.
Réponse JSON pour le rapport utilisateur
{
"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": "USER",
"customerId": "C03az79cb",
"userEmail": "liz@example.com",
"profileId": "user's unique Google Workspace ID"
},
"parameters": [
{
"name": "accounts:is_disabled",
"boolValue": false
},
{
"name": "accounts:disabled_reason",
"stringValue": "reason description"
},
{
"name": "accounts:first_name",
"stringValue": "Liz"
},
{
"name": "accounts:is_2sv_enforced",
"boolValue": false
},
{
"name": "accounts:is_2sv_enrolled",
"boolValue": false
},
{
"name": "accounts:last_name",
"stringValue": "Smith"
},
{
"name": "accounts:creation_time",
"datetimeValue": "2010-10-28T10:26:35.000Z"
},
{
"name": "accounts:last_login_time",
"datetimeValue": "1970-01-01T00:00:00.000Z"
},
{
"name": "accounts:last_sso_time",
"datetimeValue": "1970-01-01T00:00:00.000Z"
}
]
}
]
}