Share via

SearchGetSearchPOICategoryOptionalParams interface

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

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

Extends

RequestOptionsBase

プロパティ

brandSet

結果を特定のブランドに制限するために使用できるブランド名のコンマ区切りのリスト。 項目の順序は関係ありません。 複数のブランドが提供されている場合は、指定されたリストの 1 つに属する (少なくとも) 結果のみが返されます。 名前に "," を含むブランドは引用符で囲む必要があります。 使用例:

brandSet=Foo

brandSet=Foo,Bar

brandSet="A,B,C コンマ",Bar
btmRight

境界ボックスの右下の位置。 例: 37.553、-122.453
connectorSet

特定のコネクタの種類をサポートする電気自動車ステーションに結果を制限するために使用できるコネクタの種類のコンマ区切りのリスト。 項目の順序は関係ありません。 複数のコネクタの種類が指定されている場合は、指定されたリストの 1 つ (少なくとも) に属する結果のみが返されます。 使用可能なコネクタの種類は次のとおりです。

  • StandardHouseholdCountrySpecific - これらは、特定のリージョンの標準的な家庭用コネクタです。 それらはすべてAC単一フェーズおよび標準的な電圧および標準的なアンペア数である。 「 プラグ & ソケットの種類 - 世界標準」も参照してください。
  • IEC62196Type1 - IEC 62196-2 標準で定義されている「1 コネクタ」と入力します。 最初に公開された標準の後、元のメーカーまたはSAE J1772の後に矢崎とも呼ばれます。 主に120V単相または最大240V単相インフラストラクチャと組み合わせて使用されます。
  • IEC62196Type1CCS - IEC 62196-3 標準で定義されているタイプ 1 ベースのコンボ コネクタ。 このコネクタは、IEC 62196-2 標準で定義されているタイプ 1 コネクタに基づいており、DC 急速充電を可能にする 2 つの追加の直流 (DC) 接点を備えます。
  • IEC62196Type2CableAttached - IEC 62196-2 標準で定義されているタイプ 2 コネクタ。 充電ポイントに取り付けられたケーブルとプラグとして提供されます。
  • IEC62196Type2Outlet - IEC 62196-2 標準で定義されているタイプ 2 コネクタ。 充電ポイントにセットされたソケットとして提供されます。
  • IEC62196Type2CCS - IEC 62196-3 標準で定義されているタイプ 2 ベースのコンボ コネクタ。 このコネクタは、IEC 62196-2 標準で定義されているタイプ 2 コネクタに基づいており、DC 急速充電を可能にする 2 つの追加の直流 (DC) 接点を備えます。
  • IEC62196Type3 - IEC 62196-2 標準で定義されている「3 コネクタ」と入力します。 元のメーカーの後にスカメとも呼ばれます。 主に、最大240Vの単相または最大420Vの3相インフラストラクチャと組み合わせて使用されます。
  • Chademo - 東京電力と産業パートナーが設立した協会にちなんだCHAdeMOコネクタ。 このため、東京電力のコネクタとも呼ばれています。 高速DC充電に対応しています。
  • IEC60309AC1PhaseBlue - Industrial Blue コネクタは、IEC 60309 標準で定義されているコネクタです。 これは、標準、色、および単一相コネクタであるという事実の何らかの組み合わせによって呼ばれることがあります。 通常、コネクタには "P+N+E, 6h" 構成があります。
  • IEC60309DCWhite - Industrial White コネクタは、IEC 60309 標準で定義されている DC コネクタです。
  • Tesla - Tesla コネクタは、地域固有の Tesla スーパーチャージャー コネクタです。 つまり、テスラ独自のコネクタを指します。テスラポートと呼ばれることもありますが、主に北米に限定されているか、ヨーロッパでは修正されたタイプ2(DC over Type 2)です。

使用例:

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
countrySet

国コードのコンマ区切り文字列 (FR、ES など)。 これにより、指定した国に検索が制限されます
extendedPostalCodesFor

結果に拡張郵便番号を含める必要があるインデックス。 使用可能なインデックスは次のとおりです。

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
openingHours

POI (ポイント オブ インタレスト) の営業時間。 営業時間の空き時間は、利用可能なデータによって異なります。 使用できる値は次のとおりです: 'nextSevenDays'
radius

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

境界ボックスの左上の位置。 例: 37.553、-122.453
typeahead

