REST Resource: projects.locations.dataStores.userEvents

Risorsa: UserEvent

UserEvent acquisisce tutte le informazioni sui metadati che l'API Discovery Engine deve conoscere su come gli utenti finali interagiscono con il tuo sito web.

Rappresentazione JSON 
{
  "eventType": string,
  "conversionType": string,
  "userPseudoId": string,
  "engine": string,
  "dataStore": string,
  "eventTime": string,
  "userInfo": {
    object (UserInfo)
  },
  "directUserRequest": boolean,
  "sessionId": string,
  "pageInfo": {
    object (PageInfo)
  },
  "attributionToken": string,
  "filter": string,
  "documents": [
    {
      object (DocumentInfo)
    }
  ],
  "panel": {
    object (PanelInfo)
  },
  "searchInfo": {
    object (SearchInfo)
  },
  "completionInfo": {
    object (CompletionInfo)
  },
  "transactionInfo": {
    object (TransactionInfo)
  },
  "tagIds": [
    string
  ],
  "promotionIds": [
    string
  ],
  "attributes": {
    string: {
      "text": [
        string
      ],
      "numbers": [
        number
      ]
    },
    ...
  },
  "mediaInfo": {
    object (MediaInfo)
  },
  "panels": [
    {
      object (PanelInfo)
    }
  ],
  "feedback": {
    object (Feedback)
  },
  "entity": string
}
Campi
eventType

string

Obbligatorio. Tipo di evento utente. I valori consentiti sono:

Valori generici:

  • search: cerca documenti.
  • view-item: Visualizzazione dettagliata di una pagina di un documento.
  • view-item-list: Visualizzazione di un riquadro o di un elenco ordinato di documenti.
  • view-home-page: Visualizzazione della home page.
  • view-category-page: Visualizzazione di una pagina di categoria, ad es. Home > Uomo > Jeans

Valori correlati alla vendita al dettaglio:

  • add-to-cart: Aggiungi uno o più articoli al carrello, ad es. negli acquisti online al dettaglio
  • purchase: Acquisto di uno o più articoli

Valori correlati ai contenuti multimediali:

  • media-play: Avvia/riprendi la visione di un video, la riproduzione di un brano e così via.
  • media-complete: Ha terminato o interrotto a metà un video, un brano e così via.

Valore di conversione personalizzato:

  • conversion: evento di conversione definito dal cliente.
conversionType

string

Facoltativo. Tipo di conversione.

Obbligatorio se UserEvent.event_type è conversion. Si tratta di un nome di conversione definito dal cliente in lettere minuscole o numeri separati da "-", ad esempio "watch", "good-visit" e così via.

Non impostare il campo se UserEvent.event_type non è conversion. In questo modo, l'evento di conversione personalizzato viene combinato con eventi predefiniti come search, view-item e così via.
userPseudoId

string

Obbligatorio. Un identificatore univoco per il monitoraggio dei visitatori.

Ad esempio, questa operazione può essere implementata con un cookie HTTP, che dovrebbe essere in grado di identificare in modo univoco un visitatore su un singolo dispositivo. Questo identificatore univoco non deve cambiare se il visitatore esegue l'accesso o la disconnessione dal sito web.

Non impostare il campo sullo stesso ID fisso per utenti diversi. In questo modo, la cronologia eventi di questi utenti viene combinata, il che comporta una qualità del modello inferiore.

Il campo deve essere una stringa con codifica UTF-8 con un limite di lunghezza di 128 caratteri. In caso contrario, viene restituito un errore INVALID_ARGUMENT.

Il campo non deve contenere PII o dati utente. Ti consigliamo di utilizzare l'ID client di Google Analytics per questo campo.
engine

string

Il nome della risorsa Engine, nel formato projects/{project}/locations/{location}/collections/{collectionId}/engines/{engineId}.

Facoltativo. Obbligatorio solo per gli eventi utente prodotti da Engine. Ad esempio, gli eventi utente della ricerca ibrida.
dataStore

