Method: locations.businesscallsinsights.list

返回针对某个营业地点的商家来电的数据分析。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

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

查询参数

参数
pageSize

integer

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

BusinessCallsInsights

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

JSON 表示法 
{
  "name": string,
  "metricType": enum (MetricType),
  "aggregateMetrics": {
    object (AggregateMetrics)
  }
}
字段
name

string

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

enum (MetricType)

此值所适用的指标。
aggregateMetrics

object (AggregateMetrics)

基于 startDate 和 endDate 的时间范围的指标。

MetricType

指标的类型。

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

AggregateMetrics

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

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)

此指标的结束日期。

HourlyMetrics

一小时指标。

JSON 表示法 
{
  "hour": integer,
  "missedCallsCount": integer
}
字段
hour

integer

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

integer

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

WeekDayMetrics

一周的指标。

JSON 表示法 
{
  "day": enum (DayOfWeek),
  "missedCallsCount": integer
}
字段
day

enum (DayOfWeek)

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

integer

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

DayOfWeek

表示星期几。

枚举
DAY_OF_WEEK_UNSPECIFIED 未指定星期几。
MONDAY 星期一
TUESDAY 星期二
WEDNESDAY 星期三
THURSDAY 星期四
FRIDAY 星期五
SATURDAY 星期六
SUNDAY 星期日

日期

表示整个或部分日历日期，例如生日。一天中的时间和时区要么在别处指定，要么不重要。该日期相对于公历。它可以表示以下其中一项：

  • 包含非零年、月和日值的完整日期
  • 月份和日期，年份为 0（例如周年）
  • 单独的一年，零月零日
  • 年和月，日期为零（例如信用卡失效日期）

相关类型：* 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 表示单独指定年份，或者在日期不重要的情况下指定年份和月份。