Method: locations.businesscallsinsights.list

Retorna insights de chamadas comerciais para um local.

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O local pai para o qual os insights de chamadas serão buscados. Formato: locations/{locationId}

Parâmetros de consulta

Parâmetros
pageSize

integer

Opcional. O número máximo de BusinessCallsInsights a serem retornados. Se não for especificado, serão retornados no máximo 20. Alguns dos metric_types(por exemplo, AGGREGATE_COUNT) retornam uma única página. Nessas métricas, o pageSize é ignorado.
pageToken

string

Opcional. Um token de página recebido de uma chamada businesscallsinsights.list anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para businesscallsinsights.list precisam corresponder à chamada que forneceu o token da página. Alguns dos metric_types (por exemplo, AGGREGATE_COUNT) retornam uma única página. Nessas métricas, o pake_token é ignorado.
filter

string

Opcional. Um filtro que restringe o retorno dos insights de chamadas. A resposta inclui apenas entradas que correspondem ao filtro.

Se o MetricType não for fornecido, AGGREGATE_COUNT será retornado. Se nenhuma endDate for fornecida, a última data em que os dados estarão disponíveis será usada. Se nenhuma startDate for fornecida, o padrão será a primeira data em que os dados estiverem disponíveis, que atualmente é seis meses. Se startDate for anterior à data em que os dados estarão disponíveis, os dados serão retornados a partir da data em que estão disponíveis.

No momento, oferecemos suporte aos filtros a seguir. 1. startDate="DATA" em que a data está no formato AAAA-MM-DD. 2. endDate="DATA" em que a data está no formato AAAA-MM-DD. 3. metricType=XYZ onde XYZ é um MetricType válido. 4. Conjunções(E) de todas as opções acima. Por exemplo: "startDate=2021-08-01 AND endDate=2021-08-10 AND metricType=AGGREGATE_COUNT" O metricType AGGREGATE_COUNT ignora a parte DD da data.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

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

Mensagem de resposta para businesscallsinsights.list.

Representação JSON 
{
  "businessCallsInsights": [
    {
      object (BusinessCallsInsights)
    }
  ],
  "nextPageToken": string
}
Campos
businessCallsInsights[]

object (BusinessCallsInsights)

Um conjunto de insights de chamadas de negócios para o local.
nextPageToken

string

Um token, que pode ser enviado como pageToken para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes. Alguns dos metric_types (por exemplo, AGGREGATE_COUNT) retornam uma única página. Nessas métricas, o nextPageToken estará vazio.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.

BusinessCallsInsights

Insights de chamadas feitas para um local.

Representação JSON 
{
  "name": string,
  "metricType": enum (MetricType),
  "aggregateMetrics": {
    object (AggregateMetrics)
  }
}
Campos
name

string

Obrigatório. O nome do recurso das chamadas para insights. Formato: locations/{location}/businesscallsinsights
metricType

enum (MetricType)

A métrica à qual o valor se aplica.
aggregateMetrics

object (AggregateMetrics)

Métrica do período com base em startDate e endDate.

MetricType

O tipo de métrica.

Enums
METRIC_TYPE_UNSPECIFIED O tipo de métrica não foi especificado.
AGGREGATE_COUNT As métricas fornecidas são contagens agregadas ao longo de input time_range.

AggregateMetrics

Métricas agregadas no período de entrada.

Representação JSON 
{
  "missedCallsCount": integer,
  "answeredCallsCount": integer,
  "hourlyMetrics": [
    {
      object (HourlyMetrics)
    }
  ],
  "weekdayMetrics": [
    {
      object (WeekDayMetrics)
    }
  ],
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Campos
missedCallsCount

integer

Contagem total de chamadas perdidas.
answeredCallsCount

integer

Contagem total de chamadas atendidas.
hourlyMetrics[]

object (HourlyMetrics)

Uma lista de métricas por hora do dia.
weekdayMetrics[]

object (WeekDayMetrics)

Uma lista de métricas por dia da semana.
startDate

object (Date)

Data desta métrica. Se a métrica for mensal, apenas ano e mês serão usados.
endDate

object (Date)

Data de término desta métrica.

HourlyMetrics

Métricas para uma hora.

Representação JSON 
{
  "hour": integer,
  "missedCallsCount": integer
}
Campos
hour

integer

Hora do dia. Os valores permitidos são de 0 a 23.
missedCallsCount

integer

Contagem total de chamadas perdidas nesta hora.

WeekDayMetrics

Métricas para um dia da semana.

Representação JSON 
{
  "day": enum (DayOfWeek),
  "missedCallsCount": integer
}
Campos
day

enum (DayOfWeek)

Dia da semana. Os valores permitidos são de domingo a sábado.
missedCallsCount

integer

Contagem total de chamadas perdidas nesta hora.

DayOfWeek

Representa um dia da semana.

Enums
DAY_OF_WEEK_UNSPECIFIED O dia da semana não é especificado.
MONDAY Segunda-feira
TUESDAY Terça-feira
WEDNESDAY Quarta-feira
THURSDAY Quinta-feira
FRIDAY Sexta-feira
SATURDAY Sábado
SUNDAY Domingo

Data

Representa uma data inteira ou parcial do calendário, como um aniversário. A hora do dia e o fuso horário são especificados em outro lugar ou são insignificantes. A data é referente ao calendário gregoriano. Isso pode representar uma das seguintes opções:

  • uma data completa, com valores de ano, mês e dia diferentes de zero.
  • um mês e dia, com um ano zero (por exemplo, uma data comemorativa);
  • um ano sozinho, com um mês zero e um dia zero.
  • um ano e um mês, com um dia zero (por exemplo, uma data de validade de cartão de crédito);

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

Representação JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Campos
year

integer

Ano da data. Precisa ser de 1 a 9.999 ou 0 para especificar uma data sem ano.
month

integer

Mês do ano. Precisa ser de 1 a 12, ou 0 para especificar um ano sem um mês e dia.
day

integer

Dia do mês. Precisa ser de 1 a 31 e válido para o ano e o mês, ou 0 para especificar um ano sozinho ou um ano e mês em que o dia não é significativo.