プレイス ID を取得したら、Place Details (New) リクエストを開始して、特定のお店やスポットの詳細情報をリクエストできます。Place Details (New) リクエストは、完全な住所、電話番号、ユーザーの評価、クチコミなど、指定されたプレイスに関するさらに包括的な情報を返します。
プレイス ID を取得する方法はいくつかあります。次を使用できます。
API Explorer では、ライブ リクエストを実行して、API と API オプションを把握できます。
試してみるPlace Details (New) リクエスト
プレイス詳細リクエストは、次の形式の HTTP GET リクエストです。
https://places.googleapis.com/v1/places/PLACE_ID
すべてのパラメータを URL パラメータとして渡すか、GET リクエストの一部としてヘッダーで渡します。次に例を示します。
https://places.googleapis.com/v1/places/ChIJj61dQgK6j4AR4GeTYWZsKWw?fields=id,displayName&key=API_KEY
または、cURL コマンドで次のコマンドを使用します。
curl -X GET -H 'Content-Type: application/json' \ -H "X-Goog-Api-Key: API_KEY" \ -H "X-Goog-FieldMask: id,displayName" \ https://places.googleapis.com/v1/places/ChIJj61dQgK6j4AR4GeTYWZsKWw
Place Details（新版）レスポンス
場所の詳細（新規）は、 レスポンスとして JSON オブジェクトを返します。レスポンスの説明:
- レスポンスは
Placeオブジェクトで表されます。Placeオブジェクトには、プレイスに関する詳細情報が含まれます。 - リクエストで渡された FieldMask には、
Placeオブジェクトで返されるフィールドのリストを指定します。
完全な JSON オブジェクトの形式は次のとおりです。
{
"name": "places/ChIJkR8FdQNB0VQRm64T_lv1g1g",
"id": "ChIJkR8FdQNB0VQRm64T_lv1g1g",
"displayName": {
"text": "Trinidad"
}
...
}
必須パラメータ
-
FieldMask
レスポンス フィールド マスクを作成して、レスポンスで返すフィールドのリストを指定します。URL パラメータ
$fieldsまたはfieldsを使用するか、HTTP ヘッダーX-Goog-FieldMaskを使用して、レスポンス フィールド マスクをメソッドに渡します。レスポンスで返されるフィールドのデフォルト リストはありません。フィールドマスクを省略すると、メソッドからエラーが返されます。フィールド マスキングは、不要なデータをリクエストしないようにするための優れた設計手法です。これにより、不要な処理時間と課金が発生するのを防ぐことができます。
返す場所データのタイプのカンマ区切りリストを指定します。たとえば、場所の表示名と住所を取得します。
X-Goog-FieldMask: displayName,formattedAddress
すべてのフィールドを取得するには、
*を使用します。X-Goog-FieldMask: *
ワイルドカード「*」はすべてのフィールドを選択します。次のフィールドを 1 つ以上指定します。
次のフィールドは、Place Details (IDs Only) SKU をトリガーします。
attributions、id、name*、photos
*nameフィールドには、places/PLACE_ID形式の場所のリソース名が含まれます。displayNameを使用して、場所のテキスト名にアクセスします。次のフィールドは、Place Details (Location Only) SKU をトリガーします。
addressComponents、adrFormatAddress、formattedAddress、location、plusCode、shortFormattedAddress、types、viewport次のフィールドは、Place Details（基本）SKU をトリガーします。
accessibilityOptions、businessStatus、containingPlaces、displayName、googleMapsLinks*、googleMapsUri、iconBackgroundColor、iconMaskBaseUri、primaryType、primaryTypeDisplayName、pureServiceAreaBusiness、subDestinations、utcOffsetMinutes
*googleMapsLinksフィールドは一般提供前のプレビュー段階にあり、プレビュー期間中の使用料は発生しません。つまり、請求額は $0 です。次のフィールドは、Place Details (Advanced) SKU をトリガーします。
currentOpeningHours、currentSecondaryOpeningHours、internationalPhoneNumber、nationalPhoneNumber、priceLevel、priceRange、rating、regularOpeningHours、regularSecondaryOpeningHours、userRatingCount、websiteUri次のフィールドは、Place Details (Preferred) SKU をトリガーします。
allowsDogs、curbsidePickup、delivery、dineIn、editorialSummary、evChargeOptions、fuelOptions、goodForChildren、goodForGroups、goodForWatchingSports、liveMusic、menuForChildren、parkingOptions、paymentOptions、outdoorSeating、reservable、restroom、reviews、routingSummaries、*servesBeer、servesBreakfast、servesBrunch、servesCocktails、servesCoffee、servesDessert、servesDinner、servesLunch、servesVegetarianFood、servesWine、takeout
* テキスト検索と周辺検索のみ
-
placeId
テキスト検索（新版）またはNearby Search（新版） から返される、プレイスを一意に識別するテキスト表記の ID です。プレイス ID の詳細については、プレイス ID の概要をご覧ください。
文字列
places/PLACE_IDは、場所のリソース名とも呼ばれます。Place Details（新版）、Nearby Search（新版）、Text Search（新版）のリクエストからのレスポンスでは、この文字列はレスポンスのnameフィールドに含まれます。スタンドアロンのプレイス ID は、レスポンスのidフィールドに含まれます。
オプション パラメータ
languageCode
結果を返す言語。
- サポートされている言語の一覧をご覧ください。サポートされる言語は頻繁に更新されるため、このリストがすべてのサポート言語を網羅しているとは限りません。
-
languageCodeが指定されていない場合、API はデフォルトでenになります。無効な言語コードを指定すると、API はINVALID_ARGUMENTエラーを返します。 - API では、できるだけユーザーとローカルの両言語で判読可能な番地を返します。そのために、ジオコーダはローカル言語で番地を返し、優先言語も考慮して、必要に応じてユーザーが理解できるスクリプトに書き直します。それ以外の住所はすべて、優先言語で返されます。住所コンポーネントはすべて、最初のコンポーネントで選択した言語と同じ言語で返されます。
- 優先言語で名前を表示できない場合、API は最も近い言語を使用します。
- 優先言語は、API が返す結果や、結果が返される順序に多少影響します。「～通り」を表す略語や特定の言語だけで有効な同義語など、ジオコーダによる略語の解釈は言語によって異なります。
regionCode
レスポンスのフォーマットに使用される地域コード。 2 文字の CLDR コード値で指定します。デフォルト値はありません。
レスポンスの
formattedAddressフィールドの国名がregionCodeと一致する場合、国コードはformattedAddressから省略されます。このパラメータは、国名が常に含まれるadrFormatAddressと、国名が含まれないshortFormattedAddressには影響しません。ほとんどの CLDR コードは ISO 3166-1 コードと同一ですが、いくつか注意が必要な例外もあります。たとえば、英国の ccTLD は「uk」（.co.uk）ですが、その ISO 3166-1 コードは「gb」（厳密には「United Kingdom of Great Britain and Northern Ireland」のエンティティ）です。このパラメータは、適用される法律に基づいて結果に影響する可能性があります。
-
sessionToken
セッション トークンは、Autocomplete（新規）の呼び出しを「セッション」として追跡するユーザー作成の文字列です。Autocomplete（新規）は、セッション トークンを使用して、予測入力検索でのユーザーのクエリと場所の選択フェーズを、請求処理のために個別のセッションにグループ化します。セッション トークンは、Autocomplete（新規）呼び出しに続く Place Details（新規）呼び出しに渡されます。詳細については、セッション トークンをご覧ください。
Place Details の例
次の例では、placeId を使用してプレイスの詳細をリクエストします。
curl -X GET -H 'Content-Type: application/json' \ -H "X-Goog-Api-Key: API_KEY" \ -H "X-Goog-FieldMask: id,displayName" \ https://places.googleapis.com/v1/places/ChIJj61dQgK6j4AR4GeTYWZsKWw
X-Goog-FieldMask ヘッダーは、レスポンスに id,displayName というデータフィールドが含まれていることを指定します。レスポンスの形式は次のとおりです。
{
"id": "ChIJj61dQgK6j4AR4GeTYWZsKWw",
"displayName": {
"text": "Googleplex",
"languageCode": "en"
}
}
フィールドマスクにデータ型を追加して、追加情報を返します。たとえば、formattedAddress,plusCode を追加して、レスポンスに住所と Plus Code を含めます。
curl -X GET -H 'Content-Type: application/json' \ -H "X-Goog-Api-Key: API_KEY" \ -H "X-Goog-FieldMask: id,displayName,formattedAddress,plusCode" \ https://places.googleapis.com/v1/places/ChIJj61dQgK6j4AR4GeTYWZsKWw
レスポンスの形式は次のようになります。
{
"id": "ChIJj61dQgK6j4AR4GeTYWZsKWw",
"formattedAddress": "1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA",
"plusCode": {
"globalCode": "849VCWC7+RW",
"compoundCode": "CWC7+RW Mountain View, CA, USA"
},
"displayName": {
"text": "Googleplex",
"languageCode": "en"
}
}
試してみよう:
API Explorer では、サンプル リクエストを実行して、API と API オプションを把握できます。
リクエストを行うには:
- ページの右側にある API アイコン
を選択します。 - 必要に応じて、
nameパラメータを次のように設定します。places/PLACE_ID
- 必要に応じて [標準パラメータを表示] を開き、フィールド マスクに
fieldsパラメータを設定します。 - [Execute] ボタンを選択します。ポップアップで、リクエストに使用するアカウントを選択します。
API Explorer パネルで展開アイコン
を選択して、API Explorer ウィンドウを開きます。