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

Exclui permanentemente todos os eventos de usuário especificados pelo filtro fornecido. Dependendo do número de eventos especificados pelo filtro, essa operação pode levar horas ou dias para ser concluída. Para testar um filtro, use primeiro o comando "list".

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso do catálogo em que os eventos são criados. O formato é projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "filter": string,
  "force": boolean
}
Campos
filter

string

Obrigatório. A string de filtro para especificar os eventos a serem excluídos com um limite de 5.000 caracteres. Os campos qualificados para filtragem são:

  • eventType: string UserEvent.event_type entre aspas duplas.
  • eventTime: no formato "zulu" ISO 8601.
  • userPseudoId: string entre aspas duplas. Especificar essa opção exclui todos os eventos associados a um visitante.
  • userId: string entre aspas duplas. Especificar essa opção exclui todos os eventos associados a um usuário.

Observação: essa API só permite limpar um período máximo de 30 dias.

Exemplos:

  • Excluir todos os eventos em um período: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"
  • Excluir um eventType específico em um período: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" eventType = "search"
  • Excluir todos os eventos de um visitante específico em um período: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"
  • Excluir os eventos dos últimos 30 dias em um DataStore: *

Os campos de filtragem têm um AND implícito.
force

boolean

No momento, o campo force não é compatível. As solicitações de limpeza de eventos de usuário excluem permanentemente todos os eventos que podem ser limpos. Depois que o desenvolvimento for concluído: se force estiver definido como "false", o método vai retornar a contagem de limpeza esperada sem excluir eventos de usuário. O padrão desse campo é "false" se ele não for incluído na solicitação.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • discoveryengine.userEvents.purge

Para mais informações, consulte a documentação do IAM.