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)
}
フィールド
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 に含まれる場所タイプ(「レストラン」や「gas_station」など)を追加しました。

テーブル A から最大 50 個のタイプを指定できます。

競合するタイプがある場合(つまり、indTypes と excludedTypes の両方に同じタイプが含まれている場合)、INVALID_ARGUMENT エラーが返されます。

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

excludedTypes[]

string

https://developers.google.com/maps/documentation/places/web-service/place-types から場所タイプ(「レストラン」や「gas_station」など)を除外します。

テーブル A から最大 50 個のタイプを指定できます。

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

競合するタイプがある場合(つまり、indTypes と excludedTypes の両方に同じタイプが含まれている場合)、INVALID_ARGUMENT エラーが返されます。

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

includedPrimaryTypes[]

string

https://developers.google.com/maps/documentation/places/web-service/place-types から、メインの場所タイプ(「レストラン」や「gas_station」など)を追加しました。場所には、関連付けられたサポートされているタイプの表からメインのタイプを 1 つだけ設定できます。

テーブル A から最大 50 個のタイプを指定できます。

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

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

excludedPrimaryTypes[]

string

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

テーブル A から最大 50 個のタイプを指定できます。

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

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

maxResultCount

integer

返される結果の最大数。1 ~ 20(デフォルト)にする必要があります。数値が設定されていない場合は、上限に戻ります。数値が負の値に設定されているか、上限を超えている場合は、INVALID_ARGUMENT エラーが返されます。

locationRestriction

object (LocationRestriction)

必須。検索する地域。

rankPreference

enum (RankPreference)

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

レスポンスの本文

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

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

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

object (Place)

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

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 の値が設定されていません。デフォルトで POPULARITY のランクを使用します。
DISTANCE 距離ごとに結果をランク付けします。
POPULARITY 検索結果を人気度でランク付けします。