Place Details(新規)

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

プレイス ID を取得したら、Place Details (New) リクエストを開始して、特定の施設やスポットに関する詳細情報をリクエストできます。Place Details (New) リクエストは、完全な住所、電話番号、ユーザーの評価、クチコミなど、指定された場所に関するより包括的な情報を返します。

プレイス ID はさまざまな方法で取得できます。次を使用できます。

API Explorer を使用すると、ライブ リクエストを発行できるため、API と API オプションについて理解を深めることができます。

試してみる

Place Details (New) リクエスト

Place Details リクエストは、次の形式の 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(ID のみ)SKU がトリガーされます。

      id, name*, photos

      * name フィールドには、places/PLACE_ID の形式で場所のリソース名が含まれます。場所の名前のテキストにアクセスするには、displayName を使用します。

    • 次のフィールドで Place Details(場所のみ)SKU がトリガーされます。

      addressComponentsadrFormatAddressformattedAddresslocationplusCodeshortFormattedAddresstypesviewport

    • 以下のフィールドで Place Details(Basic)SKU がトリガーされます。

      accessibilityOptionsbusinessStatusdisplayNamegoogleMapsUriiconBackgroundColoriconMaskBaseUriprimaryTypeprimaryTypeDisplayNamesubDestinationsutcOffsetMinutes

    • 以下のフィールドで Place Details(Advanced)SKU がトリガーされます。

      currentOpeningHourscurrentSecondaryOpeningHoursinternationalPhoneNumbernationalPhoneNumberpriceLevelratingregularOpeningHoursregularSecondaryOpeningHoursuserRatingCountwebsiteUri

    • 以下のフィールドで Place Details(Preferred)SKU がトリガーされます。

      allowsDogs, curbsidePickup, delivery, dineIn, editorialSummary, evChargeOptions, fuelOptions, goodForChildren, goodForGroups, goodForWatchingSports, liveMusic, menuForChildren, parkingOptions, paymentOptions, outdoorSeating, reservable, restroom, reviews, {2, , , /////}servesBeerservesBreakfastservesBrunchservesCocktailsservesCoffeeservesDessertsservesDinnerservesLunchservesVegetarianFoodservesWinetakeout

  • 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 が返す結果のセットや、それらが返される順序に小さい影響を及ぼします。ジオコーダでは、道路の種類を表す略語や、ある言語では有効でも別の言語では有効でない類義語など、言語によって略語の解釈が異なります。
  • regionCode

    レスポンスのフォーマットに使用されるリージョン コード。 2 文字の CLDR コード値として指定します。デフォルト値はありません。

    レスポンスの formattedAddress フィールドの国名が regionCode と一致する場合、国コードは formattedAddress から省略されます。このパラメータは、常に国名を含む adrFormatAddress や、国名を含まない shortFormattedAddress には影響しません。

    ほとんどの CLDR コードは ISO 3166-1 コードと同一ですが、いくつか注意すべき例外があります。たとえば、英国の ccTLD は「uk」(.co.uk)ですが、ISO 3166-1 コードは「gb」(厳密には「グレート ブリテンおよび北アイルランド連合王国」のエンティティ)です。このパラメータは、適用される法律に基づき、結果に影響する場合があります。

  • sessionToken

    セッション トークンはユーザーが生成した文字列で、予測入力(新版)の呼び出しを「セッション」としてトラッキングします。予測入力(新版)は、セッション トークンを使用して、ユーザーの予測入力検索でのクエリと場所の選択フェーズを、請求処理のために個別のセッションにグループ化します。セッション トークンは、Autocomplete(New)の呼び出しに続く Place Details(New)の呼び出しに渡されます。詳細については、セッション トークンをご覧ください。

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] ウィンドウを展開します。