Share via

SearchGetSearchAddressReverseOptionalParams interface

  • リファレンス
パッケージ:
azure-maps-rest

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

Extends

RequestOptionsBase

プロパティ

allowFreeformNewline

書式設定されたアドレスの改行の形式。 true の場合、アドレスには改行が含まれます。 false の場合、改行はコンマに変換されます。
entityType

指定した geography エンティティ型の検索を絞り込みます。たとえば、市区町村のみを返します。 結果の応答には、geography ID および一致したエンティティ型が含まれます。 コンマ区切りリストとして複数のエンティティを指定した場合、エンドポイントは "使用可能な最小のエンティティ" を返します。 返された Geometry ID を使用すると、Get Search Polygon API を使用してその geography のジオメトリを取得できます。 指定できる値は、'Country'、'CountrySubdivision'、'CountrySecondarySubdivision'、'CountryTertiarySubdivision'、'Municipality'、'MunicipalitySubdivision'、'Neighbourhood'、'PostalCodeArea' です。
heading

道路のセグメントに沿って移動するための車両の方向見出しを度単位で指定します。 0 は North、90 は East など、値の範囲は -360 から 360 です。 有効桁数には、小数点以下 1 桁までを含めることができます
language

検索結果を返す言語。 サポートされている IETF 言語タグの 1 つである必要があります。大文字と小文字は区別されません。 指定した言語のデータが特定のフィールドで使用できない場合は、既定の言語が使用されます。 詳細については、「 サポートされている言語 」を参照してください。
number

要求と共に数値が送信された場合、応答には、通りの側面 (左/右) と、その番号のオフセット位置が含まれる場合があります
radius

結果を定義された領域に制限するための半径 (メートル単位)
returnMatchType

応答で実現されたジオコーダーの一致の種類に関する情報を含めます。
returnRoadUse

ブール型。 道路の戻り値を有効にするには、道路レベルでリバースコードの配列を使用します
returnSpeedLimit

ブール型。 ポストされた speedlimit のリターンを有効にするには
roadUse

リバースコードを特定の種類の roaduse に制限する。 リバースコードの道路使用配列は、LimitedAccess、動脈、ターミナル、ランプ、ロータリー、LocalStreetの1つ以上にすることができます
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

要求が自動的に終了するまでの時間 (ミリ秒)。

プロパティの詳細

allowFreeformNewline

書式設定されたアドレスの改行の形式。 true の場合、アドレスには改行が含まれます。 false の場合、改行はコンマに変換されます。

allowFreeformNewline?: boolean

プロパティ値

boolean

entityType

指定した geography エンティティ型の検索を絞り込みます。たとえば、市区町村のみを返します。 結果の応答には、geography ID および一致したエンティティ型が含まれます。 コンマ区切りリストとして複数のエンティティを指定した場合、エンドポイントは "使用可能な最小のエンティティ" を返します。 返された Geometry ID を使用すると、Get Search Polygon API を使用してその geography のジオメトリを取得できます。 指定できる値は、'Country'、'CountrySubdivision'、'CountrySecondarySubdivision'、'CountryTertiarySubdivision'、'Municipality'、'MunicipalitySubdivision'、'Neighbourhood'、'PostalCodeArea' です。

entityType?: EntityType

プロパティ値

EntityType

heading

道路のセグメントに沿って移動するための車両の方向見出しを度単位で指定します。 0 は North、90 は East など、値の範囲は -360 から 360 です。 有効桁数には、小数点以下 1 桁までを含めることができます

heading?: number

プロパティ値

number

language

検索結果を返す言語。 サポートされている IETF 言語タグの 1 つである必要があります。大文字と小文字は区別されません。 指定した言語のデータが特定のフィールドで使用できない場合は、既定の言語が使用されます。 詳細については、「 サポートされている言語 」を参照してください。

language?: string

プロパティ値

string

number

要求と共に数値が送信された場合、応答には、通りの側面 (左/右) と、その番号のオフセット位置が含まれる場合があります

number?: string

プロパティ値

string

radius

結果を定義された領域に制限するための半径 (メートル単位)

radius?: number

プロパティ値

number

returnMatchType

応答で実現されたジオコーダーの一致の種類に関する情報を含めます。

returnMatchType?: boolean

プロパティ値

boolean

returnRoadUse

ブール型。 道路の戻り値を有効にするには、道路レベルでリバースコードの配列を使用します

returnRoadUse?: boolean

プロパティ値

boolean

returnSpeedLimit

ブール型。 ポストされた speedlimit のリターンを有効にするには

returnSpeedLimit?: boolean

プロパティ値

boolean

roadUse

リバースコードを特定の種類の roaduse に制限する。 リバースコードの道路使用配列は、LimitedAccess、動脈、ターミナル、ランプ、ロータリー、LocalStreetの1つ以上にすることができます

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