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)
  },
  "includeFutureOpeningBusinesses": boolean
}
フィールド
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 エラーが返されます。

複数のタイプ制限で Place タイプが指定されている場合は、すべての制限を満たす場所のみが返されます。たとえば、{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 エラーが返されます。

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

string

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

表 A から最大 50 個のタイプを指定できます。

競合するプライマリ タイプ（includedPrimaryTypes と excludedPrimaryTypes の両方に表示されるタイプ）がある場合は、INVALID_ARGUMENT エラーが返されます。

複数のタイプ制限で Place タイプが指定されている場合は、すべての制限を満たす場所のみが返されます。たとえば、{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 エラーが返されます。

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

integer

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

object (LocationRestriction)

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

enum (RankPreference)

レスポンスで結果がランク付けされる方法。
routingParameters

object (RoutingParameters)

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

boolean

省略可。true の場合、まだ開業していないが将来開業するビジネスを含めます。

レスポンスの本文

Search Nearby のレスポンス proto。

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

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

object (Place)

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

object (RoutingSummary)

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

認可スコープ

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

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

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