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

郵便番号による住所検索を使用する(SGP、IRL)

このチュートリアルでは、郵便番号を使用してシンガポール(SGP)とアイルランド(IRL)の住所を検索する方法を示します。

手順

アイルランドの郵便番号システムである Eircode は、すべての住宅と会社の住所に固有の郵便番号を割り当てています。シンガポールでは、住所と同じくらい正確な郵便番号が割り当てられています。

どちらの国でも、郵便番号を使用して特定の住所や位置を見つけることができます。通りの名前、都市、または近所、さらには住居番号さえも必要ありません。

/geocode エンドポイントはこのユースケースをサポートしています。郵便番号のみの freeform または修飾クエリで完全な住所を見つけることができます。この機能は、これら 2 つの国でのみ使用できます。

郵便番号には、次の精度が必要です。

  • シンガポールの場合:6 桁の郵便番号
  • アイルランドの場合:7 文字の「Eircode」

たとえば、郵便番号のみを指定して、「4 Derrynane Gardens, Dublin, County Dublin, D04 WR52, Ireland」の住所を検索できます。これは、修飾クエリ、

GET https://geocode.search.hereapi.com/v1/
    geocode
    ?qq=
        postalCode=D04+WR52
    &apiKey={YOUR_API_KEY}

または freeform クエリとして行います。

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

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

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

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

どちらの場合も、レスポンスは同じです。一致したフィールドは郵便番号の 1 つのみです。ただし、結果のタイプは完全な住所です。

{
  "items": [
    {
      "title": "4 Derrynane Gardens, Dublin, County Dublin, D04 WR52, Ireland",
      "id": "here:af:streetsection:xXbhv-RtAOYHP17itm9nPC:CgcIBCCr4K5mEAEaATQ",
      "resultType": "houseNumber",
      "houseNumberType": "PA",
      "address": {
        "label": "4 Derrynane Gardens, Dublin, County Dublin, D04 WR52, Ireland",
        "countryCode": "IRL",
        "countryName": "Ireland",
        "countyCode": "D",
        "county": "County Dublin",
        "city": "Dublin",
        "district": "Dublin 4",
        "street": "Derrynane Gardens",
        "postalCode": "D04 WR52",
        "houseNumber": "4"
      },
      "position": {
        "lat": 53.33782,
        "lng": -6.22906
      },
      "access": [
        {
          "lat": 53.33786,
          "lng": -6.22839
        }
      ],
      "mapView": {
        "west": -6.23057,
        "south": 53.33692,
        "east": -6.22755,
        "north": 53.33872
      },
      "scoring": {
        "queryScore": 1,
        "fieldScore": {
          "postalCode": 1
        }
      }
    }
  ]
}

シンガポールの郵便番号は 6 桁で構成されており、他の多くの国の郵便番号とよく似ています。あいまいさを回避し、郵便番号のみのクエリの結果を取得するには、at パラメーターで空間参照を指定するか、シンガポールの国名または大文字の国コードを追加で指定することをお勧めします。または、国フィルターを「SGP」に設定します。

たとえば、ユーザーは、修飾フィールドとして郵便番号を指定し、in=countryCode:SGP パラメーターを使用して結果をシンガポールに制限することで、「53 Stamford Rd, Singapore 178887, Singapore」の住所を検索できます。

GET https://geocode.search.hereapi.com/v1/
    geocode
    ?qq=
        postalCode=178887
    &in=countryCode%3ASGP
    &apiKey={YOUR_API_KEY}

あるいは、修飾された国フィールドとして国名または国コードを指定することもできます。

GET https://geocode.search.hereapi.com/v1/
    geocode
    ?qq=
        postalCode=178887;
        country=Singapore
    &apiKey={YOUR_API_KEY}

または、国名または国コードと郵便番号を freeform クエリに組み合わせることもできます。

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

上記のクエリのいずれかに対するレスポンスは完全な住所です。

{
  "items": [
    {
      "title": "53 Stamford Rd, Singapore 178887, Singapore",
      "id": "here:af:streetsection:us5c0JNnSvmYKAY94exFYB:CgcIBCD7_IpyEAEaAjUz",
      "resultType": "houseNumber",
      "houseNumberType": "PA",
      "address": {
        "label": "53 Stamford Rd, Singapore 178887, Singapore",
        "countryCode": "SGP",
        "countryName": "Singapore",
        "county": "Singapore",
        "city": "Singapore",
        "district": "Central Business District",
        "street": "Stamford Rd",
        "postalCode": "178887",
        "houseNumber": "53"
      },
      "position": {
        "lat": 1.29427,
        "lng": 103.85078
      },
      "access": [
        {
          "lat": 1.29437,
          "lng": 103.85084
        }
      ],
      "mapView": {
        "west": 103.84988,
        "south": 1.29337,
        "east": 103.85168,
        "north": 1.29517
      },
      "scoring": {
        "queryScore": 1,
        "fieldScore": {
          "country": 1,
          "postalCode": 1
        }
      }
    }
  ]
}

クライアント アプリケーションでは、住所と郵便番号の情報を 1 つのクエリに組み合わせることができます。/geocode エンドポイントは、提供されたすべての住所コンポーネントを照合して、より高い信頼性のある結果を見つけます。

追加情報

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