- HTTP リクエスト
- パスパラメータ
- クエリ パラメータ
- リクエストの本文
- レスポンスの本文
- 承認スコープ
- BusinessCallsInsights
- MetricType
- AggregateMetrics
- HourlyMetrics
- WeekDayMetrics
- DayOfWeek
- 日付
ビジネスのビジネス通話の分析情報を返します。
HTTP リクエスト
GET https://mybusinessbusinesscalls.googleapis.com/v1/{parent=locations/*}/businesscallsinsights
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
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 |
startDate と endDate に基づく期間の指標。 |
MetricType
指標のタイプ。
列挙型 | |
---|---|
METRIC_TYPE_UNSPECIFIED |
指標のタイプが指定されていません。 |
AGGREGATE_COUNT |
提供される指標は、入力された time_range で集計された数です。 |
AggregateMetrics
入力期間で集計された指標。
JSON 表現 |
---|
{ "missedCallsCount": integer, "answeredCallsCount": integer, "hourlyMetrics": [ { object ( |
フィールド | |
---|---|
missedCallsCount |
不在着信の合計数。 |
answeredCallsCount |
応答した通話の合計数。 |
hourlyMetrics[] |
時間帯別の指標のリスト。 |
weekdayMetrics[] |
曜日別の指標のリスト。 |
startDate |
この指標の日付。指標が月別の場合、年と月のみが使用されます。 |
endDate |
この指標の終了日。 |
HourlyMetrics
1 時間の指標。
JSON 表現 |
---|
{ "hour": integer, "missedCallsCount": integer } |
フィールド | |
---|---|
hour |
時間です。指定できる値は 0 ~ 23 です。 |
missedCallsCount |
この時間の不在着信の合計数。 |
WeekDayMetrics
1 週間の指標。
JSON 表現 |
---|
{
"day": enum ( |
フィールド | |
---|---|
day |
曜日。指定できる値は日曜日~土曜日です。 |
missedCallsCount |
この時間の不在着信の合計数。 |
DayOfWeek
曜日を表します。
列挙型 | |
---|---|
DAY_OF_WEEK_UNSPECIFIED |
曜日は指定されていません。 |
MONDAY |
月曜日 |
TUESDAY |
火曜日 |
WEDNESDAY |
水曜日 |
THURSDAY |
木曜日 |
FRIDAY |
Friday |
SATURDAY |
Saturday |
SUNDAY |
日曜日 |
日付
誕生日など、カレンダーの日付の全体または一部を表します。時刻とタイムゾーンは他の場所で指定されているか、重要ではありません。日付はグレゴリオ暦を基準にしています。次のいずれかを表します。
- ゼロ以外の年、月、日の値を含む完全な日付
- 年を含む月と日(記念日など)
- 1 年自体が 0 か月と 0 日である
- 年と月、日がゼロ(クレジット カードの有効期限など)
関連する型: * 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 の場合は単独で年を指定するか、日付が重要でない年と月を指定します。 |