リクエストパラメータ
Geocoder オートコンプリートの API は非常にシンプルです。 サポートされているリクエストパラメータの数が少ない。 これらの中では、承認パラメータ(app_id
、 app_code
または apiKey
)および query
のみが必須です。
リクエストは、次の一般的なパターンに従う必要があります。
.../6.2/suggest.json?<parameter>=<value>...
サポートされているリクエストパラメータについては、次の表を参照してください。
パラメーター | タイプ | 説明 | 例 |
---|---|---|---|
クエリー | string | クエリーの基礎となる検索テキスト。 | |
MaxResults | integer | 応答に含める提案の数の上限。 デフォルトは 5 に設定されています。 有効な範囲 : 1 ~ 20 。 | |
国 | 文字列のコンマ区切りリスト (3 文字の ISO 国コード ) | 空間フィルタのタイプ。 空間フィルタは、リクエスト内の他の属性の検索を制限します。 country パラメーターは、国または国のセットに提案を制限します。 国 =
| |
マップビュー | 2 組の緯度 / 経度のペア | 空間フィルタのタイプ。 バウンディング ボックスの左上と右下の角で表される地理的領域にフォーカスを設定します。この領域内の結果は、この領域外の結果よりも重要になります。
| |
Prox です | LAT / LON ペアおよび ( 任意 ) 半径 | 空間フィルタのタイプ。 1 つの地理座標ペアで表される地理的領域に焦点を設定します。また、任意で半径 ( メートル単位 ) を設定することもできます。そのため、この領域内の結果は、この領域外の結果よりも重要になります。 国空間フィルタと組み合わせることができます。 | |
beginHighlight | string | トークンで一致の先頭をマークします。 任意の文字列を指定できます。 一般的に使用さ <b> れているのは、太字などの HTML タグです。 ただし、角括弧 "[" を使用することもできます。 デフォルト:マーカーなし | 結果 : |
endHighlight | string | トークンで一致の末尾をマークします。 | beginHighlight を参照してください |
言語 | string | 結果の住所要素の優先言語。 言語パラメータは、 2 文字の ISO 言語コードで指定する必要があります。 パラメーター(言語)の複数形はサポートされていないため、無視されます。 1 つの言語のみを指定できます。 言語設定では、マップ データで使用できる結果要素の言語が変更されます。 言語設定は、一致またはランク付けに影響を与えず、地域の好みを表すものではありません。 既定の応答言語は、クエリに最も関連性のある言語です。 | 結果 : |
結果タイプ | 「エリア」または 「 postalCode 」または ' 都市 ' | | |