- 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
- ApplicationName
Commencez à recevoir des notifications concernant les activités du compte. Pour en savoir plus, consultez l'article Recevoir des notifications push.
Requête HTTP
POST https://admin.googleapis.com/admin/reports/v1/activity/users/{userKey or all}/applications/{applicationName}/watch
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
Paramètres | |
---|---|
userKey or all |
Représente l'ID du profil ou l'adresse e-mail de l'utilisateur pour lequel les données doivent être filtrées. Peut être |
applicationName |
Nom de l'application pour laquelle les événements doivent être récupérés. |
Paramètres de requête
Paramètres | |
---|---|
actorIpAddress |
Adresse IP (Internet Protocol) de l'hôte où l'événement s'est produit. Il s'agit d'un autre moyen de filtrer la synthèse d'un rapport à l'aide de l'adresse IP de l'utilisateur dont l'activité est signalée. Cette adresse IP peut ou non refléter la position géographique de l'utilisateur. Par exemple, l'adresse IP peut être l'adresse du serveur proxy de l'utilisateur ou celle d'un réseau privé virtuel (VPN). Ce paramètre est compatible avec les versions d'adresses IPv4 et IPv6. |
customerId |
Identifiant unique du client pour lequel récupérer les données. |
endTime |
Définit la fin de la période affichée dans le rapport. La date est au format RFC 3339, par exemple 2010-10-28T10:26:35.000Z. La valeur par défaut correspond à l'heure approximative de la requête API. Un rapport d'API comporte trois concepts de temps de base:
endTime n'est pas spécifié, le rapport renvoie toutes les activités depuis le startTime jusqu'à l'heure actuelle, ou les 180 derniers jours si la startTime date de plus de 180 jours.
|
eventName |
Nom de l'événement interrogé par l'API. Chaque |
filters |
La chaîne de requête Ces paramètres d'événement sont associés à un Dans les exemples d'activités Drive suivants, la liste renvoyée comprend tous les événements
Une requête
Remarque:L'API n'accepte pas plusieurs valeurs du même paramètre. Si un paramètre est fourni plusieurs fois dans la requête API, l'API n'accepte que la dernière valeur de ce paramètre. En outre, si un paramètre non valide est fourni dans la requête API, l'API ignore ce paramètre et renvoie la réponse correspondant aux autres paramètres valides. Si aucun paramètre n'est demandé, tous les paramètres sont renvoyés. |
maxResults |
Détermine le nombre d'enregistrements d'activité affichés sur chaque page de réponse. Par exemple, si la demande définit |
orgUnitID |
ID de l'unité organisationnelle concernée par le rapport. Les enregistrements d'activité ne seront affichés que pour les utilisateurs appartenant à l'unité organisationnelle spécifiée. |
pageToken |
Jeton pour spécifier la page suivante. Un rapport comportant plusieurs pages comporte une propriété |
startTime |
Définit le début de la période affichée dans le rapport. La date est au format RFC 3339, par exemple 2010-10-28T10:26:35.000Z. Le rapport renvoie toutes les activités entre le |
groupIdFilter |
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 contient une instance de SubscriptionChannel
.
Corps de la réponse
Canal de notification utilisé pour surveiller les modifications de ressources.
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
Représentation JSON |
---|
{ "id": string, "token": string, "expiration": string, "type": string, "address": string, "payload": boolean, "params": { string: string, ... }, "resourceId": string, "resourceUri": string, "kind": string } |
Champs | |
---|---|
id |
UUID ou chaîne unique similaire identifiant ce canal. |
token |
Chaîne arbitraire délivrée à l'adresse cible avec chaque notification envoyée sur ce canal. Facultatif. |
expiration |
Date et heure d'expiration du canal de notification, exprimées en code temporel Unix, en millisecondes. Facultatif. |
type |
Type de mécanisme de distribution utilisé pour ce canal. La valeur doit être définie sur |
address |
Adresse à laquelle les notifications sont envoyées pour ce canal. |
payload |
Valeur booléenne indiquant si la charge utile est souhaitée. Une charge utile est une donnée envoyée dans le corps d'un message HTTP POST, PUT ou PATCH, qui contient des informations importantes sur la requête. Facultatif. |
params |
Paramètres supplémentaires contrôlant le comportement du canal de distribution. Facultatif. Objet contenant une liste de paires |
resourceId |
ID opaque qui identifie la ressource surveillée sur ce canal. Stable dans les différentes versions de l'API. |
resourceUri |
Identifiant spécifique à la version de la ressource surveillée. |
kind |
Indique qu'il s'agit d'un canal de notification qui permet de surveiller les modifications apportées à une ressource, à savoir " |
Champs d'application des autorisations
Requiert le niveau d'accès OAuth suivant :
https://www.googleapis.com/auth/admin.reports.audit.readonly
Pour en savoir plus, consultez le Guide relatif aux autorisations.
ApplicationName
Nom de l'application pour laquelle les événements doivent être récupérés.
Enums | |
---|---|
access_transparency |
Les rapports d'activité Access Transparency de Google Workspace renvoient des informations sur les différents types d'événements d'activité Access Transparency. |
admin |
Les rapports d'activité de l'application de la console d'administration renvoient des informations de compte relatives aux différents types d'événements liés aux activités d'administration. |
calendar |
Les rapports d'activité de l'application Google Agenda renvoient des informations sur divers événements d'activité dans Google Agenda. |
chat |
Les rapports "Activité Chat" renvoient des informations sur divers événements d'activité Chat. |
drive |
Les rapports d'activité de l'application Google Drive contiennent des informations sur divers événements d'activité Google Drive. Le rapport sur l'activité Drive n'est disponible que pour les clients Google Workspace Business et Google Workspace Enterprise. |
gcp |
Les rapports d'activité de l'application Google Cloud Platform renvoient des informations sur divers événements d'activité GCP. |
gplus |
Les rapports d'activité de l'application Google+ renvoient des informations sur divers événements d'activité Google+. |
groups |
Les rapports d'activité de l'application Google Groupes renvoient des informations sur divers événements d'activité Google Groupes. |
groups_enterprise |
Les rapports sur l'activité des groupes Enterprise renvoient des informations sur divers événements d'activité des groupes d'entreprise. |
jamboard |
Les rapports sur l'activité Jamboard renvoient des informations sur divers événements d'activité Jamboard. |
login |
Les rapports d'activité de l'application de connexion renvoient des informations de compte relatives à différents types d'événements de connexion. |
meet |
Le rapport sur les activités d'audit Meet contient des informations sur les différents types d'événements d'audit Meet. |
mobile |
Le rapport "Activité d'audit des appareils" contient des informations sur les différents types d'événements liés à l'audit des appareils. |
rules |
Le rapport "Activité liée aux règles" affiche des informations sur les différents types d'événements liés aux règles. |
saml |
Le rapport d'activité SAML renvoie des informations sur les différents types d'événements d'activité SAML. |
token |
Les rapports "Activité des jetons" renvoient des informations de compte sur les différents types d'événements liés à l'activité des jetons. |
user_accounts |
Les rapports d'activité de l'application Comptes utilisateur renvoient des informations sur les différents types d'événements liés à l'activité des comptes utilisateur. |
context_aware_access |
Les rapports d'activité d'accès contextuel renvoient des informations sur l'état Accès refusé en raison des règles d'accès contextuel |
chrome |
Les rapports d'activité Chrome renvoient des informations sur les événements du navigateur Chrome et de Chrome OS. |
data_studio |
Les rapports sur l'activité Data Studio renvoient des informations sur les différents types d'événements Data Studio. |
keep |
Les rapports d'activité de l'application Keep contiennent des informations sur divers événements d'activité Google Keep. Le rapport sur l'activité Keep est uniquement disponible pour les clients Google Workspace Business et Enterprise. |