Package google.mybusiness.businesscalls.v1

索引

BusinessCallsService

借助此 API，商家可以管理商家来电，并收集营业地点未接电话数量等信息。如需详细了解商家来电，请访问 https://support.google.com/business/answer/9688285?p=call_history

如果 Google 商家资料与 Google Ads 帐号相关联，并且启用了通话记录，那么通话时长超过特定时间且可归因于广告互动的来电就会显示在关联的 Google Ads 帐号的“直接从广告中拨打的来电”转化下。如果在优化策略中使用智能出价和来电转化，那么广告支出可能会发生变化。详细了解智能出价。”

要查看营业地点的来电并对其执行操作，您必须是营业地点的 OWNER、CO_OWNER 或 MANAGER。

GetBusinessCallsSettings

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 概览。
UpdateBusinessCallsSettings

rpc UpdateBusinessCallsSettings(UpdateBusinessCallsSettingsRequest) returns (BusinessCallsSettings)

更新指定营业地点的商家来电设置。

授权范围

需要以下 OAuth 作用域：

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

有关详情，请参阅 OAuth 2.0 概览。

AggregateMetrics

输入时间范围内汇总的指标。

字段
missed_calls_count

Int32Value

未接电话总数。
answered_calls_count

Int32Value

已接来电总数。
hourly_metrics[]

HourlyMetrics

按时段划分的指标列表。
weekday_metrics[]

WeekDayMetrics

按星期几划分的指标列表。
start_date

Date

此指标的日期。如果指标为按月，则仅使用年份和月份。
end_date

Date

此指标的结束日期。

BusinessCallsInsights

针对某个营业地点的致电次数的数据分析。

字段
name

string

必需。通话数据分析的资源名称。格式：locations/{location}/businesscallsinsights
metric_type

MetricType

此值所适用的指标。
aggregate_metrics

AggregateMetrics

基于 start_date 和 end_date 的时间范围的指标。

BusinessCallsSettings

针对营业地点的商家通话设置。

字段
name

string

必需。通话设置的资源名称。格式：locations/{location}/businesscallssettings
calls_state

CallsState

必需。此营业地点商家来电的注册状态。
consent_time

Timestamp

仅限输入。最终用户同意 API 用户启用业务调用的时间。

CallsState

营业地点在商家来电中可能所处的状态。这些状态可以更新为仅“已启用”或“已停用”。其他任何请求都将返回 PRECONDITION_FAILED 错误。

枚举
CALLS_STATE_UNSPECIFIED 未指定。
ENABLED 已为该营业地点启用商家来电功能。
DISABLED 已针对该营业地点停用商家通话。

ErrorCode

内部故障的错误代码。

枚举
ERROR_CODE_UNSPECIFIED 未指定的错误代码。
ERROR_CODE_UNVERIFIED_LOCATION 此营业地点未通过验证。
ERROR_CODE_CALLS_NOT_ENABLED 营业地点的“商家调用”状态未启用。
ERROR_CODE_NOT_ELIGIBLE_LOCATION 该营业地点不符合商家来电的条件。

GetBusinessCallsSettingsRequest

GetBusinessCallsSettings 的请求消息。

字段
name

string

必需。要获取的 BusinessCallsSettings。

name 字段用于标识要获取的商家来电设置。格式：locations/{location_id}/businesscallssettings。

HourlyMetrics

一小时指标。

字段
hour

Int32Value

一天中的小时。允许的值为 0 - 23。
missed_calls_count

Int32Value

这一小时内未接来电总数。

ListBusinessCallsInsightsRequest

ListBusinessCallsInsights 的请求消息。

字段
parent

string

必需。要获取其来电数据分析的父级位置。格式：locations/{location_id}
page_size

int32

可选。要返回的 BusinessCallsInsight 数量上限。如果未指定，则最多返回 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="DATE"，其中日期采用 YYYY-MM-DD 格式。2. end_date="DATE" ，其中日期采用 YYYY-MM-DD 格式。3. metric_type=XYZ，其中 XYZ 是有效的 MetricType。4. 以上所有方的连词(AND)。例如，"start_date=2021-08-01 AND end_date=2021-08-10 AND metric_type=AGGREGATE_COUNT" AGGREGATE_COUNT metric_type 会忽略日期的 DD 部分。

ListBusinessCallsInsightsResponse

ListBusinessCallsInsights 的响应消息。

字段
business_calls_insights[]

BusinessCallsInsights

一组营业地点的商家来电数据分析。
next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。部分 metric_types（例如 AGGREGATE_COUNT）会返回单个页面。对于这些指标，next_page_token 将为空。

MetricType

指标的类型。

枚举
METRIC_TYPE_UNSPECIFIED 未指定指标类型。
AGGREGATE_COUNT 提供的指标是按输入 time_range 汇总的计数。

UpdateBusinessCallsSettingsRequest

UpdateBusinessCallsSettings 的请求消息。

字段
business_calls_settings

BusinessCallsSettings

必需。要更新的 BusinessCallsSettings。

name 字段用于标识要更新的商家来电设置。格式：locations/{location_id}/businesscallssettings
update_mask

FieldMask

必需。要更新的字段列表。

WeekDayMetrics

一周的指标。

字段
day

DayOfWeek

星期几。允许的值包括星期日 - 星期六。
missed_calls_count

Int32Value

这一小时内未接来电总数。