Method: properties.chat

Fornisce un'interfaccia di chat per interagire con i dati di Google Analytics tramite l'API.

Questo prodotto utilizza l'AI e potrebbe mostrare informazioni imprecise. La tua attività di chat potrebbe essere utilizzata per migliorare il prodotto e il tuo utilizzo è soggetto ai Termini, alle Norme sull'utilizzo dell'AI e alle Norme sulla privacy di Google. Scopri di più sulla privacy di Chat AI delle proprietà.

Richiesta HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:chat

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
property

string

Obbligatorio. La proprietà di cui parlare. Formato: properties/{property}

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "userQuery": string,
  "returnPropertyQuota": boolean,
  "sessionId": string
}
Campi
userQuery

string

Obbligatorio. La query dell'utente.
returnPropertyQuota

boolean

Facoltativo. Se è true, la risposta includerà lo stato attuale della quota di questa proprietà Analytics. La quota viene restituita in PropertyChatQuota.
sessionId

string

Facoltativo. Fornisci questo ID sessione per continuare una conversazione esistente e mantenere il contesto. Se questo campo è vuoto o non è impostato, viene creata una nuova sessione di chat. Gli ID sessione non validi genereranno un errore.

Corpo della risposta

Messaggio di risposta per il metodo properties.chat.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "sessionId": string,
  "blocks": [
    {
      object (ResponseBlock)
    }
  ],
  "propertyQuota": {
    object (PropertyChatQuota)
  }
}
Campi
sessionId

string

L'identificatore univoco di questa sessione di chat. Fornisci questo ID nelle richieste successive per mantenere il contesto della conversazione.
blocks[]

object (ResponseBlock)

I blocchi di risposta che compongono la risposta della chat. Possono essere inclusi testo, tabelle ed elenchi.
propertyQuota

object (PropertyChatQuota)

Lo stato della quota di questa proprietà Analytics, inclusa questa richiesta.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

  • https://www.googleapis.com/auth/analytics.chatbot.read

ResponseBlock

Un blocco di dati strutturati nella risposta della chat.

Rappresentazione JSON 
{

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

string

Un blocco di testo.
table

object (DataTable)

Un blocco di dati della tabella.
Fine dei campi che si escludono a vicenda.

DataTable

Una tabella di dati.

Rappresentazione JSON 
{
  "headers": [
    {
      object (DataTableHeader)
    }
  ],
  "rows": [
    {
      object (DataTableRow)
    }
  ]
}
Campi
headers[]

object (DataTableHeader)

Descrive le colonne delle dimensioni. Il numero e l'ordine delle intestazioni corrispondono alle dimensioni presenti nelle righe.
rows[]

object (DataTableRow)

Righe di combinazioni di valori di dimensione e valori delle metriche nel report.

DataTableHeader

Descrive un'intestazione di colonna in un oggetto DataTable.

Rappresentazione JSON 
{
  "header": string,
  "dataType": string
}
Campi
header

string

Il nome dell'intestazione.
dataType

string

Il tipo di dati.

DataTableRow

Una riga in una DataTable.

Rappresentazione JSON 
{
  "columns": [
    {
      object (DataTableCell)
    }
  ]
}
Campi
columns[]

object (DataTableCell)

I valori delle celle nella riga.

DataTableCell

Una cella in una tabella di dati.

Rappresentazione JSON 
{
  "value": string
}
Campi
value

string

Il valore della cella.

PropertyChatQuota

Quota della proprietà per i campi specifici del chatbot.

Rappresentazione JSON 
{
  "tokensPerDay": {
    object (QuotaStatus)
  },
  "tokensPerHour": {
    object (QuotaStatus)
  }
}
Campi
tokensPerDay

object (QuotaStatus)

token properties.chat consumati al giorno.
tokensPerHour

object (QuotaStatus)

token properties.chat consumati all'ora.