Method: activities.watch

Commencez à recevoir des notifications concernant les activités du compte. Pour en savoir plus, consultez la section 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 de profil ou l'adresse e-mail de l'utilisateur pour lesquels les données doivent être filtrées. Il peut s'agir de all pour toutes les informations, ou de 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 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 moyen supplémentaire de filtrer le récapitulatif d'un rapport à l'aide de l'adresse IP de l'utilisateur dont l'activité est signalée. Cette adresse IP peut refléter ou non la position géographique de l'utilisateur. Il peut s'agir, par exemple, de l'adresse du serveur proxy d'un utilisateur ou de celle d'un réseau privé virtuel (VPN). Ce paramètre est compatible avec les adresses IPv4 et IPv6.
customerId

string

Identifiant unique du client pour lequel extraire 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 est l'heure approximative de la requête API. Un rapport d'API comporte trois concepts de base concernant le temps:

  • Date de la demande de rapport par 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 affichée dans le rapport. startTime doit se trouver avant endTime (si elle est spécifiée) et l'heure actuelle à laquelle la requête est effectuée. Sinon, l'API renvoie une erreur.
  • Heure de fin du rapport: fin de la période affiché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 lui-même peut être demandé en 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 jours les plus récents si startTime remonte à 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. (par exemple, les événements Google Agenda 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 enregistre cette activité dans les paramètres type et eventName des paramètres d'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 dans applicationName ci-dessus.
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 requête 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 cliquez sur la page "Événements d'activité" dans l'annexe de l'application de votre choix.

Dans les exemples d'activités Drive suivants, la liste renvoyée est constituée de tous les événements edit où 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é au format 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 est compatible avec les opérateurs relationnels suivants:

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

Remarque:L'API n'accepte pas plusieurs valeurs pour le 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. De plus, si un paramètre non valide est fourni dans la requête API, l'API l'ignore et renvoie la réponse correspondant aux paramètres valides restants. Si aucun paramètre n'est demandé, tous les paramètres sont renvoyés.
maxResults

integer

Détermine le nombre d'enregistrements d'activité à afficher 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 permettant d'accéder à 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 à inclure dans le rapport. Les enregistrements d'activité ne sont affichés que pour les utilisateurs appartenant à l'unité organisationnelle spécifiée.

pageToken

string

Jeton permettant de spécifier la page suivante. Un rapport comportant plusieurs pages comporte une propriété nextPageToken dans la réponse. Dans la demande suivante pour 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 du startTime au endTime. startTime doit se trouver avant endTime (si elle est spécifiée) et l'heure actuelle à laquelle la requête est effectuée. Sinon, l'API renvoie une erreur.
groupIdFilter

string

ID des groupes (obscurcis) séparés par une virgule sur lesquels les activités de l'utilisateur sont filtrées. La réponse ne contiendra alors les activités que pour les utilisateurs faisant partie d'au moins l'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 SubscriptionChannel.

Corps de la réponse

Canal de notification utilisé pour surveiller les modifications des 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 transmise à l'adresse cible avec chaque notification transmise sur ce canal. Facultatif.
expiration

string (int64 format)

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

string

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

string

Adresse à laquelle les notifications sont envoyées pour cette chaîne.
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 des canaux de diffusion. 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 différentes versions de l'API.
resourceUri

string

Identifiant spécifique à la version pour la ressource surveillée.
kind

string

Identifie ceci comme un canal de notification utilisé pour surveiller les modifications apportées à une ressource, qui est "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 liés aux activités Access Transparency.
admin

Les rapports d'activité de l'application de la console d'administration affichent des informations sur le compte concernant les différents types d'événements liés aux activités de l'administrateur.
calendar

Les rapports d'activité de l'application Google Agenda renvoient des informations sur différents événements d'activité de Google Agenda.
chat Les rapports d'activité Chat contiennent des informations sur divers événements d'activité Chat.
drive

Les rapports d'activité de l'application Google Drive renvoient des informations sur divers événements d'activité Google Drive. Le rapport d'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 différents é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é Groupes.
groups_enterprise

Les rapports d'activité des groupes d'entreprise contiennent des informations sur différents événements d'activité des groupes d'entreprise.
jamboard Les rapports d'activité Jamboard renvoient des informations sur divers événements liés à l'activité Jamboard.
login

Les rapports d'activité de l'application Login renvoient des informations sur le compte concernant les différents types d'événements liés à l'activité de connexion.
meet Le rapport d'activité d'audit Meet renvoie des informations sur les différents types d'événements d'audit Meet.
mobile Le rapport "Activité d'audit des appareils" renvoie des informations sur les différents types d'événements d'audit des appareils.
rules

Le rapport sur l'activité des règles renvoie des informations sur les différents types d'événements liés à l'activité des 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 d'activité de l'application de jetons renvoient des informations sur le compte concernant 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 sur l'activité de l'accès contextuel renvoient des informations sur les événements d'accès refusé des utilisateurs en raison des règles d'accès contextuel.
chrome

Les rapports d'activité Chrome fournissent des informations sur les événements liés au navigateur Chrome et à Chrome OS.
data_studio Les rapports d'activité Data Studio renvoient des informations sur différents types d'événements d'activité Data Studio.
keep Les rapports d'activité de l'application Keep renvoient des informations sur différents événements d'activité Google Keep. Le rapport d'activité Keep n'est disponible que pour les clients Google Workspace Business et Google Workspace Enterprise.