Method: properties.chat

Предоставляет интерфейс чата для взаимодействия с данными Google Analytics через API.

This product uses AI and may display inaccurate info. Your chat activity may be used to improve the product and your use is subject to Google's Terms , AI Use Policy , and Privacy Policy . Learn more about properties.chat AI Privacy .

HTTP-запрос

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

В URL-адресе используется синтаксис транскодирования gRPC .

Параметры пути

Параметры
property

string

Обязательно. Объект, который нужно обсудить. Формат: properties/{property}

Текст запроса

Тело запроса содержит данные следующей структуры:

JSON-представление 
{
  "userQuery": string,
  "returnPropertyQuota": boolean,
  "sessionId": string
}
Поля
userQuery

string

Обязательно. Запрос пользователя.

returnPropertyQuota

boolean

Необязательный параметр. Если значение равно true, в ответе будет указано текущее состояние квоты для данного аналитического ресурса. Квота возвращается в PropertyChatQuota .

sessionId

string

Optional. Provide this session ID to continue an existing conversation and maintain context. If this field is empty or unset, a new chat session is created. Invalid session IDs will result in an error.

Ответный текст

Ответное сообщение для метода properties.chat.

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "sessionId": string,
  "blocks": [
    {
      object (ResponseBlock)
    }
  ],
  "propertyQuota": {
    object (PropertyChatQuota)
  }
}
Поля
sessionId

string

Уникальный идентификатор для данной сессии чата. Указывайте этот идентификатор в последующих запросах для сохранения контекста разговора.

blocks[]

object ( ResponseBlock )

Блоки ответов, составляющие сообщение в чате. Они могут включать текст, таблицы и списки.

propertyQuota

object ( PropertyChatQuota )

Состояние квоты этого аналитического ресурса, включая данный запрос.

Области полномочий

Требуется следующая область действия OAuth:

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

ResponseBlock

Один блок структурированных данных в ответе чата.

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.
}
Поля
Один блок структурированных данных. Ниже приведён список взаимоисключающих полей. В ответе будет установлено не более одного из полей:
text

string

Блок текста.

table

object ( DataTable )

Блок табличных данных.

Конец взаимоисключающих областей.

Таблица данных

Таблица данных.

JSON-представление 
{
  "headers": [
    {
      object (DataTableHeader)
    }
  ],
  "rows": [
    {
      object (DataTableRow)
    }
  ]
}
Поля
headers[]

object ( DataTableHeader )

Описывает столбцы измерений. Количество заголовков и порядок заголовков соответствуют измерениям, присутствующим в строках.

rows[]

object ( DataTableRow )

Строки комбинаций значений измерений и значений метрик в отчете.

Заголовок таблицы данных

Описывает заголовок столбца в таблице данных.

JSON-представление 
{
  "header": string,
  "dataType": string
}
Поля
header

string

Название заголовка.

dataType

string

Тип данных.

DataTableRow

Строка в таблице данных.

JSON-представление 
{
  "columns": [
    {
      object (DataTableCell)
    }
  ]
}
Поля
columns[]

object ( DataTableCell )

Значения ячеек в строке.

DataTableCell

Ячейка в таблице данных.

JSON-представление 
{
  "value": string
}
Поля
value

string

Значение ячейки.

PropertyChatQuota

Квота на использование определенных полей чат-бота.

JSON-представление 
{
  "tokensPerDay": {
    object (QuotaStatus)
  },
  "tokensPerHour": {
    object (QuotaStatus)
  }
}
Поля
tokensPerDay

object ( QuotaStatus )

Свойства. Количество токенов чата, потребляемых в день.

tokensPerHour

object ( QuotaStatus )

Свойства. Количество токенов чата, потребляемых в час.