Gérer les événements utilisateur

Cette page explique comment afficher des informations sur les événements utilisateur et les supprimer définitivement.

Pour enregistrer des événements utilisateur en temps réel, consultez la page Enregistrer des événements utilisateur en temps réel. Pour importer des données d'événement utilisateur passées, consultez la section Importer un historique d'événements utilisateur.

Afficher les informations agrégées concernant les événements utilisateur

Vous pouvez consulter des informations sur les événements utilisateur enregistrés pour votre application dans la console Google Cloud, dans l'onglet Événements de la page Données de votre application.

Cette page affiche des informations telles que le nombre d'événements ingérés, le nombre d'événements non associés, le pourcentage de variation du nombre d'événements sur une période et le nombre moyen de type d'événement par document. De plus, vous pouvez consulter les métriques pour chaque type d'événement au fil du temps. Les métriques apparaissent environ 24 heures après la première importation d'événements dans les recommandations pour les contenus multimédias.

Pour afficher les informations sur vos événements utilisateur:

  1. Dans la console Google Cloud, accédez à la page Agent Builder.

    Agent Builder

  2. Cliquez sur le nom de l'application pour laquelle vous souhaitez afficher les informations sur les événements utilisateur.

  3. Sur la page Données, accédez à l'onglet Événements. Les informations sur les événements utilisateur s'affichent dans cet onglet.

Supprimer définitivement des événements utilisateur

Si certains de vos événements utilisateur n'ont pas été enregistrés correctement et que vous devez les supprimer, vous pouvez utiliser la méthode d'API userEvents.purge.

Spécifiez les événements que vous souhaitez supprimer à l'aide d'un filtre d'événements utilisateur. Vous pouvez utiliser le filtre d'événement utilisateur pour spécifier les événements que vous souhaitez supprimer définitivement. Vous pouvez filtrer avec les champs eventTime, eventType, visitorID et userID.

La purge ne pouvant pas être annulée, testez vos filtres en effectuant une simulation avant de supprimer les événements utilisateur. Le champ force est défini sur false par défaut. Ce paramètre permet de renvoyer le nombre d'événements à supprimer sans les supprimer. Lorsque vous êtes prêt à supprimer les événements utilisateur, définissez le champ force sur true.

Cet exemple permet de filtrer une période spécifique, qui doit être spécifiée au format date/heure Zulu. Le champ force est défini sur false.

curl -X POST \
  -H "Authorization: Bearer "$(gcloud auth application-default print-access-token)"" \
  -H "Content-Type: application/json; charset=utf-8" \
  --data '{
    "filter":"eventTime > \"2023-12-21T18:25:43.511Z\" eventTime < \"2023-12-21T18:30:43.511Z\"",
    "force":"false"
  }' \
  "https://discoveryengine.googleapis.com/v1/projects/PROJECT_NUMBER/locations/global/dataStores/DATA_STORE_ID/userEvents:purge"

Vous devriez recevoir un objet de réponse semblable à celui-ci, où purge-user-events-54321 est l'ID de l'opération:

{
  "name": "projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/operations/purge-user-events-54321"
}

Cet exemple demande l'état de l'opération :

curl -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
"https://discoveryengine.googleapis.com/v1/projects/PROJECT_NUMBER/locations/global/dataStores/DATA_STORE_ID/operations/OPERATION_ID"

Exemple d'état d'opération : 

{
  "name": "projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/operations/OPERATION_ID",
  "done": true,
  "response": {
    "@type": "type.googleapis.com/google.cloud.discoveryengine.v1.PurgeUserEventsResponse"
    "purgedEventsCount": "1"
  }
}

La définition du champ force sur true force la suppression.

curl -X POST \
  -H "Authorization: Bearer "$(gcloud auth application-default print-access-token)"" \
  -H "Content-Type: application/json; charset=utf-8" \
  --data '{
    "filter":"eventTime > \"2023-12-21T18:25:43.511Z\" eventTime < \"2023-12-21T18:30:43.511Z\"",
    "force":"true"
  }' \
"https://discoveryengine.googleapis.com/v1/projects/PROJECT_NUMBER/locations/global/dataStores/DATA_STORE_ID/userEvents:purge"

Utiliser le filtre d'événement utilisateur

Vous pouvez filtrer les événements utilisateur à supprimer.

Le filtre est une chaîne qui contient une ou plusieurs des restrictions suivantes :

  • eventTime: fournit un code temporel pour limiter les événements à supprimer. Ce filtre peut être spécifié une ou deux fois, accompagné d'un symbole supérieur à (>) ou inférieur à (<). La période spécifiée doit être un bloc unique contigu.

  • eventType: limite les événements à supprimer à un seul type d'événement.

  • visitorID: limite les événements à supprimer à un seul ID de visiteur.

  • userID: limite les événements à supprimer à un seul ID utilisateur.

Seuls les événements utilisateur qui satisfont toutes les restrictions sont supprimés.

Par exemple, pour supprimer tous les événements utilisateur de type add-to-cart qui ont été enregistrés le 1er février 2023 ou après cette date, vous devez fournir la chaîne de filtre suivante:

eventTime > "2023-02-01T00:00:00Z" eventType = add-to-cart

Étape suivante