Method: properties.chat

Bietet eine Chat-Oberfläche für die Interaktion mit Google Analytics-Daten über die API.

Dieses Produkt basiert auf künstlicher Intelligenz (KI) und kann fehlerhafte Informationen anzeigen. Ihre Chat-Aktivitäten können zur Verbesserung des Produkts verwendet werden. Ihre Nutzung unterliegt den Nutzungsbedingungen, der Richtlinie zur Nutzung von KI und der Datenschutzerklärung von Google. Weitere Informationen zum Datenschutz bei Chat-KI

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
property

string

Erforderlich. Das Attribut, über das gechattet werden soll. Format: properties/{property}

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "userQuery": string,
  "returnPropertyQuota": boolean,
  "sessionId": string
}
Felder
userQuery

string

Erforderlich. Die Anfrage des Nutzers.
returnPropertyQuota

boolean

Optional. Wenn „true“, enthält die Antwort den aktuellen Status des Kontingents dieser Analytics-Property. Das Kontingent wird in PropertyChatQuota zurückgegeben.
sessionId

string

Optional. Geben Sie diese Sitzungs-ID an, um eine bestehende Unterhaltung fortzusetzen und den Kontext beizubehalten. Wenn dieses Feld leer oder nicht festgelegt ist, wird eine neue Chatsitzung erstellt. Ungültige Sitzungs-IDs führen zu einem Fehler.

Antworttext

Antwortnachricht für die Methode „properties.chat“.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "sessionId": string,
  "blocks": [
    {
      object (ResponseBlock)
    }
  ],
  "propertyQuota": {
    object (PropertyChatQuota)
  }
}
Felder
sessionId

string

Die eindeutige Kennung für diese Chatsitzung. Geben Sie diese ID in nachfolgenden Anfragen an, um den Unterhaltungskontext beizubehalten.
blocks[]

object (ResponseBlock)

Die Antwortblöcke, aus denen sich die Chatantwort zusammensetzt. Das können Text, Tabellen und Listen sein.
propertyQuota

object (PropertyChatQuota)

Der Kontingentstatus dieser Analytics-Property, einschließlich dieser Anfrage.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

ResponseBlock

Ein Block mit strukturierten Daten in der Chatantwort.

JSON-Darstellung 
{

  // 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.
}
Felder
Ein Block mit strukturierten Daten. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
text

string

Einen Textblock.
table

object (DataTable)

Ein Block mit Tabellendaten.
Ende der sich gegenseitig ausschließenden Felder.

DataTable

Eine Datentabelle.

JSON-Darstellung 
{
  "headers": [
    {
      object (DataTableHeader)
    }
  ],
  "rows": [
    {
      object (DataTableRow)
    }
  ]
}
Felder
headers[]

object (DataTableHeader)

Beschreibt Dimensionsspalten. Die Anzahl und Reihenfolge der Überschriften entspricht den Dimensionen in den Zeilen.
rows[]

object (DataTableRow)

Zeilen mit Kombinationen aus Dimensionswerten und Messwerten im Bericht.

DataTableHeader

Beschreibt eine Spaltenüberschrift in einer DataTable.

JSON-Darstellung 
{
  "header": string,
  "dataType": string
}
Felder
header

string

Der Name des Headers.
dataType

string

Der Datentyp.

DataTableRow

Eine Zeile in einer DataTable.

JSON-Darstellung 
{
  "columns": [
    {
      object (DataTableCell)
    }
  ]
}
Felder
columns[]

object (DataTableCell)

Die Zellwerte in der Zeile.

DataTableCell

Eine Zelle in einer Datentabelle.

JSON-Darstellung 
{
  "value": string
}
Felder
value

string

Der Wert der Zelle.

PropertyChatQuota

Property-Kontingent für chatbotspezifische Felder.

JSON-Darstellung 
{
  "tokensPerDay": {
    object (QuotaStatus)
  },
  "tokensPerHour": {
    object (QuotaStatus)
  }
}
Felder
tokensPerDay

object (QuotaStatus)

Verbrauchte Chat-Tokens pro Tag
tokensPerHour

object (QuotaStatus)

properties.chat-Tokens, die pro Stunde verbraucht werden.