Gerenciar eventos do usuário

Esta página descreve como consultar informações e limpar eventos de usuário.

Para gravar eventos do usuário à medida que eles acontecem, consulte Gravar eventos do usuário em tempo real. Para importar dados de eventos do usuário de eventos anteriores, consulte Importar eventos históricos do usuário.

Conferir informações de eventos do usuário agregados

É possível conferir informações sobre eventos do usuário gravados no app no console do Google Cloud na guia Eventos da página Dados do app.

Essa página mostra informações como o número de eventos ingeridos, o número de eventos não agrupados, a mudança percentual no número de eventos em um período e a contagem média do tipo de evento por documento. Além disso, é possível conferir as métricas de cada tipo de evento ao longo do tempo. As métricas aparecem cerca de 24 horas após o primeiro upload de eventos para as recomendações de mídia.

Para conferir as informações dos eventos do usuário:

  1. No Console do Google Cloud, acesse a página Criador de agentes.

    Agent Builder.

  2. Clique no nome do app para conferir as informações dos eventos do usuário.

  3. Na página Dados, acesse a guia Eventos. As informações do evento do usuário são mostradas nesta guia.

Limpar eventos de usuário

Se você tiver eventos de usuário que não foram gravados corretamente e precisa removê-los, use o método da API userEvents.purge.

Especifique os eventos que você quer remover usando um filtro de eventos do usuário. Você pode usar o filtro de eventos do usuário para especificar os eventos que quer limpar. É possível filtrar com os campos eventTime, eventType, visitorID e userID.

Como não é possível desfazer a exclusão, teste seus filtros executando uma simulação antes de excluir eventos do usuário. O campo force é definido como false por padrão. essa configuração retornará o número de eventos a serem excluídos sem realmente excluí-los. Quando você estiver pronto para excluir os eventos do usuário, defina o campo force como true.

Este exemplo filtra um período, que precisa usar o formato de data Zulu Time. O campo force está definido como 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"

Você vai receber um objeto de resposta semelhante ao seguinte, em que purge-user-events-54321 é o ID da operação:

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

Este exemplo solicita o status da operação:

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"

Exemplo de status da operação: 

{
  "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"
  }
}

Definir o campo force como true força a exclusão.

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"

Usar o filtro de eventos do usuário

Você pode filtrar os eventos do usuário que serão excluídos.

O filtro é uma string que contém uma ou mais das seguintes restrições:

  • eventTime: fornece um carimbo de data/hora para vincular os eventos a serem excluídos. Esse filtro pode ser especificado uma ou duas vezes, com um símbolo maior que (>) ou menor que (<). O tempo limitado precisa ser um único bloco contíguo.

  • eventType: restringe os eventos a serem excluídos a um único tipo de evento.

  • visitorID: restringe os eventos a serem excluídos a um único ID de visitante.

  • userID: restringe os eventos a serem excluídos a um único ID do usuário.

Apenas os eventos de usuário que satisfaçam a todas as restrições serão excluídos.

Por exemplo, para excluir todos os eventos do usuário do tipo add-to-cart que foram registrados em 1º de fevereiro de 2023 ou após essa data, forneça a seguinte string de filtro:

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

A seguir