Method: activities.list

Récupère la liste des activités pour le compte et l'application d'un client spécifique, comme l'application de la console d'administration ou l'application Google Drive. Pour en savoir plus, consultez les guides sur les rapports sur l'activité des administrateurs et de Google Drive. Pour en savoir plus sur les paramètres du rapport sur l'activité, consultez les guides de référence sur les paramètres d'activité.

Requête HTTP

GET https://admin.googleapis.com/admin/reports/v1/activity/users/{userKey or all}/applications/{applicationName}

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 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 ou l'adresse e-mail principale d'un utilisateur. 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 de l'hôte où l'événement a été effectué. Il s'agit d'un moyen supplémentaire de filtrer le résumé d'un rapport à l'aide de l'adresse IP de l'utilisateur dont l'activité est enregistrée. Cette adresse IP peut ou non refléter l'emplacement physique de l'utilisateur. Par exemple, l'adresse IP peut correspondre à 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'adresses IPv4 et IPv6.

customerId

string

Identifiant unique du client pour lequel vous souhaitez récupérer des 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 temporels de base:

  • Date de la requête de l'API pour un rapport: 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 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é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 du startTime à l'heure actuelle ou les 180 derniers jours si la date startTime est antérieure à 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 Agenda contient toutes les activités eventName Agenda signalées par l'API. Lorsqu'un administrateur modifie un paramètre Agenda, l'API enregistre 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 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 sur les paramètres associés, accédez à la table ApplicationName, puis cliquez sur la page "Événements d'activité" de l'annexe pour l'application de votre choix.

Dans les exemples d'activités Drive suivants, la liste renvoyée comprend 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é 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 est compatible avec les opérateurs relationnels suivants:

  • == : "égal à".
  • <> : "non égal à". Doit être encodé au format URL (%3C%3E).
  • < : "moins que". 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 l'ignore 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 requête définit maxResults=1 et que le rapport comporte deux activités, le rapport 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

string

ID de l'unité organisationnelle à inclure dans le rapport. Les enregistrements d'activité ne s'affichent 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 contient une propriété nextPageToken dans la réponse. Dans la requête de suivi permettant d'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 de startTime à endTime. Le startTime doit être antérieur au endTime (le cas échéant) et à l'heure actuelle au moment de la requête, sinon l'API renvoie une erreur.

groupIdFilter

string

ID de groupe (masqués) sur lesquels les activités des utilisateurs sont filtrées, c'est-à-dire que la réponse ne contiendra que les activités des utilisateurs appartenant à au moins l'un des ID de groupe mentionnés ici. Format: "id:abc123,id:xyz456"

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Modèle JSON pour une collection d'activités.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON
{
  "kind": string,
  "etag": string,
  "items": [
    {
      object (Activity)
    }
  ],
  "nextPageToken": string
}
Champs
kind

string

Type de ressource d'API. Pour un rapport sur l'activité, la valeur est reports#activities.

etag

string

ETag de la ressource.

items[]

object (Activity)

Chaque enregistrement d'activité de la réponse.

nextPageToken

string

Jeton permettant de récupérer la page suivante du rapport. La valeur nextPageToken est utilisée dans la chaîne de requête pageToken de la requête.

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 d'autorisation.

ApplicationName

Enums
access_transparency

Les rapports sur l'activité Access Transparency Google Workspace fournissent des informations sur différents types d'événements liés aux activités dans Access Transparency.

admin

Les rapports sur l'activité de l'application de la console d'administration renvoient des informations sur le compte concernant différents types d'événements d'activité des administrateurs.

calendar

Les rapports d'activité de l'application Google Agenda fournissent des informations sur différents événements d'activité Agenda.

chat Les rapports sur l'activité Chat fournissent des informations sur différents événements d'activité Chat.
drive

Les rapports d'activité de l'application Google Drive fournissent des informations sur différents événements d'activité Google Drive. Le rapport "Activité dans Drive" n'est disponible que pour les clients Google Workspace Business et 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+ fournissent des informations sur différents événements d'activité Google+.
groups

Les rapports d'activité de l'application Google Groups fournissent des informations sur différents événements d'activité Groups.

groups_enterprise

Les rapports sur l'activité des groupes Enterprise renvoient des informations sur différents événements liés aux activités des groupes Enterprise.

jamboard Les rapports sur l'activité Jamboard renvoient des informations sur différents événements d'activité Jamboard.
login

Les rapports sur l'activité de l'application de connexion renvoient des informations sur le compte concernant différents types d'événements d'activité de connexion.

