ガイドAPIリファレンス変更履歴
ガイド

エリアをジオコーディングする

このチュートリアルでは、エリアの地理座標を検索する方法を説明します。

手順

/geocode エンドポイントを使用して、市区町村、市区町村の地区、郵便番号、郡、都道府県、国などのエリアの地理座標を検索することもできます。地理座標は、このエリアにある経路の目的地です。行政区画の場合は、よく知られた道路、主要な鉄道の駅、または自動車の通行を許可するその他の重要な道路である可能性があります。

たとえば、ドイツの首都 Berlin の地理座標を返す自由形式のテキスト クエリは、次のように作成できます。

GET https://geocode.search.hereapi.com/v1/
    geocode
    ?q=Berlin
    &apiKey={YOUR_API_KEY}

次のパラメーターを使用します。

  • q - 名前を入力します。
  • apiKey - APIキー。
📘

このリクエストはAPIキー認証を使用します。HEREプラットフォームの認証オプションの詳細については、「Identity & Access Management Guide」(IDとアクセス管理ガイド)を参照してください。

上のリクエストに対するレスポンスは次のようになります。

{
  "items": [
    {
      "title": "Berlin, Deutschland",
      "id": "here:cm:namedplace:20187403",
      "resultType": "locality",
      "localityType": "city",
      "address": {
        "label": "Berlin, Deutschland",
        "countryCode": "DEU",
        "countryName": "Deutschland",
        "stateCode": "BE",
        "state": "Berlin",
        "countyCode": "B",
        "county": "Berlin",
        "city": "Berlin",
        "postalCode": "10117"
      },
      "position": {
        "lat": 52.51604,
        "lng": 13.37691
      },
      "mapView": {
        "west": 13.08835,
        "south": 52.33812,
        "east": 13.761,
        "north": 52.6755
      },
      "scoring": {
        "queryScore": 1,
        "fieldScore": {
          "city": 1
        }
      }
    }
  ]
}

エリアの結果には、次の上位レベルの要素が含まれます。

  • resultType - locality または administrativeArea
  • localityType - 地域のタイプ。resultTypelocality の場合に返されます。
    • postalCode
    • city
    • district
    • subdistrict
  • administrativeAreaType - 行政区画のタイプ。resultTypeadministrativeArea の場合に返されます。
    • country
    • state
    • county
  • title - エリア名の代表的な表記の文字列
  • address - エリアの詳細な管理構造
  • position - 結果の代表的な地理的位置 (WGS 84)。結果を地図に表示し、結果にアクセスするために使用されます
  • mapView - 表示用に最適化された位置情報のバウンディング ボックス
  • id - 結果オブジェクトの識別子。この値を使用して /lookup エンドポイントからまったく同じオブジェクトを取得できます。
  • scoring - /geocode エンドポイントはスコアリング情報を返します。これは各結果が元のクエリとどの程度一致しているかを示します。これは、エンド ユーザー アプリケーションによって使用され、ユースケースの間違いがどの程度「高価」であるかに応じて、結果を受け入れるか拒否するかを選択できます。

なお、access の位置はエリアの結果には含まれません。

追加情報

/geocodeエンドポイントパラメーターの詳細については、「APIリファレンス」を参照してください。