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 種類を指定できます。

クライアントが includedTypes（レストランなど）と 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 に記載されている主なプレイスタイプ（「restaurant」や「gas_station」など）が含まれている。1 つの場所に関連付けることができるのは、サポートされている種類のテーブルから 1 つの主な種類のみです。

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

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

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

string

https://developers.google.com/maps/documentation/places/web-service/place-types から除外された主なプレイスタイプ（「restaurant」や「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)

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

レスポンスの本文

付近を検索のレスポンス proto。

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

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 人気度順に結果をランク付けします。