Places API レスポンスを移行する

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

はじめに

Place Details(新版)、Nearby Search(新版)、テキスト検索(新版)の各 API のレスポンス形式が、以前の API の形式から変更されました。主な違いは、 レスポンスの Place オブジェクトの変更で説明されているように、各メソッドから返される Place オブジェクトの形式です。

また、各 API のレスポンス オブジェクトのトップレベル フィールドも変更されています。参照:

レスポンスの Place オブジェクトの変更

次の表に、Place Details(新版)、Nearby Search(新版)、テキスト検索(新版)のレスポンスにおける新しい Placeオブジェクト以前の Placeオブジェクトの変更点を示します。

新しいレスポンス オブジェクトでは、フィールド名にキャメルケースが使用され、新しいフィールドが含まれ、従来のフィールドの一部が名前変更されています。

フィールド Places API(従来版)オブジェクト Places API(新版)オブジェクト メモ
住所コンポーネント address_components addressComponents
Place マイクロフォーマット アドレス adr_address adrFormatAddress
ビジネスのステータス business_status businessStatus
来週の営業時間 current_opening_hours currentOpeningHours
解説記事 editorial_summary editorialSummary
フォーマット済み住所 formatted_address formattedAddress
国内電話番号 formatted_phone_number nationalPhoneNumber
場所 geometry.location location
ビューポート geometry.viewport viewport
場所の帰属表示 html_attributions attributions 従来の API のレスポンスのトップレベル フィールド
アイコンの URL icon 削除しました。iconMaskBaseUriiconBackgroundColor を使用してください。詳しくは、 場所のアイコンをご覧ください。
アイコンの背景色 icon_background_color iconBackgroundColor
アイコン マスクの URL icon_mask_base_uri iconMaskBaseUri
国際電話番号 international_phone_number internationalPhoneNumber
テキストの場所の名前 name displayName テキストの場所の名前は displayName.textlanguagedisplayName.languageCode としてアクセスできるようになりました
営業時間 opening_hours regularOpeningHours
写真 photos photos 新しい Place オブジェクトでは、photos の形式が変更されています。詳しくは、 写真の参照の変更をご覧ください。
プレイス ID place_id id
Plus Code plus_code plusCode
価格帯 price_level priceLevel
評価 rating rating
レビュー reviews reviews
今日から来週までの 2 次的な営業時間(例外と その他のすべてのデータを含む) secondary_opening_hours currentSecondaryOpeningHours
場所タイプ types types
Google マップにおけるこの場所の URL url googleMapsUri
ユーザー評価の数 user_ratings_total userRatingCount
UTC オフセット utc_offset utcOffsetMinutes
住所の短縮形(町名と番地を含む) vicinity shortFormattedAddress
店舗のウェブサイト website websiteUri
車椅子でのアクセスの情報 wheelchair_accessible_entrance accessibilityOptions wheelchair_accessible_entranceaccessibilityOptions.wheelchairAccessibleEntrance になりました
場所の属性 takeout, delivery, dine_in, curbside_pickup, reservable, serves_breakfast, serves_lunch, serves_dinner, serves_beer, serves_wine, serves_brunch, serves_vegetarian_food takeout, delivery, dineIn, curbsidePickup, reservable, servesBreakfast, servesLunch, servesDinner, servesBeer, servesWine, servesBrunch, servesVegetarianFood
リソース名 places/PLACE_ID 形式の name フィールド 従来の API では、name フィールドに 場所の名前がテキスト文字列として含まれていました。新しい API では、その情報は displayNameにあります。
場所のプライマリ タイプ primaryTypeName 新規
場所のプライマリ タイプ(テキスト文字列) primaryTypeDisplayName 新規
通常の週ごとの 2 次的な営業時間(例外とその他のすべての データを含む) regularSecondaryOpeningHours 新規
この場所で利用できるお支払い方法 paymentOptions 新規
場所の駐車場の種類 parkingOptions 新規
この場所に関連するサブデスティネーションのリスト subDestinations 新規
ガソリンスタンドの燃料オプションに関する最新情報 fuelOptions 新規
場所の EV 充電情報 evChargeOptions 新規
場所の属性 outdoorSeating, liveMusic, menuForChildren, servesCocktails, servesDessert, servesCoffee, goodForChildren, allowsDogs, restroom, goodForGroups, goodForWatchingSports 新規

テキスト検索のレスポンスの変更

次の表に、テキスト検索(従来版)の レスポンス オブジェクト とテキスト検索(新版)の レスポンス オブジェクト のトップレベル フィールドの変更点を示します。新しい API では、レスポンスのトップレベル フィールドは places 配列のみです。

フィールド テキスト検索(従来版) テキスト検索(新版) メモ
場所の帰属表示 html_attributions 各場所の新しい Place オブジェクトに place.attributions として移動しました
場所の配列 results 従来の Place オブジェクトの配列 新しい Place オブジェクトの places 配列
リクエストのステータス status 標準の HTTP レスポンス(HTTP レスポンス コードとメッセージ)に移動しました
エラー メッセージ error_message 標準の HTTP レスポンス(HTTP レスポンス コードとメッセージ)に移動しました
情報メッセージ info_messages 削除済み
ページトークン next_page_token 削除済み

Nearby Search のレスポンスの変更

次の表に、response object for the Nearby Search(従来版)とresponse object for Nearby Search(新版)のトップレベル フィールドの変更点を示します。新しい API では、レスポンスのトップレベル フィールドは places 配列のみです。

フィールド Nearby Search(従来版) Nearby Search(新版) メモ
場所の帰属表示 html_attributions 各場所の新しい Place オブジェクトに place.attributions として移動しました
場所の配列 results 従来の Place オブジェクトの配列 新しい Place オブジェクトの places 配列
リクエストのステータス status 標準の HTTP レスポンス(HTTP レスポンス コードとメッセージ)に移動しました
エラー メッセージ error_message 標準の HTTP レスポンス(HTTP レスポンス コードとメッセージ)に移動しました
情報メッセージ info_messages 削除済み
ページトークン next_page_token 削除済み

Place Details(新版)のレスポンスの変更

次の表に、Place Details(従来版)のレスポンス オブジェクト と Place Details(新版)のレスポンス オブジェクト のトップレベル フィールドの変更点を示します。新しい API では、レスポンスのトップレベル フィールドは places 配列のみです。

フィールド Place Details(従来版) Place Details(新版) メモ
場所の帰属表示 html_attributions 新しい Place オブジェクトに attributions として移動しました
Place Details(新版) result 従来の Place オブジェクトを含む 新しい Place オブジェクト
リクエストのステータス status 標準の HTTP レスポンス(HTTP レスポンス コードとメッセージ)に移動しました
情報メッセージ info_messages 標準の HTTP レスポンス(HTTP レスポンス コードとメッセージ)に移動しました