SearchGetSearchAddressOptionalParams interface
省略可能なパラメーター。
- Extends
-
RequestOptionsBase
プロパティ
btm |
境界ボックスの右下の位置。 例: 37.553、-122.453 |
country |
国コードのコンマ区切り文字列 (FR、ES など)。 これにより、指定した国に検索が制限されます |
extended |
結果に拡張郵便番号を含める必要があるインデックス。 使用可能なインデックスは次のとおりです。 Addr = アドレス範囲 Geo = Geographies PAD = ポイント アドレス POI = 関心のあるポイント Str = Streets XStr = クロス ストリート (交差) 値は、インデックスの種類のコンマ区切りのリスト (任意の順序) またはインデックスがない場合 は None にする必要があります。 既定では、Geo を除くすべてのインデックスに拡張郵便番号が含まれます。 地域の拡張郵便番号リストは非常に長い場合があるため、必要に応じて明示的に要求する必要があります。 使用例: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None 拡張郵便番号は、住所の extendedPostalCode プロパティとして返されます。 可用性はリージョンによって異なります。 |
language | 検索結果を返す言語。 サポートされている IETF 言語タグの 1 つである必要があります。大文字と小文字は区別されません。 指定した言語のデータが特定のフィールドで使用できない場合は、既定の言語が使用されます。 詳細については、「 サポートされている言語 」を参照してください。 |
lat | 結果が偏る緯度。 例: 37.337 |
limit | 返される応答の最大数。 既定値: 10、最小: 1、最大: 100 |
lon | 結果を偏る必要がある経度。 例: -121.89 |
ofs | 完全な結果セット内の返された結果の開始オフセット。 |
radius | 結果を定義された領域に制限するための半径 (メートル単位) |
top |
境界ボックスの左上の位置。 例: 37.553、-122.453 |
typeahead | ブール型。 typeahead フラグが設定されている場合、クエリは部分的な入力として解釈され、検索は予測モードになります |
view | View パラメーターは、マップに表示される境界線やラベルなど、Azure Maps サービスを介して返される地政学的に異議を唱えるコンテンツのセットを指定します。 View パラメーター ("ユーザー リージョン パラメーター" とも呼ばれます) には、その国/地域の正しいマップが表示されます。 既定では、要求で定義していない場合でも、View パラメーターは "Unified" に設定されます。 ユーザーの場所を特定し、その場所を正しく View パラメーターを設定するのはユーザーの責任です。 または、要求の IP アドレスに基づいてマップ データを返す 'View = Auto' を設定することもできます。 Azure Mapsの View パラメーターは、マップ、画像、その他のデータ、およびユーザーがAzure Maps経由でアクセスする権限を持つ第三者のコンテンツを利用できる国のマッピングに関する法律を含む、適用される法律に準拠して使用する必要があります。 例: view=IN。 詳細については、「 サポートされているビュー 」を参照し、使用可能なビューを参照してください。 |
継承されたプロパティ
abort |
要求を中止するために使用できるシグナル。 |
custom |
{object}[customHeaders]要求が送信される前に適用されるユーザー定義のカスタム要求ヘッダー。 |
on |
ダウンロードの進行状況時に発生するコールバック。 |
on |
アップロードの進行状況時に発生するコールバック。 |
timeout | 要求が自動的に終了するまでの時間 (ミリ秒)。 |
プロパティの詳細
btmRight
境界ボックスの右下の位置。 例: 37.553、-122.453
btmRight?: string
プロパティ値
string
countrySet
国コードのコンマ区切り文字列 (FR、ES など)。 これにより、指定した国に検索が制限されます
countrySet?: string[]
プロパティ値
string[]
extendedPostalCodesFor
結果に拡張郵便番号を含める必要があるインデックス。 使用可能なインデックスは次のとおりです。
Addr = アドレス範囲
Geo = Geographies
PAD = ポイント アドレス
POI = 関心のあるポイント
Str = Streets
XStr = クロス ストリート (交差)
値は、インデックスの種類のコンマ区切りのリスト (任意の順序) またはインデックスがない場合 は None にする必要があります。
既定では、Geo を除くすべてのインデックスに拡張郵便番号が含まれます。 地域の拡張郵便番号リストは非常に長い場合があるため、必要に応じて明示的に要求する必要があります。
使用例:
extendedPostalCodesFor=POI
extendedPostalCodesFor=PAD,Addr,POI
extendedPostalCodesFor=None
拡張郵便番号は、住所の extendedPostalCode プロパティとして返されます。 可用性はリージョンによって異なります。
extendedPostalCodesFor?: string
プロパティ値
string
language
検索結果を返す言語。 サポートされている IETF 言語タグの 1 つである必要があります。大文字と小文字は区別されません。 指定した言語のデータが特定のフィールドで使用できない場合は、既定の言語が使用されます。 詳細については、「 サポートされている言語 」を参照してください。
language?: string
プロパティ値
string
lat
結果が偏る緯度。 例: 37.337
lat?: number
プロパティ値
number
limit
返される応答の最大数。 既定値: 10、最小: 1、最大: 100
limit?: number
プロパティ値
number
lon
結果を偏る必要がある経度。 例: -121.89
lon?: number
プロパティ値
number
ofs
完全な結果セット内の返された結果の開始オフセット。
ofs?: number
プロパティ値
number
radius
結果を定義された領域に制限するための半径 (メートル単位)
radius?: number
プロパティ値
number
topLeft
境界ボックスの左上の位置。 例: 37.553、-122.453
topLeft?: string
プロパティ値
string
typeahead
ブール型。 typeahead フラグが設定されている場合、クエリは部分的な入力として解釈され、検索は予測モードになります
typeahead?: boolean
プロパティ値
boolean
view
View パラメーターは、マップに表示される境界線やラベルなど、Azure Maps サービスを介して返される地政学的に異議を唱えるコンテンツのセットを指定します。 View パラメーター ("ユーザー リージョン パラメーター" とも呼ばれます) には、その国/地域の正しいマップが表示されます。 既定では、要求で定義していない場合でも、View パラメーターは "Unified" に設定されます。 ユーザーの場所を特定し、その場所を正しく View パラメーターを設定するのはユーザーの責任です。 または、要求の IP アドレスに基づいてマップ データを返す 'View = Auto' を設定することもできます。 Azure Mapsの View パラメーターは、マップ、画像、その他のデータ、およびユーザーがAzure Maps経由でアクセスする権限を持つ第三者のコンテンツを利用できる国のマッピングに関する法律を含む、適用される法律に準拠して使用する必要があります。 例: view=IN。 詳細については、「 サポートされているビュー 」を参照し、使用可能なビューを参照してください。
view?: string
プロパティ値
string
継承されたプロパティの詳細
abortSignal
要求を中止するために使用できるシグナル。
abortSignal?: AbortSignalLike
プロパティ値
AbortSignalLike
継承元 RequestOptionsBase.abortSignal
customHeaders
{object}[customHeaders]要求が送信される前に適用されるユーザー定義のカスタム要求ヘッダー。
customHeaders?: [key: string]: string
プロパティ値
[key: string]: string
継承元 RequestOptionsBase.customHeaders
onDownloadProgress
ダウンロードの進行状況時に発生するコールバック。
onDownloadProgress?: (progress: TransferProgressEvent) => void
プロパティ値
(progress: TransferProgressEvent) => void
継承元 RequestOptionsBase.onDownloadProgress
onUploadProgress
アップロードの進行状況時に発生するコールバック。
onUploadProgress?: (progress: TransferProgressEvent) => void
プロパティ値
(progress: TransferProgressEvent) => void
継承元 RequestOptionsBase.onUploadProgress
timeout
要求が自動的に終了するまでの時間 (ミリ秒)。
timeout?: number
プロパティ値
number
継承元 RequestOptionsBase.timeout