Faça a gestão de eventos do utilizador

Esta página descreve como ver e eliminar eventos do utilizador. Para obter informações sobre como registar eventos do utilizador à medida que ocorrem, consulte o artigo Registe eventos do utilizador em tempo real. Para importar dados de eventos de utilizadores de eventos anteriores, consulte o artigo Importe eventos de utilizadores históricos.

Tutorial sobre como voltar a juntar eventos de utilizadores

Este tutorial mostra como juntar novamente eventos de utilizadores fazendo um pedido POST ao ponto final userEvents:rejoin.

Para seguir orientações passo a passo para esta tarefa diretamente no editor do Cloud Shell, clique em Orientar-me:

Visita guiada

Tutorial sobre a remoção de eventos de utilizadores

Este tutorial mostra como remover completamente eventos de utilizadores.

Para seguir orientações passo a passo para esta tarefa diretamente no editor do Cloud Shell, clique em Orientar-me:

Visita guiada

Veja informações de eventos de utilizadores agregadas

Veja as métricas de integração de eventos no separador Eventos na consola de pesquisa para comércio página Dados. Esta página mostra todos os eventos escritos ou importados no último ano. As métricas podem demorar até 24 horas a aparecer após a ingestão de dados bem-sucedida.

Aceda à página Dados

Estatísticas de eventos de utilizadores do Vertex AI Search for commerce

Volte a juntar eventos de utilizador

Pode voltar a juntar eventos de utilizador fazendo um pedido POST ao ponto final userEvents:rejoin.

A operação de junção volta a juntar eventos especificados com a versão mais recente do catálogo de produtos.

Um evento de utilizador é considerado não associado se o produto ao qual está associado não estiver presente no catálogo no momento em que o evento de utilizador é carregado. Os eventos não associados não têm informações detalhadas sobre os produtos e não são tão úteis para preparar modelos e publicar resultados.

Além de resolver eventos não associados, a operação de associação novamente pode ser usada para corrigir eventos que foram associados ao catálogo de produtos errado.

Tem de ter a função do IAM Retail AI Admin para chamar este método. Uma operação de nova associação pode demorar horas ou dias a ser concluída.

curl

Defina userEventRejoinScope de acordo com os tipos de eventos aos quais está a voltar a aderir:

  • USER_EVENT_REJOIN_SCOPE_UNSPECIFIED: predefinição. Acionar a junção novamente para eventos com e sem junção.
  • JOINED_EVENTS: acione a junção novamente apenas para eventos com junção.
  • UNJOINED_EVENTS: acione a nova associação apenas para eventos sem associação.

O exemplo seguinte aciona uma nova associação apenas para eventos não associados:

curl -X POST \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    --data "{
     'userEventRejoinScope': 'UNJOINED_EVENTS'
     }" \
    "https://retail.googleapis.com/v2/projects/PROJECT_ID/locations/global/catalogs/default_catalog/userEvents:rejoin"

Deve receber um objeto de resposta com um aspeto semelhante ao seguinte:

{
  "name": "projects/PROJECT_ID/locations/global/catalogs/default_catalog/operations/OPERATION_ID"
}

Pode verificar o estado da nova associação. Substitua OPERATION_ID pelo ID da operação devolvido pelo método rejoin:

curl -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
"https://retail.googleapis.com/v2/projects/PROJECT_ID/locations/global/catalogs/default_catalog/operations/OPERATION_ID"

Quando a operação estiver concluída, o estado da operação é devolvido como done:

{
  "name": "projects/PROJECT_ID/locations/global/catalogs/default_catalog/operations/OPERATION_ID",
  "done": true,
  "response": {
    "@type": "type.googleapis.com/google.cloud.retail.v2.RejoinUserEventsResponse",
    "rejoinedUserEventsCount": "1"
  }
}

Java

