SearchURL class
SearchURL は、Azure Maps検索操作の URL を表します。
- Extends
コンストラクター
| SearchURL(Pipeline, string) | SearchURL のインスタンスを作成します。 |
継承されたプロパティ
| maps |
ベース URL 文字列値。 |
メソッド
| search |
住所ジオコーディング 多くの場合、従来のジオコーディングにのみ関心がある場合など、完全な検索サービスが多すぎる可能性があります。 Searchは、アドレス検索専用にアクセスすることもできます。 ジオコーディングは、問題の住所または一部の住所のみを含むジオコーディング エンドポイントに到達することによって実行されます。 ジオコーディング検索インデックスは、道路レベルのデータの上にあるすべてのものに対してクエリが実行されます。 POI は返されません。 ジオコーダーは入力ミスと不完全な住所に対して非常に耐性があることに注意してください。 また、正確な通りの住所や通りや交差点だけでなく、市内中心部、郡、州などのより高いレベルの地域からすべてを処理します。Get Search Address API を使用します。https://docs.microsoft.com/rest/api/maps/search/getsearchaddress |
| search |
住所への逆ジオコーディング 座標 (例: -122.3862、37.786505) を人間が理解できる番地に変換する必要がある場合があります。 多くの場合、これは、デバイスまたはアセットから GPS フィードを受信し、座標が配置されているアドレスを知る必要があるアプリケーションをトラッキングする場合に必要です。 このエンドポイントは、特定の座標のアドレス情報を返します。 Get Search Address Reverse API を使用します。https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreverse |
| search |
クロス ストリートへの逆ジオコーディング 座標 (例: -122.3862、37.786505) を人間が理解できるクロス ストリートに変換する必要がある場合があります。 多くの場合、これは、デバイスまたはアセットから GPS フィードを受信し、座標が配置されているアドレスを知る必要があるアプリケーションをトラッキングする場合に必要です。 このエンドポイントは、特定の座標のクロスストリート情報を返します。 Get Search Address Reverse Cross Street API を使用します。https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreversecrossstreet |
| search |
構造化住所ジオコーディング Azure 住所ジオコーディングには、構造化された住所の検索専用にアクセスすることもできます。 ジオコーディング検索インデックスは、道路レベルのデータの上にあるすべてのものに対してクエリが実行されます。 POI は返されません。 ジオコーダーは入力ミスと不完全な住所に対して非常に耐性があることに注意してください。 また、正確な通りの住所や通りや交差点だけでなく、市内中心部、郡、州などのより高いレベルの地域からすべてを処理します。Get Search Address Structured API を使用します。https://docs.microsoft.com/rest/api/maps/search/getsearchaddressstructured |
| search |
ルートに沿ったSearch エンドポイントを使用すると、指定したルートに沿って POI のあいまい検索を実行できます。
この検索は、制限メジャーを |
| search |
Free Form Search 基本的な既定の API は Free Form Search であり、アドレスまたは POI トークンの任意の組み合わせを処理する入力の最もあいまいな部分を処理します。
この検索 API は、正規の "単一行検索" です。
Free Form Search API は、POI 検索とジオコーディングのシームレスな組み合わせです。
また、API は、コンテキスト位置 (lat./lon. ペア) で重み付けすることも、座標と半径によって完全に制約することも、geo バイアス アンカー ポイントなしでより一般的に実行することもできます。
"countrySet" パラメーターを使用して、アプリケーションでカバレッジが必要な国のみを指定することを強くお勧めします。既定の動作では、世界中を検索し、不要な結果を返す可能性があります。 例: |
| search |
Search Geometry エンドポイントを使用すると、1 つのジオメトリまたはその多くで自由形式の検索を実行できます。
geometry/geometries 内にある検索結果が返されます。
検索する地理フィーチャは、次 |
| search |
近くのSearch 特定の場所に関する POI 結果のみを取得するユース ケースがある場合は、近くの検索方法が適切な選択肢である可能性があります。 このエンドポイントでは POI の結果のみが返され、検索クエリ パラメーターは使用されません。 Get Search Nearby API を使用します。https://docs.microsoft.com/rest/api/maps/search/getsearchnearby |
| searchPOI(Aborter, string, Search |
名前で POI を取得する 検索ユース ケースに POI 結果のみが必要な場合は、POI エンドポイントを使用して検索できます。 このエンドポイントは POI 結果のみを返します。 GET Search POI API を使用します。https://docs.microsoft.com/rest/api/maps/search/getsearchpoi |
| search |
カテゴリ別に POI を取得する 検索ユース ケースでカテゴリでフィルター処理された POI 結果のみが必要な場合は、カテゴリ エンドポイントを使用できます。 このエンドポイントは、指定されたカテゴリに分類された POI 結果のみを返します。 利用可能なカテゴリの一覧 については、こちらを参照してください。 GET Search POI Category API を使用します。https://docs.microsoft.com/rest/api/maps/search/getsearchpoicategory |
| search |
Search Polygon API を使用すると、以前に GeoJSON 形式のオンライン Search要求から取得した一連のエンティティについて、市区町村や国のアウトラインなどのジオメトリ データを要求できます。 geometry ID は、Search Address または Search Fuzzy 呼び出しで、dataSources オブジェクトの "geometry" と "id" で返されます。 オンライン Search エンドポイントから取得されたジオメトリ ID の有効期間は限られていることに注意してください。 これらの識別子の安定性は長期間保証されないため、クライアントは、後で紹介するために永続的なストレージにジオメトリ ID を格納しないでください。 Polygon メソッドへの要求は、ID を指定した Online Search メソッドへの要求から数分以内に行われる必要があります。 このサービスでは、最大 20 個の識別子をバッチ要求できます。 Get Search Polygon API を使用します。https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon |
継承されたメソッド
| new |
Credential が指定された新しい Pipeline オブジェクトを作成するために使用される静的メソッド。 |
コンストラクターの詳細
SearchURL(Pipeline, string)
SearchURL のインスタンスを作成します。
new SearchURL(pipeline: Pipeline, mapsUrl?: string)パラメーター
- pipeline
- Pipeline
MapsURL.newPipeline() を呼び出して既定のパイプラインを作成するか、カスタマイズされたパイプラインを提供します。
- mapsUrl
-
string
サービスを指す URL 文字列Azure Maps。既定値は です"https://atlas.microsoft.com"。
プロトコルが指定されていない場合 (例: "atlas.microsoft.com")、と https 見なされます。
継承されたプロパティの詳細
mapsUrl
メソッドの詳細
searchAddress(Aborter, string, SearchAddressOptions)
住所ジオコーディング 多くの場合、従来のジオコーディングにのみ関心がある場合など、完全な検索サービスが多すぎる可能性があります。 Searchは、アドレス検索専用にアクセスすることもできます。 ジオコーディングは、問題の住所または一部の住所のみを含むジオコーディング エンドポイントに到達することによって実行されます。 ジオコーディング検索インデックスは、道路レベルのデータの上にあるすべてのものに対してクエリが実行されます。 POI は返されません。 ジオコーダーは入力ミスと不完全な住所に対して非常に耐性があることに注意してください。 また、正確な通りの住所や通りや交差点だけでなく、市内中心部、郡、州などのより高いレベルの地域からすべてを処理します。Get Search Address API を使用します。https://docs.microsoft.com/rest/api/maps/search/getsearchaddress
function searchAddress(aborter: Aborter, query: string, options?: SearchAddressOptions): Promise<SearchAddressResponse>パラメーター
- aborter
- Aborter
Aborter.none または Aborter.timeout() を使用して新しい Aborter インスタンスを作成します。要求の取り消しに関するその他の例については、Aborter の goto ドキュメントを参照してください。
- query
-
string
検索するアドレス (例: "1 Microsoft way, Redmond, WA")。
- options
- SearchAddressOptions
戻り値
Promise<SearchAddressResponse>
searchAddressReverse(Aborter, GeoJSON.Position, SearchAddressReverseOptions)
住所への逆ジオコーディング 座標 (例: -122.3862、37.786505) を人間が理解できる番地に変換する必要がある場合があります。 多くの場合、これは、デバイスまたはアセットから GPS フィードを受信し、座標が配置されているアドレスを知る必要があるアプリケーションをトラッキングする場合に必要です。 このエンドポイントは、特定の座標のアドレス情報を返します。 Get Search Address Reverse API を使用します。https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreverse
function searchAddressReverse(aborter: Aborter, position: GeoJSON.Position, options?: SearchAddressReverseOptions): Promise<SearchAddressReverseResponse>パラメーター
- aborter
- Aborter
Aborter.none または Aborter.timeout() を使用して新しい Aborter インスタンスを作成します。要求の取り消しに関するその他の例については、Aborter の goto ドキュメントを参照してください。
- position
- GeoJSON.Position
逆検索する位置は、例えば の[longitude, latitude]座標配列である。 [-122.125679, 47.641268]
- options
- SearchAddressReverseOptions
戻り値
Promise<SearchAddressReverseResponse>
searchAddressReverseCrossStreet(Aborter, GeoJSON.Position, SearchAddressReverseCrossStreetOptions)
クロス ストリートへの逆ジオコーディング 座標 (例: -122.3862、37.786505) を人間が理解できるクロス ストリートに変換する必要がある場合があります。 多くの場合、これは、デバイスまたはアセットから GPS フィードを受信し、座標が配置されているアドレスを知る必要があるアプリケーションをトラッキングする場合に必要です。 このエンドポイントは、特定の座標のクロスストリート情報を返します。 Get Search Address Reverse Cross Street API を使用します。https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreversecrossstreet
function searchAddressReverseCrossStreet(aborter: Aborter, position: GeoJSON.Position, options?: SearchAddressReverseCrossStreetOptions): Promise<SearchAddressReverseCrossStreetResponse>パラメーター
- aborter
- Aborter
Aborter.none または Aborter.timeout() を使用して新しい Aborter インスタンスを作成します。要求の取り消しに関するその他の例については、Aborter の goto ドキュメントを参照してください。
- position
- GeoJSON.Position
逆検索する位置は、例えば の[longitude, latitude]座標配列である。 [-122.125679, 47.641268]
戻り値
searchAddressStructured(Aborter, string, SearchAddressStructuredOptions)
構造化住所ジオコーディング Azure 住所ジオコーディングには、構造化された住所の検索専用にアクセスすることもできます。 ジオコーディング検索インデックスは、道路レベルのデータの上にあるすべてのものに対してクエリが実行されます。 POI は返されません。 ジオコーダーは入力ミスと不完全な住所に対して非常に耐性があることに注意してください。 また、正確な通りの住所や通りや交差点だけでなく、市内中心部、郡、州などのより高いレベルの地域からすべてを処理します。Get Search Address Structured API を使用します。https://docs.microsoft.com/rest/api/maps/search/getsearchaddressstructured
function searchAddressStructured(aborter: Aborter, countryCode: string, options?: SearchAddressStructuredOptions): Promise<SearchAddressStructuredResponse>パラメーター
- aborter
- Aborter
Aborter.none または Aborter.timeout() を使用して新しい Aborter インスタンスを作成します。要求の取り消しに関するその他の例については、Aborter の goto ドキュメントを参照してください。
- countryCode
-
string
住所の 2 文字または 3 文字 ISO3166-1 の国コード部分。 例: 米国
- options
- SearchAddressStructuredOptions
戻り値
Promise<SearchAddressStructuredResponse>
searchAlongRoute(Aborter, string, number, SearchAlongRouteRequestBody, SearchAlongRouteOptions)
ルートに沿ったSearch エンドポイントを使用すると、指定したルートに沿って POI のあいまい検索を実行できます。
この検索は、制限メジャーを maxDetourTime 指定することによって制限されます。
ルート ポイントを送信するには、 を使用bodyします。この には型としてGeoJSON LineString表される オブジェクトが含routeまれており、Content-Typeヘッダーは にapplication/json設定されます。
のroute各ルート ポイントは、型 (経度値の後に緯度値が続き、高度の値が無視される配列) としてGeoJSON Position表されます。
には route 、少なくとも 2 つのルート ポイントが含まれている必要があります。
元のルートが変更され、その一部のポイントがスキップされる可能性があります。
見つかったポイントを通過するルートが元のルートよりも高速な場合、 detourTime 応答の値は負になります。
ルート API に沿ってポスト Searchを使用します。https://docs.microsoft.com/rest/api/maps/search/postsearchalongroute
function searchAlongRoute(aborter: Aborter, query: string, maxDetourTime: number, body: SearchAlongRouteRequestBody, options?: SearchAlongRouteOptions): Promise<SearchAlongRouteResponse>パラメーター
- aborter
- Aborter
Aborter.none または Aborter.timeout() を使用して新しい Aborter インスタンスを作成します。要求の取り消しに関するその他の例については、Aborter の goto ドキュメントを参照してください。
- query
-
string
該当するクエリ文字列 (例: "seattle"、"pizza")。
- maxDetourTime
-
number
関心のあるポイントの最大迂回時間 (秒単位)。 最大値は 3600 秒です
これは一緒に検索するルートを表し、有効 GeoJSON LineString な型である必要があります。 詳細については、 RFC 7946 を参照してください。
- options
- SearchAlongRouteOptions
戻り値
Promise<SearchAlongRouteResponse>
searchFuzzy(Aborter, string | GeoJSON.Position, SearchFuzzyOptions)
Free Form Search 基本的な既定の API は Free Form Search であり、アドレスまたは POI トークンの任意の組み合わせを処理する入力の最もあいまいな部分を処理します。
この検索 API は、正規の "単一行検索" です。
Free Form Search API は、POI 検索とジオコーディングのシームレスな組み合わせです。
また、API は、コンテキスト位置 (lat./lon. ペア) で重み付けすることも、座標と半径によって完全に制約することも、geo バイアス アンカー ポイントなしでより一般的に実行することもできます。
"countrySet" パラメーターを使用して、アプリケーションでカバレッジが必要な国のみを指定することを強くお勧めします。既定の動作では、世界中を検索し、不要な結果を返す可能性があります。 例: countrySet=US,FR. サポートされているすべての国の完全な一覧については、[Search カバレッジ] (https://docs.microsoft.com/azure/location-based-services/geocoding-coverage) を参照してください。
ほとんどのSearchクエリの既定値は =2 でmaxFuzzyLevel、パフォーマンスを向上させ、通常とは異なる結果を減らします。
この新しい既定値は、クエリ パラメーター maxFuzzyLevel=3 または 4 を渡すことによって、要求ごとに必要に応じてオーバーライドできます。
Get Search Fuzzy API を使用します。https://docs.microsoft.com/rest/api/maps/search/getsearchfuzzy
function searchFuzzy(aborter: Aborter, query: string | GeoJSON.Position, options?: SearchFuzzyOptions): Promise<SearchFuzzyResponse>パラメーター
- aborter
- Aborter
Aborter.none または Aborter.timeout() を使用して新しい Aborter インスタンスを作成します。要求の取り消しに関するその他の例については、Aborter の goto ドキュメントを参照してください。
- query
-
string | GeoJSON.Position
該当するクエリ文字列 (例: "seattle"、"pizza")。
の座標配列[longitude, latitude]として指定することもできます (例: [-122.125679, 47.641268])。
- options
- SearchFuzzyOptions
戻り値
Promise<SearchFuzzyResponse>
searchInsideGeometry(Aborter, string, SearchInsideGeometryRequestBody, SearchInsideGeometryOptions)
Search Geometry エンドポイントを使用すると、1 つのジオメトリまたはその多くで自由形式の検索を実行できます。
geometry/geometries 内にある検索結果が返されます。
検索する地理フィーチャは、次 GeoJSON のいずれかの種類を使用して表現される Polygon ジオメトリや Circle ジオメトリとしてモデル化できます。 GeoJSON FeatureCollection、 は geometry オブジェクトとして GeoJSON FeatureCollection 表すことができます。
ジオメトリに Polygon と Circle の両方が含まれている場合は、このオプションをお勧めします。
には FeatureCollection 、最大 50 GeoJSON Feature 個のオブジェクトを含めることができます。
各 Feature オブジェクトは、Polygon または Circle を次の条件で表す必要があります。 Feature Polygon ジオメトリのオブジェクトの座標は最大 50 で、プロパティは空である必要があります。
Feature Circle ジオメトリのオブジェクトは、型と半径値 (メートル単位) を使用してGeoJSON Point表される中心で構成されます。この値は、オブジェクトのプロパティで指定する必要があり、その値は 'Circle' である subType プロパティと共に指定する必要があります。
サンプル FeatureCollection 表現については、以下の「例」セクションを参照してください。
GeoJSON GeometryCollection、 は geometry オブジェクトとして GeoJSON GeometryCollection 表すことができます。
ジオメトリに Polygons のみのリストが含まれている場合は、このオプションをお勧めします。
には GeometryCollection 、最大 50 GeoJSON Polygon 個のオブジェクトを含めることができます。
各 Polygon オブジェクトは、最大 50 個の座標を持つことができます。
サンプル GeometryCollection 表現については、以下の「例」セクションを参照してください。
GeoJSON Polygon, The geometry can be represented as a GeoJSON Polygon object.
ジオメトリに 1 つの Polygon が含まれている場合は、このオプションをお勧めします。
オブジェクトには Polygon 、最大 50 個の座標を指定できます。
Geometry 内のポスト Search API を使用します。https://docs.microsoft.com/rest/api/maps/search/postsearchinsidegeometry
function searchInsideGeometry(aborter: Aborter, query: string, body: SearchInsideGeometryRequestBody, options?: SearchInsideGeometryOptions): Promise<SearchInsideGeometryResponse>パラメーター
- aborter
- Aborter
Aborter.none または Aborter.timeout() を使用して新しい Aborter インスタンスを作成します。要求の取り消しに関するその他の例については、Aborter の goto ドキュメントを参照してください。
- query
-
string
該当するクエリ文字列 (例: "seattle"、"pizza")。
これは、検索する 1 つ以上の地理的特徴 (公園、州の境界など) のジオメトリを表し、GeoJSON 準拠の型である必要があります。 詳細については、 RFC 7946 を参照してください。
- options
- SearchInsideGeometryOptions
戻り値
Promise<SearchInsideGeometryResponse>
searchNearby(Aborter, GeoJSON.Position, SearchNearbyOptions)
近くのSearch 特定の場所に関する POI 結果のみを取得するユース ケースがある場合は、近くの検索方法が適切な選択肢である可能性があります。 このエンドポイントでは POI の結果のみが返され、検索クエリ パラメーターは使用されません。 Get Search Nearby API を使用します。https://docs.microsoft.com/rest/api/maps/search/getsearchnearby
function searchNearby(aborter: Aborter, location: GeoJSON.Position, options?: SearchNearbyOptions): Promise<SearchNearbyResponse>パラメーター
- aborter
- Aborter
Aborter.none または Aborter.timeout() を使用して新しい Aborter インスタンスを作成します。要求の取り消しに関するその他の例については、Aborter の goto ドキュメントを参照してください。
- location
- GeoJSON.Position
結果に偏りがある場所。
の配列 [longitude, latitude]である必要があります (例: [-121.89, 37.337])。
- options
- SearchNearbyOptions
戻り値
Promise<SearchNearbyResponse>
searchPOI(Aborter, string, SearchPOIOptions)
名前で POI を取得する 検索ユース ケースに POI 結果のみが必要な場合は、POI エンドポイントを使用して検索できます。 このエンドポイントは POI 結果のみを返します。 GET Search POI API を使用します。https://docs.microsoft.com/rest/api/maps/search/getsearchpoi
function searchPOI(aborter: Aborter, query: string, options?: SearchPOIOptions): Promise<SearchPOIResponse>パラメーター
- aborter
- Aborter
Aborter.none または Aborter.timeout() を使用して新しい Aborter インスタンスを作成します。要求の取り消しに関するその他の例については、Aborter の goto ドキュメントを参照してください。
- query
-
string
検索する POI 名 (例: "自由の女神"、"starbucks")。
- options
- SearchPOIOptions
戻り値
Promise<SearchPOIResponse>
searchPOICategory(Aborter, string, SearchPOICategoryOptions)
カテゴリ別に POI を取得する 検索ユース ケースでカテゴリでフィルター処理された POI 結果のみが必要な場合は、カテゴリ エンドポイントを使用できます。 このエンドポイントは、指定されたカテゴリに分類された POI 結果のみを返します。 利用可能なカテゴリの一覧 については、こちらを参照してください。 GET Search POI Category API を使用します。https://docs.microsoft.com/rest/api/maps/search/getsearchpoicategory
function searchPOICategory(aborter: Aborter, query: string, options?: SearchPOICategoryOptions): Promise<SearchPOICategoryResponse>パラメーター
- aborter
- Aborter
Aborter.none または Aborter.timeout() を使用して新しい Aborter インスタンスを作成します。要求の取り消しに関するその他の例については、Aborter の goto ドキュメントを参照してください。
- query
-
string
検索する POI カテゴリ (例: "AIRPORT"、"BEACH")。
- options
- SearchPOICategoryOptions
戻り値
Promise<SearchPOICategoryResponse>
searchPolygon(Aborter, string[])
Search Polygon API を使用すると、以前に GeoJSON 形式のオンライン Search要求から取得した一連のエンティティについて、市区町村や国のアウトラインなどのジオメトリ データを要求できます。 geometry ID は、Search Address または Search Fuzzy 呼び出しで、dataSources オブジェクトの "geometry" と "id" で返されます。 オンライン Search エンドポイントから取得されたジオメトリ ID の有効期間は限られていることに注意してください。 これらの識別子の安定性は長期間保証されないため、クライアントは、後で紹介するために永続的なストレージにジオメトリ ID を格納しないでください。 Polygon メソッドへの要求は、ID を指定した Online Search メソッドへの要求から数分以内に行われる必要があります。 このサービスでは、最大 20 個の識別子をバッチ要求できます。
Get Search Polygon API を使用します。https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon
function searchPolygon(aborter: Aborter, geometries: string[]): Promise<SearchPolygonResponse>パラメーター
- aborter
- Aborter
Aborter.none または Aborter.timeout() を使用して新しい Aborter インスタンスを作成します。要求の取り消しに関するその他の例については、Aborter の goto ドキュメントを参照してください。
- geometries
-
string[]
以前にオンライン Search要求から取得した geometry UUID のコンマ区切りリスト。
戻り値
Promise<SearchPolygonResponse>
継承済みメソッドの詳細
newPipeline(Credential, INewPipelineOptions)
Credential が指定された新しい Pipeline オブジェクトを作成するために使用される静的メソッド。
static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions): Pipelineパラメーター
- credential
- Credential
SubscriptionKeyCredential、TokenCredential、MapControlCredential など。
- pipelineOptions
- INewPipelineOptions
戻り値
新しい Pipeline オブジェクト。