- HTTP 要求
- 路徑參數
- 查詢參數
- 要求主體
- 回應主體
- 授權範圍
- BusinessCallsInsights
- MetricType
- AggregateMetrics
- HourlyMetrics
- WeekDayMetrics
- DayOfWeek
- 日期
傳回商家對特定地點的來電洞察資料。
HTTP 要求
GET https://mybusinessbusinesscalls.googleapis.com/v1/{parent=locations/*}/businesscallsinsights
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
parent |
必要欄位。要擷取來電洞察資料的上層位置。格式:locations/{locationId} |
查詢參數
參數 | |
---|---|
pageSize |
選用設定。要傳回的 BusinessCallsInsights 數量上限。如未指定,最多會傳回 20 個。部分 metric_types(例如 AGGREGATE_COUNT) 會傳回單一頁面。針對這些指標,系統會忽略 pageSize。 |
pageToken |
選用設定。屬於接收自前一個 進行分頁時,提供至 |
filter |
選用設定。篩選器會限制系統傳回的來電洞察資料。回應只會包含符合篩選條件的項目。 如未提供 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 |
可做為 |
授權範圍
需要下列 OAuth 範圍:
https://www.googleapis.com/auth/business.manage
詳情請參閱 OAuth 2.0 總覽。
BusinessCallsInsights
地點來電分析資料。
JSON 表示法 |
---|
{ "name": string, "metricType": enum ( |
欄位 | |
---|---|
name |
必要欄位。通話深入分析的資源名稱。格式:locations/{location}/businesscallsinsights |
metricType |
要套用值的指標。 |
aggregateMetrics |
根據開始日期和結束日期顯示時間範圍的指標。 |
MetricType
指標的類型。
列舉 | |
---|---|
METRIC_TYPE_UNSPECIFIED |
未指定指標類型。 |
AGGREGATE_COUNT |
提供的指標是輸入時間範圍的匯總數量。 |
AggregateMetrics
輸入時間範圍內匯總的指標。
JSON 表示法 |
---|
{ "missedCallsCount": integer, "answeredCallsCount": integer, "hourlyMetrics": [ { object ( |
欄位 | |
---|---|
missedCallsCount |
未接來電總數。 |
answeredCallsCount |
已接來電總數。 |
hourlyMetrics[] |
按時段顯示的指標清單。 |
weekdayMetrics[] |
按星期幾劃分的指標清單。 |
startDate |
這項指標的日期。如果是每月指標,則只會使用年份和月份。 |
endDate |
這項指標的結束日期。 |
HourlyMetrics
一小時的指標。
JSON 表示法 |
---|
{ "hour": integer, "missedCallsCount": integer } |
欄位 | |
---|---|
hour |
時段。有效值為 0 至 23。 |
missedCallsCount |
這個小時的未接來電總數。 |
WeekDayMetrics
一週的指標。
JSON 表示法 |
---|
{
"day": enum ( |
欄位 | |
---|---|
day |
星期幾。允許的值為星期日至星期六。 |
missedCallsCount |
這個小時的未接來電總數。 |
DayOfWeek
代表星期幾。
列舉 | |
---|---|
DAY_OF_WEEK_UNSPECIFIED |
未指定星期幾。 |
MONDAY |
週一 |
TUESDAY |
週二 |
WEDNESDAY |
星期三 |
THURSDAY |
週四 |
FRIDAY |
星期五 |
SATURDAY |
Saturday (週六) |
SUNDAY |
星期日 |
日期
代表完整或部分日曆的日期,例如生日。您可在其他位置指定日期和時間,或沒有其他選擇。日期以公曆為相對於公曆。可能代表下列其中一種:
- 完整日期,具有非零的年、月和日值
- 月份和日期,帶有零年 (例如週年紀念日)
- 只有一年,變成零月和零日
- 年份和月份,出現零天 (例如信用卡到期日)
相關類型:* google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
JSON 表示法 |
---|
{ "year": integer, "month": integer, "day": integer } |
欄位 | |
---|---|
year |
日期的年份。必須為 1 到 9999,或是 0 才能指定不含年份的日期。 |
month |
一年中的月份。必須為 1 到 12 或 0,才能指定不含月份和日的年份。 |
day |
一個月中的第幾天。值必須介於 1 到 31 之間,且為該年和月份計算而得;設為 0 可以只指定年份,也可以只指定年份和月份,但日期可不算。 |