Cette page a été traduite par l'API Cloud Translation.

Method: activities.watch

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
- Représentation JSON
Niveaux d'accès des autorisations
ApplicationName

Commencez à recevoir des notifications pour les activités du compte. Pour en savoir plus, consultez 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

Paramètres
`userKey or all`	`string` Représente l'ID du profil ou l'adresse e-mail de l'utilisateur pour lesquels 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. L'utilisateur ne doit pas avoir été 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.

userKey or all

string

Représente l'ID du profil ou l'adresse e-mail de l'utilisateur pour lesquels 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. L'utilisateur ne doit pas avoir été 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 de l'hôte sur lequel l'événement a été effectué. 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 ou non refléter l'emplacement physique de l'utilisateur. Par exemple, l'adresse IP peut être celle du serveur proxy de l'utilisateur ou celle d'un réseau privé virtuel (VPN). Ce paramètre est compatible avec les versions d'adresse 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 temporels 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 affichée dans le rapport. Le `startTime` doit être antérieur au `endTime` (le cas échéant) et à l'heure actuelle au moment de l'envoi de la requête. 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écapitulé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 à partir de `startTime` jusqu'à l'heure actuelle ou les 180 derniers jours 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écifiques, 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` de l'agenda signalées par l'API. Lorsqu'un administrateur modifie un paramètre Agenda, l'API signale cette activité dans les paramètres Agenda `type` et `eventName`. Pour en savoir plus sur les chaînes de requête et les paramètres `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 séparée par des virgules, 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 leurs 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é Drive suivants, la liste renvoyée se compose 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 dont la valeur `doc_id` est égale à `12345`. Dans le deuxième exemple, le rapport renvoie tous les documents modifiés dont 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". 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 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é affichés sur chaque page de réponse. Par exemple, si la requête 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 sur laquelle générer le rapport. Les journaux d'activité ne s'affichent que pour les utilisateurs appartenant à l'unité organisationnelle spécifiée. Les données antérieures au 17 décembre 2018 n'apparaissent pas dans les résultats filtrés.
`pageToken`	`string` Jeton permettant de spécifier la page suivante. Un rapport comportant plusieurs pages possède une propriété `nextPageToken` dans la réponse. Dans votre demande de récupération de 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 `startTime` et `endTime`. Le `startTime` doit être antérieur au `endTime` (le cas échéant) et à l'heure actuelle au moment de l'envoi de la requête. Sinon, l'API renvoie une erreur.
`groupIdFilter (deprecated)`	`string` `Deprecated`. Ce champ est obsolète et n'est plus accepté. ID de groupe (masqués) séparés par une virgule sur lesquels les activités des utilisateurs sont filtrées. Autrement dit, la réponse ne contiendra que les activités des utilisateurs qui font partie d'au moins l'un des ID de groupe mentionnés ici. Format : "id:abc123,id:xyz456" Important : Pour filtrer les résultats par groupe, vous devez ajouter explicitement les groupes à votre liste d'autorisation de groupes de filtrage. Pour savoir comment ajouter des groupes à la liste d'autorisation des groupes de filtrage, consultez Filtrer les résultats par groupe Google.

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 apportées aux 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 }

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 envoyé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 sous la forme d'un code temporel 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 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. Elle 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 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 ce canal de notification comme étant utilisé pour surveiller les modifications apportées à une ressource, qui est "`api#channel`".

Niveaux d'accès des autorisations

Requiert l'habilitation OAuth suivante :

https://www.googleapis.com/auth/admin.reports.audit.readonly

Pour en savoir plus, consultez le guide d'autorisation.

ApplicationName