Package google.mybusiness.businesscalls.v1

Индекс

БизнесЗвонкиСервис

Этот API позволяет компаниям управлять деловыми звонками и собирать такую ​​информацию, как количество пропущенных звонков в их местоположение. Дополнительную информацию о деловых звонках можно найти на странице https://support.google.com/business/answer/9688285?p=call_history .

Если профиль компании в Google связан с аккаунтом Google Рекламы и включена история звонков, звонки, которые длятся дольше определенного времени и которые можно отнести к взаимодействию с рекламой, будут отображаться в связанном аккаунте Google Рекламы в разделе «Звонки от Конверсия рекламы. Если в стратегии оптимизации используются интеллектуальное назначение ставок и звонки-конверсии, расходы на рекламу могут измениться. Узнайте больше об интеллектуальном назначении ставок ».

Чтобы просматривать и выполнять действия по вызовам местоположения, вам необходимо быть OWNER , CO_OWNER или MANAGER местоположения.

Настройки GetBusinessCalls

rpc GetBusinessCallsSettings( GetBusinessCallsSettingsRequest ) returns ( BusinessCallsSettings )

Возвращает ресурс настроек деловых звонков для данного местоположения.

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

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

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

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

ListBusinessCallsInsights

rpc ListBusinessCallsInsights( ListBusinessCallsInsightsRequest ) returns ( ListBusinessCallsInsightsResponse )

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

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

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

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

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

Обновить настройки BusinessCalls

rpc UpdateBusinessCallsSettings( UpdateBusinessCallsSettingsRequest ) returns ( BusinessCallsSettings )

Обновляет настройки делового звонка для указанного местоположения.

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

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

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

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

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

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

Поля
missed_calls_count

Int32Value

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

answered_calls_count

Int32Value

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

hourly_metrics[]

HourlyMetrics

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

weekday_metrics[]

WeekDayMetrics

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

start_date

Date

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

end_date

Date

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

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

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

Поля
name

string

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

metric_type

MetricType

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

aggregate_metrics

AggregateMetrics

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

БизнесЗвонкиНастройки

Настройки деловых звонков для местоположения.

Поля
name

string

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

calls_state

CallsState

Необходимый. Состояние регистрации этого адреса в бизнес-звонках.

consent_time

Timestamp

Только ввод. Время, когда конечный пользователь предоставил согласие пользователю API на включение бизнес-вызовов.

Состояние звонков

Возможные состояния местоположения в деловых звонках. Состояния могут быть обновлены только до ВКЛЮЧЕНО или ВЫКЛЮЧЕНО. Все остальное вернет ошибку PRECONDITION_FAILED.

Перечисления
CALLS_STATE_UNSPECIFIED Неопределенные.
ENABLED Для этого местоположения включены деловые звонки.
DISABLED Деловые звонки отключены для данного местоположения.

Код ошибки

Коды ошибок внутренних сбоев.

Перечисления
ERROR_CODE_UNSPECIFIED Неуказанный код ошибки.
ERROR_CODE_UNVERIFIED_LOCATION Местоположение не проверено.
ERROR_CODE_CALLS_NOT_ENABLED Состояние «Деловые звонки» для местоположения НЕ ВКЛЮЧЕНО.
ERROR_CODE_NOT_ELIGIBLE_LOCATION Местоположение не подходит для деловых звонков.

GetBusinessCallsSettingsЗапрос

Сообщение запроса для GetBusinessCallsSettings.

Поля
name

string

Необходимый. Параметры BusinessCallsSettings, которые необходимо получить.

Поле name используется для определения параметров бизнес-вызова, которые необходимо получить. Формат: location/{location_id}/businesscallssettings.

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

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

Поля
hour

Int32Value

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

missed_calls_count

Int32Value

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

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

Сообщение запроса для ListBusinessCallsInsights.

Поля
parent

string

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

page_size

int32

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

page_token

string

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

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

filter

string

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

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

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

ListBusinessCallsInsightsResponse

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

Поля
business_calls_insights[]

BusinessCallsInsights

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

next_page_token

string

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

Тип метрики

Тип метрики.

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

ОбновлениеBusinessCallsНастройкиЗапрос

Сообщение запроса для UpdateBusinessCallsSettings.

Поля
business_calls_settings

BusinessCallsSettings

Необходимый. Параметры BusinessCallsSettings, которые необходимо обновить.

Поле name используется для определения параметров делового звонка, которые необходимо обновить. Формат: location/{location_id}/businesscallssettings.

update_mask

FieldMask

Необходимый. Список полей для обновления.

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

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

Поля
day

DayOfWeek

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

missed_calls_count

Int32Value

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