修飾クエリを作成する

このチュートリアルでは、修飾クエリを使用する方法を説明します。

手順

/geocode エンドポイントの修飾住所入力は、住所テキストを別々のフィールドでキャプチャーする場合のオプションです。

たとえば、サインアッププロセスの一環として、または構造化された入力が必要な場合に使用します。

たとえば、「425 W Randolph St, Chicago, IL 60606, United States」という住所は、次のサブパラメーターのセットとして修飾できます。

houseNumber=425
street=W Randolph St
city=Chicago
state=IL
postalCode=60606
country=United States

この場合の country は、住所の修飾フィールドであり、単一の国名または大文字の国コードをサポートしています。大文字のISO 3166-1 alpha-3国コードのリストで結果を限定するには、inパラメーターを使用してください。

📘
注：
次の国では、HERE Geocoding and SearchはISO-3166コードとは異なるコードを使用しています。XSB-BSB、XCY-CUN、XGS-GAS、XGI-GRI、XKO-KOS、XKI-KRI、XNC-NCY、XPI-PLI、XSO-SAS、XSI-SPI。

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

GET https://geocode.search.hereapi.com/v1/
    geocode
    ?qq=
        houseNumber=425;
        street=W+Randolph+St;
        city=Chicago;
        state=IL;
        postalCode=60606;
        country=United+States
    &apiKey={YOUR_API_KEY}

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

qq - 修飾クエリを入力します。修飾クエリはフリーテキストクエリに似ていますが、構造化されています。セミコロンで区切って複数のサブパラメーターを指定できるため、クエリのさまざまな側面を指定できます。
apiKey - APIキー。

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

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

{
  "items": [
    {
      "title": "425 W Randolph St, Chicago, IL 60606-1506, United States",
      "id": "here:af:streetsection:hdZ6xBRUraY46IQZCqZidD:CgcIBCDMlOElEAEaAzQyNShk",
      "resultType": "houseNumber",
      "houseNumberType": "PA",
      "address": {
        "label": "425 W Randolph St, Chicago, IL 60606-1506, United States",
        "countryCode": "USA",
        "countryName": "United States",
        "stateCode": "IL",
        "state": "Illinois",
        "county": "Cook",
        "city": "Chicago",
        "district": "West Loop",
        "street": "W Randolph St",
        "postalCode": "60606-1506",
        "houseNumber": "425"
      },
      "position": {
        "lat": 41.88432,
        "lng": -87.63877
      },
      "access": [
        {
          "lat": 41.88449,
          "lng": -87.63877
        }
      ],
      "mapView": {
        "west": -87.63998,
        "south": 41.88342,
        "east": -87.63756,
        "north": 41.88522
      },
      "scoring": {
        "queryScore": 1,
        "fieldScore": {
          "country": 1,
          "state": 1,
          "city": 1,
          "streets": [
            1
          ],
          "houseNumber": 1,
          "postalCode": 1
        }
      }
    }
  ]
}

また、/geocode エンドポイントでは、住所行への道路の名前と住居番号の結合がサポートされています。住所行は street サブパラメーターで指定できます

上のクエリは次のように作成することもできます。

street=425 W Randolph St
city=Chicago
state=IL
postalCode=60606
country=United States

GET https://geocode.search.hereapi.com/v1/
    geocode
    ?qq=
        street=425+W+Randolph+St;
        city=Chicago;
        state=IL;
        postalCode=60606;
        country=United+States
    &apiKey={YOUR_API_KEY}

📘
注：
日本では、修飾クエリは州、郡、市区町村、地区、郵便番号でのみサポートされています。

追加情報

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