string

Il nome completo della risorsa DataStore, nel formato projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}.

Facoltativo. Obbligatorio solo per gli eventi utente il cui datastore non può essere determinato da UserEvent.engine o UserEvent.documents. Se il datastore è impostato nel genitore delle richieste di scrittura/importazione/raccolta di eventi utente, questo campo può essere omesso.
eventTime

string (Timestamp format)

Obbligatorio solo per il metodo UserEventService.ImportUserEvents. Timestamp dell'evento utente.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
userInfo

object (UserInfo)

Informazioni sull'utente finale.
directUserRequest

boolean

Deve essere impostato su true se la richiesta viene effettuata direttamente dall'utente finale, nel qual caso UserEvent.user_info.user_agent può essere compilato dalla richiesta HTTP.

Questo flag deve essere impostato solo se la richiesta API viene effettuata direttamente dall'utente finale, ad esempio da un'app mobile (e non se un gateway o un server elabora e invia gli eventi utente).

Questo valore non deve essere impostato quando si utilizza il tag JavaScript in UserEventService.CollectUserEvent.
sessionId

string

Un identificatore univoco per monitorare una sessione visitatore con un limite di lunghezza di 128 byte. Una sessione è un'aggregazione del comportamento di un utente finale in un intervallo di tempo.

Una linea guida generale per compilare sessionId:

  1. Se l'utente non ha attività per 30 minuti, deve essere assegnato un nuovo sessionId.
  2. L'ID sessione deve essere univoco per tutti gli utenti. Ti consigliamo di utilizzare UUID o di aggiungere UserEvent.user_pseudo_id come prefisso.
pageInfo

object (PageInfo)

Metadati della pagina, come categorie e altre informazioni essenziali per determinati tipi di eventi, ad esempio view-category-page.
attributionToken

string

Token per attribuire una risposta dell'API all'azione o alle azioni dell'utente per attivare l'evento.

Consigliato vivamente per gli eventi utente che sono il risultato di RecommendationService.Recommend. Questo campo consente un'attribuzione accurata del rendimento del modello di consigli.

Il valore deve essere uno dei seguenti:

Questo token ci consente di attribuire con precisione la visualizzazione di pagina o il completamento della conversione all'evento e alla particolare risposta di previsione contenente questo prodotto su cui è stato fatto clic/acquistato. Se l'utente fa clic sul prodotto K nei risultati dei consigli, trasmetti RecommendResponse.attribution_token come parametro URL alla pagina del prodotto K. Quando registri gli eventi nella pagina del prodotto K, inserisci RecommendResponse.attribution_token in questo campo.
filter

string

Facoltativo. La sintassi del filtro è costituita da un linguaggio di espressioni per costruire un predicato da uno o più campi dei documenti da filtrare.

Un esempio riguarda gli eventi search, il relativo SearchRequest può contenere un'espressione di filtro in SearchRequest.filter conforme a https://google.aip.dev/160#filtering.

Allo stesso modo, per gli eventi view-item-list generati da un RecommendRequest, questo campo può essere compilato direttamente da RecommendRequest.filter in conformità con https://google.aip.dev/160#filtering.

Il valore deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 1000 caratteri. In caso contrario, viene restituito un errore INVALID_ARGUMENT.
documents[]

object (DocumentInfo)

Elenco di Document associati a questo evento utente.

Questo campo è facoltativo, ad eccezione dei seguenti tipi di eventi:

  • view-item
  • add-to-cart
  • purchase
  • media-play
  • media-complete

In un evento search, questo campo rappresenta i documenti restituiti all'utente finale nella pagina corrente (l'utente finale potrebbe non aver ancora terminato la navigazione dell'intera pagina). Quando all'utente finale viene restituita una nuova pagina, dopo la paginazione/il filtraggio/l'ordinamento anche per la stessa query, è necessario un nuovo evento search con un UserEvent.documents diverso.
panel

object (PanelInfo)

Metadati del panel associati a questo evento utente.
searchInfo

