Method: activities.watch

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

string

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 all pour toutes les informations, ou userKey pour l'ID de profil Google Workspace unique d'un utilisateur ou son adresse e-mail principale. Il ne doit pas s'agir d'un compte utilisateur supprimé. Pour un utilisateur supprimé, appelez users.list dans l'API Directory avec showDeleted=true, puis utilisez le ID renvoyé comme userKey.

applicationName

enum (ApplicationName)

Nom de l'application pour laquelle les événements doivent être récupérés.

Paramètres de requête

Paramètres
actorIpAddress

string

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

string

Identifiant unique du client pour lequel récupérer les données.

endTime

string

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:

  • Date de la demande de rapport de l'API: date à laquelle l'API a créé et récupéré le rapport.
  • Heure de début du rapport: début de la période indiquée dans le rapport. La valeur startTime doit être antérieure à la valeur endTime (si spécifiée) et à l'heure actuelle à laquelle la requête est effectuée. Dans le cas contraire, l'API renvoie une erreur.
  • Heure de fin du rapport: fin de la période indiquée dans le rapport. Par exemple, la période des événements résumés dans un rapport peut commencer en avril et se terminer en mai. Le rapport en lui-même sera disponible au mois d'août.
Si 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

string

Nom de l'événement interrogé par l'API. Chaque eventName est associé à un service ou à une fonctionnalité Google Workspace spécifique que l'API organise en types d'événements. C'est le cas, par exemple, des événements Google Agenda affichés dans les rapports de l'application de la console d'administration. La structure type des paramètres d'agenda contient toutes les activités eventName d'Agenda signalées par l'API. Lorsqu'un administrateur modifie un paramètre Agenda, l'API signale cette activité dans les paramètres type et eventName des paramètres Agenda. Pour en savoir plus sur les chaînes et les paramètres de requête eventName, consultez la liste des noms d'événements pour différentes applications ci-dessus dans applicationName.

filters

string

La chaîne de requête filters est une liste d'éléments séparés par une virgule composée de paramètres d'événement manipulés par des opérateurs relationnels. Les paramètres d'événement sont au format {parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...

Ces paramètres d'événement sont associés à un eventName spécifique. Un rapport vide est renvoyé si le paramètre de la demande n'appartient pas à eventName. Pour en savoir plus sur les champs eventName disponibles pour chaque application et les paramètres associés, accédez au tableau ApplicationName, puis à la page "Activity Events" (Événements d'activité) de l'annexe de l'application souhaitée.

Dans les exemples d'activités Drive suivants, la liste renvoyée comprend tous les événements edit pour lesquels la valeur du paramètre doc_id correspond aux conditions définies par l'opérateur relationnel. Dans le premier exemple, la requête renvoie tous les documents modifiés avec une valeur doc_id égale à 12345. Dans le deuxième exemple, le rapport renvoie tous les documents modifiés pour lesquels la valeur doc_id n'est pas égale à 98765. L'opérateur <> est encodé en URL dans la chaîne de requête de la requête (%3C%3E):

GET...&eventName=edit&filters=doc_id==12345
GET...&eventName=edit&filters=doc_id%3C%3E98765

Une requête filters accepte les opérateurs relationnels suivants:

  • == : "égal à".
  • <> : "différent de". Doit être encodé au format URL (%3C%3E).
  • < : "inférieur à". Doit être encodé au format URL (%3C).
  • <= : "inférieur ou égal à". Doit être encodé au format URL (%3C=).
  • > : "supérieur à". Doit être encodé au format URL (%3E).
  • >= : "supérieur ou égal à". Doit être encodé au format URL (%3E=).

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

integer

Détermine le nombre d'enregistrements d'activité affichés sur chaque page de réponse. Par exemple, si la demande définit maxResults=1 et que le rapport comporte deux activités, il 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 dans la requête. La valeur par défaut est 1 000.

orgUnitID
(deprecated)

string

Deprecated Ce champ est obsolète et n'est plus accepté.

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

string

Jeton pour spécifier la page suivante. Un rapport comportant plusieurs pages comporte une propriété nextPageToken dans la réponse. Dans votre demande de suivi visant à obtenir la page suivante du rapport, saisissez la valeur nextPageToken dans la chaîne de requête pageToken.

startTime

string

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 startTime et le endTime. La valeur startTime doit être antérieure à la valeur endTime (si spécifiée) et à l'heure actuelle à laquelle la requête est effectuée. Dans le cas contraire, l'API renvoie une erreur.

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 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

string

UUID ou chaîne unique similaire identifiant ce canal.

token

string

Chaîne arbitraire délivrée à l'adresse cible avec chaque notification envoyée sur ce canal. Facultatif.

expiration

string (int64 format)

Date et heure d'expiration du canal de notification, exprimées en code temporel Unix, en millisecondes. Facultatif.

type

string

Type de mécanisme de distribution utilisé pour ce canal. La valeur doit être définie sur "web_hook".

address

string

Adresse à laquelle les notifications sont envoyées pour ce canal.

payload

boolean

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

map (key: string, value: string)

Paramètres supplémentaires contrôlant le comportement du canal de distribution. Facultatif.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

resourceId

string

ID opaque qui identifie la ressource surveillée sur ce canal. Stable dans les différentes versions de l'API.

resourceUri

string

Identifiant spécifique à la version de la ressource surveillée.

kind

string

Indique qu'il s'agit d'un canal de notification qui permet de surveiller les modifications apportées à une ressource, à savoir "api#channel".

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.