Method: properties.chat

Proporciona una interfaz de chat para interactuar con los datos de Google Analytics a través de la API.

Este producto usa IA y puede mostrar información inexacta. Es posible que tu actividad de chat se use para mejorar el producto y que tu uso esté sujeto a las Condiciones, la Política de Uso de IA y la Política de Privacidad de Google. Obtén más información sobre la privacidad de la IA de Chat de propiedades.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
property

string

Obligatorio. Es la propiedad sobre la que se chateará. Formato: properties/{property}

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "userQuery": string,
  "returnPropertyQuota": boolean,
  "sessionId": string
}
Campos
userQuery

string

Obligatorio. Es la búsqueda del usuario.
returnPropertyQuota

boolean

Opcional. Si es verdadero, la respuesta incluirá el estado actual de la cuota de esta propiedad de Analytics. La cuota se devuelve en PropertyChatQuota.
sessionId

string

Opcional. Proporciona este ID de sesión para continuar una conversación existente y mantener el contexto. Si este campo está vacío o no se configuró, se crea una sesión de chat nueva. Los IDs de sesión no válidos generarán un error.

Cuerpo de la respuesta

Es el mensaje de respuesta para el método properties.chat.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "sessionId": string,
  "blocks": [
    {
      object (ResponseBlock)
    }
  ],
  "propertyQuota": {
    object (PropertyChatQuota)
  }
}
Campos
sessionId

string

Es el identificador único de esta sesión de chat. Proporciona este ID en solicitudes posteriores para mantener el contexto de la conversación.
blocks[]

object (ResponseBlock)

Son los bloques de respuesta que componen la respuesta del chat. Esto puede incluir texto, tablas y listas.
propertyQuota

object (PropertyChatQuota)

Es el estado de la cuota de esta propiedad de Analytics, incluida esta solicitud.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

ResponseBlock

Un bloque de datos estructurados en la respuesta del chat.

Representación 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
Es un bloque de datos estructurados. A continuación, se incluye una lista de campos mutuamente excluyentes. En una respuesta, se establecerá, como máximo, uno de los siguientes campos:
text

string

Es un bloque de texto.
table

object (DataTable)

Es un bloque de datos de tabla.
Fin de los campos mutuamente exclusivos.

DataTable

Es una tabla de datos.

Representación JSON 
{
  "headers": [
    {
      object (DataTableHeader)
    }
  ],
  "rows": [
    {
      object (DataTableRow)
    }
  ]
}
Campos
headers[]

object (DataTableHeader)

Describe las columnas de dimensiones. La cantidad y el orden de los encabezados coinciden con las dimensiones presentes en las filas.
rows[]

object (DataTableRow)

Son las filas de combinaciones de valores de dimensiones y valores de métricas en el informe.

DataTableHeader

Describe un encabezado de columna en un DataTable.

Representación JSON 
{
  "header": string,
  "dataType": string
}
Campos
header

string

Es el nombre del encabezado.
dataType

string

Es el tipo de datos.

DataTableRow

Es una fila de un objeto DataTable.

Representación JSON 
{
  "columns": [
    {
      object (DataTableCell)
    }
  ]
}
Campos
columns[]

object (DataTableCell)

Son los valores de las celdas de la fila.

DataTableCell

Es una celda en una tabla de datos.

Representación JSON 
{
  "value": string
}
Campos
value

string

Es el valor de la celda.

PropertyChatQuota

Es la cuota de propiedad para los campos específicos del chatbot.

Representación JSON 
{
  "tokensPerDay": {
    object (QuotaStatus)
  },
  "tokensPerHour": {
    object (QuotaStatus)
  }
}
Campos
tokensPerDay

object (QuotaStatus)

Son los tokens de chat consumidos por día.
tokensPerHour

object (QuotaStatus)

Propiedades: Tokens de chat consumidos por hora.