Package google.maps.areainsights.v1

インデックス

AreaInsights

Places Aggregate RPC のサービス定義。

ComputeInsights

rpc ComputeInsights(ComputeInsightsRequest) returns (ComputeInsightsResponse)

この方法では、地域、場所の種類、営業状況、価格帯、評価など、さまざまなフィルタを使用して地域に関する分析情報を取得できます。現在、[数] と [場所] の分析情報がサポートされています。「数」の分析情報を使用すると、「営業中で、低価格で、平均評価が 4 つ星以上のレストランがカリフォルニア州に何件あるか」などの質問に回答できます（詳細については、insight 列挙型をご覧ください）。「場所」のインサイトでは、指定したフィルタに一致する場所を特定できます。クライアントは、これらの場所のリソース名を使用して、Places API で個々の場所の詳細を取得できます。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

ComputeInsightsRequest

ComputeInsights RPC のリクエスト。

フィールド
insights[]

Insight

必須。計算する分析情報。現在、サポートされているのは INSIGHT_COUNT と INSIGHT_PLACES のみです。
filter

Filter

必須。分析情報のフィルタ。

ComputeInsightsResponse

ComputeInsights RPC のレスポンス。

フィールド
place_insights[]

PlaceInsight

Insights.INSIGHT_PLACES の結果。
count

int64

Insights.INSIGHT_COUNT の結果。

フィルタ

ComputeInsights RPC のフィルタ。

フィールド
location_filter

LocationFilter

必須。場所フィルタで指定したエリア内の場所のみに結果を制限します。
type_filter

TypeFilter

必須。場所タイプのフィルタ。
operating_status[]

OperatingStatus

省略可。営業ステータスがこのリストに含まれる場所に結果を制限します。operating_status が設定されていない場合、OPERATING_STATUS_OPERATIONAL がデフォルトとして使用されます。
price_levels[]

PriceLevel

省略可。料金レベルがこのリストに含まれている場所に結果を限定します。price_levels が設定されていない場合、すべての価格帯が結果に含まれます。
rating_filter

RatingFilter

省略可。ユーザーの平均評価が rating_filter で指定した範囲内の場所に結果を制限します。rating_filter が設定されていない場合、すべての評価が結果に含まれます。

分析情報

サポートされている分析情報。

列挙型
INSIGHT_UNSPECIFIED 指定なし。
INSIGHT_COUNT

カウントに関する分析情報。

この分析情報を指定すると、ComputeInsights は指定されたフィルタ条件に一致する場所の数を返します。

リクエストの例:

{
  "insights": ["INSIGHT_COUNT"],
  "filter": {
    "locationFilter": {
      "region": {
        "place": "places/ChIJPV4oX_65j4ARVW8IJ6IJUYs"
      }
    },
    "typeFilter": {
      "includedTypes": ["restaurant"]
    },
    "operatingStatus": ["OPERATING_STATUS_OPERATIONAL"],
    "priceLevels": [
      "PRICE_LEVEL_FREE",
      "PRICE_LEVEL_INEXPENSIVE"
    ],
    "ratingFilter": {
      "minRating": 4.0
    }
  }
}

レスポンスの例:

{
  "count": 1234
}
INSIGHT_PLACES

返品場所

この分析情報を指定すると、ComputeInsights は指定されたフィルタ条件に一致するプレイス ID を返します。

リクエストの例:

{
  "insights": ["INSIGHT_PLACES"],
  "filter": {
    "locationFilter": {
      "region": {
        "place": "places/ChIJPV4oX_65j4ARVW8IJ6IJUYs"
      }
    },
    "typeFilter": {
      "includedTypes": ["restaurant"]
    },
    "operatingStatus": ["OPERATING_STATUS_OPERATIONAL"],
    "priceLevels": [
      "PRICE_LEVEL_FREE",
      "PRICE_LEVEL_INEXPENSIVE"
    ],
    "ratingFilter": {
      "minRating": 4.0
    }
  }
}

レスポンスの例:

{
  "placeInsights": [
    {"place": "places/ABC"},
    {"place": "places/PQR"},
    {"place": "places/XYZ"}
  ]
}

LocationFilter

場所フィルタ。

分析情報の対象領域を指定します。

フィールド
共用体フィールド area。次のいずれかを指定する必要があります。area は次のいずれかになります。
circle

Circle

円の面積。
region

Region

エリアをリージョンとして使用。
custom_area

CustomArea

ポリゴンで指定されたカスタムエリア。

