SearchGetSearchAddressStructuredOptionalParams interface

パッケージ:

azure-maps-rest

省略可能なパラメーター。

Extends

RequestOptionsBase

プロパティ

countrySecondarySubdivision	構造化住所の郡
countrySubdivision	住所の国の分割部分
countryTertiarySubdivision	構造化アドレスの名前付き領域
crossStreet	構造化住所のクロスストリート名
extendedPostalCodesFor	結果に拡張郵便番号を含める必要があるインデックス。 使用可能なインデックスは次のとおりです。 Addr = アドレス範囲 Geo = Geographies PAD = ポイント アドレス POI = 目的地 Str = Streets XStr = クロス ストリート (交差点) 値は、インデックスの種類 (任意の順序) のコンマ区切りのリスト、またはインデックスがない場合は None にする必要があります。 既定では、Geo を除くすべてのインデックスに拡張郵便番号が含まれます。 地域の拡張郵便番号リストは非常に長い場合があるため、必要に応じて明示的に要求する必要があります。 使用例: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None 拡張郵便番号は、住所の extendedPostalCode プロパティとして返されます。 可用性はリージョンに依存します。
language	検索結果を返す言語。 サポートされている IETF 言語タグの 1 つである必要があります。大文字と小文字は区別されません。 指定した言語のデータが特定のフィールドで使用できない場合は、既定の言語が使用されます。 詳細については、「 サポートされている言語 」を参照してください。
limit	返される応答の最大数
municipality	住所の市区町村部分
municipalitySubdivision	構造化住所の市区町村区分 (サブ/スーパーシティ)
ofs	完全な結果セット内の返された結果の開始オフセット
postalCode	住所の郵便番号部分
streetName	住所の番地の部分
streetNumber	住所の番地の部分
view	View パラメーターは、マップに表示される境界線やラベルなど、Azure Maps サービスを介して返される地政学的に紛争のあるコンテンツのセットを指定します。 View パラメーター ("ユーザー リージョン パラメーター" とも呼ばれます) には、その国/地域の正しいマップが表示されます。 既定では、View パラメーターは、要求で定義していない場合でも "Unified" に設定されます。 ユーザーの場所を特定し、その場所を正しく View パラメーターを設定するのはユーザーの責任です。 または、要求の IP アドレスに基づいてマップ データを返す 'View = Auto' を設定することもできます。 Azure Mapsの View パラメーターは、マップ、画像、その他のデータ、Azure Maps経由でアクセスする権限を持つ第三者のコンテンツが利用可能になる国のマッピングに関する法律を含む、適用される法律に準拠して使用する必要があります。 例: view=IN。 詳細については、「 サポートされているビュー」 を参照し、使用可能なビューを参照してください。

継承されたプロパティ

abortSignal	要求を中止するために使用できるシグナル。
customHeaders	{object}[customHeaders]要求が送信される前に適用されるユーザー定義のカスタム要求ヘッダー。
onDownloadProgress	ダウンロードの進行状況時に発生するコールバック。
onUploadProgress	アップロードの進行状況時に発生するコールバック。
timeout	要求が自動的に終了するまでの時間 (ミリ秒)。

プロパティの詳細

countrySecondarySubdivision

構造化住所の郡

countrySecondarySubdivision?: string

プロパティ値

string

countrySubdivision

住所の国の分割部分

countrySubdivision?: string

プロパティ値

string

countryTertiarySubdivision

構造化アドレスの名前付き領域

countryTertiarySubdivision?: string

プロパティ値

string

crossStreet

構造化住所のクロスストリート名

crossStreet?: 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

limit

返される応答の最大数

limit?: number

プロパティ値

number

municipality

住所の市区町村部分

municipality?: string

プロパティ値

string

municipalitySubdivision

構造化住所の市区町村区分 (サブ/スーパーシティ)

municipalitySubdivision?: string

プロパティ値

string

ofs

完全な結果セット内の返された結果の開始オフセット

ofs?: number

プロパティ値

number

postalCode

住所の郵便番号部分

postalCode?: string

プロパティ値

string

streetName

住所の番地の部分

streetName?: string

プロパティ値

string

streetNumber

住所の番地の部分

streetNumber?: string

プロパティ値

string

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