meet Le rapport sur l'activité de l'audit Meet fournit des informations sur différents types d'événements d'activité de l'audit Meet.
mobile Le rapport sur l'activité d'audit de l'appareil fournit des informations sur différents types d'événements d'activité d'audit de l'appareil.
rules

Le rapport "Activité des règles" fournit des informations sur différents types d'événements d'activité des règles.

saml

Le rapport sur l'activité SAML fournit des informations sur différents types d'événements d'activité SAML.

token

Les rapports sur l'activité de l'application de jetons renvoient des informations sur le compte concernant différents types d'événements d'activité des jetons.

user_accounts

Les rapports d'activité de l'application Comptes utilisateur renvoient des informations sur le compte concernant différents types d'événements d'activité des comptes utilisateur.

context_aware_access

Les rapports sur l'activité d'accès contextuel renvoient des informations sur les événements d'accès refusés des utilisateurs en raison de règles d'accès contextuel.

chrome

Les rapports sur l'activité Chrome fournissent 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 différents types d'événements d'activité Data Studio.
keep Les rapports d'activité de l'application Keep fournissent des informations sur différents événements d'activité Google Keep. Le rapport sur l'activité Keep n'est disponible que pour les clients Google Workspace Business et Enterprise.
vault Les rapports sur l'activité Vault renvoient des informations sur différents types d'événements d'activité Vault.
gemini_in_workspace_apps Les rapports sur l'activité Gemini pour Workspace fournissent des informations sur différents types d'événements d'activité Gemini effectués par les utilisateurs dans une application Workspace.

Activité

Modèle JSON pour la ressource d'activité.

Représentation JSON
{
  "kind": string,
  "etag": string,
  "ownerDomain": string,
  "ipAddress": string,
  "events": [
    {
      "type": string,
      "name": string,
      "parameters": [
        {
          "messageValue": {
            "parameter": [
              {
                object (NestedParameter)
              }
            ]
          },
          "name": string,
          "value": string,
          "multiValue": [
            string
          ],
          "intValue": string,
          "multiIntValue": [
            string
          ],
          "boolValue": boolean,
          "multiMessageValue": [
            {
              "parameter": [
                {
                  object (NestedParameter)
                }
              ]
            }
          ]
        }
      ],
      "resourceIds": [
        string
      ]
    }
  ],
  "id": {
    "time": string,
    "uniqueQualifier": string,
    "applicationName": string,
    "customerId": string
  },
  "actor": {
    "profileId": string,
    "email": string,
    "callerType": string,
    "key": string,
    "applicationInfo": {
      "oauthClientId": string,
      "applicationName": string,
      "impersonation": boolean
    }
  },
  "resourceDetails": [
    {
      object (ResourceDetails)
    }
  ]
}
Champs
kind

string

Type de ressource d'API. Pour un rapport sur l'activité, la valeur est audit#activity.

etag

string

ETag de l'entrée.

ownerDomain

string

Il s'agit du domaine concerné par l'événement du rapport. Par exemple, le domaine de la console d'administration ou le propriétaire du document de l'application Drive.

ipAddress

string

Adresse IP de l'utilisateur effectuant l'action. Il s'agit de l'adresse IP de l'utilisateur lorsqu'il se connecte à Google Workspace. Elle peut ou non refléter sa position géographique. Par exemple, l'adresse IP peut correspondre à celle du serveur proxy de l'utilisateur ou à celle d'un réseau privé virtuel (VPN). L'API est compatible avec IPv4 et IPv6.

events[]

object

Événements d'activité dans le rapport.

events[].type

string

Type d'événement. Le service ou la fonctionnalité Google Workspace qu'un administrateur modifie est identifié dans la propriété type, qui identifie un événement à l'aide de la propriété eventName. Pour obtenir la liste complète des catégories type de l'API, consultez la liste des noms d'événements pour différentes applications ci-dessus dans applicationName.

events[].name

string

Nom de l'événement. Il s'agit du nom spécifique de l'activité signalée 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.
Pour les paramètres de requête eventName en général:

  • Si aucun eventName n'est fourni, le rapport renvoie toutes les instances possibles d'un eventName.
  • Lorsque vous demandez un eventName, la réponse de l'API renvoie toutes les activités qui contiennent ce eventName.

Pour en savoir plus sur les propriétés eventName, consultez la liste des noms d'événements pour différentes applications ci-dessus dans applicationName.

events[].parameters[]

object

Paires de valeurs de paramètres pour diverses applications. Pour en savoir plus sur les paramètres eventName, consultez la liste des noms d'événements pour différentes applications ci-dessus dans applicationName.

