Search - Get Search POI
名前で目的地を検索するには、 を使用します。
Points of Interest (POI) Search
API は、名前で POI の結果を要求できる HTTP GET
要求です。 また、言語などの追加のクエリ パラメーターや、国/地域や境界ボックスに基づく関心領域による結果のフィルター処理もサポートされています。 エンドポイントは、クエリ文字列と一致する POI 結果のみを返します。 応答には、住所、座標の場所、カテゴリなどの POI の詳細が含まれます。
GET https://atlas.microsoft.com/search/poi/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/search/poi/{format}?api-version=1.0&query={query}&typeahead={typeahead}&limit={limit}&ofs={ofs}&categorySet={categorySet}&countrySet={countrySet}&lat={lat}&lon={lon}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&language={language}&extendedPostalCodesFor={extendedPostalCodesFor}&brandSet={brandSet}&connectorSet={connectorSet}&view={view}&openingHours=nextSevenDays
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
format
|
path | True |
応答の目的の形式。 値には json または xml のいずれかを指定できます。 |
|
api-version
|
query | True |
string |
Azure Maps API のバージョン番号。 |
query
|
query | True |
string |
検索する POI 名 (例: "自由の女神"、"starbucks") は、正しく URL エンコードされている必要があります。 |
brand
|
query |
string[] |
結果を特定のブランドに制限するために使用できるブランド名のコンマ区切りのリスト。 項目の順序は関係ありません。 複数のブランドが提供されている場合、指定されたリストの 1 つ (少なくとも) に属する結果のみが返されます。 名前に "," を含むブランドは、引用符で囲む必要があります。 使用例: brandSet=Foo brandSet=Foo,Bar brandSet="A,B,C コンマ",Bar |
|
btm
|
query |
string |
境界ボックスの右下の位置。 例: 37.553,-122.453 |
|
category
|
query |
integer[] |
特定のポイントオブインタレストカテゴリに結果を制限するために使用できるカテゴリセットIDのコンマ区切りのリスト。 ID の順序は関係ありません。 要求ごとにサポートされる値の
|
|
connector
|
query |
特定のコネクタの種類をサポートする電気自動車ステーションに結果を制限するために使用できるコネクタの種類のコンマ区切りのリスト。 項目の順序は関係ありません。 複数のコネクタの種類が指定されている場合は、指定されたリストの 1 つ (少なくとも) に属する結果のみが返されます。 使用可能なコネクタの種類は次のとおりです。
使用例: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached |
||
country
|
query |
string[] |
国/地域コードのコンマ区切り文字列 (FR、ES など)。 これにより、指定した国/地域に検索が制限されます |
|
extended
|
query |
結果に拡張郵便番号を含める必要があるインデックス。 使用可能なインデックスは次のとおりです。 POI = 目的地 拡張郵便番号を無効にするには、 値を POI または None にする必要があります。 既定では、拡張郵便番号が含まれます。 使用例: extendedPostalCodesFor=POI extendedPostalCodesFor=None 拡張郵便番号は、住所の extendedPostalCode プロパティとして返されます。 可用性はリージョンに依存します。 |
||
language
|
query |
string |
検索結果を返す言語。 サポートされている IETF 言語タグの 1 つである必要があります。大文字と小文字は区別されません。 指定した言語のデータが特定のフィールドで使用できない場合は、既定の言語が使用されます。 詳細については、「 サポートされている言語 」を参照してください。 |
|
lat
|
query |
number double |
結果が偏る緯度。 例: 37.337 |
|
limit
|
query |
integer |
返される応答の最大数。 既定値: 10、最小: 1、最大: 100 |
|
lon
|
query |
number double |
結果をバイアスする必要がある経度。 例: -121.89 |
|
ofs
|
query |
integer |
完全な結果セット内の返された結果の開始オフセット。 既定値は0 |
|
opening
|
query |
POI (ポイント オブ インタレスト) の操作時間。 操作時間の可用性は、使用可能なデータによって異なります。 渡されない場合、営業時間情報は返されません。 サポートされている値: nextSevenDays |
||
radius
|
query |
integer |
結果を定義された領域に制限するための半径 (メートル単位) |
|
top
|
query |
string |
境界ボックスの左上の位置。 例: 37.553,-122.453 |
|
typeahead
|
query |
boolean |
ブール型。 typeahead フラグが設定されている場合、クエリは部分的な入力として解釈され、検索は予測モードになります |
|
view
|
query |
View パラメーター ("user region" パラメーターとも呼ばれます) を使用すると、地政学的に紛争が発生している地域の特定の国/地域の正しいマップを表示できます。 このようなリージョンのビューは国や地域によって異なり、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セキュリティを使用するには、ガイダンスについては、次の記事を参照してください。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
予期しないエラーが発生しました。 |
セキュリティ
AADToken
これらは OAuth 2.0 フロー Microsoft Entraです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上のAzure Mapsリソース アカウントまたはサブリソースへのアクセスを指定するために使用されます。 REST API をAzure Mapsするための 1 つ以上のアクセス許可で構成される組み込みロールまたはカスタム ロールを使用して、ユーザー、グループ、またはサービス プリンシパルにアクセス権を付与できます。
シナリオを実装するには、 認証の概念を表示することをお勧めします。 要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを使用してアプリケーションをモデル化するためのソリューションを提供します。
注意
- このセキュリティ定義では、 ヘッダーを使用して、
x-ms-client-id
アプリケーションがアクセスを要求しているリソース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でAzure Maps アカウントを作成するとき、または PowerShell、CLI、Azure SDK、または REST API を使用するときにプロビジョニングされる共有キーです。
このキーを使用すると、すべてのアプリケーションがすべての REST API にアクセスできます。 つまり、このキーは、発行されたアカウントのマスター キーとして使用できます。
公開されているアプリケーションの場合は、機密クライアント アプリケーションのアプローチを使用して、キーを安全に格納できるように、Azure Maps REST API にアクセスすることをお勧めします。
型:
apiKey
/:
query
SAS Token
これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して、Azure 管理プレーンを介して、Azure Maps リソースの List SAS 操作から作成される共有アクセス署名トークンです。
このトークンを使用すると、すべてのアプリケーションが Azure ロールベースのアクセス制御を使用してアクセスし、特定のトークンに使用される有効期限、レート、およびリージョンをきめ細かく制御できます。 つまり、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できるようにします。
公開されているアプリケーションの場合、 Map アカウント リソース で許可される配信元の特定の一覧を構成して、レンダリングの不正使用を制限し、SAS トークンを定期的に更新することをお勧めします。
型:
apiKey
/:
header
例
Search for juice bars within 5 miles of Seattle Downtown and limit the response to 5 results
要求のサンプル
GET https://atlas.microsoft.com/search/poi/json?api-version=1.0&query=juice bars&limit=5&lat=47.606038&lon=-122.333345&radius=8046&openingHours=nextSevenDays
応答のサンプル
{
"summary": {
"query": "juice bars",
"queryType": "NON_NEAR",
"queryTime": 36,
"numResults": 5,
"offset": 0,
"totalResults": 12,
"fuzzyLevel": 1,
"geoBias": {
"lat": 47.606038,
"lon": -122.333345
}
},
"results": [
{
"type": "POI",
"id": "US/POI/p0/9223158",
"score": 5.664,
"dist": 667.2710170950347,
"info": "search:ta:840539001755244-US",
"poi": {
"name": "Pressed Juicery",
"phone": "+(1)-(206)-6240804",
"brands": [
{
"name": "Pressed Juicery"
}
],
"categorySet": [
{
"id": 7315149
}
],
"url": "www.pressedjuicery.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "400",
"streetName": "Pine St",
"municipalitySubdivision": "Seattle, Central Business District",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98101",
"extendedPostalCode": "981011628",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "400 Pine St, Seattle, WA 98101",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.61138,
"lon": -122.3374
},
"viewport": {
"topLeftPoint": {
"lat": 47.61228,
"lon": -122.33873
},
"btmRightPoint": {
"lat": 47.61048,
"lon": -122.33607
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.61134,
"lon": -122.33737
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/9222534",
"score": 5.663,
"dist": 1101.6849025777728,
"info": "search:ta:840539001760125-US",
"poi": {
"name": "Pressed Juicery",
"phone": "+(1)-(206)-4533785",
"brands": [
{
"name": "Pressed Juicery"
}
],
"categorySet": [
{
"id": 7315149
}
],
"url": "www.pressedjuicery.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "315",
"streetName": "E Pine St",
"municipalitySubdivision": "Seattle, Broadway",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98122",
"extendedPostalCode": "9812200",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "315 E Pine St, Seattle, WA 98122",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.61518,
"lon": -122.32768
},
"viewport": {
"topLeftPoint": {
"lat": 47.61608,
"lon": -122.32901
},
"btmRightPoint": {
"lat": 47.61428,
"lon": -122.32635
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.61523,
"lon": -122.32768
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/9133689",
"score": 5.659,
"dist": 2649.8700791555398,
"info": "search:ta:840539001339220-US",
"poi": {
"name": "Pressed Juicery",
"phone": "+(1)-(206)-2820651",
"brands": [
{
"name": "Pressed Juicery"
}
],
"categorySet": [
{
"id": 7315149
}
],
"url": "www.pressedjuicery.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "604",
"streetName": "1st Ave N",
"municipalitySubdivision": "Seattle, Lower Queen Anne",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98109",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "604 1st Ave N, Seattle, WA 98109",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.6247,
"lon": -122.35533
},
"viewport": {
"topLeftPoint": {
"lat": 47.6256,
"lon": -122.35666
},
"btmRightPoint": {
"lat": 47.6238,
"lon": -122.354
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.6247,
"lon": -122.3554
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/9131285",
"score": 5.646,
"dist": 5097.757019046541,
"info": "search:ta:840539001743255-US",
"poi": {
"name": "Custom Smoothie & Sports Nutrition",
"phone": "+(1)-(206)-5475522",
"categorySet": [
{
"id": 7315149
}
],
"url": "www.customsmoothie.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "462",
"streetName": "N 34th St",
"municipalitySubdivision": "Seattle, Fremont",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98103",
"extendedPostalCode": "981038600",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "462 N 34th St, Seattle, WA 98103",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.65016,
"lon": -122.35182
},
"viewport": {
"topLeftPoint": {
"lat": 47.65106,
"lon": -122.35315
},
"btmRightPoint": {
"lat": 47.64926,
"lon": -122.35049
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.64991,
"lon": -122.3519
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/9228250",
"score": 5.637,
"dist": 6235.798481758295,
"info": "search:ta:840531000416784-US",
"poi": {
"name": "Jamba Juice",
"phone": "+(1)-(206)-6322060",
"brands": [
{
"name": "Jamba Juice"
}
],
"categorySet": [
{
"id": 7315149
}
],
"url": "www.jambajuice.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "4555",
"streetName": "Stone Way N",
"municipalitySubdivision": "Wallingford, Seattle",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98103",
"extendedPostalCode": "981036600",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "4555 Stone Way N, Seattle, WA 98103",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.66179,
"lon": -122.34233
},
"viewport": {
"topLeftPoint": {
"lat": 47.66269,
"lon": -122.34367
},
"btmRightPoint": {
"lat": 47.66089,
"lon": -122.34099
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.66188,
"lon": -122.34211
}
}
]
}
]
}
定義
名前 | 説明 |
---|---|
Address |
結果のアドレス |
Address |
検索結果の通りの両側のアドレス範囲について説明します。 アドレス範囲の開始位置と終了位置の座標が含まれます。 |
Bounding |
ビューポートの左上と右下の座標で表される結果をカバーするビューポート。 |
Bounding |
場所の境界ボックス。 |
Brand |
POI に関連付けられているブランド |
Classification |
返される POI の分類 |
Classification |
分類の名前 |
Data |
省略可能なセクション。 Get Search Polygon API で使用する参照 ID。 |
Electric |
特定のコネクタの種類をサポートする電気自動車ステーションに結果を制限するために使用できるコネクタの種類のコンマ区切りのリスト。 項目の順序は関係ありません。 複数のコネクタの種類が指定されている場合は、指定されたリストの 1 つ (少なくとも) に属する結果のみが返されます。 使用可能なコネクタの種類は次のとおりです。
使用例: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached |
Entity |
境界ボックスのエンティティ型ソース。 逆ジオコーディングの場合、これは常に位置と等しくなります。 |
Entry |
返される POI のエントリ ポイント。 |
Entry |
エントリ ポイントの種類。 値には、メインまたはマイナーのいずれかを指定できます。 |
Error |
リソース管理エラーの追加情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答 |
Geographic |
Geography エンティティ型。 entityType が要求され、使用可能な場合にのみ表示されます。 |
Geometry |
結果の幾何学的形状に関する情報。 型 == Geography の場合にのみ存在します。 |
Lat |
短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。 |
Localized |
View パラメーター ("user region" パラメーターとも呼ばれます) を使用すると、地政学的に紛争が発生している地域の特定の国/地域の正しいマップを表示できます。 このようなリージョンのビューは国や地域によって異なり、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 カテゴリ |
Point |
結果に拡張郵便番号を含める必要があるインデックス。 使用可能なインデックスは次のとおりです。 POI = 関心のあるポイント 拡張郵便番号を無効にするには、 値を POI または None にする必要があります。 既定では、拡張郵便番号が含まれます。 使用例: extendedPostalCodesFor=POI extendedPostalCodesFor=None 拡張郵便番号は、住所の extendedPostalCode プロパティとして返されます。 可用性はリージョンによって異なります。 |
Query |
返されるクエリの種類: NEARBY または NON_NEAR。 |
Response |
応答の目的の形式。 値には json または xml を指定できます。 |
Search |
このオブジェクトは、正常なSearch呼び出しから返されます。 |
Search |
Search API 応答の結果オブジェクト。 |
Search |
つぎのいずれかです。
|
Search |
Search API 応答の Summary オブジェクト。 |
Address
結果のアドレス
名前 | 型 | 説明 |
---|---|---|
boundingBox |
場所の境界ボックス。 |
|
buildingNumber |
string |
通りの建物番号。 非推奨です。代わりに streetNumber を使用してください。 |
country |
string |
国/地域名 |
countryCode |
string |
国 (注: これは国/地域名ではなく、2 文字のコードです)。 |
countryCodeISO3 |
string |
ISO alpha-3 国コード |
countrySecondarySubdivision |
string |
County |
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 |
名前配列 |
ClassificationName
分類の名前
名前 | 型 | 説明 |
---|---|---|
name |
string |
Name プロパティ |
nameLocale |
string |
Name Locale プロパティ |
DataSources
省略可能なセクション。 Get Search Polygon API で使用する参照 ID。
名前 | 型 | 説明 |
---|---|---|
geometry |
結果の幾何学的形状に関する情報。 型 == Geography の場合にのみ存在します。 |
ElectricVehicleConnector
特定のコネクタの種類をサポートする電気自動車ステーションに結果を制限するために使用できるコネクタの種類のコンマ区切りのリスト。 項目の順序は関係ありません。 複数のコネクタの種類が指定されている場合は、指定されたリストの 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
名前 | 型 | 説明 |
---|---|---|
Chademo |
string |
東京電力と産業パートナーが設立した協会にちなんだCHAdeMOコネクタ。 このため、東京電力のコネクタとも呼ばれています。 高速DC充電に対応しています。 |
IEC60309AC1PhaseBlue |
string |
Industrial Blue コネクタは、IEC 60309 標準で定義されているコネクタです。 これは、標準、色、および単一相コネクタであるという事実の何らかの組み合わせによって呼ばれることがあります。 通常、コネクタには "P+N+E, 6h" 構成があります。 |
IEC60309DCWhite |
string |
産業用ホワイト コネクタは、IEC 60309 標準で定義されている DC コネクタです。 |
IEC62196Type1 |
string |
IEC 62196-2 標準で定義されている「1 コネクタ」と入力します。 最初に公開された標準の後、元のメーカーまたはSAE J1772の後に矢崎とも呼ばれます。 主に120V単相または最大240V単相インフラストラクチャと組み合わせて使用されます。 |
IEC62196Type1CCS |
string |
IEC 62196-3 標準で定義されているタイプ 1 ベースのコンボ コネクタ。 このコネクタは、IEC 62196-2 標準で定義されているタイプ 1 コネクタに基づいており、DC 急速充電を可能にする 2 つの追加の直流 (DC) 接点を備えます。 |
IEC62196Type2CCS |
string |
IEC 62196-3 標準で定義されているタイプ 2 ベースのコンボ コネクタ。 このコネクタは、IEC 62196-2 標準で定義されているタイプ 2 コネクタに基づいており、DC 急速充電を可能にする 2 つの追加の直流 (DC) 接点を備えます。 |
IEC62196Type2CableAttached |
string |
IEC 62196-2 標準で定義されているタイプ 2 コネクタ。 充電ポイントに取り付けられたケーブルとプラグとして提供 |
IEC62196Type2Outlet |
string |
IEC 62196-2 標準で定義されているタイプ 2 コネクタ。 充電ポイントにセットされたソケットとして提供されます。 |
IEC62196Type3 |
string |
IEC 62196-2 標準で定義されている「3 コネクタ」と入力します。 元のメーカーの後にスカメとも呼ばれます。 主に、最大240Vの単相または最大420Vの3相インフラストラクチャと組み合わせて使用されます。 |
StandardHouseholdCountrySpecific |
string |
これらは、特定のリージョンの標準的な家庭用コネクタです。 それらはすべてAC単一フェーズおよび標準的な電圧および標準的なアンペア数である。 「プラグ & ソケットの種類 - 世界標準」も参照してください。 |
Tesla |
string |
Tesla コネクタは、地域固有の Tesla スーパーチャージャー コネクタです。 つまり、テスラ独自のコネクタを指します。テスラポートと呼ばれることもありますが、主に北米に限定されているか、ヨーロッパでは修正されたタイプ2(DC over Type 2)です。 |
Entity
境界ボックスのエンティティ型ソース。 逆ジオコーディングの場合、これは常に位置と等しくなります。
名前 | 型 | 説明 |
---|---|---|
position |
string |
Position エンティティ |
EntryPoint
返される POI のエントリ ポイント。
名前 | 型 | 説明 |
---|---|---|
position |
短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。 |
|
type |
エントリ ポイントの種類。 値には、メインまたはマイナーのいずれかを指定できます。 |
EntryPointType
エントリ ポイントの種類。 値には、メインまたはマイナーのいずれかを指定できます。
名前 | 型 | 説明 |
---|---|---|
main |
string |
|
minor |
string |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細です。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーのターゲット。 |
ErrorResponse
エラー応答
名前 | 型 | 説明 |
---|---|---|
error |
error オブジェクト。 |
GeographicEntityType
Geography エンティティ型。 entityType が要求され、使用可能な場合にのみ表示されます。
名前 | 型 | 説明 |
---|---|---|
Country |
string |
国/地域名 |
CountrySecondarySubdivision |
string |
County |
CountrySubdivision |
string |
都道府県 |
CountryTertiarySubdivision |
string |
名前付き領域 |
Municipality |
string |
市区町村 |
MunicipalitySubdivision |
string |
サブ/スーパーシティ |
Neighbourhood |
string |
近所 |
PostalCodeArea |
string |
郵便番号/郵便番号 |
Geometry
結果の幾何学的形状に関する情報。 型 == Geography の場合にのみ存在します。
名前 | 型 | 説明 |
---|---|---|
id |
string |
これを geometryId として Get Search Polygon API に渡して、この結果のジオメトリ情報をフェッチします。 |
LatLongPairAbbreviated
短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。
名前 | 型 | 説明 |
---|---|---|
lat |
number |
Latitude プロパティ |
lon |
number |
Longitude プロパティ |
LocalizedMapView
View パラメーター ("user region" パラメーターとも呼ばれます) を使用すると、地政学的に紛争が発生している地域の特定の国/地域の正しいマップを表示できます。 このようなリージョンのビューは国や地域によって異なり、View パラメーターを使用すると、アプリケーションが提供する国/地域に必要なビューにアプリケーションを準拠できます。 既定では、要求で定義していない場合でも、View パラメーターは "Unified" に設定されます。 ユーザーの場所を特定し、その場所を正しく View パラメーターを設定するのはユーザーの責任です。 または、要求の IP アドレスに基づいてマップ データを返す 'View = Auto' を設定することもできます。 Azure Mapsの View パラメーターは、マップ、画像、その他のデータ、Azure Maps経由でアクセスする権限を持つ第三者のコンテンツが利用可能になる国/地域のマッピングに関する法律を含む、適用される法律に準拠して使用する必要があります。 例: view=IN。
詳細については、「 サポートされているビュー 」を参照し、使用可能なビューを参照してください。
名前 | 型 | 説明 |
---|---|---|
AE |
string |
アラブ首長国連邦、AE |
AR |
string |
アルゼンチン (アルゼンチン ビュー) |
Auto |
string |
要求の IP アドレスに基づいてマップ データを返します。 |
BH |
string |
バーレーン (アラビアのビュー) |
IN |
string |
インド (インド ビュー) |
IQ |
string |
イラク (アラビアのビュー) |
JO |
string |
ヨルダン (アラビアのビュー) |
KW |
string |
クウェート (アラビアのビュー) |
LB |
string |
レバノン (アラビアのビュー) |
MA |
string |
モロッコ (モロッコのビュー) |
OM |
string |
オマーン (アラビアのビュー) |
PK |
string |
パキスタン (パキスタンのビュー) |
PS |
string |
パレスチナ自治政府 (アラビアのビュー) |
QA |
string |
カタール (アラビアのビュー) |
SA |
string |
サウジアラビア (アラビアのビュー) |
SY |
string |
シリア (アラビアのビュー) |
Unified |
string |
統一されたビュー (その他) |
YE |
string |
イエメン (アラビアのビュー) |
MatchType
逆引きアドレス検索操作の一致の種類。
名前 | 型 | 説明 |
---|---|---|
AddressPoint |
string |
|
HouseNumberRange |
string |
|
Street |
string |
OperatingHours
POI (ポイント オブ インタレスト) の営業時間。
名前 | 型 | 説明 |
---|---|---|
mode |
string |
要求で使用される値: none または "nextSevenDays" |
timeRanges |
次の 7 日間の時間範囲の一覧 |
OperatingHoursRange
POI (目的地) の操作時間。 操作時間の可用性は、使用可能なデータによって異なります。 渡されない場合、営業時間情報は返されません。 サポートされる値: nextSevenDays
名前 | 型 | 説明 |
---|---|---|
nextSevenDays |
string |
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。 |
PointOfInterestExtendedPostalCodes
結果に拡張郵便番号を含める必要があるインデックス。
使用可能なインデックスは次のとおりです。
POI = 関心のあるポイント
拡張郵便番号を無効にするには、 値を POI または None にする必要があります。
既定では、拡張郵便番号が含まれます。
使用例:
extendedPostalCodesFor=POI
extendedPostalCodesFor=None
拡張郵便番号は、住所の extendedPostalCode プロパティとして返されます。 可用性はリージョンによって異なります。
名前 | 型 | 説明 |
---|---|---|
None |
string |
|
POI |
string |
QueryType
返されるクエリの種類: NEARBY または NON_NEAR。
名前 | 型 | 説明 |
---|---|---|
NEARBY |
string |
Searchは、定義された半径を持つ特定の緯度と経度を中心に実行されました |
NON_NEAR |
string |
Searchは、特定の緯度と経度に偏らず、半径が定義されていない、グローバルに実行されました |
ResponseFormat
応答の目的の形式。 値には json または xml を指定できます。
名前 | 型 | 説明 |
---|---|---|
json |
string |
|
xml |
string |
SearchAddressResult
このオブジェクトは、正常なSearch呼び出しから返されます。
名前 | 型 | 説明 |
---|---|---|
results |
SEARCH API の結果の一覧。 |
|
summary |
Search API 応答の Summary オブジェクト |
SearchAddressResultItem
Search API 応答の結果オブジェクト。
名前 | 型 | 説明 |
---|---|---|
address |
結果のアドレス |
|
addressRanges |
検索結果の番地の両側のアドレス範囲について説明します。 アドレス範囲の開始位置と終了位置の座標が含まれます。 |
|
dataSources |
省略可能なセクション。 Get Search Polygon API で使用する参照ジオメトリ ID。 |
|
detourTime |
integer |
迂回時間 (秒単位)。 Search Along Route API の呼び出しに対してのみ返されます。 |
dist |
number |
結果とジオビアスの位置の間の直線距離 (メートル単位)。 |
entityType |
Geography エンティティ型。 entityType が要求され、使用可能な場合にのみ表示されます。 |
|
entryPoints |
EntryPoints の配列。 これらは、場所で利用可能な入り口の種類を説明します。 種類は、フロント ドアやロビーなどのメインの入り口には "メイン"、サイド ドアとバック ドアの場合は "マイナー" です。 |
|
id |
string |
Id プロパティ |
info |
string |
結果の元のデータ ソースに関する情報。 サポート要求に使用されます。 |
matchType |
一致の種類に関する情報。 つぎのいずれかです。
|
|
poi |
名前、電話番号、URL アドレス、分類などの情報を含む、返される POI の詳細。 |
|
position |
短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。 |
|
score |
number |
結果セット内の値。結果間の相対的な一致スコアを示します。 これを使用して、x の値が y の値の 2 倍の場合、結果 x が結果 y の 2 倍の関連性を持つ可能性があることを判断できます。 値はクエリによって異なり、1 つの結果セットの相対値としてのみ使用されます。 |
type |
つぎのいずれかです。
|
|
viewport |
ビューポートの左上と右下の座標で表される結果をカバーするビューポート。 |
SearchAddressResultType
つぎのいずれかです。
- POI
- Street
- [地理的な場所]
- ポイント住所
- アドレス範囲
- 交差道路
名前 | 型 | 説明 |
---|---|---|
Address Range |
string |
|
Cross Street |
string |
|
Geography |
string |
|
POI |
string |
|
Point Address |
string |
|
Street |
string |
SearchSummary
Search API 応答の Summary オブジェクト。
名前 | 型 | 説明 |
---|---|---|
fuzzyLevel |
integer |
結果を提供するために必要な最大あいまいレベル。 |
geoBias |
内部検索エンジンが地理空間バイアスを適用して結果のランク付けを向上させるタイミングを示します。 一部のメソッドでは、lat パラメーターと lon パラメーターを使用可能な場合に設定すると、これが影響を受ける可能性があります。 それ以外の場合は、純粋に内部的です。 |
|
limit |
integer |
返される応答の最大数 |
numResults |
integer |
応答の結果の数。 |
offset |
integer |
完全な結果セット内の返された結果の開始オフセット。 |
query |
string |
これらの検索結果を生成するために使用されたクエリ パラメーター。 |
queryTime |
integer |
クエリの解決に費やされた時間 (ミリ秒単位)。 |
queryType |
返されるクエリの種類: NEARBY または NON_NEAR。 |
|
totalResults |
integer |
検出された結果の合計数。 |