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

Elimina permanentemente todos os eventos do utilizador especificados pelo filtro fornecido. Consoante o número de eventos especificados pelo filtro, esta operação pode demorar horas ou dias a ser concluída. Para testar um filtro, use primeiro o comando list.

Pedido HTTP

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

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

Parâmetros de caminho

Parâmetros
parent

string

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

Corpo do pedido

O corpo do pedido 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 eliminar com um limite de comprimento de 5000 carateres. Os campos elegíveis para filtragem são:

  • eventType: String UserEvent.event_type entre aspas duplas.
  • eventTime: no formato "zulu" da norma ISO 8601.
  • userPseudoId: string entre aspas duplas. Se especificar esta opção, elimina todos os eventos associados a um visitante.
  • userId: string entre aspas duplas. Se especificar esta opção, elimina todos os eventos associados a um utilizador.

Nota: esta API só suporta a eliminação de um intervalo máximo de 30 dias.

Exemplos:

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

Assume-se que os campos de filtragem têm um AND implícito.
force

boolean

O campo force não é atualmente suportado. Os pedidos de remoção completa de eventos do utilizador eliminam permanentemente todos os eventos removíveis. Quando o desenvolvimento estiver concluído: se force estiver definido como falso, o método devolve a quantidade de eliminação esperada sem eliminar eventos do utilizador. Este campo reverte para a predefinição false se não for incluído no pedido.

Corpo da resposta

Se for bem-sucedido, o corpo da resposta contém uma instância de Operation.

Âmbitos de autorização

Requer um dos seguintes âmbitos 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 o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso parent:

  • discoveryengine.userEvents.purge

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