ブール型。 typeahead フラグが設定されている場合、クエリは部分的な入力として解釈され、検索は予測モードになります
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

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

プロパティの詳細

brandSet

結果を特定のブランドに制限するために使用できるブランド名のコンマ区切りのリスト。 項目の順序は関係ありません。 複数のブランドが提供されている場合は、指定されたリストの 1 つに属する (少なくとも) 結果のみが返されます。 名前に "," を含むブランドは引用符で囲む必要があります。 使用例:

brandSet=Foo

brandSet=Foo,Bar

brandSet="A,B,C コンマ",Bar

brandSet?: string[]

プロパティ値

string[]

btmRight

境界ボックスの右下の位置。 例: 37.553、-122.453

btmRight?: string

プロパティ値

string

connectorSet

特定のコネクタの種類をサポートする電気自動車ステーションに結果を制限するために使用できるコネクタの種類のコンマ区切りのリスト。 項目の順序は関係ありません。 複数のコネクタの種類が指定されている場合は、指定されたリストの 1 つ (少なくとも) に属する結果のみが返されます。 使用可能なコネクタの種類は次のとおりです。

  • StandardHouseholdCountrySpecific - これらは、特定のリージョンの標準的な家庭用コネクタです。 それらはすべてAC単一フェーズおよび標準的な電圧および標準的なアンペア数である。 「 プラグ & ソケットの種類 - 世界標準」も参照してください。
  • IEC62196Type1 - IEC 62196-2 標準で定義されている「1 コネクタ」と入力します。 最初に公開された標準の後、元のメーカーまたはSAE J1772の後に矢崎とも呼ばれます。 主に120V単相または最大240V単相インフラストラクチャと組み合わせて使用されます。
  • IEC62196Type1CCS - IEC 62196-3 標準で定義されているタイプ 1 ベースのコンボ コネクタ。 このコネクタは、IEC 62196-2 標準で定義されているタイプ 1 コネクタに基づいており、DC 急速充電を可能にする 2 つの追加の直流 (DC) 接点を備えます。
  • IEC62196Type2CableAttached - IEC 62196-2 標準で定義されているタイプ 2 コネクタ。 充電ポイントに取り付けられたケーブルとプラグとして提供されます。
  • IEC62196Type2Outlet - IEC 62196-2 標準で定義されているタイプ 2 コネクタ。 充電ポイントにセットされたソケットとして提供されます。
  • IEC62196Type2CCS - IEC 62196-3 標準で定義されているタイプ 2 ベースのコンボ コネクタ。 このコネクタは、IEC 62196-2 標準で定義されているタイプ 2 コネクタに基づいており、DC 急速充電を可能にする 2 つの追加の直流 (DC) 接点を備えます。
  • IEC62196Type3 - IEC 62196-2 標準で定義されている「3 コネクタ」と入力します。 元のメーカーの後にスカメとも呼ばれます。 主に、最大240Vの単相または最大420Vの3相インフラストラクチャと組み合わせて使用されます。
  • Chademo - 東京電力と産業パートナーが設立した協会にちなんだCHAdeMOコネクタ。 このため、東京電力のコネクタとも呼ばれています。 高速DC充電に対応しています。
  • IEC60309AC1PhaseBlue - Industrial Blue コネクタは、IEC 60309 標準で定義されているコネクタです。 これは、標準、色、および単一相コネクタであるという事実の何らかの組み合わせによって呼ばれることがあります。 通常、コネクタには "P+N+E, 6h" 構成があります。
  • IEC60309DCWhite - Industrial White コネクタは、IEC 60309 標準で定義されている DC コネクタです。
  • Tesla - Tesla コネクタは、地域固有の Tesla スーパーチャージャー コネクタです。 つまり、テスラ独自のコネクタを指します。テスラポートと呼ばれることもありますが、主に北米に限定されているか、ヨーロッパでは修正されたタイプ2(DC over Type 2)です。

使用例:

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached

connectorSet?: ConnectorSet[]

プロパティ値

ConnectorSet[]

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

openingHours

POI (ポイント オブ インタレスト) の営業時間。 営業時間の空き時間は、利用可能なデータによって異なります。 使用できる値は次のとおりです: 'nextSevenDays'

openingHours?: OpeningHours

プロパティ値

OpeningHours

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