Method: locations.businesscallsinsights.list

Возвращает аналитическую информацию о бизнес-вызовах местоположения.

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
parent

string

Необходимый. Родительское местоположение, для которого требуется получить статистику вызовов. Формат: location/{locationId}.

Параметры запроса

Параметры
pageSize

integer

Необязательный. Максимальное количество возвращаемых BusinessCallsInsights. Если не указано, будет возвращено не более 20. Некоторые из metric_types (например, AGGREGATE_COUNT) возвращают одну страницу. Для этих метрик параметр pageSize игнорируется.

pageToken

string

Необязательный. Токен страницы, полученный в результате предыдущего вызова businesscallsinsights.list . Укажите это, чтобы получить следующую страницу.

При разбиении на страницы все остальные параметры, предоставленные в businesscallsinsights.list должны соответствовать вызову, который предоставил токен страницы. Некоторые из типов metric_types (например, AGGREGATE_COUNT) возвращают одну страницу. Для этих метрик pake_token игнорируется.

filter

string

Необязательный. Фильтр, ограничивающий возврат статистики вызовов. Ответ включает только записи, соответствующие фильтру.

Если MetricType не указан, возвращается AGGREGATE_COUNT. Если endDate не указан, используется последняя дата, для которой доступны данные. Если startDate не указан, по умолчанию мы будем использовать первую дату, для которой доступны данные, которая в настоящее время составляет 6 месяцев. Если startDate предшествует дате доступности данных, данные возвращаются, начиная с даты их доступности.

В настоящее время мы поддерживаем следующие фильтры. 1. startDate="ДАТА", где дата имеет формат ГГГГ-ММ-ДД. 2. endDate="ДАТА", где дата имеет формат ГГГГ-ММ-ДД. 3. metricType=XYZ, где XYZ — допустимый тип метрики. 4. Союзы (И) всего вышеперечисленного. например, «startDate=2021-08-01 И endDate=2021-08-10 И metricType=AGGREGATE_COUNT» Параметр metricType AGGREGATE_COUNT игнорирует часть даты, состоящую из DD.

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

В случае успеха тело ответа содержит данные следующей структуры:

Ответное сообщение для businesscallsinsights.list.

JSON-представление 
{
  "businessCallsInsights": [
    {
      object (BusinessCallsInsights)
    }
  ],
  "nextPageToken": string
}
Поля
businessCallsInsights[]

object ( BusinessCallsInsights )

Коллекция бизнес-звонков с информацией о местоположении.

nextPageToken

string

Токен, который можно отправить как pageToken для получения следующей страницы. Если это поле опущено, последующие страницы отсутствуют. Некоторые из типов metric_types (например, AGGREGATE_COUNT) возвращают одну страницу. Для этих метрик nextPageToken будет пустым.

Области авторизации

Требуется следующая область действия OAuth:

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

Дополнительную информацию см. в обзоре OAuth 2.0 .

БизнесЗвонкиАналитика

Статистика звонков, совершенных в определенное место.

JSON-представление 
{
  "name": string,
  "metricType": enum (MetricType),
  "aggregateMetrics": {
    object (AggregateMetrics)
  }
}
Поля
name

string

Необходимый. Имя ресурса статистики вызовов. Формат: location/{location}/businesscallsinsights.

metricType

enum ( MetricType )

Метрика, к которой применяется значение.

aggregateMetrics

object ( AggregateMetrics )

Метрика для диапазона времени на основе startDate и endDate.

Тип метрики

Тип метрики.

Перечисления
METRIC_TYPE_UNSPECIFIED Тип метрики не указан.
AGGREGATE_COUNT Предоставленные метрики представляют собой счетчики, агрегированные по входному диапазону времени.

Агрегатные метрики

Метрики, агрегированные за входной диапазон времени.

JSON-представление 
{
  "missedCallsCount": integer,
  "answeredCallsCount": integer,
  "hourlyMetrics": [
    {
      object (HourlyMetrics)
    }
  ],
  "weekdayMetrics": [
    {
      object (WeekDayMetrics)
    }
  ],
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Поля
missedCallsCount

integer

Общее количество пропущенных звонков.

answeredCallsCount

integer

Общее количество отвеченных вызовов.

hourlyMetrics[]

object ( HourlyMetrics )

Список метрик по часам суток.

weekdayMetrics[]

object ( WeekDayMetrics )

Список показателей по дням недели.

startDate

object ( Date )

Дата для этого показателя. Если метрика является ежемесячной, используются только год и месяц.

endDate

object ( Date )

Дата окончания для этого показателя.

Почасовые метрики

Показатели за час.

JSON-представление 
{
  "hour": integer,
  "missedCallsCount": integer
}
Поля
hour

integer

Час дня. Допустимые значения: 0–23.

missedCallsCount

integer

Общее количество пропущенных звонков за этот час.

НеделяДеньМетрики

Показатели за день недели.

JSON-представление 
{
  "day": enum (DayOfWeek),
  "missedCallsCount": integer
}
Поля
day

enum ( DayOfWeek )

День недели. Допустимые значения: воскресенье – суббота.

missedCallsCount

integer

Общее количество пропущенных звонков за этот час.

ДеньНедели

Представляет день недели.

Перечисления
DAY_OF_WEEK_UNSPECIFIED День недели не указан.
MONDAY Понедельник
TUESDAY Вторник
WEDNESDAY Среда
THURSDAY Четверг
FRIDAY Пятница
SATURDAY Суббота
SUNDAY Воскресенье

Дата

Представляет полную или частичную календарную дату, например день рождения. Время суток и часовой пояс либо указаны в другом месте, либо не имеют значения. Дата указана по григорианскому календарю. Это может представлять собой одно из следующих действий:

  • Полная дата с ненулевыми значениями года, месяца и дня.
  • Месяц и день с нулевым годом (например, годовщина)
  • Год сам по себе, с нулевым месяцем и нулевым днем.
  • Год и месяц с нулевым днем ​​(например, дата истечения срока действия кредитной карты).

Связанные типы: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp

JSON-представление 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Поля
year

integer

Год даты. Должно быть от 1 до 9999 или 0, чтобы указать дату без года.

month

integer

Месяц года. Должно быть от 1 до 12 или 0, чтобы указать год без месяца и дня.

day

integer

День месяца. Должно быть от 1 до 31 и действительно для года и месяца, или 0, чтобы указать год отдельно или год и месяц, если день не имеет значения.