public static String rejoinUserEvents(UserEventRejoinScope scope)
    throws IOException, InterruptedException, ExecutionException {
  UserEventServiceClient userEventsClient = getUserEventServiceClient();

  RejoinUserEventsRequest request = RejoinUserEventsRequest.newBuilder()
      .setParent(DEFAULT_CATALOG_NAME)
      .setUserEventRejoinScope(scope)
      .build();

  String operationName = userEventsClient
      .rejoinUserEventsAsync(request).getName();

  userEventsClient.shutdownNow();
  userEventsClient.awaitTermination(2, TimeUnit.SECONDS);

  return operationName;
}

Remova eventos de utilizadores

Geralmente, deve deixar os eventos do utilizador no lugar depois de terem sido registados. Não é recomendável limpar eventos.

A eliminação de eventos pode demorar até vários dias a ser concluída. Se planeia repor completamente os eventos do utilizador, pondere criar um novo projeto.

Se tiver eventos de utilizadores que não foram registados corretamente e precisar de os remover, pode fazê-lo através do método userEvents.purge.

Especifique os eventos que quer remover através de uma string de filtro. Esta funcionalidade permite eliminar seletivamente eventos do utilizador filtrando pelos campos eventTime, eventType, visitorID e userID.

Uma vez que não pode anular a eliminação, teste a string de filtro executando um teste antes de eliminar eventos de utilizador. O campo force está definido como false por predefinição. Esta definição devolve o número de eventos a eliminar sem os eliminar efetivamente. Quando estiver pronto para eliminar efetivamente os eventos do utilizador, defina o campo force como true.

curl

Este exemplo filtra um intervalo de tempo, que tem de usar o formato de data/hora Zulu. 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 > \"2019-12-23T18:25:43.511Z\" eventTime < \"2019-12-23T18:30:43.511Z\"",
    "force":"false"
  }' \
  "https://retail.googleapis.com/v2/projects/PROJECT_ID/locations/global/catalogs/default_catalog/userEvents:purge"

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

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

Este exemplo pede o estado da operação:

curl -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
"https://retail.googleapis.com/v2/projects/PROJECT_ID/locations/global/catalogs/default_catalog/operations/OPERATION_ID"

Exemplo de estado da operação: 

{
  "name": "projects/PROJECT_ID/locations/global/catalogs/default_catalog/operations/OPERATION_ID",
  "done": true,
  "response": {
    "@type": "type.googleapis.com/google.cloud.retail.v2.PurgeUserEventsResponse",
    "purgedEventsCount": "1"
  }
}

Definir o campo force como true força a eliminaçã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 > \"2019-12-23T18:25:43.511Z\" eventTime < \"2019-12-23T18:30:43.511Z\"",
    "force":"true"
  }' \
"https://retail.googleapis.com/v2/projects/PROJECT_ID/locations/global/catalogs/default_catalog/userEvents:purge"

Java

public static String purgeUserEvents(
    String filter)
    throws IOException, InterruptedException, ExecutionException {
  UserEventServiceClient userEventsClient = getUserEventServiceClient();

  PurgeUserEventsRequest request = PurgeUserEventsRequest.newBuilder()
      .setParent(DEFAULT_CATALOG_NAME)
      .setFilter(filter)
      .setForce(true)
      .build();

  String operationName = userEventsClient
      .purgeUserEventsAsync(request).getName();

  userEventsClient.shutdownNow();
  userEventsClient.awaitTermination(2, TimeUnit.SECONDS);

  return operationName;
}

Use o filtro de eventos do utilizador

Pode filtrar os eventos do utilizador a eliminar.

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

  • eventTime

    Fornece uma indicação de tempo para limitar os eventos a eliminar. Este filtro pode ser especificado uma ou duas vezes, com um símbolo de maior que (>) ou menor que (<). O tempo delimitado tem de ser um único bloco contíguo.

  • eventType

    Restrinja os eventos a eliminar a um único tipo de evento.

  • visitorID

    Restringir os eventos a eliminar a um único ID de visitante.

  • userID

    Restringir os eventos a eliminar a um único ID de utilizador.

Apenas os eventos do utilizador que satisfazem todas as restrições são eliminados.

Para eliminar todos os eventos de utilizador do tipo add-to-cart que foram registados a 1 de fevereiro de 2019 ou após essa data, forneceria a seguinte string de filtro:

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