Method: places.searchNearby

場所の近くの場所を検索する。

HTTP リクエスト

POST https://places.googleapis.com/v1/places:searchNearby

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

リクエストの本文

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

JSON 表現 
{
  "languageCode": string,
  "regionCode": string,
  "includedTypes": [
    string
  ],
  "excludedTypes": [
    string
  ],
  "includedPrimaryTypes": [
    string
  ],
  "excludedPrimaryTypes": [
    string
  ],
  "maxResultCount": integer,
  "locationRestriction": {
    object (LocationRestriction)
  },
  "rankPreference": enum (RankPreference),
  "routingParameters": {
    object (RoutingParameters)
  }
}
フィールド
languageCode

string

場所の詳細が使用言語で表示されます（使用可能な場合）。言語コードが指定されていないか認識されない場合は、任意の言語の場所の詳細が返されます。そのような詳細が存在する場合は、英語が優先されます。

現在サポートされている言語の一覧: https://developers.google.com/maps/faq#languagesupport。
regionCode

string

リクエストの送信元の場所の Unicode 国/地域コード（CLDR）。このパラメータは、地域固有のプレイス名などのプレイスの詳細を表示するために使用されます（利用可能な場合）。このパラメータは、適用される法律に基づいて結果に影響する可能性があります。

詳細については、https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html をご覧ください。

現時点では、3 桁の地域コードはサポートされていません。
includedTypes[]

string

https://developers.google.com/maps/documentation/places/web-service/place-types のプレイスタイプ（「restaurant」や「gas_station」など）が含まれている。

表 A の中から最大 50 種類を指定できます。

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

複数のタイプ制限を指定して場所のタイプを指定すると、すべての制限を満たす場所のみが返されます。たとえば、{includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]} の場合、返される場所は「レストラン」関連のサービスを提供していますが、主に「レストラン」として機能していません。
excludedTypes[]

string

https://developers.google.com/maps/documentation/places/web-service/place-types の除外プレイスタイプ（例: 「restaurant」、「gas_station」）。

表 A の中から最大 50 種類を指定できます。

クライアントが includeType（例: 軒のレストラン）と excludedTypes（例: カフェ）の両方を提供している場合、レスポンスにはレストランであってカフェではない場所が含まれる必要がある。レスポンスには、includedTypes の少なくとも 1 つに一致し、excludedTypes のいずれにも一致しないプレイスが含まれます。

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

複数のタイプ制限を指定して場所のタイプを指定すると、すべての制限を満たす場所のみが返されます。たとえば、{includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]} とした場合、返される場所は「レストラン」関連のサービスを提供しますが、主に「レストラン」として運営されているわけではありません。
includedPrimaryTypes[]

string

https://developers.google.com/maps/documentation/places/web-service/place-types から、メインの場所タイプ（「レストラン」、「gas_station」など）を追加しました。1 つの場所に関連付けることができるのは、サポートされている種類のテーブルから 1 つの主な種類のみです。

表 A の中から最大 50 種類を指定できます。

競合するプライマリ型がある場合、つまり、indPrimaryTypes と excludePrimaryTypes の両方に 1 つの型が含まれている場合、INVALID_ARGUMENT エラーが返されます。

複数のタイプ制限を指定して場所のタイプを指定すると、すべての制限を満たす場所のみが返されます。たとえば、{includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]} の場合、返される場所は「レストラン」関連のサービスを提供していますが、主に「レストラン」として機能していません。
excludedPrimaryTypes[]

string

https://developers.google.com/maps/documentation/places/web-service/place-types から、メインの場所タイプ（「レストラン」、「gas_station」など）を除外しました。

表 A の中から最大 50 種類を指定できます。

競合するプライマリ タイプ（includedPrimaryTypes と excludedPrimaryTypes の両方に同じタイプが含まれている）がある場合、INVALID_ARGUMENT エラーが返されます。

複数のタイプ制限を指定して場所のタイプを指定すると、すべての制限を満たす場所のみが返されます。たとえば、{includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]} とした場合、返される場所は「レストラン」関連のサービスを提供しますが、主に「レストラン」として運営されているわけではありません。
maxResultCount

integer

返される結果の最大数。1 ～ 20（デフォルト）の範囲で指定してください。数値が設定されていない場合は、上限にフォールバックします。数値が負の値に設定されているか、上限を超えている場合、INVALID_ARGUMENT エラーが返されます。
locationRestriction

object (LocationRestriction)

必須。検索するリージョン。
rankPreference

enum (RankPreference)

レスポンスで結果をランク付けする方法。
routingParameters

object (RoutingParameters)

省略可。検索結果へのルーティングに影響するパラメータ。

レスポンスの本文

Search Nearby のレスポンス プロトコル。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "places": [
    {
      object (Place)
    }
  ],
  "routingSummaries": [
    {
      object (RoutingSummary)
    }
  ]
}
フィールド
places[]

object (Place)

ユーザーの要件を満たす場所のリスト（場所のタイプ、場所の数、特定の場所の制限など）。
routingSummaries[]

object (RoutingSummary)

ルーティングの概要のリスト。各エントリは、places フィールドの同じインデックス内の対応するプレイスに関連付けられます。いずれかの場所でルーティングの概要が利用できない場合は、空のエントリが含まれます。リクエストに応じて、このリストには場所のリストと同数のエントリが必要です。

LocationRestriction

検索する地域。

JSON 表現 
{

  // Union field type can be only one of the following:
  "circle": {
    object (Circle)
  }
  // End of list of possible types for union field type.
}
フィールド

共用体フィールド type。

type は次のいずれかになります。
circle

object (Circle)

中心点と半径で定義される円。

RankPreference

回答内の検索結果のランク付け方法。

列挙型
RANK_PREFERENCE_UNSPECIFIED RankPreference の値が設定されていません。デフォルトでは、人気度によるランキングが使用されます。
DISTANCE 距離順に結果を並べ替えます。
POPULARITY 検索結果を人気度でランク付けします。