events[].parameters[].messageValue

object

Paires de valeurs de paramètres imbriquées associées à ce paramètre. Le type de valeur complexe d'un paramètre est renvoyé sous la forme d'une liste de valeurs de paramètre. Par exemple, le paramètre d'adresse peut avoir la valeur [{parameter: [{name: city, value: abc}]}].

events[].parameters[].messageValue.parameter[]

object (NestedParameter)

Valeurs de paramètres

events[].parameters[].name

string

Nom du paramètre.

events[].parameters[].value

string

Valeur de la chaîne du paramètre.

events[].parameters[].multiValue[]

string

Valeurs de chaîne du paramètre.

events[].parameters[].intValue

string (int64 format)

Valeur entière du paramètre.

events[].parameters[].multiIntValue[]

string (int64 format)

Valeurs entières du paramètre.

events[].parameters[].boolValue

boolean

Valeur booléenne du paramètre.

events[].parameters[].multiMessageValue[]

object

activities.list d'objets messageValue.

events[].parameters[].multiMessageValue[].parameter[]

object (NestedParameter)

Valeurs de paramètres

events[].resourceIds[]

string

ID de ressource associés à l'événement.

id

object

Identifiant unique de chaque enregistrement d'activité.

id.time

string

Heure de l'activité. Il s'agit de l'epoch UNIX en secondes.

id.uniqueQualifier

string (int64 format)

Qualificateur unique si plusieurs événements ont la même heure.

id.applicationName

string

Nom de l'application à laquelle l'événement appartient. Pour connaître les valeurs possibles, consultez la liste des applications ci-dessus dans applicationName.

id.customerId

string

Identifiant unique d'un compte Google Workspace.

actor

object

Utilisateur effectuant l'action

actor.profileId

string

ID de profil Google Workspace unique de l'acteur. Cette valeur peut être absente si l'acteur n'est pas un utilisateur Google Workspace, ou correspondre au numéro 105250506097979753968, qui sert d'ID d'espace réservé.

actor.email

string

Adresse e-mail principale de l'acteur. Peut être absent si aucune adresse e-mail n'est associée à l'acteur.

actor.callerType

string

Type d'acteur.

actor.key

string

N'est présente que si callerType est KEY. Peut être l'consumer_key de l'auteur de la requête pour les requêtes d'API OAuth 2LO ou un identifiant pour les comptes robot.

actor.applicationInfo

object

Détails de l'application qui était l'acteur de l'activité.

actor.applicationInfo.oauthClientId

string

ID client OAuth de l'application tierce utilisée pour effectuer l'action.

actor.applicationInfo.applicationName

string

Nom de l'application utilisée pour effectuer l'action.

actor.applicationInfo.impersonation

boolean

Indique si l'application usurpait l'identité d'un utilisateur.

resourceDetails[]

object (ResourceDetails)

Détails de la ressource sur laquelle l'action a été effectuée.

ResourceDetails

Détails de la ressource sur laquelle l'action a été effectuée.

Représentation JSON
{
  "id": string,
  "title": string,
  "type": string,
  "appliedLabels": [
    {
      object (AppliedLabel)
    }
  ],
  "relation": string
}
Champs
id

string

Identifiant de la ressource.

title

string

Titre de la ressource. Par exemple, dans le cas d'un document Drive, il s'agit du titre du document. Dans le cas d'un e-mail, il s'agit de l'objet.

type

string

Type de ressource : document, e-mail, message de chat

appliedLabels[]

object (AppliedLabel)

activities.list des libellés appliqués à la ressource

relation

string

Définit la relation de la ressource aux événements

AppliedLabel

Détails du libellé appliqué à la ressource.

Représentation JSON
{
  "id": string,
  "title": string,
  "fieldValues": [
    {
      object (FieldValue)
    }
  ],
  "reason": {
    object (Reason)
  }
}
Champs
id

string

Identifiant du libellé : uniquement l'ID du libellé, et non le nom complet de la ressource OnePlatform.

title

string

Titre du libellé

fieldValues[]

object (FieldValue)

activities.list Liste des champs qui font partie du libellé et qui ont été définis par l'utilisateur. Si le libellé comporte un champ qui n'a pas été défini par l'utilisateur, il ne figurera pas dans cette liste.

reason

object (Reason)

Raison pour laquelle le libellé a été appliqué à la ressource.

FieldValue

Détails de la valeur du champ définie par l'utilisateur pour le libellé en question.