object (SearchInfo)

Dettagli di SearchService.Search relativi all'evento.

Questo campo deve essere impostato per l'evento search.
completionInfo

object (CompletionInfo)

Dettagli di CompletionService.CompleteQuery relativi all'evento.

Questo campo deve essere impostato per l'evento search quando la funzione di completamento automatico è abilitata e l'utente fa clic su un suggerimento per la ricerca.
transactionInfo

object (TransactionInfo)

I metadati della transazione (se presenti) associati a questo evento utente.
tagIds[]

string

Un elenco di identificatori per i gruppi sperimentali indipendenti a cui appartiene questo evento utente. Viene utilizzato per distinguere gli eventi utente associati a configurazioni di esperimenti diverse.
promotionIds[]

string

Gli ID promozione se si tratta di un evento associato alle promozioni. Al momento, questo campo è limitato a un solo ID.
attributes

map (key: string, value: object)

Facoltativo. Funzionalità aggiuntive degli eventi utente da includere nel modello di suggerimento. Questi attributi NON devono contenere dati che devono essere analizzati o elaborati ulteriormente, ad esempio JSON o altre codifiche.

Se fornisci attributi personalizzati per gli eventi utente importati, includili anche negli eventi utente che associ alle richieste di previsione. La formattazione degli attributi personalizzati deve essere coerente tra gli eventi importati e quelli forniti con le richieste di previsione. In questo modo, l'API Discovery Engine può utilizzare questi attributi personalizzati durante l'addestramento dei modelli e la pubblicazione delle previsioni, il che contribuisce a migliorare la qualità dei suggerimenti.

Questo campo deve soddisfare tutti i criteri riportati di seguito, altrimenti viene restituito un errore INVALID_ARGUMENT:

  • La chiave deve essere una stringa con codifica UTF-8 con un limite di lunghezza di 5000 caratteri.
  • Per gli attributi di testo, sono consentiti al massimo 400 valori. Non sono consentiti valori vuoti. Ogni valore deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 256 caratteri.
  • Per gli attributi numerici, sono consentiti al massimo 400 valori.

Per i consigli sui prodotti, un esempio di informazioni aggiuntive sull'utente è traffic_channel, ovvero il modo in cui un utente arriva al sito. Gli utenti possono arrivare al sito direttamente, tramite la Ricerca Google o in altri modi.
attributes.text[]

string

I valori testuali di questo attributo personalizzato. Ad esempio, ["yellow", "green"] quando la chiave è "color".

La stringa vuota non è consentita. In caso contrario, viene restituito un errore INVALID_ARGUMENT.

Deve essere impostato esattamente uno dei due valori: CustomAttribute.text o CustomAttribute.numbers. In caso contrario, viene restituito un errore INVALID_ARGUMENT.
attributes.numbers[]

number

I valori numerici di questo attributo personalizzato. Ad esempio, [2.3, 15.4] quando la chiave è "lengths_cm".

Deve essere impostato esattamente uno dei due valori: CustomAttribute.text o CustomAttribute.numbers. In caso contrario, viene restituito un errore INVALID_ARGUMENT.
mediaInfo

object (MediaInfo)

Informazioni specifiche per i contenuti multimediali.
panels[]

object (PanelInfo)

Facoltativo. Elenco dei panel associati a questo evento. Utilizzato per i dati sulle impressioni a livello di pagina.
feedback

object (Feedback)

Facoltativo. Questo campo è facoltativo, ad eccezione dei tipi di eventi add-feedback.
entity

string

Facoltativo. Rappresenta l'entità per i clienti che potrebbero gestire più entità, domini, siti o regioni diversi, ad esempio Google US, Google Ads, Waymo, google.com, youtube.com e così via. Ti consigliamo di impostare entity per ottenere risultati migliori di ricerca, completamento e previsione per entità.

UserInfo

Informazioni di un utente finale.

