Places API は、既存の周辺検索をサポートしています。既存の Nearby Search をご存じの方向けに、新しいバージョンの Nearby Search の変更点について説明します。
- 新しい Nearby Search では HTTP POST リクエストを使用します。HTTP POST リクエストの一部として、リクエスト本文またはヘッダーでパラメータを渡します。一方、既存の Nearby Search では、HTTP GET リクエストを使用して URL パラメータを渡します。
- フィールドのマスキングは必須です。レスポンスで返すフィールドを指定する必要があります。返されるフィールドのデフォルト リストはありません。このリストを省略すると、メソッドはエラーを返します。詳細については、FieldMask をご覧ください。
- 新しい Nearby Search は、認証メカニズムとして API キーと OAuth トークンの両方をサポートしています。
- 新しい周辺検索では、レスポンス形式として JSON のみがサポートされています。
- Nearby Search（新版）はテキスト入力をサポートしていないため、テキスト クエリを含むすべてのリクエストで Text Search（新版）を使用する必要があります。
- Nearby Search（新版）API の JSON レスポンスの形式が、既存の API の形式から変更されました。詳しくは、Places API レスポンスを移行するをご覧ください。
次の表に、新しい周辺検索用に名前が変更または変更された既存の周辺検索のパラメータ、またはサポートが終了したパラメータを示します。
| 現在のパラメータ | 新しいパラメータ | メモ |
|---|---|---|
keyword |
サポートされていません。代わりに テキスト検索（新版）を使用してください。 | |
language |
languageCode |
|
location |
locationRestriction |
必須。 |
maxprice/minprice |
|
サポートされていません。 |
maxResultCount |
新しいパラメータ。 | |
opennow |
|
サポートされていません。 |
pagetoken |
サポートされていません。 | |
radius |
|
今すぐ locationRestriction をご利用ください。 |
rankby |
rankPreference |
|
regionCode |
新しいパラメータ。 | |
type |
includedTypesexcludedTypesincludedPrimaryTypesexcludedPrimaryTypes
|
新しいパラメータは、複数の型値も受け入れます。既存の API は 1 つの値のみを受け入れます。 |
リクエスト例
次の GET リクエストの例では、既存の周辺検索を使用しています。この例では、restaurant タイプの場所に関する情報を含む JSON レスポンスをリクエストし、すべてのパラメータを URL パラメータとして渡します。
curl -L -X GET \ 'https://maps.googleapis.com/maps/api/place/nearbysearch/json?location=37.7937%2C-122.3965&radius=500&type=restaurant&key=API_KEY'
Nearby Search（新規）では、POST リクエストを作成し、JSON リクエスト本文またはヘッダーにすべてのパラメータを POST リクエストの一部として渡します。この例でもフィールド マスクを使用しているため、レスポンスにはプレイスの表示名とフォーマットされた住所のみが含まれます。
curl -X POST -d '{
"includedTypes": ["restaurant"],
"locationRestriction": {
"circle": {
"center": {
"latitude": 37.7937,
"longitude": -122.3965},
"radius": 500.0
}
}
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
-H "X-Goog-FieldMask: places.displayName,places.formattedAddress" \
https://places.googleapis.com/v1/places:searchNearby