Représentation JSON
{
  "id": string,
  "displayName": string,
  "type": string,
  "reason": {
    object (Reason)
  },

  // Union field value can be only one of the following:
  "unsetValue": boolean,
  "longTextValue": string,
  "textValue": string,
  "textListValue": {
    object (TextListValue)
  },
  "selectionValue": {
    object (SelectionValue)
  },
  "selectionListValue": {
    object (SelectionListValue)
  },
  "integerValue": string,
  "userValue": {
    object (UserValue)
  },
  "userListValue": {
    object (UserListValue)
  },
  "dateValue": {
    object (Date)
  }
  // End of list of possible types for union field value.
}
Champs
id

string

Identifiant du champ

displayName

string

Nom à afficher du champ

type

string

Type du champ

reason

object (Reason)

Raison pour laquelle le champ a été appliqué au libellé.

Champ d'union value. Stocke les valeurs stockées dans le champ value, qui ne peut être que l'une des valeurs suivantes:
unsetValue

boolean

Si le champ n'est pas défini, cette valeur est "true".

longTextValue

string

Définir une valeur textuelle longue

textValue

string

Définir une valeur de texte.

textListValue

object (TextListValue)

Définir une valeur de liste de texte

selectionValue

object (SelectionValue)

Définir une valeur de sélection en sélectionnant une seule valeur dans une liste déroulante.

selectionListValue

object (SelectionListValue)

Définir une valeur de liste de sélection en sélectionnant plusieurs valeurs dans une liste déroulante.

integerValue

string (int64 format)

Définir une valeur entière.

userValue

object (UserValue)

Définir une valeur utilisateur en sélectionnant un seul utilisateur.

userListValue

object (UserListValue)

Définir une valeur de liste d'utilisateurs en sélectionnant plusieurs utilisateurs.

dateValue

object (Date)

Définir une valeur de date.

TextListValue

Définir une valeur de liste de texte

Représentation JSON
{
  "values": [
    string
  ]
}
Champs
values[]

string

activities.list de valeurs textuelles.

SelectionValue

Définir une valeur de sélection en sélectionnant une seule valeur dans une liste déroulante.

Représentation JSON
{
  "id": string,
  "displayName": string,
  "badged": boolean
}
Champs
id

string

Identifiant de la sélection.

displayName

string

Nom à afficher de la sélection.

badged

boolean

Indique si la sélection est associée à un badge.

SelectionListValue

Définir une valeur de liste de sélection en sélectionnant plusieurs valeurs dans une liste déroulante.

Représentation JSON
{
  "values": [
    {
      object (SelectionValue)
    }
  ]
}
Champs
values[]

object (SelectionValue)

activities.list of selections.

UserValue

Définir une valeur utilisateur en sélectionnant un seul utilisateur.

Représentation JSON
{
  "email": string
}
Champs
email

string

Adresse e-mail de l'utilisateur.

UserListValue

Définir une valeur de liste d'utilisateurs en sélectionnant plusieurs utilisateurs.

Représentation JSON
{
  "values": [
    {
      object (UserValue)
    }
  ]
}
Champs
values[]

object (UserValue)

activities.list des utilisateurs.

Date

Représente une date du calendrier entière ou partielle, par exemple un anniversaire. L'heure de la journée et le fuseau horaire sont spécifiés ailleurs, ou ne sont pas significatifs. La date est donnée selon le calendrier grégorien. Il peut s'agir de l'un des éléments suivants:

  • Une date complète, avec des valeurs non nulles pour l'année, le mois et le jour.
  • un mois et un jour, avec une année nulle (par exemple, un anniversaire).
  • une année seule, avec un mois et un jour nuls ;
  • Une année et un mois, avec un jour zéro (par exemple, la date d'expiration d'une carte de crédit).

Types associés :

Représentation JSON
{
  "year": integer,
  "month": integer,
  "day": integer
}
Champs
year

integer

Année de la date. Elle doit être comprise entre 1 et 9999, ou égale à 0 si vous spécifiez une date sans année.

month

integer

Mois d'une année. Il doit être compris entre 1 et 12, ou égal à 0 pour spécifier une année sans mois ni jour.

day

integer

Jour d'un mois. Il doit être compris entre 1 et 31, et valide pour l'année et le mois, ou égal à 0 pour spécifier une année seule, ou une année et un mois où le jour n'est pas significatif.

Motif

Raison pour laquelle le libellé/champ a été appliqué.

Représentation JSON
{
  "reasonType": string
}
Champs
reasonType

string

Type de la raison.