Rappresentazione JSON 
{
  "userId": string,
  "userAgent": string,
  "timeZone": string,
  "preciseLocation": {
    object (PreciseLocation)
  }
}
Campi
userId

string

Consigliato vivamente per gli utenti che hanno eseguito l'accesso. Identificatore univoco dell'utente che ha eseguito l'accesso, ad esempio un nome utente. Non impostare per gli utenti anonimi.

Utilizza sempre un valore hash per questo ID.

Non impostare il campo sullo stesso ID fisso per utenti diversi. In questo modo, la cronologia eventi di questi utenti viene combinata, il che comporta una qualità del modello inferiore.

Il campo deve essere una stringa con codifica UTF-8 con un limite di lunghezza di 128 caratteri. In caso contrario, viene restituito un errore INVALID_ARGUMENT.

Rappresenta un ID opaco per l'API Search. L'API Search non interpreta il valore in alcun modo. Questo campo viene utilizzato per associare gli eventi a un utente in più sessioni se gli eventi vengono caricati.
userAgent

string

User agent incluso nell'intestazione HTTP.

Il campo deve essere una stringa con codifica UTF-8 con un limite di lunghezza di 1000 caratteri. In caso contrario, viene restituito un errore INVALID_ARGUMENT.

Questo valore non deve essere impostato quando si utilizza la generazione di report sugli eventi lato client con GTM o il tag JavaScript in UserEventService.CollectUserEvent o se è impostato UserEvent.direct_user_request.
timeZone

string

Facoltativo. Fuso orario IANA, ad esempio Europe/Budapest.
preciseLocation

object (PreciseLocation)

Facoltativo. Solo input. La posizione esatta dell'utente. Viene utilizzato nel ranking personalizzato per calcolare la distanza tra l'utente e i documenti pertinenti.

PreciseLocation

Dati sulla posizione esatta con più opzioni di rappresentazione.

Rappresentazione JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "point": {
    object (LatLng)
  },
  "address": string
  // End of mutually exclusive fields.
}
Campi
Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
point

object (LatLng)

(Facoltativo) Posizione rappresentata da un punto di latitudine/longitudine.
address

string

posizione rappresentata da un indirizzo in linguaggio naturale. Verranno geocodificati e convertiti in un punto o un poligono.
Fine dei campi che si escludono a vicenda.

PageInfo

Informazioni dettagliate sulla pagina.

Rappresentazione JSON 
{
  "pageviewId": string,
  "pageCategory": string,
  "uri": string,
  "referrerUri": string
}
Campi
pageviewId

string

Un ID univoco di una visualizzazione di una pagina web.

Questo valore deve rimanere uguale per tutti gli eventi utente attivati dalla stessa visualizzazione di pagina. Ad esempio, la visualizzazione di una pagina dei dettagli dell'articolo potrebbe attivare più eventi mentre l'utente naviga nella pagina. La proprietà pageviewId deve rimanere la stessa per tutti questi eventi in modo che possano essere raggruppati correttamente.

Quando utilizzi i report sugli eventi lato client con il pixel JavaScript e Google Tag Manager, questo valore viene compilato automaticamente.
pageCategory

string

La categoria più specifica associata a una pagina della categoria.

Per rappresentare il percorso completo della categoria, utilizza il simbolo ">" per separare le diverse gerarchie. Se ">" fa parte del nome della categoria, sostituiscilo con altri caratteri.

Le pagine delle categorie includono pagine speciali come vendite o promozioni. Ad esempio, una pagina di vendita speciale potrebbe avere la gerarchia di categorie: "pageCategory" : "Sales > 2017 Black Friday Deals".

Obbligatorio per gli eventi view-category-page. Gli altri tipi di eventi non devono impostare questo campo. In caso contrario, viene restituito un errore INVALID_ARGUMENT.
uri

string

URL completo (window.location.href) della pagina corrente dell'utente.

Quando utilizzi i report sugli eventi lato client con il pixel JavaScript e Google Tag Manager, questo valore viene compilato automaticamente. La lunghezza massima è di 5000 caratteri.
referrerUri

