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 recuperarán las estadísticas de llamadas. Formato: locations/{locationId}

Parámetros de consulta

Parámetros
pageSize

integer

Opcional. Es la cantidad máxima de BusinessCallsInsights que se debe mostrar. Si no se especifican, se mostrarán 20 como máximo. Algunos de metric_types(p. ej., 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 metric_types (p. ej., AGGREGATE_COUNT) muestran una sola página. Para estas métricas, se ignora el pake_token.
filter

string

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

Si no se proporciona MetricType, se muestra AGGREGATE_COUNT. Si no se proporciona endDate, se utiliza la última fecha para la que hay datos disponibles. Si no se proporciona startDate, usaremos de forma predeterminada la primera fecha de la que haya datos disponibles, 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. fechadeinicio="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(AND) de todo lo anterior. p.ej., "startDate=2021-08-01 AND endDate=2021-08-10 AND metricType=AGGREGATE_COUNT" El AGGREGATE_COUNT metricType ignora la parte del 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)

Es una colección de estadísticas de llamadas a empresas de 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 metric_types (p. ej., AGGREGATE_COUNT) muestran una sola página. Para estas métricas, el 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: locations/{location}/businesscallsinsights
metricType

enum (MetricType)

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

object (AggregateMetrics)

Es una métrica del intervalo de tiempo basado en startDate y endDate.

MetricType

Es el tipo de métrica.

Enumeraciones
METRIC_TYPE_UNSPECIFIED No se especifica el tipo de métrica.
AGGREGATE_COUNT Las métricas proporcionadas son recuentos agregados en el intervalo de tiempo de entrada.

AggregateMetrics

Son 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

Recuento total de llamadas contestadas.
hourlyMetrics[]

object (HourlyMetrics)

Una lista de métricas por hora del día.
weekdayMetrics[]

object (WeekDayMetrics)

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

object (Date)

Es la 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 por 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 durante 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 durante esta hora.

DayOfWeek

Representa un día de la semana.

Enumeraciones
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 son insignificantes. La fecha está relacionada con el calendario gregoriano. 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 en cero (p.ej., una 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 ser entre 1 y 9,999, o bien 0 para especificar una fecha sin año.
month

integer

Mes del año. Debe ser del 1 al 12 o 0 para especificar un año sin un mes ni un día.
day

integer

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