@azure-rest/maps-search package
インターフェイス
| AddressAdminDistrictsItemOutput | |
| AddressCountryRegionOutput | |
| AddressOutput |
結果のアドレス |
| BoundaryOutput |
このサービスは通常、Polygon または MultiPolygon サブタイプを持つ GeometryCollection を返します。 |
| BoundaryPropertiesOutput |
Boundary オブジェクトのプロパティ。 |
| ErrorAdditionalInfoOutput |
リソース管理エラーの追加情報。 |
| ErrorDetailOutput |
エラーの詳細。 |
| ErrorResponseOutput |
失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。 |
| FeaturesItemOutput | |
| FeaturesItemPropertiesOutput | |
| GeoJsonFeatureCollectionDataOutput | |
| GeoJsonFeatureCollectionOutput |
有効な |
| GeoJsonFeatureDataOutput | |
| GeoJsonFeatureOutputParent |
有効な |
| GeoJsonGeometryCollectionDataOutput | |
| GeoJsonGeometryCollectionOutput |
有効な |
| GeoJsonGeometryOutputParent |
有効な |
| GeoJsonLineStringDataOutput | |
| GeoJsonLineStringOutput |
有効な |
| GeoJsonMultiLineStringDataOutput | |
| GeoJsonMultiLineStringOutput |
有効な |
| GeoJsonMultiPointDataOutput |
|
| GeoJsonMultiPointOutput |
有効な |
| GeoJsonMultiPolygonDataOutput | |
| GeoJsonMultiPolygonOutput |
有効な |
| GeoJsonObjectOutputParent |
有効な |
| GeoJsonPointDataOutput |
|
| GeoJsonPointOutput |
有効な |
| GeoJsonPolygonDataOutput | |
| GeoJsonPolygonOutput |
有効な |
| GeocodePointsItemOutput | |
| GeocodingBatchRequestBody |
処理する住所ジオコーディング クエリ/要求の一覧。 リストには最大 100 個のクエリを含めることができます。少なくとも 1 つのクエリを含む必要があります。 |
| GeocodingBatchRequestItem |
Batch Query オブジェクト |
| GeocodingBatchResponseItemOutput | |
| GeocodingBatchResponseOutput |
このオブジェクトは、成功したジオコーディング バッチ サービス呼び出しから返されます。 |
| GeocodingBatchResponseSummaryOutput |
バッチ要求の概要 |
| GeocodingResponseOutput |
このオブジェクトは、ジオコーディング呼び出しが成功した場合に返されます |
| GeometryCopyrightOutput |
Boundary オブジェクトのジオメトリの著作権情報。 |
| GetGeocoding | |
| GetGeocodingBatch | |
| GetPolygon | |
| GetReverseGeocoding | |
| GetReverseGeocodingBatch | |
| IntersectionOutput |
結果のアドレス。 |
| ReverseGeocodingBatchRequestBody |
処理する逆ジオコーディング クエリ/要求の一覧。 リストには最大 100 個のクエリを含めることができます。少なくとも 1 つのクエリを含む必要があります。 |
| ReverseGeocodingBatchRequestItem |
Batch Query オブジェクト |
| Routes | |
| SearchGetGeocoding200Headers | |
| SearchGetGeocoding200Response |
ジオコーディング 多くの場合、従来のジオコーディングのみに関心がある場合など、完全な検索サービスが多すぎる可能性があります。 検索には、アドレス検索専用にアクセスすることもできます。 ジオコーディングは、問題の住所または住所の一部のみを使用してジオコーディング エンドポイントにヒットすることによって実行されます。 ジオコーディング検索インデックスは、道路レベルのデータより上のすべてのデータに対してクエリを実行します。 ポイント オブ インタレスト (POI) は返されません。 ジオコーダーは入力ミスと不完全な住所に対して非常に耐性があることに注意してください。 また、市区町村、郡、州などのより高いレベルの地域だけでなく、正確な番地や通りや交差点からすべてを処理します。 |
| SearchGetGeocodingBatch200Response |
バッチ API のジオコーディングの に適用: 価格 レベルを参照してください。 ジオコーディング バッチ API は、単一の API 呼び出しを使用して、ジオコーディング API にクエリのバッチを送信します。 この API を使用すると、呼び出し元は最大 100 クエリをバッチ処理できます。 同期バッチ要求の送信軽量バッチ要求には、同期 API をお勧めします。 サービスが要求を受け取ると、バッチ項目が計算されるとすぐに応答し、後で結果を取得することはできません。 要求に 60 秒を超える時間がかかる場合、同期 API はタイムアウト エラー (408 応答) を返します。 バッチ項目の数は、この API の 100 に制限されています。 バッチ要求の POST 本文
ジオコーディング クエリを送信するには、要求本文に batchItem オブジェクト バッチには、少なくとも 1 つの クエリ バッチ応答モデルバッチ応答には、元のバッチ要求の一部であった
|
| SearchGetGeocodingBatchBodyParam | |
| SearchGetGeocodingBatchDefaultResponse |
バッチ API のジオコーディングの に適用: 価格 レベルを参照してください。 ジオコーディング バッチ API は、単一の API 呼び出しを使用して、ジオコーディング API にクエリのバッチを送信します。 この API を使用すると、呼び出し元は最大 100 クエリをバッチ処理できます。 同期バッチ要求の送信軽量バッチ要求には、同期 API をお勧めします。 サービスが要求を受け取ると、バッチ項目が計算されるとすぐに応答し、後で結果を取得することはできません。 要求に 60 秒を超える時間がかかる場合、同期 API はタイムアウト エラー (408 応答) を返します。 バッチ項目の数は、この API の 100 に制限されています。 バッチ要求の POST 本文
ジオコーディング クエリを送信するには、要求本文に batchItem オブジェクト バッチには、少なくとも 1 つの クエリ バッチ応答モデルバッチ応答には、元のバッチ要求の一部であった
|
| SearchGetGeocodingBatchMediaTypesParam | |
| SearchGetGeocodingDefaultResponse |
ジオコーディング 多くの場合、従来のジオコーディングのみに関心がある場合など、完全な検索サービスが多すぎる可能性があります。 検索には、アドレス検索専用にアクセスすることもできます。 ジオコーディングは、問題の住所または住所の一部のみを使用してジオコーディング エンドポイントにヒットすることによって実行されます。 ジオコーディング検索インデックスは、道路レベルのデータより上のすべてのデータに対してクエリを実行します。 ポイント オブ インタレスト (POI) は返されません。 ジオコーダーは入力ミスと不完全な住所に対して非常に耐性があることに注意してください。 また、市区町村、郡、州などのより高いレベルの地域だけでなく、正確な番地や通りや交差点からすべてを処理します。 |
| SearchGetGeocodingQueryParam | |
| SearchGetGeocodingQueryParamProperties | |
| SearchGetPolygon200Response |
多角形の を取得する 市区町村や国の地域などの地理的領域のアウトラインの多角形データを提供します。 |
| SearchGetPolygonDefaultResponse |
多角形の を取得する 市区町村や国の地域などの地理的領域のアウトラインの多角形データを提供します。 |
| SearchGetPolygonQueryParam | |
| SearchGetPolygonQueryParamProperties | |
| SearchGetReverseGeocoding200Response |
逆ジオコーディング の 座標 (例: 37.786505、-122.3862) を人間が理解できる番地に変換します。 ほとんどの場合、これは、デバイスまたは資産から GPS フィードを受信し、座標が配置されているアドレスを知りたいアプリケーションを追跡するために必要です。 このエンドポイントは、特定の座標のアドレス情報を返します。 |
| SearchGetReverseGeocodingBatch200Response |
バッチ API の逆ジオコーディングの に適用: 価格 レベルを参照してください。 逆ジオコーディング バッチ API は、1 つの API 呼び出しのみを使用して、逆ジオコーディング API 同期バッチ要求の送信軽量バッチ要求には、同期 API をお勧めします。 サービスが要求を受け取ると、バッチ項目が計算されるとすぐに応答し、後で結果を取得することはできません。 要求に 60 秒を超える時間がかかる場合、同期 API はタイムアウト エラー (408 応答) を返します。 バッチ項目の数は、この API の 100 に制限されています。 バッチ要求の POST 本文
逆ジオコーディング クエリを送信するには、 batchItem オブジェクト バッチには、少なくとも 1 つの クエリ バッチ応答モデルバッチ応答には、元のバッチ要求の一部であった
|
| SearchGetReverseGeocodingBatchBodyParam | |
| SearchGetReverseGeocodingBatchDefaultResponse |
バッチ API の逆ジオコーディングの に適用: 価格 レベルを参照してください。 逆ジオコーディング バッチ API は、1 つの API 呼び出しのみを使用して、逆ジオコーディング API 同期バッチ要求の送信軽量バッチ要求には、同期 API をお勧めします。 サービスが要求を受け取ると、バッチ項目が計算されるとすぐに応答し、後で結果を取得することはできません。 要求に 60 秒を超える時間がかかる場合、同期 API はタイムアウト エラー (408 応答) を返します。 バッチ項目の数は、この API の 100 に制限されています。 バッチ要求の POST 本文
逆ジオコーディング クエリを送信するには、 batchItem オブジェクト バッチには、少なくとも 1 つの クエリ バッチ応答モデルバッチ応答には、元のバッチ要求の一部であった
|
| SearchGetReverseGeocodingBatchMediaTypesParam | |
| SearchGetReverseGeocodingDefaultResponse |
逆ジオコーディング の 座標 (例: 37.786505、-122.3862) を人間が理解できる番地に変換します。 ほとんどの場合、これは、デバイスまたは資産から GPS フィードを受信し、座標が配置されているアドレスを知りたいアプリケーションを追跡するために必要です。 このエンドポイントは、特定の座標のアドレス情報を返します。 |
| SearchGetReverseGeocodingQueryParam | |
| SearchGetReverseGeocodingQueryParamProperties | |
型エイリアス
| GeoJsonFeatureOutput |
有効な |
| GeoJsonGeometryOutput |
有効な |
| GeoJsonObjectOutput |
有効な |
| MapsSearchClient | |
| SearchGetGeocodingBatchParameters | |
| SearchGetGeocodingParameters | |
| SearchGetPolygonParameters | |
| SearchGetReverseGeocodingBatchParameters | |
| SearchGetReverseGeocodingParameters | |
関数
| default(Azure |
サブスクリプション キーから MapsSearchClient のインスタンスを作成します。 例 |
| default(Token |
Azure Identity 例 |
| default(Azure |
Azure Identity 例 |
| is |
|
| is |
|
| is |
|
| is |
|
| is |
関数の詳細
default(AzureKeyCredential, ClientOptions)
サブスクリプション キーから MapsSearchClient のインスタンスを作成します。
例
import MapsSearch from "@azure-rest/maps-search";
import { AzureKeyCredential } from "@azure/core-auth";
const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsSearch(credential);
function default(credential: AzureKeyCredential, options?: ClientOptions): MapsSearchClientパラメーター
- credential
- AzureKeyCredential
サービスへの要求を認証するために使用される AzureKeyCredential インスタンス
- options
- ClientOptions
検索クライアントの構成に使用するオプション
戻り値
default(TokenCredential, string, ClientOptions)
Azure Identity TokenCredentialから MapsSearch のインスタンスを作成します。
例
import MapsSearch from "@azure-rest/maps-search";
import { DefaultAzureCredential } from "@azure/identity";
const credential = new DefaultAzureCredential();
const client = MapsSearch(credential, "<maps-account-client-id>");
function default(credential: TokenCredential, mapsAccountClientId: string, options?: ClientOptions): MapsSearchClientパラメーター
- credential
- TokenCredential
サービスへの要求を認証するために使用される TokenCredential インスタンス
- mapsAccountClientId
-
string
特定のマップ リソースの Azure Maps クライアント ID
- options
- ClientOptions
検索クライアントの構成に使用するオプション
戻り値
default(AzureSASCredential, ClientOptions)
Azure Identity AzureSASCredentialから MapsSearch のインスタンスを作成します。
例
import MapsSearch from "@azure-rest/maps-search";
import { AzureSASCredential } from "@azure/core-auth";
const credential = new AzureSASCredential("<SAS Token>");
const client = MapsSearch(credential);
function default(credential: AzureSASCredential, options?: ClientOptions): MapsSearchClientパラメーター
- credential
- AzureSASCredential
サービスへの要求を認証するために使用される AzureSASCredential インスタンス
- options
- ClientOptions
検索クライアントの構成に使用するオプション
戻り値
isUnexpected(SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse)
function isUnexpected(response: SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse): responseパラメーター
戻り値
response
isUnexpected(SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse)
function isUnexpected(response: SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse): responseパラメーター
戻り値
response
isUnexpected(SearchGetPolygon200Response | SearchGetPolygonDefaultResponse)
function isUnexpected(response: SearchGetPolygon200Response | SearchGetPolygonDefaultResponse): responseパラメーター
戻り値
response
isUnexpected(SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse)
function isUnexpected(response: SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse): responseパラメーター
戻り値
response
isUnexpected(SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse)
function isUnexpected(response: SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse): responseパラメーター
戻り値
response
Azure SDK for JavaScript