string

L'URL del referrer della pagina corrente.

Quando utilizzi i report sugli eventi lato client con il pixel JavaScript e Google Tag Manager, questo valore viene compilato automaticamente. Tuttavia, alcune limitazioni della privacy del browser potrebbero causare la visualizzazione di questo campo vuoto.

DocumentInfo

Informazioni dettagliate sul documento associate a un evento utente.

Rappresentazione JSON 
{
  "promotionIds": [
    string
  ],
  "joined": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "id": string,
  "name": string,
  "uri": string
  // End of mutually exclusive fields.
  "quantity": integer,
  "conversionValue": number
}
Campi
promotionIds[]

string

Gli ID promozione associati a questo documento. Al momento, questo campo è limitato a un solo ID.
joined

boolean

Solo output. Se il documento a cui viene fatto riferimento è presente nel datastore.

Un descrittore obbligatorio del Document associato.

  • Se viene specificato id, vengono utilizzati i valori predefiniti per {location}, {collection_id}, {data_store_id} e {branch_id} durante l'annotazione con il documento archiviato.

  • Se viene specificato name, i valori forniti (sono consentiti i valori predefiniti) per {location}, {collection_id}, {data_store_id} e {branch_id} vengono utilizzati per l'annotazione con il documento archiviato. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
id

string

L'ID risorsa Document.
name

string

Il nome completo della risorsa Document, nel formato: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}/branches/{branchId}/documents/{documentId}
uri

string

L'URI Document, consentito solo per i datastore di siti web.
Fine dei campi che si escludono a vicenda.
quantity

integer

Quantità del documento associato all'evento utente. Il valore predefinito è 1.

Ad esempio, questo campo è 2 se due quantità dello stesso documento sono coinvolte in un evento add-to-cart.

Obbligatorio per gli eventi dei seguenti tipi:

  • add-to-cart
  • purchase
conversionValue

number

Facoltativo. Il valore di conversione associato a questo documento. Deve essere impostato se UserEvent.event_type è "conversione".

Ad esempio, un valore di 1000 indica che sono stati trascorsi 1000 secondi a visualizzare un documento per il tipo di conversione watch.

PanelInfo

Informazioni dettagliate sul pannello associate a un evento utente.

Rappresentazione JSON 
{
  "panelId": string,
  "displayName": string,
  "documents": [
    {
      object (DocumentInfo)
    }
  ],
  "panelPosition": integer,
  "totalPanels": integer
}
Campi
panelId

string

Obbligatorio. L'ID pannello.
displayName

string

Il nome visualizzato del riquadro.
documents[]

object (DocumentInfo)

Facoltativo. Gli ID documento associati a questo riquadro.
panelPosition

integer

La posizione ordinata del riquadro, se mostrato all'utente insieme ad altri riquadri. Se impostato, deve essere impostato anche totalPanels.
totalPanels

integer

Il numero totale di riquadri, incluso questo, mostrati all'utente. Deve essere impostato se è impostato panelPosition.

SearchInfo

Informazioni dettagliate sulla ricerca.

Rappresentazione JSON 
{
  "searchQuery": string,
  "orderBy": string,
  "offset": integer
}
Campi
searchQuery

string

Facoltativo. La query di ricerca dell'utente.

Per la definizione, vedi SearchRequest.query.

Il valore deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 5000 caratteri. In caso contrario, viene restituito un errore INVALID_ARGUMENT.

È obbligatorio specificare almeno un valore per searchQuery o PageInfo.page_category per gli eventi search. Gli altri tipi di eventi non devono impostare questo campo. In caso contrario, viene restituito un errore INVALID_ARGUMENT.
orderBy

string

L'ordine in cui vengono restituiti i prodotti, se applicabile.

Consulta SearchRequest.order_by per la definizione e la sintassi.

Il valore deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 1000 caratteri. In caso contrario, viene restituito un errore INVALID_ARGUMENT.

