Nearby Search(新機能)への移行

欧州経済領域(EEA)のデベロッパー

はじめに

Places API は Nearby Search(Legacy)をサポートしています。 Nearby Search(Legacy)をご存じの場合は、 Nearby Search(新版)で次の 変更が行われています。

  • Nearby Search(新版)では HTTP POST リクエストを使用します。 パラメータは、HTTP POST リクエストの一部としてリクエスト本文またはヘッダーで渡します。一方、Nearby Search(Legacy)では、 HTTP GET リクエストを使用して URL パラメータを渡します。
  • フィールド マスクは必須です。レスポンスで返されるフィールドを指定する必要があります。 返されるフィールドのデフォルト リストはありません。このリストを省略すると、メソッドからエラーが返されます。詳しくは、 FieldMask をご覧ください。
  • Nearby Search(新版)では、認証メカニズムとして API キーOAuth トークンの両方がサポートされています。
  • Nearby Search(新版)では、レスポンス形式として JSON のみがサポートされています。
  • Nearby Search(新版)ではテキスト入力がサポートされていないため、テキスト クエリを含むすべてのリクエストで テキスト検索(新版) を使用する必要があります。
  • Nearby Search(新版)の JSON レスポンス形式は、従来の API の形式から変更されています。 詳しくは、 Places API レスポンスを移行するをご覧ください。

次の表に、Nearby Search(Legacy)のパラメータのうち、Nearby Search(新版)で名前が変更または変更されたパラメータ、またはサポートされなくなったパラメータを示します。

現在のパラメータ 新しいパラメータ メモ
keyword 対象外です。代わりに テキスト検索(新版) を使用してください。
language languageCode
location locationRestriction 必須。
maxprice/minprice 対象外です。
maxResultCount 新しいパラメータ。
opennow 対象外です。
pagetoken 対象外です。
radius 現在は locationRestriction を使用してください。
rankby rankPreference
regionCode 新しいパラメータ。
type includedTypes
excludedTypes
includedPrimaryTypes
excludedPrimaryTypes
新しいパラメータでは、複数のタイプ値も受け入れられます。従来の API では、単一の値のみを受け入れます。

リクエスト例

次の GET リクエストの例では、Nearby Search(Legacy)を使用しています。この例では、タイプ 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