結果を特定の国に限定する

このチュートリアルでは、API が結果を 1 つまたは複数の国に限定する方法を説明します。

手順

/geocode エンドポイントでは、結果をAPI が 1 つまたは複数の国に限定できます。これは、すべての住所が特定の国にあることがわかっている場合に、あいまいさや予期しない結果を避ける時に役立ちます。

たとえば、20 Victoria St, London というクエリの場合、/geocode は 2 つの結果 (1 つは英国、もう 1 つはカナダ) を返します。

アプリケーションがアメリカとカナダの住所でのみ動作する場合は、in=countryCode:CAN,USA パラメーターを使用して、結果をこれら 2 つの国に限定できます。

クエリは次のように作成できます。

GET https://geocode.search.hereapi.com/v1/
    geocode
    ?q=20+Victoria+St%2C+London
    &in=countryCode%3ACAN%2CUSA
    &apiKey={YOUR_API_KEY}

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

q - 名前を入力します。
In - 地理的エリア内を検索します。結果が指定したエリア内にある場合、結果が返されます。
apiKey - APIキー。

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

カナダでは上のリクエストに対するレスポンスには1件の結果が含まれ、次のように表示されます。

{
  "items": [
    {
      "title": "20 Victoria St, London, ON N6A, Canada",
      "id": "here:af:streetsection:YOrVG8JgXxLvp3Qomjb.SB:EAIaAjIwKGQ",
      "resultType": "houseNumber",
      "houseNumberType": "interpolated",
      "address": {
        "label": "20 Victoria St, London, ON N6A, Canada",
        "countryCode": "CAN",
        "countryName": "Canada",
        "stateCode": "ON",
        "state": "Ontario",
        "county": "Middlesex",
        "city": "London",
        "district": "North London",
        "street": "Victoria St",
        "postalCode": "N6A",
        "houseNumber": "20"
      },
      "position": {
        "lat": 43.0009,
        "lng": -81.2681
      },
      "access": [
        {
          "lat": 43.00078,
          "lng": -81.26803
        }
      ],
      "mapView": {
        "west": -81.26933,
        "south": 43,
        "east": -81.26687,
        "north": 43.0018
      },
      "scoring": {
        "queryScore": 1,
        "fieldScore": {
          "city": 1,
          "streets": [
            1
          ],
          "houseNumber": 1
        }
      }
    }
  ]
}

追加情報

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