Può essere impostato solo per gli eventi search. Gli altri tipi di eventi non devono impostare questo campo. In caso contrario, viene restituito un errore INVALID_ARGUMENT.
offset

integer

Un numero intero che specifica l'offset corrente per la paginazione (la posizione iniziale con indice 0 tra i prodotti ritenuti pertinenti dall'API).

Per la definizione, vedi SearchRequest.offset.

Se questo campo è negativo, viene restituito un INVALID_ARGUMENT.

Può essere impostato solo per gli eventi search. Gli altri tipi di eventi non devono impostare questo campo. In caso contrario, viene restituito un errore INVALID_ARGUMENT.

CompletionInfo

Informazioni dettagliate sul completamento, inclusi il token di attribuzione del completamento e le informazioni sul completamento dei clic.

Rappresentazione JSON 
{
  "selectedSuggestion": string,
  "selectedPosition": integer
}
Campi
selectedSuggestion

string

Facoltativo. Utente finale selezionato CompleteQueryResponse.QuerySuggestion.suggestion.
selectedPosition

integer

Posizione CompleteQueryResponse.QuerySuggestion.suggestion selezionata dall'utente finale, a partire da 0.

TransactionInfo

Una transazione rappresenta l'intera transazione di acquisto.

Rappresentazione JSON 
{
  "currency": string,
  "transactionId": string,
  "value": number,
  "tax": number,
  "cost": number,
  "discountValue": number
}
Campi
currency

string

Obbligatorio. Codice valuta. Utilizza il codice ISO-4217 di tre caratteri.
transactionId

string

L'ID transazione con un limite di lunghezza di 128 caratteri.
value

number

Obbligatorio. Il valore totale diverso da zero associato alla transazione. Questo valore può includere spedizione, tasse o altri aggiustamenti al valore totale da includere.
tax

number

Tutte le imposte associate alla transazione.
cost

number

Tutti i costi associati ai prodotti. Questi possono essere costi di produzione, spese di spedizione non sostenute dall'utente finale o altri costi, in modo che:
discountValue

number

Il valore totale degli sconti applicati a questa transazione. Questa cifra deve essere esclusa da TransactionInfo.value

Ad esempio, se un utente ha pagato l'importo TransactionInfo.value, il valore nominale (pre-sconto) della transazione è la somma di TransactionInfo.value e TransactionInfo.discount_value

Ciò significa che il profitto viene calcolato allo stesso modo, indipendentemente dal valore dello sconto, e che TransactionInfo.discount_value può essere maggiore di TransactionInfo.value:

MediaInfo

Informazioni sugli eventi utente specifiche per i contenuti multimediali.

Rappresentazione JSON 
{
  "mediaProgressDuration": string,
  "mediaProgressPercentage": number
}
Campi
mediaProgressDuration

string (Duration format)

Il tempo di avanzamento dei contenuti multimediali in secondi, se applicabile. Ad esempio, se l'utente finale ha terminato 90 secondi di un video riprodotto, MediaInfo.media_progress_duration.seconds deve essere impostato su 90.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".
mediaProgressPercentage

number

L'avanzamento dei contenuti multimediali deve essere calcolato utilizzando solo mediaProgressDuration rispetto alla durata totale dei contenuti multimediali.

Questo valore deve essere compreso tra [0, 1.0] inclusi.

Se non si tratta di una riproduzione o se non è possibile calcolare l'avanzamento (ad es. live streaming in corso), questo campo deve essere deselezionato.

Feedback

Informazioni sul feedback degli utenti. Queste informazioni verranno utilizzate per la registrazione e le metriche.

Rappresentazione JSON 
{
  "feedbackType": enum (FeedbackType),
  "reasons": [
    enum (Reason)
  ],
  "comment": string,
  "conversationInfo": {
    object (ConversationInfo)
  },
  "llmModelVersion": string,
  "feedbackSource": enum (FeedbackSource),
  "componentVersion": string,
  "dataTermsAccepted": boolean
}
Campi
feedbackType

