特定の場所付近の場所を検索します。
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 ( |
フィールド | |
---|---|
languageCode |
場所の詳細が優先言語で表示される場合は、その言語が使用されます。言語コードが指定されていない場合や言語コードが認識されない場合は、どの言語のプレイスの詳細情報でも返されます。詳細が存在する場合は英語が優先されて返されます。 現在サポートされている言語の一覧については、https://developers.google.com/maps/faq#languagesupport をご覧ください。 |
regionCode |
リクエストの送信元の場所の Unicode 国/地域コード(CLDR)。このパラメータは、地域固有の場所の名前など、場所の詳細(ある場合)を表示するために使用されます。パラメータは、適用される法律に基づいて結果に影響を与える場合があります。 詳しくは、https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html をご覧ください。 現在、3 桁の地域コードはサポートされていません。 |
includedTypes[] |
https://developers.google.com/maps/documentation/places/web-service/place-types に含まれる場所タイプ(例: "レストラン"、"gas_station")。 Table A から最大 50 個のタイプを指定できます。 競合するタイプがある場合(つまり、あるタイプが includeTypes と excludedTypes の両方にある場合)、INVALID_ARGUMENT エラーが返されます。 指定した場所のタイプに複数のタイプの制限がある場合は、すべての制限を満たす場所のみが返されます。たとえば、{includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]} の場合、返される場所は「レストラン」関連のサービスを提供しますが、主に「レストラン」としては機能しません。 |
excludedTypes[] |
https://developers.google.com/maps/documentation/places/web-service/place-types から除外されている場所タイプ(「レストラン」、「ガソリン スタンド」など)。 Table A から最大 50 個のタイプを指定できます。 クライアントが includeType(レストランなど)と excludedTypes(カフェなど)の両方を提供する場合、レスポンスにはレストランではなくカフェ以外の場所を含める必要があります。レスポンスには、includeType の少なくとも 1 つに一致し、excludedTypes には一致しない場所が含まれます。 競合するタイプがある場合(つまり、あるタイプが includeTypes と excludedTypes の両方にある場合)、INVALID_ARGUMENT エラーが返されます。 指定した場所のタイプに複数のタイプの制限がある場合は、すべての制限を満たす場所のみが返されます。たとえば、{includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]} の場合、返される場所は「レストラン」関連のサービスを提供しますが、主に「レストラン」としては機能しません。 |
includedPrimaryTypes[] |
https://developers.google.com/maps/documentation/places/web-service/place-types の主要な場所タイプ(「レストラン」や「gas_station」など)を追加しました。1 つの場所には、関連付けられたサポート対象のタイプ表からメインのタイプを 1 つだけ指定できます。 Table A から最大 50 個のタイプを指定できます。 メインの型が競合する場合(つまり、ある型が includePrimaryTypes と excludedPrimaryTypes の両方に含まれている場合)、INVALID_ARGUMENT エラーが返されます。 指定した場所のタイプに複数のタイプの制限がある場合は、すべての制限を満たす場所のみが返されます。たとえば、{includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]} の場合、返される場所は「レストラン」関連のサービスを提供しますが、主に「レストラン」としては機能しません。 |
excludedPrimaryTypes[] |
https://developers.google.com/maps/documentation/places/web-service/place-types から、メインの場所タイプ(「レストラン」や「gas_station」など)を除外しました。 Table A から最大 50 個のタイプを指定できます。 メインの型が競合する場合(つまり、ある型が includePrimaryTypes と excludedPrimaryTypes の両方に含まれている場合)、INVALID_ARGUMENT エラーが返されます。 指定した場所のタイプに複数のタイプの制限がある場合は、すべての制限を満たす場所のみが返されます。たとえば、{includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]} の場合、返される場所は「レストラン」関連のサービスを提供しますが、主に「レストラン」としては機能しません。 |
maxResultCount |
返される結果の最大数。1 ~ 20(デフォルト)の範囲で指定してください。番号が設定されていない場合は、上限にフォールバックします。数値が負の値に設定されているか、上限を超えている場合は、INVALID_ARGUMENT エラーが返されます。 |
locationRestriction |
必須。検索する地域。 |
rankPreference |
回答における結果のランク付けの方法。 |
レスポンスの本文
Search Nearby のレスポンス プロトコル。
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{
"places": [
{
object ( |
フィールド | |
---|---|
places[] |
場所のタイプ、場所の数、具体的な場所の制限など、ユーザーの要件を満たす場所のリスト。 |
LocationRestriction
検索する地域。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド
|
|
circle |
中心点と半径で定義された円。 |
RankPreference
回答における結果のランク付けの方法。
列挙型 | |
---|---|
RANK_PREFERENCE_UNSPECIFIED |
RankPreference の値が設定されていません。デフォルトでは人気度に基づくランキングを使用します。 |
DISTANCE |
距離を基準に結果をランク付けします。 |
POPULARITY |
人気度によって結果をランク付けします。 |