Method: projects.locations.collections.dataStores.userEvents.purge

Supprime définitivement tous les événements utilisateur spécifiés par le filtre fourni. Selon le nombre d'événements spécifiés par le filtre, cette opération peut prendre plusieurs heures, voire plusieurs jours. Pour tester un filtre, utilisez d'abord la commande list.

Requête HTTP

POST https://discoveryengine.googleapis.com/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:purge

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de ressource du catalogue sous lequel les événements sont créés. Il a le format suivant : projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "filter": string,
  "force": boolean
}
Champs
filter

string

Obligatoire. Chaîne de filtre permettant de spécifier les événements à supprimer (limite de 5 000 caractères). Les champs éligibles pour le filtrage sont les suivants :

  • eventType : chaîne UserEvent.event_type entre guillemets doubles.
  • eventTime : au format ISO 8601 "zulu".
  • userPseudoId : chaîne entre guillemets doubles. Spécifier ce champ permet de supprimer tous les événements associés à un visiteur.
  • userId : chaîne entre guillemets doubles. Spécifier ce champ permet de supprimer tous les événements associés à un utilisateur.

Remarque : Cette API ne permet d'effacer que les données d'une période de 30 jours maximum.

Exemples :

  • Supprimer tous les événements d'une période : eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"
  • Supprimer un eventType spécifique dans une plage de temps : eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" eventType = "search"
  • Supprimer tous les événements d'un visiteur spécifique sur une période donnée : eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"
  • Supprimer les événements des 30 derniers jours dans un DataStore : *

Les champs de filtrage sont supposés avoir un AND implicite.
force

boolean

Le champ force n'est actuellement pas disponible. Les demandes de suppression définitive d'événements utilisateur suppriment définitivement tous les événements pouvant l'être. Une fois le développement terminé : si force est défini sur "false", la méthode renvoie le nombre de suppressions attendu sans supprimer d'événements utilisateur. Si ce champ n'est pas inclus dans la requête, la valeur par défaut sera "false".

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Operation.

Niveaux d'accès des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • discoveryengine.userEvents.purge

Pour en savoir plus, consultez la documentation IAM.