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

商家來電中不同地點的可能狀態。狀態可更新為「已啟用」或「已停用」。所有其他動作都會傳回 PRE 條件_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

選用設定。要傳回的 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="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 提供的指標是輸入時間範圍的匯總數量。

UpdateBusinessCallsSettingsRequest

要求 UpdateBusinessCallsSettings 訊息。

欄位
business_calls_settings

BusinessCallsSettings

必要欄位。要更新的 BusinessCallsSettings。

name 欄位的用途是找出要更新的商家通話設定。格式：locations/{location_id}/businesscallssettings
update_mask

FieldMask

必要欄位。要更新的欄位清單。

WeekDayMetrics

一週的指標。

欄位
day

DayOfWeek

星期幾。允許的值為星期日至星期六。
missed_calls_count

Int32Value

這個小時的未接來電總數。