Search - Post Search Inside Geometry
もう 1 つのジオメトリ内で自由形式の検索を実行するために使用します。
Post Search Inside Geometry
API と HTTP POST request that allows you to perform a free form search inside a single geometry or multiple geometries. The search results that fall inside the geometry/geometries will be returned.<br><br>To send the geometry you will use a
POSTrequest where the request body will contain the
geometryobject represented as a
GeoJSONtype and the
Content-Typeheader will be set to
application/json. The geographical features to be searched can be modeled as Polygon and/or Circle geometries represented using any one of the following
geoJSONtypes:<ul><li>**GeoJSON FeatureCollection** <br>The
geometrycan be represented as a
GeoJSON FeatureCollectionobject. This is the recommended option if the geometry contains both Polygons and Circles. The
FeatureCollectioncan contain a max of 50
GeoJSON Featureobjects. Each
Featureobject should represent either a Polygon or a Circle with the following conditions:<ul style="list-style-type:none"><li>A
Featureobject for the Polygon geometry can have a max of 50 coordinates and it's properties must be empty.</li><li>A
object should represent either a Polygon or a Circle with the following conditions:<ul style="list-style-type:none"><li>A
地物object for the Circle geometry is composed of a _center_ represented using a
GeoJSON ポイントtype and a _radius_ value (in meters) which must be specified in the object's properties along with the _subType_ property whose value should be 'Circle'.</li></ul><br> Please see the Examples section below for a sample
FeatureCollectionrepresentation.<br><br></li><li>**GeoJSON GeometryCollection**<br>The
geometrycan be represented as a
geometryobject. This is the recommended option if the geometry contains a list of Polygons only. The
GeometryCollectioncan contain a max of 50
GeoJSON Polygonobjects. Each
Polygonobject can have a max of 50 coordinates. Please see the Examples section below for a sample
GeometryCollectionrepresentation.<br><br></li><li>**GeoJSON Polygon**<br>The
geometrycan be represented as a
geoJSON Polygonobject. This is the recommended option if the geometry contains a single Polygon. The
Polygonobject can have a max of 50 coordinates. Please see the Examples section below for a sample
Polygon' リプレゼンテーション。
.
POST https://atlas.microsoft.com/search/geometry/{format}?api-version=1.0&query={query}
POST https://atlas.microsoft.com/search/geometry/{format}?api-version=1.0&query={query}&limit={limit}&language={language}&categorySet={categorySet}&extendedPostalCodesFor={extendedPostalCodesFor}&idxSet={idxSet}&view={view}&openingHours=nextSevenDays
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
format
|
path | True |
応答の目的の形式。 値は、json することも、xml することもできます。 |
|
api-version
|
query | True |
string |
Azure Maps API のバージョン番号。 |
query
|
query | True |
string |
検索する POI 名 (例: "自由の女神"、"starbucks"、"pizza")。 URL が正しくエンコードされている必要があります。 |
category
|
query |
integer[] |
結果を特定の目的地カテゴリに制限するために使用できるカテゴリ セット ID のコンマ区切りのリスト。 ID の順序は関係ありません。 要求ごとにサポートされる
|
|
extended
|
query |
結果に拡張郵便番号を含める必要があるインデックス。 使用可能なインデックスは次のとおりです。 Addr = アドレス範囲 geo = Geographies PAD = ポイント アドレス POI = 目的地 Str = 道路 XStr = クロス ストリート (交差点) 値は、インデックスの種類のコンマ区切りのリスト (任意の順序) またはインデックスがない場合は [なし] する必要があります。 既定では、Geo を除くすべてのインデックスに拡張郵便番号が含まれます。 地域の拡張郵便番号リストは非常に長い場合があるため、必要に応じて明示的に要求する必要があります。 使用例: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None 拡張郵便番号は、住所の extendedPostalCode プロパティとして返されます。 可用性はリージョンに依存します。 |
||
idx
|
query |
検索に使用するインデックスのコンマ区切りリスト。 品目の順序は関係ありません。 使用可能なインデックス: Addr = 住所範囲補間、Geo = Geographies、PAD = Point Addresses、POI = 目的地、Str = 道路、Xstr = クロス ストリート (交差点) |
||
language
|
query |
string |
検索結果を返す言語。 サポートされている IETF 言語タグの 1 つである必要があります。大文字と小文字は区別されません。 指定した言語のデータが特定のフィールドで使用できない場合は、既定の言語が使用されます。 詳細については、サポートされている言語の を参照してください。 |
|
limit
|
query |
integer minimum: 1maximum: 100 |
返される応答の最大数。 既定値: 10、最小: 1、最大: 100 |
|
opening
|
query |
POI の操作時間 (目的地)。 操作時間の可用性は、使用可能なデータによって異なります。 合格しなかった場合、営業時間情報は返されません。 サポートされる値: nextSevenDays |
||
view
|
query |
View パラメーター ("ユーザーリージョン" パラメーターとも呼ばれます) を使用すると、地政学的に紛争が生じしている地域の特定の国/地域の正しいマップを表示できます。 このようなリージョンのビューは国や地域によって異なります。また、View パラメーターを使用すると、アプリケーションがサービスを提供する国/地域で必要なビューにアプリケーションを準拠できます。 既定では、要求で定義していない場合でも、View パラメーターは "Unified" に設定されます。 ユーザーの場所を特定し、その場所に対して View パラメーターを正しく設定するのは、ユーザーの責任です。 または、要求の IP アドレスに基づいてマップ データを返す 'View=Auto' を設定することもできます。 Azure Maps の View パラメーターは、マップ、画像、その他のデータ、および Azure Maps 経由でアクセスする権限を持つ第三者のコンテンツが利用できる国/地域のマッピングに関する法律を含む、適用される法律に従って使用する必要があります。 例: view=IN。 詳細については、サポートされているビューの を参照し、使用可能なビューを参照してください。 |
要求ヘッダー
名前 | 必須 | 型 | 説明 |
---|---|---|---|
x-ms-client-id |
string |
Microsoft Entra ID セキュリティ モデルと組み合わせて使用するアカウントを指定します。 これは Azure Maps アカウントの一意の ID を表し、Azure Maps 管理プレーン アカウント API から取得できます。 Azure Maps で Microsoft Entra ID セキュリティを使用するには、ガイダンス 次の |
要求本文
名前 | 型 | 説明 |
---|---|---|
geometry | GeoJsonObject: |
有効な |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
わかりました |
|
Other Status Codes |
予期しないエラーが発生しました。 |
セキュリティ
AADToken
これらは、Microsoft Entra OAuth 2.0 フロー
シナリオを実装するには、認証の概念表示することをお勧めします。 要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを介してアプリケーションをモデル化するためのソリューションを提供します。
注
- このセキュリティ定義 使用して、アプリケーションがアクセスを要求している Azure Maps リソースを示す必要があります。 これは、Maps 管理 API から取得できます。
-
Authorization URL
は、Azure パブリック クラウド インスタンスに固有です。 ソブリン クラウドには、一意の承認 URL と Microsoft Entra ID 構成があります。 - Azure ロールベースのアクセス制御は、Azure portal、PowerShell、CLI、Azure SDK、または REST API を使用して
Azure 管理プレーンから構成されます。 - Azure Maps Web SDK を使用すると、複数のユース ケースに対するアプリケーションの構成ベースのセットアップが可能になります。
- Microsoft ID プラットフォームの詳細については、「Microsoft ID プラットフォームの概要」を参照してください。
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
これは、Azure portal で、または PowerShell、CLI、Azure SDK、または REST API を使用して Azure Maps アカウント を作成 場合にプロビジョニングされる共有キーです。
このキーを使用すると、すべてのアプリケーションがすべての REST API にアクセスできます。 つまり、このキーは、発行されたアカウントのマスター キーとして使用できます。
パブリックに公開されているアプリケーションの場合は、キーを安全に格納できるように、機密クライアント アプリケーション アプローチを使用して Azure Maps REST API にアクセスすることをお勧めします。
型:
apiKey
/:
query
SAS Token
これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンを介して、Azure Maps リソース のリスト SAS 操作から作成される Shared Access Signature トークンです。
このトークンを使用すると、すべてのアプリケーションは、Azure ロールベースのアクセス制御と、特定のトークンに対する使用の有効期限、レート、およびリージョンに対するきめ細かな制御を使用してアクセスすることが承認されます。 つまり、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できるようにします。
パブリックに公開されているアプリケーションの場合は、Map アカウント リソースの許可された配信元の特定の一覧を構成し、レンダリングの不正使用を制限し、SAS トークンを定期的に更新するように することをお勧めします。
型:
apiKey
/:
header
例
Search for burger joints inside a geometry represented as a GeoJSON GeometryCollection type
要求のサンプル
POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=burger&limit=2&openingHours=nextSevenDays
{
"geometry": {
"type": "GeometryCollection",
"geometries": [
{
"type": "Polygon",
"coordinates": [
[
[
-122.43576049804686,
37.7524152343544
],
[
-122.43301391601562,
37.70660472542312
],
[
-122.36434936523438,
37.712059855877314
],
[
-122.43576049804686,
37.7524152343544
]
]
]
},
{
"type": "Polygon",
"coordinates": [
[
[
-123.43576049804686,
37.7524152343544
],
[
-123.43301391601562,
37.70660472542312
],
[
-123.36434936523438,
37.712059855877314
],
[
-123.43576049804686,
37.7524152343544
]
]
]
}
]
}
}
応答のサンプル
{
"summary": {
"query": "burger",
"queryType": "NON_NEAR",
"queryTime": 21,
"numResults": 2,
"offset": 0,
"totalResults": 4,
"fuzzyLevel": 1
},
"results": [
{
"type": "POI",
"id": "9P2i9inRyndAA-_V40J8oA",
"score": 2.0041828156,
"info": "search:ta:840061003419653-US",
"poi": {
"name": "Burger Joint",
"phone": "+1 415-349-4331",
"categorySet": [
{
"id": 7315015
}
],
"categories": [
"fast food",
"restaurant"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "restaurant"
},
{
"nameLocale": "en-US",
"name": "fast food"
}
]
}
]
},
"address": {
"streetNumber": "167",
"streetName": "Leland Avenue",
"municipality": "San Francisco",
"neighbourhood": "Visitacion Valley",
"countrySecondarySubdivision": "San Francisco",
"countrySubdivisionName": "California",
"countrySubdivisionCode": "CA",
"postalCode": "94134",
"extendedPostalCode": "94134-2844",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "167 Leland Avenue, San Francisco, CA 94134",
"localName": "San Francisco"
},
"position": {
"lat": 37.712228,
"lon": -122.407022
},
"viewport": {
"topLeftPoint": {
"lat": 37.71313,
"lon": -122.40816
},
"btmRightPoint": {
"lat": 37.71133,
"lon": -122.40589
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 37.71241,
"lon": -122.40693
}
}
]
},
{
"type": "POI",
"id": "hkr-N07YS6Gv2dOciQ9lwA",
"score": 2.0041515827,
"info": "search:ta:840067000526682-US",
"poi": {
"name": "Sound of Burgers",
"categorySet": [
{
"id": 7315
}
],
"categories": [
"restaurant"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "167",
"streetName": "Leland Avenue",
"municipality": "San Francisco",
"neighbourhood": "Visitacion Valley",
"countrySecondarySubdivision": "San Francisco",
"countrySubdivision": "CA",
"countrySubdivisionName": "California",
"countrySubdivisionCode": "CA",
"postalCode": "94134",
"extendedPostalCode": "94134-2844",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "167 Leland Avenue, San Francisco, CA 94134",
"localName": "San Francisco"
},
"position": {
"lat": 37.712228,
"lon": -122.407022
},
"viewport": {
"topLeftPoint": {
"lat": 37.71313,
"lon": -122.40816
},
"btmRightPoint": {
"lat": 37.71133,
"lon": -122.40589
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 37.71241,
"lon": -122.40693
}
}
]
}
]
}
Search for pizza places inside a geometry represented as a GeoJSON FeatureCollection type
要求のサンプル
POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=pizza&limit=2&openingHours=nextSevenDays
{
"geometry": {
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-122.143035,
47.653536
],
[
-122.187164,
47.617556
],
[
-122.114981,
47.570599
],
[
-122.132756,
47.654009
],
[
-122.143035,
47.653536
]
]
]
},
"properties": {}
},
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-122.126986,
47.639754
]
},
"properties": {
"subType": "Circle",
"radius": 100
}
}
]
}
}
応答のサンプル
{
"summary": {
"query": "pizza",
"queryType": "NON_NEAR",
"queryTime": 34,
"numResults": 2,
"offset": 0,
"totalResults": 21,
"fuzzyLevel": 1
},
"results": [
{
"type": "POI",
"id": "-UuwTye4GGsea4KmCLvoqQ",
"score": 2.1455535889,
"info": "search:ta:840537000108972-US",
"poi": {
"name": "Biryani & Pizza House",
"categorySet": [
{
"id": 7315036
}
],
"categories": [
"pizza",
"restaurant"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "restaurant"
},
{
"nameLocale": "en-US",
"name": "pizza"
}
]
}
]
},
"address": {
"streetNumber": "15025",
"streetName": "Northeast 24th Street",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countrySubdivision": "WA",
"countrySubdivisionName": "Washington",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "98052-5531",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15025 Northeast 24th Street, Redmond, WA 98052",
"localName": "Redmond"
},
"position": {
"lat": 47.630786,
"lon": -122.139302
},
"viewport": {
"topLeftPoint": {
"lat": 47.63169,
"lon": -122.14064
},
"btmRightPoint": {
"lat": 47.62989,
"lon": -122.13797
}
},
"entryPoints": [
{
"type": "minor",
"position": {
"lat": 47.63079,
"lon": -122.13931
}
},
{
"type": "main",
"position": {
"lat": 47.63147,
"lon": -122.13935
}
}
]
},
{
"type": "POI",
"id": "7r095LCcCSkdoGoeLcnvsQ",
"score": 2.1454992294,
"info": "search:ta:840537000103468-US",
"poi": {
"name": "Pagliacci Pizza",
"categorySet": [
{
"id": 7315036
}
],
"url": "www.pagliacci.com/",
"categories": [
"pizza",
"restaurant"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "restaurant"
},
{
"nameLocale": "en-US",
"name": "pizza"
}
]
}
],
"openingHours": {
"mode": "nextSevenDays",
"timeRanges": [
{
"startTime": {
"date": "2024-03-14",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-14",
"hour": 11,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-17",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-17",
"hour": 11,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-18",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-18",
"hour": 11,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-19",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-19",
"hour": 11,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-20",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-20",
"hour": 11,
"minute": 0
}
}
]
}
},
"address": {
"streetNumber": "15238",
"streetName": "Bel Red Road",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countrySubdivision": "WA",
"countrySubdivisionName": "Washington",
"countrySubdivisionCode": "WA",
"postalCode": "98007",
"extendedPostalCode": "98007-3815",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15238 Bel Red Road, Bellevue, WA 98007",
"localName": "Bellevue"
},
"position": {
"lat": 47.628008,
"lon": -122.13646
},
"viewport": {
"topLeftPoint": {
"lat": 47.62891,
"lon": -122.13779
},
"btmRightPoint": {
"lat": 47.62711,
"lon": -122.13513
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.6283,
"lon": -122.13611
}
}
]
}
]
}
Search for subs joints inside a geometry represented as a GeoJSON Polygon type
要求のサンプル
POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=subs&limit=2&openingHours=nextSevenDays
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-122.43576049804686,
37.7524152343544
],
[
-122.43301391601562,
37.70660472542312
],
[
-122.36434936523438,
37.712059855877314
],
[
-122.43576049804686,
37.7524152343544
]
]
]
}
}
応答のサンプル
{
"summary": {
"query": "subs",
"queryType": "NON_NEAR",
"queryTime": 42,
"numResults": 2,
"offset": 0,
"totalResults": 5,
"fuzzyLevel": 1
},
"results": [
{
"type": "POI",
"id": "HOIWGiNwVv0z6bF8MO3EbA",
"score": 2.1455111504,
"info": "search:ta:840069009512242-US",
"poi": {
"name": "Adams Grub Truck",
"phone": "+1 415-307-8844",
"categorySet": [
{
"id": 7315042
}
],
"categories": [
"restaurant",
"sandwich"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "sandwich"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "1465",
"streetName": "Carroll Avenue",
"municipality": "San Francisco",
"neighbourhood": "Bayview",
"countrySecondarySubdivision": "San Francisco",
"countrySubdivisionName": "California",
"countrySubdivisionCode": "CA",
"postalCode": "94124",
"extendedPostalCode": "94124-3604",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1465 Carroll Avenue, San Francisco, CA 94124",
"localName": "San Francisco"
},
"position": {
"lat": 37.72328,
"lon": -122.39091
},
"viewport": {
"topLeftPoint": {
"lat": 37.72418,
"lon": -122.39205
},
"btmRightPoint": {
"lat": 37.72238,
"lon": -122.38977
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 37.72348,
"lon": -122.39073
}
}
]
},
{
"type": "POI",
"id": "bXbc0QxTRlkSo8GnU7EU-Q",
"score": 2.1454677582,
"info": "search:ta:840061001992959-US",
"poi": {
"name": "SUBWAY San Francisco San Francisco",
"phone": "+1 415-657-9898",
"brands": [
{
"name": "SUBWAY"
}
],
"categorySet": [
{
"id": 7315042
}
],
"categories": [
"restaurant",
"sandwich"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "sandwich"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
],
"openingHours": {
"mode": "nextSevenDays",
"timeRanges": [
{
"startTime": {
"date": "2024-03-13",
"hour": 7,
"minute": 0
},
"endTime": {
"date": "2024-03-13",
"hour": 21,
"minute": 30
}
},
{
"startTime": {
"date": "2024-03-14",
"hour": 7,
"minute": 0
},
"endTime": {
"date": "2024-03-14",
"hour": 21,
"minute": 30
}
},
{
"startTime": {
"date": "2024-03-15",
"hour": 7,
"minute": 0
},
"endTime": {
"date": "2024-03-15",
"hour": 21,
"minute": 30
}
},
{
"startTime": {
"date": "2024-03-16",
"hour": 9,
"minute": 0
},
"endTime": {
"date": "2024-03-16",
"hour": 21,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-17",
"hour": 9,
"minute": 0
},
"endTime": {
"date": "2024-03-17",
"hour": 21,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-18",
"hour": 8,
"minute": 0
},
"endTime": {
"date": "2024-03-18",
"hour": 20,
"minute": 30
}
},
{
"startTime": {
"date": "2024-03-19",
"hour": 7,
"minute": 0
},
"endTime": {
"date": "2024-03-19",
"hour": 21,
"minute": 30
}
}
]
}
},
"address": {
"streetNumber": "2599",
"streetName": "San Bruno Avenue",
"municipality": "San Francisco",
"neighbourhood": "Portola",
"countrySecondarySubdivision": "San Francisco",
"countrySubdivision": "CA",
"countrySubdivisionName": "California",
"countrySubdivisionCode": "CA",
"postalCode": "94134",
"extendedPostalCode": "94134-1504",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "2599 San Bruno Avenue, San Francisco, CA 94134",
"localName": "San Francisco"
},
"position": {
"lat": 37.729004,
"lon": -122.403956
},
"viewport": {
"topLeftPoint": {
"lat": 37.7299,
"lon": -122.40509
},
"btmRightPoint": {
"lat": 37.7281,
"lon": -122.40282
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 37.72892,
"lon": -122.40414
}
}
]
}
]
}
定義
名前 | 説明 |
---|---|
Address |
結果のアドレス |
Address |
検索結果の番地の両側の住所範囲について説明します。 アドレス範囲の開始位置と終了位置の座標が含まれます。 |
Bounding |
ビューポートの左上と右下の座標で表される結果をカバーするビューポート。 |
Bounding |
場所の境界ボックス。 |
Brand |
POI に関連付けられているブランド |
Classification |
返される POI の分類 |
Classification |
分類の名前 |
Data |
省略可能なセクション。 Get Search Polygon API で使用する参照 ID。 |
Entity |
境界ボックスのエンティティ型ソース。 逆ジオコーディングの場合、これは常に位置と等しくなります。 |
Entry |
返される POI のエントリ ポイント。 |
Entry |
エントリ ポイントの種類。 値は、メイン することも、マイナー することもできます。 |
Error |
リソース管理エラーの追加情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答 |
Geographic |
Geography エンティティ型。 entityType が要求され、使用可能な場合にのみ存在します。 |
Geo |
有効な |
Geo |
有効な |
Geo |
有効な |
Geo |
有効な |
Geo |
有効な |
Geo |
有効な |
Geo |
有効な |
Geo |
有効な |
Geo |
有効な |
Geo |
有効な |
Geometry |
結果の幾何学的形状に関する情報。 型 == Geography の場合にのみ存在します。 |
Lat |
短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。 |
Localized |
View パラメーター ("ユーザーリージョン" パラメーターとも呼ばれます) を使用すると、地政学的に紛争が生じしている地域の特定の国/地域の正しいマップを表示できます。 このようなリージョンのビューは国や地域によって異なります。また、View パラメーターを使用すると、アプリケーションがサービスを提供する国/地域で必要なビューにアプリケーションを準拠できます。 既定では、要求で定義していない場合でも、View パラメーターは "Unified" に設定されます。 ユーザーの場所を特定し、その場所に対して View パラメーターを正しく設定するのは、ユーザーの責任です。 または、要求の IP アドレスに基づいてマップ データを返す 'View=Auto' を設定することもできます。 Azure Maps の View パラメーターは、マップ、画像、その他のデータ、および Azure Maps 経由でアクセスする権限を持つ第三者のコンテンツが利用できる国/地域のマッピングに関する法律を含む、適用される法律に従って使用する必要があります。 例: view=IN。 詳細については、サポートされているビューの を参照し、使用可能なビューを参照してください。 |
Match |
逆アドレス検索操作の一致の種類。 |
Operating |
POI (目的地) の営業時間。 |
Operating |
POI の操作時間 (目的地)。 操作時間の可用性は、使用可能なデータによって異なります。 合格しなかった場合、営業時間情報は返されません。 サポートされる値: nextSevenDays |
Operating |
日付と時刻を表します |
Operating |
1 日の開いている時間範囲 |
Point |
名前、電話番号、URL アドレス、分類などの情報を含む、返される POI の詳細。 |
Point |
POI カテゴリ |
Query |
返されるクエリの種類: NEARBY または NON_NEAR。 |
Response |
応答の目的の形式。 値は、json することも、xml することもできます。 |
Search |
このオブジェクトは、成功した Search 呼び出しから返されます。 |
Search |
Search API 応答の結果オブジェクト。 |
Search |
つぎのいずれかです。
|
Search |
結果に拡張郵便番号を含める必要があるインデックス。 使用可能なインデックスは次のとおりです。 Addr = アドレス範囲 geo = Geographies PAD = ポイント アドレス POI = 目的地 Str = 道路 XStr = クロス ストリート (交差点) 値は、インデックスの種類のコンマ区切りのリスト (任意の順序) またはインデックスがない場合は [なし] する必要があります。 既定では、Geo を除くすべてのインデックスに拡張郵便番号が含まれます。 地域の拡張郵便番号リストは非常に長い場合があるため、必要に応じて明示的に要求する必要があります。 使用例: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None 拡張郵便番号は、住所の extendedPostalCode プロパティとして返されます。 可用性はリージョンに依存します。 |
Search |
この型は、Search Inside Geometry サービスの要求本文を表します。 |
Search |
Search API 応答の概要オブジェクト。 |
Address
結果のアドレス
名前 | 型 | 説明 |
---|---|---|
boundingBox |
場所の境界ボックス。 |
|
buildingNumber |
string |
通りの建物番号。 非推奨、代わりに streetNumber を使用してください。 |
country |
string |
国/地域名 |
countryCode |
string |
国 (注: 国/地域名ではなく、2 文字のコードです)。 |
countryCodeISO3 |
string |
ISO alpha-3 国コード |
countrySecondarySubdivision |
string |
郡 |
countrySubdivision |
string |
都道府県 |
countrySubdivisionCode |
string |
|
countrySubdivisionName |
string |
国/地域管理階層の第 1 レベルのフル ネーム。 このフィールドは、countrySubdivision が省略形で表示される場合にのみ表示されます。 米国、カナダ、英国でのみサポートされます。 |
countryTertiarySubdivision |
string |
名前付き領域 |
crossStreet |
string |
交差している通りの名前。 |
extendedPostalCode |
string |
拡張郵便番号 (利用可能状況は地域によって異なります)。 |
freeformAddress |
string |
結果の配信元の国/地域の書式設定規則に従って書式設定された住所行、または国/地域の場合は、その完全な国/地域名。 |
localName |
string |
管理単位にならずに、アドレス指定の目的で複数のアドレス可能オブジェクトをグループ化する地理的領域または地域の名前を表すアドレス コンポーネント。 このフィールドは、 |
municipality |
string |
市区町村 |
municipalitySubdivision |
string |
サブ/スーパーシティ |
neighbourhood |
string |
地域は、都市または町内の地理的にローカライズされた地域であり、住民間の特徴的な特徴と社会的相互作用があります。 |
postalCode |
string |
郵便番号/郵便番号 |
routeNumbers |
string[] |
道路を明確に識別するために使用されるコード |
street |
string |
番地の名前。 非推奨、代わりに streetName を使用してください。 |
streetName |
string |
番地の名前。 |
streetNameAndNumber |
string |
番地の名前と番号。 |
streetNumber |
string |
通りの建物番号。 |
AddressRanges
検索結果の番地の両側の住所範囲について説明します。 アドレス範囲の開始位置と終了位置の座標が含まれます。
名前 | 型 | 説明 |
---|---|---|
from |
短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。 |
|
rangeLeft |
string |
通りの左側の住所範囲。 |
rangeRight |
string |
道路の右側の住所範囲。 |
to |
短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。 |
BoundingBox
ビューポートの左上と右下の座標で表される結果をカバーするビューポート。
名前 | 型 | 説明 |
---|---|---|
btmRightPoint |
短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。 |
|
topLeftPoint |
短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。 |
BoundingBoxCompassNotation
場所の境界ボックス。
名前 | 型 | 説明 |
---|---|---|
entity |
境界ボックスのエンティティ型ソース。 逆ジオコーディングの場合、これは常に位置と等しくなります。 |
|
northEast |
string |
北東緯度、境界ボックスの経度座標 (コンマ区切り浮動小数点数) |
southWest |
string |
境界ボックスの南西緯度、経度座標 (コンマ区切り浮動小数点数) |
Brand
POI に関連付けられているブランド
名前 | 型 | 説明 |
---|---|---|
name |
string |
ブランド名 |
Classification
返される POI の分類
名前 | 型 | 説明 |
---|---|---|
code |
string |
Code プロパティ |
names |
Names 配列 |
ClassificationName
分類の名前
名前 | 型 | 説明 |
---|---|---|
name |
string |
名前プロパティ |
nameLocale |
string |
Name Locale プロパティ |
DataSources
省略可能なセクション。 Get Search Polygon API で使用する参照 ID。
名前 | 型 | 説明 |
---|---|---|
geometry |
結果の幾何学的形状に関する情報。 型 == Geography の場合にのみ存在します。 |
Entity
境界ボックスのエンティティ型ソース。 逆ジオコーディングの場合、これは常に位置と等しくなります。
値 | 説明 |
---|---|
position |
位置エンティティ |
EntryPoint
返される POI のエントリ ポイント。
名前 | 型 | 説明 |
---|---|---|
position |
短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。 |
|
type |
エントリ ポイントの種類。 値は、メイン することも、マイナー することもできます。 |
EntryPointType
エントリ ポイントの種類。 値は、メイン することも、マイナー することもできます。
値 | 説明 |
---|---|
main | |
minor |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーターゲット。 |
ErrorResponse
エラー応答
名前 | 型 | 説明 |
---|---|---|
error |
エラー オブジェクト。 |
GeographicEntityType
Geography エンティティ型。 entityType が要求され、使用可能な場合にのみ存在します。
値 | 説明 |
---|---|
Country |
国/地域名 |
CountrySecondarySubdivision |
郡 |
CountrySubdivision |
都道府県 |
CountryTertiarySubdivision |
名前付き領域 |
Municipality |
市区町村 |
MunicipalitySubdivision |
サブ/スーパーシティ |
Neighbourhood |
近所 |
PostalCodeArea |
郵便番号/郵便番号 |
GeoJsonFeature
有効な GeoJSON Feature
オブジェクト型。 詳細については、RFC 7946 を参照してください。
名前 | 型 | 説明 |
---|---|---|
featureType |
string |
フィーチャーの種類。 値は、現在の特徴が含まれるデータ モデルによって異なります。 一部のデータ モデルには空の値が含まれる場合があります。 |
geometry | GeoJsonGeometry: |
有効な |
id |
string |
機能の識別子。 |
type |
string:
Feature |
|
GeoJsonFeatureCollection
有効な GeoJSON FeatureCollection
オブジェクト型。 詳細については、RFC 7946 を参照してください。
名前 | 型 | 説明 |
---|---|---|
features |
有効な |
|
type |
string:
Feature |
|
GeoJsonGeometry
有効な GeoJSON
geometry オブジェクト。 この型は、Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection の 7 つの有効な GeoJSON ジオメトリ 型のいずれかである必要があります。 詳細については、RFC 7946 を参照してください。
名前 | 型 | 説明 |
---|---|---|
type |
Geo |
|
GeoJsonGeometryCollection
有効な GeoJSON GeometryCollection
オブジェクト型。 詳細については、RFC 7946 を参照してください。
名前 | 型 | 説明 |
---|---|---|
geometries | GeoJsonGeometry[]: |
有効な |
type |
string:
Geometry |
|
GeoJsonLineString
有効な GeoJSON LineString
geometry 型。 詳細については、RFC 7946 を参照してください。
名前 | 型 | 説明 |
---|---|---|
coordinates |
number[] (double) |
|
type |
string:
Line |
|
GeoJsonMultiLineString
有効な GeoJSON MultiLineString
geometry 型。 詳細については、RFC 7946 を参照してください。
名前 | 型 | 説明 |
---|---|---|
coordinates |
number[] (double) |
|
type |
string:
Multi |
|
GeoJsonMultiPoint
有効な GeoJSON MultiPoint
geometry 型。 詳細については、RFC 7946 を参照してください。
名前 | 型 | 説明 |
---|---|---|
coordinates |
number[] (double) |
|
type |
string:
Multi |
|
GeoJsonMultiPolygon
有効な GeoJSON MultiPolygon
オブジェクト型。 詳細については、RFC 7946 を参照してください。
名前 | 型 | 説明 |
---|---|---|
coordinates |
number[] (double) |
有効な |
type |
string:
Multi |
|
GeoJsonPoint
有効な GeoJSON Point
geometry 型。 詳細については、RFC 7946 を参照してください。
名前 | 型 | 説明 |
---|---|---|
coordinates |
number[] (double) |
|
type |
string:
Point |
|
GeoJsonPolygon
有効な GeoJSON Polygon
geometry 型。 詳細については、RFC 7946 を参照してください。
名前 | 型 | 説明 |
---|---|---|
coordinates |
number[] (double) |
|
type |
string:
Polygon |
|
Geometry
結果の幾何学的形状に関する情報。 型 == Geography の場合にのみ存在します。
名前 | 型 | 説明 |
---|---|---|
id |
string |
これを geometryId として Get Search Polygon API に渡して、この結果のジオメトリ情報をフェッチします。 |
LatLongPairAbbreviated
短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。
名前 | 型 | 説明 |
---|---|---|
lat |
number (double) |
Latitude プロパティ |
lon |
number (double) |
Longitude プロパティ |
LocalizedMapView
View パラメーター ("ユーザーリージョン" パラメーターとも呼ばれます) を使用すると、地政学的に紛争が生じしている地域の特定の国/地域の正しいマップを表示できます。 このようなリージョンのビューは国や地域によって異なります。また、View パラメーターを使用すると、アプリケーションがサービスを提供する国/地域で必要なビューにアプリケーションを準拠できます。 既定では、要求で定義していない場合でも、View パラメーターは "Unified" に設定されます。 ユーザーの場所を特定し、その場所に対して View パラメーターを正しく設定するのは、ユーザーの責任です。 または、要求の IP アドレスに基づいてマップ データを返す 'View=Auto' を設定することもできます。 Azure Maps の View パラメーターは、マップ、画像、その他のデータ、および Azure Maps 経由でアクセスする権限を持つ第三者のコンテンツが利用できる国/地域のマッピングに関する法律を含む、適用される法律に従って使用する必要があります。 例: view=IN。
詳細については、サポートされているビューの を参照し、使用可能なビューを参照してください。
値 | 説明 |
---|---|
AE |
アラブ首長国連邦 (アラビアビュー) |
AR |
アルゼンチン (アルゼンチン ビュー) |
Auto |
要求の IP アドレスに基づいてマップ データを返します。 |
BH |
バーレーン (アラビアビュー) |
IN |
インド (インドビュー) |
IQ |
イラク (アラビア語ビュー) |
JO |
ヨルダン (アラビアビュー) |
KW |
クウェート (アラビアビュー) |
LB |
レバノン (アラビア語ビュー) |
MA |
モロッコ (モロッコビュー) |
OM |
オマーン (アラビアビュー) |
PK |
パキスタン (パキスタン ビュー) |
PS |
パレスチナ自治政府 (アラビア語ビュー) |
QA |
カタール (アラビアビュー) |
SA |
サウジアラビア (アラビア語ビュー) |
SY |
シリア (アラビアビュー) |
Unified |
統合ビュー (その他) |
YE |
イエメン (アラビアビュー) |
MatchType
逆アドレス検索操作の一致の種類。
値 | 説明 |
---|---|
AddressPoint | |
HouseNumberRange | |
Street |
OperatingHours
POI (目的地) の営業時間。
名前 | 型 | 説明 |
---|---|---|
mode |
string |
要求で使用される値: none または "nextSevenDays" |
timeRanges |
次の 7 日間の時間範囲の一覧 |
OperatingHoursRange
POI の操作時間 (目的地)。 操作時間の可用性は、使用可能なデータによって異なります。 合格しなかった場合、営業時間情報は返されません。 サポートされる値: nextSevenDays
値 | 説明 |
---|---|
nextSevenDays |
POI の現地時刻の現在の日から始まる、次の週の操作時間を示します。 |
OperatingHoursTime
日付と時刻を表します
名前 | 型 | 説明 |
---|---|---|
date |
string |
POI タイム ゾーンの現在のカレンダー日付を表します (例: "2019-02-07")。 |
hour |
integer |
時間は POI の現地時刻の 24 時間形式です。指定できる値は 0 から 23 です。 |
minute |
integer |
分は POI の現地時刻です。指定できる値は 0 から 59 です。 |
OperatingHoursTimeRange
1 日の開いている時間範囲
名前 | 型 | 説明 |
---|---|---|
endTime |
特定の POI が閉じられているときの次の 7 日間の範囲のポイント。範囲の前に閉じられた場合は範囲の先頭。 |
|
startTime |
特定の POI を開くときの次の 7 日間の範囲のポイント。範囲の前に開かれた場合は範囲の先頭。 |
PointOfInterest
名前、電話番号、URL アドレス、分類などの情報を含む、返される POI の詳細。
名前 | 型 | 説明 |
---|---|---|
brands |
Brand[] |
ブランド配列。 返される POI のブランド名。 |
categories |
string[] |
Categories 配列 |
categorySet |
最も具体的な POI カテゴリの一覧 |
|
classifications |
分類配列 |
|
name |
string |
POI プロパティの名前 |
openingHours |
POI (目的地) の営業時間。 |
|
phone |
string |
電話番号プロパティ |
url |
string |
Web サイトの URL プロパティ |
PointOfInterestCategorySet
POI カテゴリ
名前 | 型 | 説明 |
---|---|---|
id |
integer |
カテゴリ ID |
QueryType
返されるクエリの種類: NEARBY または NON_NEAR。
値 | 説明 |
---|---|
NEARBY |
半径が定義された特定の緯度と経度を中心に検索が実行されました |
NON_NEAR |
特定の緯度と経度に偏らず、半径が定義されていない、グローバルに検索が実行されました |
ResponseFormat
応答の目的の形式。 値は、json することも、xml することもできます。
値 | 説明 |
---|---|
json |
JavaScript オブジェクト表記データ交換形式 を する |
xml |
拡張マークアップ言語 を する |
SearchAddressResult
このオブジェクトは、成功した Search 呼び出しから返されます。
名前 | 型 | 説明 |
---|---|---|
results |
Search API の結果の一覧。 |
|
summary |
Search API 応答の概要オブジェクト |
SearchAddressResultItem
Search API 応答の結果オブジェクト。
名前 | 型 | 説明 |
---|---|---|
address |
結果のアドレス |
|
addressRanges |
検索結果の番地の両側の住所範囲について説明します。 アドレス範囲の開始位置と終了位置の座標が含まれます。 |
|
dataSources |
省略可能なセクション。 Get Search Polygon API で使用する参照ジオメトリ ID。 |
|
detourTime |
integer |
迂回時間 (秒単位)。 ルート検索 API の呼び出しに対してのみ返されます。 |
dist |
number (double) |
結果とジオビアスの位置の間の直線距離 (メートル単位)。 |
entityType |
Geography エンティティ型。 entityType が要求され、使用可能な場合にのみ存在します。 |
|
entryPoints |
EntryPoints の配列。 これらは、場所で利用可能な入り口の種類を記述します。 種類は、正面ドアやロビーなどのメインエントランスの場合は "メイン"、サイドドアとバックドアの場合は "マイナー" です。 |
|
id |
string |
Id プロパティ |
info |
string |
結果の元のデータ ソースに関する情報。 サポート要求に使用されます。 |
matchType |
一致の種類に関する情報。 つぎのいずれかです。
|
|
poi |
名前、電話番号、URL アドレス、分類などの情報を含む、返される POI の詳細。 |
|
position |
短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。 |
|
score |
number (double) |
結果セット内の値。結果間の相対的な一致スコアを示します。 これを使用して、x の値が y の値の 2 倍の場合、結果 x が結果 y の 2 倍の関連性を持つ可能性があることを判断できます。 値はクエリによって異なり、1 つの結果セットの相対値としてのみ使用されます。 |
type |
つぎのいずれかです。
|
|
viewport |
ビューポートの左上と右下の座標で表される結果をカバーするビューポート。 |
SearchAddressResultType
つぎのいずれかです。
- POI
- 通り
- 地理学
- ポイント住所
- アドレス範囲
- 交差道路
値 | 説明 |
---|---|
Address Range | |
Cross Street | |
Geography | |
POI | |
Point Address | |
Street |
SearchIndexes
結果に拡張郵便番号を含める必要があるインデックス。
使用可能なインデックスは次のとおりです。
Addr = アドレス範囲
geo = Geographies
PAD = ポイント アドレス
POI = 目的地
Str = 道路
XStr = クロス ストリート (交差点)
値は、インデックスの種類のコンマ区切りのリスト (任意の順序) またはインデックスがない場合は [なし] する必要があります。
既定では、Geo を除くすべてのインデックスに拡張郵便番号が含まれます。 地域の拡張郵便番号リストは非常に長い場合があるため、必要に応じて明示的に要求する必要があります。
使用例:
extendedPostalCodesFor=POI
extendedPostalCodesFor=PAD,Addr,POI
extendedPostalCodesFor=None
拡張郵便番号は、住所の extendedPostalCode プロパティとして返されます。 可用性はリージョンに依存します。
値 | 説明 |
---|---|
Addr | |
Geo | |
PAD | |
POI | |
Str | |
Xstr |
SearchInsideGeometryRequest
この型は、Search Inside Geometry サービスの要求本文を表します。
名前 | 型 | 説明 |
---|---|---|
geometry | GeoJsonObject: |
有効な |
SearchSummary
Search API 応答の概要オブジェクト。
名前 | 型 | 説明 |
---|---|---|
fuzzyLevel |
integer |
結果を提供するために必要な最大あいまいレベル。 |
geoBias |
内部検索エンジンが地理空間バイアスを適用して結果のランク付けを向上させるタイミングを示します。 一部のメソッドでは、lat パラメーターと lon パラメーターを使用可能な場合に設定することで、この影響を受ける可能性があります。 該当しない場合は、純粋な結果にのみ左右されます。 |
|
limit |
integer |
返される応答の最大数 |
numResults |
integer |
応答の結果の数。 |
offset |
integer |
完全な結果セット内の返された結果の開始オフセット。 |
query |
string |
これらの検索結果の生成に使用されたクエリ パラメーター。 |
queryTime |
integer |
クエリの解決に費やされた時間 (ミリ秒単位)。 |
queryType |
返されるクエリの種類: NEARBY または NON_NEAR。 |
|
totalResults |
integer |
検出された結果の合計数。 |