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

このチュートリアルでは、/autocomplete エンドポイントを使用して結果を 1 つまたは複数の国に限定する方法を説明します。

手順

この機能はすべての住所が特定の国にあることがわかっている場合に、あいまいさや予期しない結果を避けるときに役立ちます。

たとえば、グローバルクエリ Paris の関連性の高い結果の 1 つはフランスの首都です。ただし、エンドユーザーがドイツの住所候補のみに関心がある場合は、アプリケーションでパラメーター in=countryCode:DEU を指定して、結果をドイツに限定できます。

次のようにクエリを作成します。

GET https://autocomplete.search.hereapi.com/v1/
    autocomplete
    ?q=Paris
    &in=countryCode%3ADEU
    &limit=2
    &apiKey={YOUR_API_KEY}

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

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

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

このクエリにはパラメーターlimit=2が含まれており、候補の数を制限しています。/autocomplete のデフォルトの上限は 5 です。/autocomplete でサポートされている limit パラメーターの最大値は 20 です。

Paris はフランスの都市であるため、国フィルター条件に合致していません。代わりに /autocomplete はトークン Paris を含む道路名や地区名などのドイツの住所候補を返します。関連性がある候補の 1 つはベルリンの Pariser Platz です。

{
  "items": [
    {
      "title": "Deutschland, Berlin, Pariser Platz",
      "id": "here:af:street:blZMmLnwtsYaXawaeHWfzC",
      "language": "de",
      "resultType": "street",
      "address": {
        "label": "Pariser Platz, 10117 Berlin, Deutschland",
        "countryCode": "DEU",
        "countryName": "Deutschland",
        "stateCode": "BE",
        "state": "Berlin",
        "countyCode": "B",
        "county": "Berlin",
        "city": "Berlin",
        "street": "Pariser Platz",
        "postalCode": "10117"
      },
      "highlights": {
        "title": [
          {
            "start": 21,
            "end": 26
          }
        ],
        "address": {
          "label": [
            {
              "start": 0,
              "end": 5
            }
          ],
          "street": [
            {
              "start": 0,
              "end": 5
            }
          ]
        }
      }
    },
    {
      "title": "Deutschland, Berlin, Straße der Pariser Kommune",
      "id": "here:af:street:AfkQXa0XADEPA-WZxLPzmB",
      "language": "de",
      "resultType": "street",
      "address": {
        "label": "Straße der Pariser Kommune, 10243 Berlin, Deutschland",
        "countryCode": "DEU",
        "countryName": "Deutschland",
        "stateCode": "BE",
        "state": "Berlin",
        "countyCode": "B",
        "county": "Berlin",
        "city": "Berlin",
        "district": "Friedrichshain",
        "street": "Straße der Pariser Kommune",
        "postalCode": "10243"
      },
      "highlights": {
        "title": [
          {
            "start": 32,
            "end": 37
          }
        ],
        "address": {
          "label": [
            {
              "start": 11,
              "end": 16
            }
          ],
          "street": [
            {
              "start": 11,
              "end": 16
            }
          ]
        }
      }
    }
  ]
}

追加情報

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