Places API は、既存の Place Details をサポートしています。既存の Places API に精通している場合、新しいバージョンの Place Details では次の変更が加えられています。
- フィールドのマスキングは必須です。レスポンスで返すフィールドを指定する必要があります。返されるフィールドのデフォルト リストはありません。このリストを省略すると、メソッドはエラーを返します。詳細については、FieldMask をご覧ください。
- 新しい Place Details は、認証メカニズムとして API キーと OAuth トークンの両方をサポートしています。
- 新しい Place Details では、レスポンス形式として JSON のみがサポートされています。
- Place Details(New)API の JSON レスポンス形式は、既存の API の形式から変更されました。詳しくは、Places API レスポンスの移行をご覧ください。
次の表に、新しい Place Details 用に名前が変更または変更された既存の Place Details のパラメータ、またはサポートが終了したパラメータを示します。
現在のパラメータ | 新しいパラメータ | メモ |
---|---|---|
place_id |
places/PLACE_ID |
文字列 places/PLACE_ID は、場所のリソース名とも呼ばれます。Place Details(新版)、Nearby Search(新版)、Text Search(新版)のリクエストからのレスポンスでは、この文字列はレスポンスの name フィールドに含まれます。スタンドアロンのプレイス ID は、レスポンスの id フィールドに含まれます。 |
language |
languageCode |
|
region |
regionCode |
リクエスト例
次の GET リクエストの例では、既存の場所の詳細を使用しています。この例では、プレイス ID に関する情報を含む JSON レスポンスをリクエストし、すべてのパラメータを URL パラメータとして渡します。この例でも fields
を使用しているため、レスポンスにはプレイスの名前とフォーマットされた住所のみが含まれます。
curl -L -X GET \ 'https://maps.googleapis.com/maps/api/place/details/json?place_id=ChIJj61dQgK6j4AR4GeTYWZsKWw&fields=name%2Cformatted_address&key=API_KEY'
Place Details(新規)では、GET リクエストを行い、URL パラメータとヘッダー内のすべてのパラメータをリクエストの一部として渡します。この例でもフィールド マスクを使用しているため、レスポンスにはプレイスの表示名とフォーマット済み住所のみが含まれます。
curl -X GET -H 'Content-Type: application/json' \ -H "X-Goog-Api-Key: API_KEY" \ -H "X-Goog-FieldMask: displayName,formattedAddress" \ https://places.googleapis.com/v1/places/ChIJj61dQgK6j4AR4GeTYWZsKWw
文字列 places/PLACE_ID
は、場所のリソース名とも呼ばれます。Place Details(新版)、Nearby Search(新版)、Text Search(新版)リクエストからのレスポンスでは、この文字列はレスポンスの name
フィールドに含まれます。スタンドアロンのプレイス ID は、レスポンスの id
フィールドに含まれます。