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(新版)を使用する必要があります。
- 周辺検索(新規)の JSON レスポンス形式は、以前の API の形式から変更されています。詳しくは、Places API レスポンスを移行するをご覧ください。
次の表に、周辺検索(新規)で名前が変更または変更された周辺検索(従来版)のパラメータ、またはサポートが終了したパラメータを示します。
現在のパラメータ | 新しいパラメータ | メモ |
---|---|---|
keyword |
サポートされていません。代わりに テキスト検索(新版)を使用してください。 | |
language |
languageCode |
|
location |
locationRestriction |
必須。 |
maxprice/minprice |
|
サポートされていません。 |
maxResultCount |
新しいパラメータ。 | |
opennow |
|
サポートされていません。 |
pagetoken |
サポートされていません。 | |
radius |
|
locationRestriction を今すぐ使用 |
rankby |
rankPreference |
|
regionCode |
新しいパラメータ。 | |
type |
includedTypes excludedTypes includedPrimaryTypes excludedPrimaryTypes
|
新しいパラメータは、複数の型値も受け入れます。以前の 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'
周辺検索(新規)では、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