Place Details（新規）

プラットフォームを選択: Android iOS JavaScript ウェブサービス

プレイス 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（新版）レスポンス

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（場所のみ）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.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

    場所を一意に識別するテキスト表記の ID。テキスト検索（新版）または Nearby Search（新版）から返されます。プレイス ID の詳細については、プレイス ID の概要をご覧ください。

    文字列 places/PLACE_ID は、場所のリソース名とも呼ばれます。Place Details（新版）、Nearby 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（新規）呼び出しに続く 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 オプションを把握できます。

リクエストを行うには:

  1. ページの右側にある API アイコン API Explorer を開きます。 を選択します。
  2. 必要に応じて、name パラメータを次のように設定します。
    places/PLACE_ID
  3. 必要に応じて、[標準パラメータを表示] を開き、fields パラメータをフィールド マスクに設定します。
  4. [Execute] ボタンを選択します。ポップアップで、リクエストに使用するアカウントを選択します。

  5. [API Explorer] パネルで展開アイコン API Explorer を開きます。 を選択して、[API Explorer] ウィンドウを展開します。