Method: accounts.locations.reportInsights

指標に関する分析情報を含むビジネス別のレポートを返します。

HTTP リクエスト

POST https://mybusiness.googleapis.com/v4/{name=accounts/*}/locations:reportInsights

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

パスパラメータ

パラメータ
name

string

アカウントのリソース名。

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "locationNames": [
    string
  ],
  "basicRequest": {
    object (BasicMetricsRequest)
  },
  "drivingDirectionsRequest": {
    object (DrivingDirectionMetricsRequest)
  }
}
フィールド
locationNames[]

string

分析情報を取得するビジネスのコレクションです。ビジネスの名前で指定します。
basicRequest

object (BasicMetricsRequest)

基本的な指標の分析情報をレポートに含めるためのリクエストです。
drivingDirectionsRequest

object (DrivingDirectionMetricsRequest)

運転ルートのリクエストに関する分析情報をレポートに含めるためのリクエストです。

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

Insights.ReportLocationInsights に対するレスポンス メッセージです。

JSON 表現 
{
  "locationMetrics": [
    {
      object (LocationMetrics)
    }
  ],
  "locationDrivingDirectionMetrics": [
    {
      object (LocationDrivingDirectionMetrics)
    }
  ]
}
フィールド
locationMetrics[]

object (LocationMetrics)

指標の値のコレクションです。ビジネス別に表示されます。
locationDrivingDirectionMetrics[]

object (LocationDrivingDirectionMetrics)

運転ルート関連の指標の値のコレクション。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

詳しくは、OAuth 2.0 の概要をご覧ください。

DrivingDirectionMetricsRequest

運転ルートに関する分析情報のリクエストです。

JSON 表現 
{
  "numDays": enum (NumDays),
  "languageCode": string
}
フィールド
numDays

enum (NumDays)

データを集計する日数。返される結果は、直近のリクエストした日数分の入手可能なデータになります。有効な値は 7、30、90 です。
languageCode

string

言語の BCP 47 コード。言語コードの指定がなければ、デフォルトで英語に設定されます。

NumDays

このリクエストがサポートできる日数です。

列挙型
SEVEN 7 日間。これがデフォルト値です。
THIRTY 30 日間
NINETY 90 日間。

LocationMetrics

一定の期間にわたってビジネスに関連付けられる一連の Metrics と BreakdownMetrics です。

JSON 表現 
{
  "locationName": string,
  "timeZone": string,
  "metricValues": [
    {
      object (MetricValue)
    }
  ]
}
フィールド
locationName

string

この値が関連付けられているビジネスのリソース名です。
timeZone

string

ビジネスの IANA タイムゾーン。
metricValues[]

object (MetricValue)

リクエストされた指標の値のリスト。

LocationDrivingDirectionMetrics

多くのユーザーが発生している地域のインデックスが付いたビジネスです。各地域からこのビジネスまでの運転ルートのリクエスト数をカウントして取得されます。

JSON 表現 
{
  "locationName": string,
  "topDirectionSources": [
    {
      object (TopDirectionSources)
    }
  ],
  "timeZone": string
}
フィールド
locationName

string

この指標値が属するビジネス リソース名。
topDirectionSources[]

object (TopDirectionSources)

ソース地域別の運転ルート リクエストです。通常最大 10 件の結果がカウント数の多い順に並べ替えられます。
timeZone

string

ビジネスのタイムゾーン（「Europe/London」などの IANA タイムゾーン ID）。

TopDirectionSources

運転ルートのリクエストの発生元としてカウント数が上位の地域です。

JSON 表現 
{
  "dayCount": integer,
  "regionCounts": [
    {
      object (RegionCount)
    }
  ]
}
フィールド
dayCount

integer

データを集計する日数。
regionCounts[]

object (RegionCount)

カウントの降順で並べ替えた地域です。

RegionCount

リクエスト数が関連付けられているリージョン。

JSON 表現 
{
  "latlng": {
    object (LatLng)
  },
  "label": string,
  "count": string
}
フィールド
latlng

object (LatLng)

地域の中心です。
label

string

人間が読める形式の地域ラベル。
count

string (int64 format)

この地域で発生した運転ルート リクエスト数です。