Method: properties.chat

Fournit une interface de chat pour interagir avec les données Google Analytics via l'API.

Ce produit utilise l'IA et peut afficher des informations inexactes. Votre activité de chat peut être utilisée pour améliorer le produit, et votre utilisation est soumise aux Conditions d'utilisation, au Règlement sur l'utilisation de l'IA et aux Règles de confidentialité de Google. En savoir plus sur la confidentialité de l'IA dans les propriétés Chat

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
property

string

Obligatoire. Propriété sur laquelle discuter. Format : properties/{property}

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "userQuery": string,
  "returnPropertyQuota": boolean,
  "sessionId": string
}
Champs
userQuery

string

Obligatoire. Requête de l'utilisateur.
returnPropertyQuota

boolean

Facultatif. Si la valeur est "true", la réponse inclut l'état actuel du quota de cette propriété Analytics. Le quota est renvoyé dans PropertyChatQuota.
sessionId

string

Facultatif. Fournissez cet ID de session pour poursuivre une conversation existante et conserver le contexte. Si ce champ est vide ou non défini, une nouvelle session de chat est créée. Les ID de session non valides génèrent une erreur.

Corps de la réponse

Message de réponse pour la méthode properties.chat.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "sessionId": string,
  "blocks": [
    {
      object (ResponseBlock)
    }
  ],
  "propertyQuota": {
    object (PropertyChatQuota)
  }
}
Champs
sessionId

string

Identifiant unique de cette session de chat. Fournissez cet ID dans les requêtes suivantes pour conserver le contexte de la conversation.
blocks[]

object (ResponseBlock)

Blocs de réponse qui composent la réponse du chat. Il peut s'agir de texte, de tableaux et de listes.
propertyQuota

object (PropertyChatQuota)

État du quota de cette propriété Analytics, y compris cette requête.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

ResponseBlock

Un bloc de données structurées dans une réponse de chat.

Représentation 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.
}
Champs
Un bloc de données structurées. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
text

string

Un bloc de texte.
table

object (DataTable)

Bloc de données de tableau.
Fin des champs qui s'excluent mutuellement.

DataTable

Table de données.

Représentation JSON 
{
  "headers": [
    {
      object (DataTableHeader)
    }
  ],
  "rows": [
    {
      object (DataTableRow)
    }
  ]
}
Champs
headers[]

object (DataTableHeader)

Décrit les colonnes de dimensions. Le nombre et l'ordre des en-têtes correspondent aux dimensions présentes dans les lignes.
rows[]

object (DataTableRow)

Lignes de combinaisons de valeurs de dimension et de valeurs de métrique dans le rapport.

DataTableHeader

Décrit un en-tête de colonne dans une DataTable.

Représentation JSON 
{
  "header": string,
  "dataType": string
}
Champs
header

string

Nom de l'en-tête.
dataType

string

Type de données.

DataTableRow

Ligne d'un DataTable.

Représentation JSON 
{
  "columns": [
    {
      object (DataTableCell)
    }
  ]
}
Champs
columns[]

object (DataTableCell)

Valeurs des cellules de la ligne.

DataTableCell

Cellule d'un tableau de données.

Représentation JSON 
{
  "value": string
}
Champs
value

string

Valeur de la cellule.

PropertyChatQuota

Quota de propriété pour les champs spécifiques aux chatbots.

Représentation JSON 
{
  "tokensPerDay": {
    object (QuotaStatus)
  },
  "tokensPerHour": {
    object (QuotaStatus)
  }
}
Champs
tokensPerDay

object (QuotaStatus)

Propriétés : jetons Chat consommés par jour.
tokensPerHour

object (QuotaStatus)

Jetons properties.chat utilisés par heure.