enum (FeedbackType)

Obbligatorio. Indica se l'utente fornisce un feedback positivo o negativo. Se l'utente esprime un feedback negativo, potrebbero essere presenti ulteriori dettagli.
reasons[]

enum (Reason)

Facoltativo. Il motivo se l'utente ha messo un Non mi piace.
comment

string

Facoltativo. Il commento aggiuntivo dell'utente sul feedback se l'utente ha messo un Non mi piace.
conversationInfo

object (ConversationInfo)

Le informazioni sulla conversazione correlata quando l'utente invia un feedback.
llmModelVersion

string

La versione del modello LLM utilizzata per generare la risposta.
feedbackSource

enum (FeedbackSource)

Facoltativo. Il componente UI da cui proviene il feedback dell'utente, che potrebbe essere GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP.
componentVersion

string

Facoltativo. La versione del componente da cui viene inviato questo report.
dataTermsAccepted

boolean

Facoltativo. Indica se il cliente ha accettato i termini per l'utilizzo dei dati.

FeedbackType

Il tipo di feedback fornito dall'utente.

Enum
FEEDBACK_TYPE_UNSPECIFIED Tipo di feedback non specificato.
LIKE L'utente invia un feedback positivo.
DISLIKE L'utente invia un feedback negativo.

Motivo

Il motivo per cui l'utente esprime un feedback negativo.

Enum
REASON_UNSPECIFIED Motivo non specificato.
INACCURATE_RESPONSE La risposta non è precisa.
NOT_RELEVANT La risposta non è pertinente.
INCOMPREHENSIVE La risposta è incompleta.
OFFENSIVE_OR_UNSAFE La risposta è offensiva o non sicura.
FORMAT_AND_STYLES La risposta non è formattata correttamente.
BAD_CITATION La risposta non è associata correttamente alla query.
CANVAS_NOT_GENERATED Il canvas previsto non è stato generato per la risposta.
CANVAS_QUALITY_BAD La tela generata è di scarsa qualità (ad es. imprecisa, incompleta, con una formattazione scadente).
CANVAS_EXPORT_FAILED L'esportazione del canvas generato non è riuscita (ad es. il download o l'azione di esportazione esterna non è stata completata correttamente).

ConversationInfo

Le informazioni sulla conversazione, come l'indice delle domande e il nome della sessione.

Rappresentazione JSON 
{
  "questionIndex": integer,
  "session": string,
  "query": {
    object (Query)
  },
  "assistToken": string,
  "answerQueryToken": string,
  "taskName": string
}
Campi
questionIndex

integer

L'indice dell'input utente dell'utente all'interno dei messaggi della conversazione.
session

string

Il nome della sessione appena generata o continuata.
query

object (Query)

Obbligatorio. La query di ricerca dell'utente.
assistToken

string

Facoltativo. Il token che può essere utilizzato per recuperare il log dell'assistente.
answerQueryToken

string

Facoltativo. Il token che può essere utilizzato per recuperare il log delle risposte.
taskName

string

Facoltativo. Il nome completo della risorsa dell'attività Sobi se la conversazione è stata gestita da un'attività dell'agente a lunga esecuzione. Formato: projects/{project}/locations/{location}/tasks/{taskId}

FeedbackSource

Origine del feedback in base all'integrazione.

Enum
FEEDBACK_SOURCE_UNSPECIFIED Origine del feedback non specificata.
GOOGLE_CONSOLE L'origine del feedback è Google Console.
GOOGLE_WIDGET L'origine del feedback è il widget Google.
GOOGLE_WEBAPP L'origine del feedback è l'app web Google.
GOOGLE_AGENTSPACE_MOBILE La fonte del feedback è l'app mobile Google Agentspace.

Metodi

collect

 Scrive un singolo evento utente dal browser.

import

 Importazione collettiva degli eventi utente.

purge

 Elimina definitivamente tutti gli eventi utente specificati dal filtro fornito.

write

 Scrive un singolo evento utente.