Method: properties.chat

Oferece uma interface de chat para interagir com os dados do Google Analytics usando a API.

Este produto usa IA e pode apresentar informações imprecisas. Sua atividade no chat pode ser usada para melhorar o produto e está sujeita aos Termos, à política de uso da IA e à Política de Privacidade do Google. Saiba mais sobre "properties.chat AI Privacy".

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
property

string

Obrigatório. A propriedade sobre a qual conversar. Formato: properties/{property}

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "userQuery": string,
  "returnPropertyQuota": boolean,
  "sessionId": string
}
Campos
userQuery

string

Obrigatório. A consulta do usuário.
returnPropertyQuota

boolean

Opcional. Se for verdadeiro, a resposta vai incluir o estado atual da cota dessa propriedade do Google Analytics. A cota é retornada em PropertyChatQuota.
sessionId

string

Opcional. Forneça esse ID para continuar uma conversa e manter o contexto. Se esse campo estiver vazio ou não definido, uma nova sessão de chat será criada. IDs de sessão inválidos vão resultar em um erro.

Corpo da resposta

Mensagem de resposta para o método properties.chat.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "sessionId": string,
  "blocks": [
    {
      object (ResponseBlock)
    }
  ],
  "propertyQuota": {
    object (PropertyChatQuota)
  }
}
Campos
sessionId

string

O identificador exclusivo desta sessão de chat. Forneça esse ID em solicitações subsequentes para manter o contexto da conversa.
blocks[]

object (ResponseBlock)

Os blocos de resposta que compõem a resposta do chat. Isso pode incluir texto, tabelas e listas.
propertyQuota

object (PropertyChatQuota)

O estado da cota da propriedade do Google Analytics, incluindo esta solicitação.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

ResponseBlock

Um bloco de dados estruturados na resposta do chat.

Representação 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.
}
Campos
Um bloco de dados estruturados. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo, um dos campos será definido em uma resposta:
text

string

Um bloco de texto.
table

object (DataTable)

Um bloco de dados de tabela.
Fim dos campos mutuamente exclusivos.

DataTable

Uma tabela de dados.

Representação JSON 
{
  "headers": [
    {
      object (DataTableHeader)
    }
  ],
  "rows": [
    {
      object (DataTableRow)
    }
  ]
}
Campos
headers[]

object (DataTableHeader)

Descreve colunas de dimensão. O número e a ordem dos cabeçalhos correspondem às dimensões presentes nas linhas.
rows[]

object (DataTableRow)

Linhas de combinações de valores de dimensão e valores de métricas no relatório.

DataTableHeader

Descreve um cabeçalho de coluna em uma DataTable.

Representação JSON 
{
  "header": string,
  "dataType": string
}
Campos
header

string

Nome do cabeçalho.
dataType

string

O tipo de dados.

DataTableRow

Uma linha em uma DataTable.

Representação JSON 
{
  "columns": [
    {
      object (DataTableCell)
    }
  ]
}
Campos
columns[]

object (DataTableCell)

Os valores das células na linha.

DataTableCell

Uma célula em uma tabela de dados.

Representação JSON 
{
  "value": string
}
Campos
value

string

O valor da célula.

PropertyChatQuota

Cota de propriedade para campos específicos do chatbot.

Representação JSON 
{
  "tokensPerDay": {
    object (QuotaStatus)
  },
  "tokensPerHour": {
    object (QuotaStatus)
  }
}
Campos
tokensPerDay

object (QuotaStatus)

tokens properties.chat consumidos por dia.
tokensPerHour

object (QuotaStatus)

tokens properties.chat consumidos por hora.