サークル

円は、中心点と半径（メートル単位）で定義されます。

フィールド
radius

int32

省略可。円の半径（メートル）
共用体フィールド center。円の中心。center は次のいずれかになります。
lat_lng

LatLng

円の中心の緯度と経度。
place

string

形式: places/PLACE_ID の形式にする必要があります。ここで、PLACE_ID は場所の一意の ID です。例: places/ChIJgUbEo8cfqokR5lP9_Wh_DaM。

CustomArea

カスタム領域。

フィールド
polygon

Polygon

必須。ポリゴンとして表されるカスタムエリア

ポリゴン

ポリゴンは、反時計回りの順序で接続された一連の座標で表されます。座標は閉じたループを形成し、塗りつぶし領域を定義します。最初の座標と最後の座標は同等であり、同じ値を含める必要があります。この形式は、GeoJSON ポリゴンの簡素化バージョンです（反時計回りの外側リングのみをサポート）。

フィールド
coordinates[]

LatLng

省略可。ポリゴンを定義する座標。

地域

地域とは、都市、郵便番号、郡、州などの地理的境界を指します。

フィールド
共用体フィールド region。地理的なリージョンを定義します。一度に指定できる地域の種類（場所など）は 1 つのみです。region は次のいずれかになります。
place

string

特定の地域の一意の識別子。

OperatingStatus

場所の営業状況。

列挙型
OPERATING_STATUS_UNSPECIFIED 指定なし。この値は使用しないでください。
OPERATING_STATUS_OPERATIONAL 場所が営業しており、定義された営業時間内に営業している。
OPERATING_STATUS_PERMANENTLY_CLOSED スポットが営業を停止している。
OPERATING_STATUS_TEMPORARILY_CLOSED この場所は臨時休業しており、今後再開される予定です。

PlaceInsight

場所に関する情報を保持します。

フィールド
place

string

場所の一意の識別子。このリソース名を使用して、Places API で場所の詳細を取得できます。

PriceLevel

場所の価格帯。

列挙型
PRICE_LEVEL_UNSPECIFIED 指定なし。この値は使用しないでください。
PRICE_LEVEL_FREE 場所が無料サービスを提供している。
PRICE_LEVEL_INEXPENSIVE 低価格のサービスを提供している。
PRICE_LEVEL_MODERATE 手頃な価格のサービスを提供する場所。
PRICE_LEVEL_EXPENSIVE 高額なサービスを提供している。
PRICE_LEVEL_VERY_EXPENSIVE 非常に高価なサービスを提供している場所。

RatingFilter

ユーザー評価の平均フィルタ。

フィールド
min_rating

float

省略可。平均ユーザー評価が min_rating 以上の場所のみに結果を制限します。値は 1.0 ～ 5.0 の範囲で指定してください。
max_rating

float

省略可。平均ユーザー評価が max_rating 以下である場所のみに結果を制限します。値は 1.0 ～ 5.0 の範囲で指定してください。

TypeFilter

場所タイプのフィルタ。

表 a のプレイスタイプのみがサポートされます。

1 つの場所に関連付けることができるプライマリ タイプは 1 つだけです。たとえば、プライマリ タイプは「mexican_restaurant」や「steak_house」などです。included_primary_types と excluded_primary_types を使用して、場所のプライマリ タイプで結果をフィルタします。

1 つの場所に複数のタイプ値を関連付けることもできます。たとえば、レストランには「seafood_restaurant」、「restaurant」、「food」、「point_of_interest」、「establishment」などのタイプがあります。included_types と excluded_types を使用して、場所に関連付けられているタイプのリストで結果をフィルタします。

検索で複数の種類の制限が指定されている場合、すべての制限を満たす場所のみが返されます。たとえば、{"included_types": ["restaurant"], "excluded_primary_types": ["steak_house"]} と指定すると、返される場所は「レストラン」関連のサービスを提供していますが、主に「ステーキハウス」として運営されていません。

競合するタイプ（included_types と excluded_types の両方、または included_primary_types と excluded_primary_types の両方に同じタイプが含まれている）がある場合、INVALID_ARGUMENT エラーが返されます。

included_types または included_primary_types のいずれかを設定する必要があります。

フィールド
included_types[]

string

省略可。含まれるプレイスタイプ。
excluded_types[]

string

省略可。除外されたプレイスタイプ。
included_primary_types[]

string

省略可。主なプレイスタイプを追加しました。
excluded_primary_types[]

string

省略可。除外された主な Place Type。