Method: locations.businesscallsinsights.list

Muestra estadísticas de las llamadas a empresas para una ubicación.

Solicitud HTTP

GET https://mybusinessbusinesscalls.googleapis.com/v1/{parent=locations/*}/businesscallsinsights

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

Parámetros de ruta de acceso

Parámetros
parent

string

Obligatorio. La ubicación superior para la que se deben recuperar las estadísticas de llamadas. Formato: ubicaciones/{locationId}

Parámetros de consulta

Parámetros
pageSize

integer

Opcional. Es la cantidad máxima de BusinessCallsInsights que se mostrarán. Si no se especifican, se mostrarán 20 como máximo. Algunos de los tipos de métricas(por ejemplo, AGGREGATE_COUNT) muestran una sola página. Para estas métricas, se ignora pageSize.
pageToken

string

Opcional. Un token de página, recibido desde una llamada businesscallsinsights.list anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a businesscallsinsights.list deben coincidir con la llamada que proporcionó el token de la página. Algunos de los metric_types (p. ej., AGGREGATE_COUNT) muestran una sola página. Para estas métricas, se ignora pake_token.
filter

string

Opcional. Un filtro que restringe las estadísticas de las llamadas para que se muestren. La respuesta solo incluye entradas que coinciden con el filtro.

Si no se proporciona el MetricType, se muestra AGGREGATE_COUNT. Si no se proporciona endDate, se utilizará la última fecha para la cual se hayan disponible datos. Si no se proporciona una fecha de inicio, se utilizará de forma predeterminada la primera fecha para la que estén disponibles los datos, que actualmente es de 6 meses. Si startDate es anterior a la fecha en que los datos están disponibles, los datos se muestran a partir de la fecha en que están disponibles.

En este momento, admitimos los siguientes filtros. 1. startDate="DATE", donde la fecha está en formato AAAA-MM-DD. 2. endDate="DATE", donde la fecha está en formato AAAA-MM-DD. 3. metricType=XYZ, en el que XYZ es un MetricType válido 4. Conjunciones(Y) de todo lo anterior, p. ej., "startDate=2021-08-01 AND endDate=2021-08-10 AND metricType=AGGREGATE_COUNT" El metricType AGGREGATE_COUNT ignora la parte DD de la fecha.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

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

Mensaje de respuesta para businesscallsinsights.list.

Representación JSON 
{
  "businessCallsInsights": [
    {
      object (BusinessCallsInsights)
    }
  ],
  "nextPageToken": string
}
Campos
businessCallsInsights[]

object (BusinessCallsInsights)

Un conjunto de estadísticas de llamadas a empresas relacionadas con la ubicación
nextPageToken

string

Un token que se puede enviar como pageToken para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes. Algunos de los metric_types (p. ej., AGGREGATE_COUNT) muestran una sola página. En estas métricas, el valor nextPageToken estará vacío.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/business.manage

Para obtener más información, consulta la Descripción general de OAuth 2.0.

BusinessCallsInsights

Estadísticas de las llamadas realizadas a una ubicación

Representación JSON 
{
  "name": string,
  "metricType": enum (MetricType),
  "aggregateMetrics": {
    object (AggregateMetrics)
  }
}
Campos
name

string

Obligatorio. El nombre del recurso de las estadísticas de llamadas. Formato: ubicaciones/{location}/businesscallsinsights
metricType

enum (MetricType)

La métrica para la que se aplica el valor.
aggregateMetrics

object (AggregateMetrics)

Métrica para el intervalo de tiempo basada en startDate y endDate.

MetricType

Es el tipo de métrica.

Enumeradores
METRIC_TYPE_UNSPECIFIED No se especificó el tipo de métrica.
AGGREGATE_COUNT Las métricas proporcionadas son recuentos agregados en el time_range de entrada.

AggregateMetrics

Métricas agregadas durante el intervalo de tiempo de entrada.

Representación JSON 
{
  "missedCallsCount": integer,
  "answeredCallsCount": integer,
  "hourlyMetrics": [
    {
      object (HourlyMetrics)
    }
  ],
  "weekdayMetrics": [
    {
      object (WeekDayMetrics)
    }
  ],
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Campos
missedCallsCount

integer

Recuento total de llamadas perdidas
answeredCallsCount

integer

Cantidad total de llamadas respondidas
hourlyMetrics[]

object (HourlyMetrics)

Una lista de métricas según la hora del día.
weekdayMetrics[]

object (WeekDayMetrics)

Una lista de métricas por día de la semana.
startDate

object (Date)

Fecha de esta métrica. Si la métrica es mensual, solo se usan el año y el mes.
endDate

object (Date)

Es la fecha de finalización de esta métrica.

HourlyMetrics

Métricas durante una hora.

Representación JSON 
{
  "hour": integer,
  "missedCallsCount": integer
}
Campos
hour

integer

Hora del día Se permiten valores incluidos en el rango del 0 al 23.
missedCallsCount

integer

Recuento total de llamadas perdidas en esta hora.

WeekDayMetrics

Métricas para un día de la semana.

Representación JSON 
{
  "day": enum (DayOfWeek),
  "missedCallsCount": integer
}
Campos
day

enum (DayOfWeek)

Día de la semana. Los valores permitidos son de domingo a sábado.
missedCallsCount

integer

Recuento total de llamadas perdidas en esta hora.

DayOfWeek

Representa un día de la semana.

Enumeradores
DAY_OF_WEEK_UNSPECIFIED No se especifica el día de la semana.
MONDAY Lunes
TUESDAY Martes
WEDNESDAY miércoles".
THURSDAY Jueves
FRIDAY Viernes
SATURDAY Sábado
SUNDAY Domingo

Fecha

Representa una fecha de calendario completa o parcial, como un cumpleaños. La hora del día y la zona horaria se especifican en otro lugar o no son significativas. La fecha está relacionada con el calendario gregoriano. Esto puede representar una de las siguientes opciones:

  • Una fecha completa con valores de año, mes y día que no sean cero
  • Un mes y un día con un año cero (p.ej., un aniversario)
  • Un año solo, con un mes cero y un día cero
  • Un año y un mes, con un día cero (p.ej., la fecha de vencimiento de una tarjeta de crédito)

Tipos relacionados: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp

Representación JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Campos
year

integer

Año de la fecha. Debe encontrarse entre 1 y 9999, o bien entre 0 para especificar una fecha sin año.
month

integer

Mes del año Debe encontrarse entre 1 y 12, o bien 0 para especificar un año sin mes ni día.
day

integer

Día del mes. Debe encontrarse entre 1 y 31 y ser válido para el año y el mes, o bien 0 para especificar solo un año o un año y mes en los que el día no sea importante.