Place Details（新規）

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

プレイス ID の取得後、Place Details (New) リクエストを開始して、特定の店やスポットに関する詳細をリクエストできます。Place Details（新版）リクエストは、指定された場所に関する包括的な情報を返します。たとえば、完全な住所、電話番号、ユーザーの評価、レビューなどです。

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

場所の詳細（新規）は、 レスポンスとして 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 (Basic) 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 は最も近い一致を使用します。
    • 優先言語は、API が返す結果のセットと、返される順序にわずかに影響します。ジオコーダは、道路の種類の略語や、ある言語では有効でも別の言語では有効でない類義語など、言語に応じて略語を解釈します。

  • regionCode

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

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

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

  • 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 オプションを把握できます。

  1. ページの右側にある API アイコン api を選択します。

  2. 必要に応じて、リクエスト パラメータを編集します。

  3. [Execute] ボタンを選択します。ダイアログで、リクエストに使用するアカウントを選択します。

  4. API Explorer パネルで、全画面アイコン fullscreen を選択して API Explorer ウィンドウを開きます。