Package google.mybusiness.businesscalls.v1

索引

BusinessCallsService

この API を使用すると、ビジネス通話を管理し、店舗への不在着信数などのインサイトを収集できます。ビジネス通話について詳しくは、https://support.google.com/business/answer/9688285?p=call_history をご覧ください。

Google ビジネス プロフィールが Google 広告アカウントにリンクされ、通話履歴が有効になっている場合、通話時間が特定の時間より長く、広告インタラクションに起因する可能性がある通話は、リンクされた Google 広告アカウントの [広告経由の通話数] コンバージョンに表示されます。スマート自動入札と通話コンバージョンを最適化戦略で使用している場合は、広告費用が変わる可能性があります。スマート自動入札の詳細

ビジネスの通話に対するアクションを表示、実行するには、ビジネスの 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

ビジネス通話においてビジネスの考えられるステータスです。状態は ENABLED または DISABLED にのみ更新できます。それ以外の場合、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

1 時間の指標。

フィールド
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 提供される指標は、入力された time_range で集計された数です。

UpdateBusinessCallsSettingsRequest

UpdateBusinessCallsSettings に対するリクエスト メッセージです。

フィールド
business_calls_settings

BusinessCallsSettings

必須。更新する BusinessCallsSettings。

name フィールドは、更新するビジネス通話の設定を指定する場合に使用します。形式: locations/{location_id}/businesscallssettings
update_mask

FieldMask

必須。更新するフィールドのリスト。

WeekDayMetrics

1 週間の指標。

フィールド
day

DayOfWeek

曜日。指定できる値は日曜日～土曜日です。
missed_calls_count

Int32Value

この時間の不在着信の合計数。