結果を特定の国に絞り込む
このチュートリアルでは /autocomplete
、エンドポイントで 1 つ以上の国に結果を制限する方法について説明します。
プロシージャ
この機能は、すべての住所が特定の国にあることがわかっている場合に、あいまいさや予期しない結果を避けるのに役立ちます。
たとえば、グローバルクエリーの関連性の高い結果の 1 つ Paris
がフランスの首都になります。 ただし、エンドユーザーがドイツからの住所の提案のみに関心がある場合は、パラメータを指定することで、ドイツに結果を制限できます 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 platform の認証オプションの詳細については、『ID およびアクセス管理ガイド』を参照してください。
このクエリには 、候補の数を制限するパラメーター limit=2
が含まれています。 /autocomplete
のデフォルトの制限 は 5 です。 /autocomplete
でサポートされている limit パラメータの最大値 は 20 です。
Paris
はフランスの都市であるため、国のフィルタ条件を満たしていません。 代わり /autocomplete
Paris
に、は、通り名や地区名などにトークンが含まれているドイツの住所候補を使用して応答します。 関連する提案がベルリンのパリサー広場にある可能性があります。
{
"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 リファレンス。