In questa pagina viene descritto come registrare gli eventi utente in tempo reale. Gli eventi utente sono obbligatori per i suggerimenti sui contenuti multimediali. Se non usi i consigli sui contenuti multimediali, l'importazione degli eventi utente non è obbligatoria. Tuttavia, la registrazione degli eventi utente è consigliata per le app di ricerca di contenuti multimediali.
Per i tipi di eventi utente che puoi registrare, consulta il campo eventType
della
userEvents
. Importando gli eventi utente, puoi migliorare la qualità dei consigli e il ranking dei risultati di ricerca.
I risultati con percentuali di clic più elevate vengono messi in evidenza, mentre quelli con percentuali di clic più basse vengono nascosti. Non registrare eventi utente per i documenti che non hai ancora importato.
Se utilizzi un'app di ricerca con più datastore collegati, Google consiglia di importare gli eventi utente a livello di località anziché a livello di datastore. Ciò consente di inviare un determinato evento utente
datastore al quale è associato. Per importare eventi utente con documenti di diversi
dataStores
a livello di località anziché di datastore,
consulta userEvents.write
.
Per importare collettivamente gli eventi utente storici, consulta Importare gli eventi utente storici.
Puoi registrare gli eventi utente nei seguenti modi:
Per la rappresentazione JSON per gli eventi utente, consulta
userEvents
nel riferimento API.
Prima di iniziare
Prima di importare gli eventi utente:
- Crea un datastore e un'app.
- Consulta la sezione Informazioni sugli eventi utente per i requisiti degli eventi utente.
Registra eventi utente in tempo reale con un pixel JavaScript
Per registrare gli eventi utente con un pixel JavaScript:
- Crea una chiave API per le chiamate al canale
userEvents.Collect
metodo - Consulta l'esempio di pixel JavaScript per un esempio di tag JavaScript che raccoglie gli eventi utente
crea una chiave API
Una chiave API è obbligatoria se utilizzi un pixel JavaScript per raccogliere gli eventi utente dai browser degli utenti.
Per creare una chiave API per le chiamate a userEvents.Collect
, procedi nel seguente modo:
procedi nel seguente modo:
Nella console Google Cloud, vai alla pagina Credenziali.
Nel menu a discesa del progetto nella parte superiore della pagina della console Google Cloud, seleziona il progetto (potrebbe essere già selezionato).
Fai clic su Crea credenziali e poi seleziona Chiave API. Non aggiungere limitazioni per i referrer. Alcune impostazioni della privacy dell'utente sono che non trasmette l'URL del referrer.
- Prendi nota della chiave API generata, che utilizzerai durante la chiamata e il logging degli eventi utente.
Per una maggiore sicurezza, aggiungi una limitazione HTTP alla tua chiave API per limitare l'accesso al servizio Vertex AI Agent Builder all'indirizzo
https://discoveryengine.googleapis.com/*
.
Esempio di pixel JavaScript
Il seguente esempio registra un evento utente view-item
utilizzando un pixel
JavaScript.
Per la rappresentazione JSON degli eventi utente, consulta userEvents
nel
riferimento all'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>
Registra gli eventi utente in tempo reale con il metodo userEvents.write
REST
Puoi utilizzare la userEvents.write
per inviare gli eventi utente direttamente all'API dal server di backend.
Per registrare gli eventi utente, invia una richiesta POST al metodo userEvents.write
e fornisci il corpo della richiesta appropriato. Per la rappresentazione JSON degli eventi
dell'utente, consulta userEvents
nel riferimento all'API.
Se hai un'app con più datastore, Google ti consiglia di:
importare eventi a livello di località. In questo caso, utilizza l'endpointhttps://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#
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API C# Vertex AI Agent Builder.
Per autenticarti in Vertex AI Agent Builder, configura le credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Go
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API Go Vertex AI Agent Builder.
Per autenticarti in Vertex AI Agent Builder, configura le credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Java
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API Java Vertex AI Agent Builder.
Per autenticarti in Vertex AI Agent Builder, configura le credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Python
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API Python Vertex AI Agent Builder.
Per autenticarti in Vertex AI Agent Builder, configura le credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Ruby
Per ulteriori informazioni, consulta la documentazione di riferimento dell'API Ruby Vertex AI Agent Builder.
Per eseguire l'autenticazione su Vertex AI Agent Builder, configura le credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.