Autocomplete

Geocode/autocomplete Endpointを使用すると、有効な番地または管理エリアに入力された数回のキーストロークを完了することで、アドレスクエリーの入力時間を短縮できます。 /autocomplete は、結果オブジェクトの完全なアドレスと識別子を含む提案を返します。 エンドユーザーが関連する提案を選択すると、顧客アプリケーションは、後で /lookup Endpointを使用して、識別子に基づいて提案の地理座標を取得できます。 または、顧客のアプリケーションが /geocode Endpointを使用して、/autocompleteによって返されたアドレスをジオコードに送信でき ます。

エンドユーザーは、/autocompleteの助け を借りて住所の入力を続行するためのベースとして使用する中間結果を選択することもできます。 たとえば、市区町村名の入力が完了したら、番地と住居番号を選択します。

たとえば、アドレスのリストを取得するクエリーで、テキストPariser 2 Frankを入力 すると、次のリクエストを使用して作成できます。

GET https://autocomplete.search.hereapi.com/v1/
    autocomplete
    ?q=Pariser+2+Frank
    &apiKey={YOUR_API_KEY}

上記のリクエストへのレスポンスには、 2 つの提案が含まれています。これらの提案では、クエリーテキストが入力され、次のようになります。

{
  "items": [
    {
      "title": "Deutschland, 60486, Frankfurt am Main, Pariser Straße 2",
      "id": "here:af:streetsection:A2eGBPgL70TOTtA85fTiEB:CggIBCDg0K_aAhABGgEy",
      "language": "de",
      "resultType": "houseNumber",
      "houseNumberType": "PA",
      "address": {
        "label": "Pariser Straße 2, 60486 Frankfurt am Main, Deutschland",
        "countryCode": "DEU",
        "countryName": "Deutschland",
        "stateCode": "HE",
        "state": "Hessen",
        "countyCode": "F",
        "county": "Frankfurt am Main",
        "city": "Frankfurt am Main",
        "district": "Gallus",
        "street": "Pariser Straße",
        "postalCode": "60486",
        "houseNumber": "2"
      },
      "highlights": {
        "title": [
          {
            "start": 20,
            "end": 25
          },
          {
            "start": 39,
            "end": 46
          },
          {
            "start": 54,
            "end": 55
          }
        ],
        "address": {
          "label": [
            {
              "start": 0,
              "end": 7
            },
            {
              "start": 15,
              "end": 16
            },
            {
              "start": 24,
              "end": 29
            }
          ],
          "city": [
            {
              "start": 0,
              "end": 5
            }
          ],
          "street": [
            {
              "start": 0,
              "end": 7
            }
          ],
          "houseNumber": [
            {
              "start": 0,
              "end": 1
            }
          ]
        }
      }
    },
    {
      "title": "Deutschland, Frankenthal (Pfalz), Pariser Weg",
      "id": "here:af:streetsection:CUcedHTrEUhmgRAcm.mbnD",
      "language": "de",
      "resultType": "street",
      "address": {
        "label": "Pariser Weg, 67227 Frankenthal (Pfalz), Deutschland",
        "countryCode": "DEU",
        "countryName": "Deutschland",
        "stateCode": "RP",
        "state": "Rheinland-Pfalz",
        "countyCode": "FT",
        "county": "Frankenthal (Pfalz)",
        "city": "Frankenthal (Pfalz)",
        "district": "Frankenthal (Pfalz)",
        "street": "Pariser Weg",
        "postalCode": "67227"
      },
      "highlights": {
        "title": [
          {
            "start": 13,
            "end": 18
          },
          {
            "start": 34,
            "end": 41
          }
        ],
        "address": {
          "label": [
            {
              "start": 0,
              "end": 7
            },
            {
              "start": 19,
              "end": 24
            }
          ],
          "city": [
            {
              "start": 0,
              "end": 5
            }
          ],
          "street": [
            {
              "start": 0,
              "end": 7
            }
          ]
        }
      }
    }
  ]
}

レスポンスには、結果ごとに次の上位レベルの要素が含まれています。

  • resultType - HERE Geocoding and Search /autocomplete では 、住所およびエリアをカバーする複数のタイプのアイテム ('' houseNumberlocalitystreet
    administrativeArea, intersectionpostalCodePoint ) を戻すことができます。
  • houseNumberType - 住所データのタイプ ( 住所の結果についてのみ返されます ):
    • PA - ポイントアドレス。位置は個々のポイントオブジェクトと一致します
    • interpolated - 住所範囲に基づいて位置情報が補間されました
  • title –結果の代表的な文字列
  • address - 結果の詳細なAddress
  • id - 結果オブジェクトの識別子。 その値を使用 して、/lookup エンドポイントを介してまったく同じオブジェクトを取得
  • language - 結果の住所要素の優先言語。 この値を使用して、 /lookup ID によってEndpointを介して同じオブジェクトを取得する際に、同じ言語設定を設定できます
  • highlights - クエリに一致するテキストスライス。 これらのスライスを使用して、結果内の関連する一致するクエリ用語を強調表示できます。

/autocompleteパラメータの詳細については、『 API リファレンス』を参照してください。

Geocode /autocomplete Endpointは、住所または管理エリアの一部にテキスト条件を一致させることで、入力されたテキストを完了しようとします。 「完了」ユースケースな /autocomplete ので、エンドユーザーは、すでに入力されているすべての用語を提案に含めることができます。 /autocomplete この期待を満たすために、Endpointは次の機能を提供します。

  • /autocomplete Endpointは、すべてのクエリ条件を含む結果のみを返します。 唯一の例外は、house numberに一致しません。 /autocompleteが 住所に完全なクエリを一致させることができますが、house numberに一致しない場合。/autocompleteの結果として、house numbernoない番地の候補が返されます上の例では、 2 番目の提案にはhouse numberが含まれていません。マップ データでは利用できませんが、実際には有効な場合があります。
  • /autocomplete Endpointが応答言語を選択すると、エンドユーザーは、入力されたすべての用語をクエリと同じ言語で表示および認識できます。 lang 顧客アプリケーションは、パラメータを使用して、エンドユーザーが優先する応答言語を指定できます。 一致する住所フィールドの言語は変更されませんが、住所の REST の言語設定が設定されます
  • /autocomplete Endpointの結果titleの形式が、他のすべてのEndpointと異なります。 国名から始まる統一された方法で結果を表します。 およびには、一致したすべてのクエリー条件が含まれます
  • 応答に はブロックhighlightsが含まれてい ます。ブロックを使用すると、結果title内およびブロックaddress内の詳細なアドレスコンポーネント内で、一致するクエリー用語を強調表示できます。
結果のタイトル内のクエリ用語を強調表示します。
図 1. 結果のタイトル内のクエリ用語を強調表示します。

詳細については、「Autocompleteの例」を参照してください。

メモ

HERE Geocoding and Search /autocomplete Endpointは日本のプレミアムデータをサポートしていません。

」に一致する結果は 件です

    」に一致する結果はありません