場所の結果を除外する

このチュートリアルでは、任意パラメーターtypesを使用して/geocodeエンドポイントの結果リストから場所の結果を除外する方法を説明します。

手順

/geocode エンドポイントには任意パラメーター types があり、結果を特定のタイプに限定できます。

場所の結果を除外するために必要な、結果タイプのフィルターの値は次のとおりです。

address - 結果を houseNumber、street、postalCodePoint、intersection、または addressBlock の結果タイプに限定します。
area - 結果をすべてのサブタイプを含むlocalityまたはadministrativeAreaの結果タイプに限定します。

/geocodeエンドポイントでサポートされているその他のtypesフィルターの値はcity、postalCode、street、houseNumber、placeです。詳細については、「APIリファレンス」を参照してください。

たとえば、「Harfowa, Warszawa」をクエリすると、「ulica Harfowa」という名前の道路と、「Harfowa」という名前の近くにあるバス停の、2つの関連する結果が表示される可能性があります。タイプフィルターを使用しない場合、resultType が place のバス停の結果のみが返されます。これは、そのほうが正確であり、クエリ名と完全に一致するためです。

{
  "items": [
    {
      "title": "Harfowa",
      "id": "here:pds:place:616q9wpy-4be9c9c2e0060d9880fa7e8d8d3fc104",
      "resultType": "place",
      "address": {
        "label": "Harfowa, ulica Włodarzewska, 02-384 Ochota, Polska",
        "countryCode": "POL",
        "countryName": "Polska",
        "state": "Woj. Mazowieckie",
        "county": "Warszawa",
        "city": "Warszawa",
        "district": "Ochota",
        "subdistrict": "Szczęśliwice",
        "street": "ulica Włodarzewska",
        "postalCode": "02-384"
      },
      "position": {
        "lat": 52.2017,
        "lng": 20.96456
      },
      "access": [
        {
          "lat": 52.20162,
          "lng": 20.96435
        }
      ],
      "categories": [
        {
          "id": "400-4100-0042",
          "name": "Przystanek autobusowy",
          "primary": true
        }
      ],
      "scoring": {
        "queryScore": 1,
        "fieldScore": {
          "city": 1,
          "placeName": 1
        }
      }
    }
  ]
}

パラメーター types=address,area を使用すると、顧客アプリケーションは場所の結果を除外できます。

GET https://geocode.search.hereapi.com/v1/
    geocode
    ?q=Harfowa%2C+Warszawa
    &types=address%2Carea
    &apiKey={YOUR_API_KEY}

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

q - 名前を入力します。
types - レスポンスに含める必要がある、タイプのコンマ区切りのリスト。
apiKey - APIキー。

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

上のリクエストに対するレスポンスはバス停ではなくなり、あいまい一致した道路ulica Harfowaになります。

{
  "items": [
    {
      "title": "ulica Harfowa, 02-389 Ochota, Polska",
      "id": "here:af:streetsection:RZk.ZvMCIgkrPBiscT2oGB",
      "resultType": "street",
      "address": {
        "label": "ulica Harfowa, 02-389 Ochota, Polska",
        "countryCode": "POL",
        "countryName": "Polska",
        "state": "Woj. Mazowieckie",
        "county": "Warszawa",
        "city": "Warszawa",
        "district": "Ochota",
        "subdistrict": "Szczęśliwice",
        "street": "ulica Harfowa",
        "postalCode": "02-389"
      },
      "position": {
        "lat": 52.20009,
        "lng": 20.96503
      },
      "mapView": {
        "west": 20.96401,
        "south": 52.19966,
        "east": 20.96639,
        "north": 52.20156
      },
      "scoring": {
        "queryScore": 1,
        "fieldScore": {
          "city": 1,
          "streets": [
            0.9
          ]
        }
      }
    }
  ]
}

追加情報

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

さまざまなエンドポイントによるtypesフィルターのサポートの概要については、次を参照してください：結果をタイプでフィルタリングする。