- HTTP リクエスト
- パスパラメータ
- リクエストの本文
- レスポンスの本文
- 承認スコープ
- DrivingDirectionMetricsRequest
- NumDays
- LocationMetrics
- LocationDrivingDirectionMetrics
- TopDirectionSources
- RegionCount
1 つ以上の指標に関する分析情報を含むレポートを返します。
HTTP リクエスト
POST https://mybusiness.googleapis.com/v4/{name=accounts/*}/locations:reportInsights
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
name |
アカウントのリソース名。 |
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 | |
---|---|
{ "locationNames": [ string ], "basicRequest": { object ( |
フィールド | |
---|---|
locationNames[] |
分析情報を取得するビジネスのコレクション。ビジネスの名前で指定します。 |
basicRequest |
基本的な指標の分析情報をレポートに含めるためのリクエスト。 |
drivingDirectionsRequest |
運転ルートのリクエストに関する分析情報をレポートに含めるリクエスト。 |
レスポンスの本文
成功すると、レスポンスの本文に次の構造のデータが含まれます。
Insights.ReportLocationInsights
に対するレスポンス メッセージです。
JSON 表現 | |
---|---|
{ "locationMetrics": [ { object ( |
フィールド | |
---|---|
locationMetrics[] |
ロケーション別の指標値のコレクション。 |
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 |
データを集計する日数を指定します。返される結果には、過去数日間分のデータが含まれます。有効な値は 7、30、90 です。 |
languageCode |
言語の BCP 47 コード。言語コードを指定しない場合は、デフォルトで英語が使用されます。 |
NumDays
このリクエストがサポートできる日数。
列挙型 | |
---|---|
SEVEN |
7 日間です。これがデフォルト値です。 |
THIRTY |
30 日間です。 |
NINETY |
90 日間です。 |
LocationMetrics
一定期間にわたってビジネスに関連付けられた一連の Metrics と BreakdownMetrics。
JSON 表現 | |
---|---|
{
"locationName": string,
"timeZone": string,
"metricValues": [
{
object ( |
フィールド | |
---|---|
locationName |
これらの値が属するビジネスのリソース名です。 |
timeZone |
ビジネスの IANA タイムゾーン。 |
metricValues[] |
リクエストされた指標の値のリスト。 |
LocationDrivingDirectionMetrics
人々が通常居住する地域をインデックスに登録したビジネス。この数値は、このビジネスへの運転ルートのリクエスト数を地域ごとにカウントすることで取得されます。
JSON 表現 | |
---|---|
{
"locationName": string,
"topDirectionSources": [
{
object ( |
フィールド | |
---|---|
locationName |
この指標値が属しているビジネスのリソース名。 |
topDirectionSources[] |
参照元の地域ごとの運転ルート リクエスト。慣例として、これらは件数で並べ替えられ、最大で 10 件の結果が得られます。 |
timeZone |
ビジネスのタイムゾーン(IANA タイムゾーン ID。「Europe/London」など)。 |
TopDirectionSources
運転ルートのリクエストの発信元となった上位の地域。
JSON 表現 | |
---|---|
{
"dayCount": integer,
"regionCounts": [
{
object ( |
フィールド | |
---|---|
dayCount |
データが集計される日数。 |
regionCounts[] |
件数の降順で並べ替えられた地域。 |
RegionCount
関連するリクエスト数があるリージョン。
JSON 表現 | |
---|---|
{
"latlng": {
object ( |
フィールド | |
---|---|
latlng |
地域の中心。 |
label |
人が読める形式の地域のラベル。 |
count |
この地域からの運転ルート リクエストの数。 |