Method: locations.businesscallsinsights.list

ビジネスに関するビジネス通話のインサイトを返します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。通話のインサイトを取得する親ビジネス。形式: locations/{locationId}

クエリ パラメータ

パラメータ
pageSize

integer

省略可。返される BusinessCallsInsights の最大数。指定しない場合は、最大で 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"date は YYYY-MM-DD 形式です。2. endDate="DATE"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

1 時間の指標。

JSON 表現 
{
  "hour": integer,
  "missedCallsCount": integer
}
フィールド
hour

integer

時間帯です。指定できる値は 0 ～ 23 です。
missedCallsCount

integer

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

WeekDayMetrics

1 日の指標。

JSON 表現 
{
  "day": enum (DayOfWeek),
  "missedCallsCount": integer
}
フィールド
day

enum (DayOfWeek)

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

integer

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

DayOfWeek

曜日を表します。

列挙型
DAY_OF_WEEK_UNSPECIFIED 曜日が指定されていません。
MONDAY 月曜日
TUESDAY 火曜日
WEDNESDAY 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 年の中の月。1～12、または月と日のない年を指定する場合は 0 にする必要があります。
day

integer

1 月の中の日付。1～31 で、その年と月に対して有効である必要があります。または、日が重要でない場合に年のみか年と月を指定するには 0 にする必要があります。