- Solicitação HTTP
- Parâmetros de caminho
- Parâmetros de consulta
- Corpo da solicitação
- Corpo da resposta
- Escopos da autorização
- BusinessCallsInsights
- MetricType
- AggregateMetrics
- HourlyMetrics
- WeekDayMetrics
- DayOfWeek
- Data
Retorna insights sobre chamadas comerciais de 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 |
Obrigatório. O local pai em que os insights de chamadas vão ser buscados. Formato: locations/{locationId} |
Parâmetros de consulta
Parâmetros | |
---|---|
pageSize |
Opcional. O número máximo de BusinessCallsInsights a serem retornados. Se não for especificado, será retornado no máximo 20. Alguns dos metric_types(por exemplo, AGGREGATE_COUNT) retornam uma única página. Para essas métricas, o pageSize é ignorado. |
pageToken |
Opcional. Um token de página recebido de uma chamada Ao paginar, todos os outros parâmetros fornecidos para |
filter |
Opcional. Um filtro que restringe os insights de chamadas a retornar. A resposta inclui apenas entradas que correspondem ao filtro. Se MetricType não for fornecido, AGGREGATE_COUNT será retornado. Se a data endDate não for fornecida, será usada a última data em que os dados estarão disponíveis. Se nenhuma startDate for fornecida, o padrão será a primeira data em que os dados estiverem disponíveis, que atualmente é de seis meses. Se startDate for anterior à data em que os dados estiverem disponíveis, os dados serão retornados a partir da data em que estiverem disponíveis. No momento, oferecemos suporte aos filtros a seguir. 1. startDate="DATE" em que a data está no formato AAAA-MM-DD. 2. endDate="DATE", em que a data está no formato AAAA-MM-DD. 3. metricType=XYZ, em que XYZ é um MetricType válido. 4. Conjunções(E) de todas as opções acima. Por exemplo: "startDate=01-08-2021 AND endDate=10-08-2021 AND metricType=AGGREGATE_COUNT" O AGGREGATE_COUNT metricType 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 ( |
Campos | |
---|---|
businessCallsInsights[] |
Uma coleção de insights de chamadas de negócios para o local. |
nextPageToken |
Um token, que pode ser enviado como |
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 ( |
Campos | |
---|---|
name |
Obrigatório. O nome do recurso dos insights de chamadas. Formato: locations/{location}/businesscallsinsights |
metricType |
A métrica à qual o valor se aplica. |
aggregateMetrics |
Métrica para o 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 no time_range de entrada. |
AggregateMetrics
Métricas agregadas no período de entrada.
Representação JSON |
---|
{ "missedCallsCount": integer, "answeredCallsCount": integer, "hourlyMetrics": [ { object ( |
Campos | |
---|---|
missedCallsCount |
Contagem total de ligações perdidas. |
answeredCallsCount |
Contagem total de chamadas atendidas. |
hourlyMetrics[] |
Uma lista de métricas por hora do dia. |
weekdayMetrics[] |
Uma lista de métricas por dia da semana. |
startDate |
Data desta métrica. Se a métrica for mensal, apenas o ano e o mês serão usados. |
endDate |
Data de término dessa métrica. |
HourlyMetrics
Métricas por uma hora.
Representação JSON |
---|
{ "hour": integer, "missedCallsCount": integer } |
Campos | |
---|---|
hour |
Hora do dia. Os valores permitidos são de 0 a 23. |
missedCallsCount |
Contagem total de ligações perdidas para esta hora. |
WeekDayMetrics
Métricas para um dia da semana.
Representação JSON |
---|
{
"day": enum ( |
Campos | |
---|---|
day |
Dia da semana Os valores permitidos são domingo - sábado. |
missedCallsCount |
Contagem total de ligações perdidas para esta 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 um dia, com 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 do 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 |
Ano da data. Precisa ser de 1 a 9999 ou 0 para especificar uma data sem ano. |
month |
Mês do ano. Precisa ser de 1 a 12, ou 0 para especificar um ano sem um mês e dia. |
day |
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. |