Places API は既存の Nearby Search をサポートしています。既存の Nearby Search に慣れている場合、新しいバージョンの Nearby Search では次の変更が行われています。
- 新しい Nearby Search では HTTP POST リクエストを使用します。HTTP POST リクエストの一部として、リクエスト本文またはヘッダーでパラメータを渡します。一方、既存の Nearby Search では、HTTP GET リクエストを使用して URL パラメータを渡します。
- フィールド マスキングは必須です。レスポンスで返すフィールドを指定する必要があります。返されるフィールドのデフォルト リストはありません。このリストを省略すると、メソッドはエラーを返します。詳細については、FieldMask をご覧ください。
- 新しい Nearby Search では、認証メカニズムとして API キーと OAuth トークンの両方がサポートされています。
- 新しい Nearby Search では、レスポンス形式として JSON のみがサポートされています。
- Nearby Search(新版)はテキスト入力に対応していないため、テキストクエリを含むすべてのリクエストでテキスト検索(新版)を使用するようになりました。
- Nearby Search(新版)API の JSON レスポンスの形式が、既存の API の形式から変更されました。詳しくは、Places API レスポンスを移行するをご覧ください。
次の表に、既存の Nearby Search で名前が変更された、新しい Nearby Search 用に変更されたパラメータ、またはサポートが終了したパラメータを示します。
現在のパラメータ | 新しいパラメータ | メモ |
---|---|---|
keyword |
サポートされていません。代わりにテキスト検索(新版)を使用してください。 | |
language |
languageCode |
|
location |
locationRestriction |
必須。 |
maxprice/minprice |
|
サポートされていません。 |
maxResultCount |
新しいパラメータ。 | |
opennow |
|
サポートされていません。 |
pagetoken |
サポートされていません。 | |
radius |
|
今すぐ locationRestriction をご利用ください。 |
rankby |
rankPreference |
|
regionCode |
新しいパラメータ。 | |
type |
includedTypes excludedTypes includedPrimaryTypes excludedPrimaryTypes
|
新しいパラメータも複数の型の値を受け入れます。既存の API は 1 つの値のみを受け入れます。 |
リクエスト例
次の GET リクエストの例では、既存の Nearby Search を使用します。この例では、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 リクエストを作成し、すべてのパラメータを POST リクエストの一部として JSON リクエストの本文またはヘッダーで渡します。また、この例ではフィールド マスクを使用して、レスポンスに場所の表示名とフォーマット済み住所のみが含まれるようにしています。
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