Esta página descreve como gravar eventos do usuário em tempo real. Os eventos do usuário são necessários para recomendações de mídia. Se você não usar recomendações de mídia, não é necessário importar eventos do usuário. No entanto, a gravação de eventos do usuário é recomendada para apps de pesquisa de mídia.
Para saber os tipos de evento do usuário que podem ser gravados, consulte o campo eventType
do objeto userEvents
. Ao ingerir eventos do usuário, você melhora o
a qualidade de suas recomendações, bem como a classificação de seus resultados de pesquisa.
Os resultados com taxas de cliques mais altas são impulsionados, enquanto os resultados com taxas de cliques mais baixas são ocultados. Não registre eventos de usuário em documentos que você
ainda não foram importadas.
Se você estiver usando um app de pesquisa com vários repositórios de dados anexados, o Google
recomenda que você ingira eventos de usuário no nível do local, em vez de no
nível do repositório de dados. Isso permite que um determinado evento de usuário seja enviado ao
repositório de dados ao qual está associado. Para importar eventos do usuário com documentos de diferentes
dataStores
no nível do local, em vez de no nível do repositório de dados,
consulte userEvents.write
.
Para importar eventos históricos de usuários em massa, consulte Importar eventos históricos de usuários.
É possível registrar eventos de usuários das seguintes maneiras:
Para a representação JSON para eventos de usuário, consulte
userEvents
na referência da API.
Antes de começar
Antes de importar eventos do usuário:
- Crie um repositório de dados e um app.
- Consulte Sobre os eventos do usuário para conferir os requisitos.
Registrar eventos do usuário em tempo real com um pixel JavaScript
Para registrar eventos do usuário com um pixel JavaScript:
- Crie uma chave de API para chamadas ao método
userEvents.Collect
. - Veja um exemplo de pixel JavaScript para um exemplo de Tag JavaScript que coleta eventos do usuário
Criar uma chave de API
Uma chave de API é necessária se você usar um pixel JavaScript para coletar eventos do usuário nos navegadores deles.
Para criar uma chave de API para chamadas ao método userEvents.Collect
, siga estas etapas:
No Console do Google Cloud, acesse a página Credenciais.
No menu suspenso do projeto na parte de cima da página do console do Google Cloud, selecione seu projeto (o projeto pode já estar selecionado).
Clique em Criar credenciais e, em seguida, selecione Chave de API. Não adicione restrições de referenciadores. Algumas configurações de privacidade do usuário costumam não transmitir o URL de referência.
- Anote a chave de API gerada, que será usada ao chamar a API de registro de eventos do usuário.
Para reforçar a segurança, adicione um Restrição HTTP à sua chave de API para restringir o acesso ao serviço do Vertex AI Agent Builder às
https://discoveryengine.googleapis.com/*
.
Exemplo de pixel JavaScript
O exemplo a seguir registra um evento do usuário view-item
usando um pixel
JavaScript.
Para a representação JSON de eventos do usuário, consulte userEvents
na
referência da API.
<script type="text/javascript">
var user_event = {
"eventType" : "view-item",
"userPseudoId": "USER_PSEUDO_ID",
"userInfo": {
"userId": "USER_ID"
},
"attributionToken": "ATTRIBUTION_TOKEN",
"tagIds": "TAG_ID",
"documents": [
{
"id": "DOCUMENT_ID"
}
]
};
var _gre = _gre || {};
// Credentials for project.
_gre.apiKey = '[API_KEY]';
_gre.logEvent = user_event;
_gre.projectId = 'PROJECT_ID';
_gre.locationId = 'LOCATION_ID';
_gre.dataStoreId = 'DATA_STORE_ID';
(function() {
var gre = document.createElement('script'); gre.type = 'text/javascript'; gre.async = true;
gre.src = 'https://www.gstatic.com/discoveryengine/v1beta_event.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(gre, s);
})();
</script>
Registrar eventos do usuário em tempo real com o método userEvents.write
REST
É possível usar o método userEvents.write
para enviar eventos do usuário diretamente para a API do servidor de back-end.
Para registrar eventos do usuário, envie uma solicitação POST para o método userEvents.write
e
forneça o corpo da solicitação apropriado. Para a representação JSON de eventos
do usuário, consulte userEvents
na referência da API.
Se você tiver um aplicativo com vários repositórios de dados, o Google recomenda
ingerir eventos no local. Nesse caso, use o endpoint
https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_NUMBER/locations/LOCATION/userEvents:write
.
export GOOGLE_APPLICATION_CREDENTIALS=/tmp/my-key.json
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
--data "{
'eventType': 'view-item',
'userPseudoId': 'visitor0',
'eventTime': '2020-01-01T03:33:33.000001Z',
'tagIds': ['321'],
'attributionToken': 'ABC',
'attributes': {
'example_text_attribute': {
'text': ['text_1', 'text_2']
},
'example_number_attribute': {
'numbers': [3.14, 42, 1.2345]
}
},
'documents': [{
'id': 'abc'
}],
'userInfo': {
'userId': 'abc',
'userAgent': 'Mozilla/5.0'
},
'pageInfo': {
'uri': 'http://example',
'referrerUri': 'http://example',
'pageViewId': 'currentPageUri'
}
}" \\
"https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_NUMBER/locations/global/dataStores/DATA_STORE_ID/userEvents:write"
C#
Para mais informações, consulte a API Vertex AI Agent Builder C# documentação de referência.
Para autenticar no Vertex AI Agent Builder, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Go
Para mais informações, consulte a API Vertex AI Agent Builder Go documentação de referência.
Para autenticar no Vertex AI Agent Builder, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Java
Para mais informações, consulte a documentação de referência da API Java do Vertex AI Agent Builder.
Para autenticar no Vertex AI Agent Builder, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Python
Para mais informações, consulte a documentação de referência da API Python do Vertex AI Agent Builder.
Para autenticar no Vertex AI Agent Builder, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Ruby
Para mais informações, consulte a API Vertex AI Agent Builder Ruby documentação de referência.
Para autenticar no Vertex AI Agent Builder, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.