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

Borra de forma permanente todos los eventos del usuario especificados por el filtro proporcionado. Según la cantidad de eventos especificados por el filtro, esta operación podría tardar horas o días en completarse. Para probar un filtro, primero usa el comando list.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

Obligatorio. Es el nombre del recurso del catálogo en el que se crean los eventos. El formato es projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "filter": string,
  "force": boolean
}
Campos
filter

string

Obligatorio. Es la cadena de filtro para especificar los eventos que se borrarán, con un límite de 5,000 caracteres. Estos son los campos aptos para filtrar:

  • eventType: Cadena UserEvent.event_type entre comillas dobles.
  • eventTime: En formato ISO 8601 “zulu”.
  • userPseudoId: Cadena entre comillas dobles. Si especificas esto, se borrarán todos los eventos asociados con un visitante.
  • userId: Cadena entre comillas dobles. Si especificas esto, se borrarán todos los eventos asociados con un usuario.

Nota: Esta API solo admite la purga de un rango máximo de 30 días.

Ejemplos:

  • Cómo borrar todos los eventos en un período: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"
  • Borra un eventType específico en un período: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" eventType = "search"
  • Borra todos los eventos de un visitante específico en un período: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"
  • Borra los eventos de los últimos 30 días dentro de un DataStore: *

Se supone que los campos de filtrado tienen un AND implícito.
force

boolean

Actualmente, no se admite el campo force. Las solicitudes de borrado definitivo de eventos de usuario borrarán de forma permanente todos los eventos que se puedan borrar definitivamente. Una vez que se complete el desarrollo, si force se establece como falso, el método devolverá el recuento de eliminación previsto sin borrar los eventos del usuario. Si no se incluye en la solicitud, el valor predeterminado de este campo será falso.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Operation.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • discoveryengine.userEvents.purge

Para obtener más información, consulta la documentación de IAM.