Search - Post Search Along Route

リファレンス

Service:: Maps

API Version:: 1.0

を使用して、指定したルートに沿って POI のあいまい検索を実行します。

Post Search Along Route API は HTTP POST 要求であり、指定したルートに沿って POI のあいまい検索を実行できます。この検索は、制限メジャーを maxDetourTime 指定することによって制限されます。

ルートポイントを送信するには、要求本文に型としてGeoJSON LineString表されるオブジェクトが含まれroute、ヘッダーがに設定される要求をContent-Typeapplication/json使用POSTします。の route 各ルートポイントは、型として GeoJSON Position 表されます。 つまり、経度 値の後に緯度値が続き、高度の値が無視される配列です。には route 、少なくとも 2 つのルートポイントが含まれている必要があります。

元のルートが変更され、その一部のポイントがスキップされる可能性があります。見つかったポイントを通過するルートが元のルートよりも高速である場合、 detourTime 応答の値は負になります。

POST https://atlas.microsoft.com/search/alongRoute/{format}?api-version=1.0&query={query}&maxDetourTime={maxDetourTime}

With optional parameters:

POST https://atlas.microsoft.com/search/alongRoute/{format}?api-version=1.0&query={query}&maxDetourTime={maxDetourTime}&limit={limit}&brandSet={brandSet}&categorySet={categorySet}&connectorSet={connectorSet}&view={view}&openingHours=nextSevenDays

URI パラメーター

名前	/	必須	型	説明
format	path	True	ResponseFormat	応答の目的の形式。値には json または xml を指定できます。
api-version	query	True	string	Azure Maps API のバージョン番号。
maxDetourTime	query	True	integer	関心のあるポイントの最大迂回時間 (秒単位)。最大値は 3600 秒です
query	query	True	string	検索する POI 名 (例: "自由の女神"、"starbucks"、"pizza")。 URL が正しくエンコードされている必要があります。
brandSet	query		string[]	結果を特定のブランドに制限するために使用できるブランド名のコンマ区切りのリスト。項目の順序は関係ありません。複数のブランドが提供されている場合は、指定されたリストの 1 つに属する (少なくとも) 結果のみが返されます。名前に "," を含むブランドは引用符で囲む必要があります。使用例: brandSet=Foo brandSet=Foo,Bar brandSet="A,B,C コンマ",Bar
categorySet	query		integer[]	結果を特定のポイントオブインタレストカテゴリに制限するために使用できるカテゴリセット ID のコンマ区切りリスト。 ID の順序は重要ではありません。要求ごとにサポートされる値の `categorySet` 最大数は 10 です。複数のカテゴリ識別子を指定すると、指定されたリストのカテゴリの 1 つに属する (少なくとも) POI のみが返されます。サポートされているカテゴリの一覧は、 POI Categories API を使用して検出できます。使用例: categorySet=7315 (カテゴリレストランからSearchポイント) categorySet=7315025,7315017 (イタリア料理またはフレンチレストランのカテゴリのSearchポイント)
connectorSet	query		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
limit	query		integer	返される応答の最大数。既定値は 10 です。最大値は 20 です
openingHours	query		OperatingHoursRange	POI (ポイントオブインタレスト) の操作時間。操作時間の可用性は、使用可能なデータによって異なります。渡されない場合、営業時間情報は返されません。サポートされている値: nextSevenDays
view	query		LocalizedMapView	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セキュリティを使用するには、次の記事を参照してください。

要求本文

名前	型	説明
route	GeoJsonLineString	有効な `GeoJSON LineString` geometry 型。詳細については、 RFC 7946 を参照してください。

応答

名前	型	説明
200 OK	SearchAddressResult	OK
Other Status Codes	ErrorResponse	予期しないエラーが発生しました。

セキュリティ

AADToken

これらは OAuth 2.0 フロー Microsoft Entraです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上のAzure Mapsリソースアカウントまたはサブリソースへのアクセスを指定するために使用されます。 REST API に対する 1 つ以上のアクセス許可で構成される組み込みロールまたはカスタムロールを使用して、任意のユーザー、グループ、またはサービスプリンシパルにアクセス権 Azure Mapsを付与できます。

シナリオを実装するには、認証の概念を表示することをお勧めします。要約すると、このセキュリティ定義は、特定の 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 プラットフォームの概要」を参照してください。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
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 にアクセスすることをお勧めします。

Type: apiKey
In: query

SAS Token

これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンを介して、Azure Maps リソースの List SAS 操作から作成される共有アクセス署名トークンです。

このトークンを使用すると、すべてのアプリケーションが Azure ロールベースのアクセス制御を使用してアクセスし、特定のトークンに使用される有効期限、レート、およびリージョンに対するきめ細かい制御が許可されます。言い換えると、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できます。

公開されているアプリケーションの場合、 Map アカウントリソースで許可される配信元の特定のリストを構成して、レンダリングの不正使用を制限し、SAS トークンを定期的に更新することをお勧めします。

Type: apiKey
In: header

例

Search for burger joints along a route

Sample Request

HTTP

POST https://atlas.microsoft.com/search/alongRoute/json?api-version=1.0&query=burger&maxDetourTime=1000&limit=2&openingHours=nextSevenDays

{
  "route": {
    "type": "LineString",
    "coordinates": [
      [
        -122.143035,
        47.653536
      ],
      [
        -122.187164,
        47.617556
      ],
      [
        -122.114981,
        47.570599
      ],
      [
        -122.132756,
        47.654009
      ]
    ]
  }
}

Sample Response

Status code:: 200

{
  "summary": {
    "query": "burger",
    "queryType": "NON_NEAR",
    "queryTime": 394,
    "numResults": 2,
    "offset": 0,
    "totalResults": 2,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "POI",
      "id": "US/POI/p0/8596348",
      "score": 3.104,
      "dist": 1754.9604168059973,
      "info": "search:ta:840531000465150-US",
      "poi": {
        "name": "BURGER KING",
        "phone": "+(1)-(425)-7467508",
        "brands": [
          {
            "name": "BURGER KING"
          }
        ],
        "categorySet": [
          {
            "id": 7315015
          }
        ],
        "url": "www.burgerking.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "fast food"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "14620",
        "streetName": "NE 24th St",
        "municipalitySubdivision": "Crossroads, Bellevue",
        "municipality": "Bellevue",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivisionCode": "WA",
        "postalCode": "98007",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "14620 NE 24th St, Bellevue, WA 98007",
        "localName": "Bellevue",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.63188,
        "lon": -122.14462
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.63278,
          "lon": -122.14595
        },
        "btmRightPoint": {
          "lat": 47.63098,
          "lon": -122.14329
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.63155,
            "lon": -122.14462
          }
        }
      ],
      "detourTime": -55
    },
    {
      "type": "POI",
      "id": "US/POI/p0/8596112",
      "score": 3.111,
      "dist": 161.17565489389224,
      "info": "search:ta:840531000465149-US",
      "poi": {
        "name": "BURGER KING",
        "phone": "+(1)-(425)-4535775",
        "brands": [
          {
            "name": "BURGER KING"
          }
        ],
        "categorySet": [
          {
            "id": 7315015
          }
        ],
        "url": "www.burgerking.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "fast food"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "11723",
        "streetName": "NE 8th St",
        "municipalitySubdivision": "Willburton, Bellevue",
        "municipality": "Bellevue",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivisionCode": "WA",
        "postalCode": "98005",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "11723 NE 8th St, Bellevue, WA 98005",
        "localName": "Bellevue",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.61683,
        "lon": -122.18338
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.61773,
          "lon": -122.18471
        },
        "btmRightPoint": {
          "lat": 47.61593,
          "lon": -122.18205
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.61723,
            "lon": -122.1834
          }
        }
      ],
      "detourTime": 12
    }
  ]
}

定義

名前	説明
Address	結果のアドレス
AddressRanges	検索結果の番地の両側のアドレス範囲について説明します。アドレス範囲の開始位置と終了位置の座標が含まれます。
BoundingBox	ビューポートの左上と右下の座標で表される結果をカバーするビューポート。
BoundingBoxCompassNotation	場所の境界ボックス。
Brand	POI に関連付けられているブランド
Classification	返される POI の分類
ClassificationName	分類の名前
DataSources	省略可能なセクション。 Get Search Polygon API で使用する参照 ID。
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
Entity	境界ボックスのエンティティ型ソース。逆ジオコーディングの場合、これは常に位置と等しくなります。
EntryPoint	返される POI のエントリポイント。
EntryPointType	エントリポイントの種類。値には、メインまたはマイナーのいずれかを指定できます。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
GeographicEntityType	Geography エンティティ型。 entityType が要求され、使用可能な場合にのみ表示されます。
GeoJsonLineString	有効な `GeoJSON LineString` geometry 型。詳細については、 RFC 7946 を参照してください。
Geometry	結果の幾何学的形状に関する情報。型 == Geography の場合にのみ存在します。
LatLongPairAbbreviated	短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。
LocalizedMapView	View パラメーター ("user region" パラメーターとも呼ばれます) を使用すると、地政学的に紛争が発生している地域の特定の国/地域の正しいマップを表示できます。このようなリージョンのビューは国や地域によって異なり、View パラメーターを使用すると、アプリケーションが提供する国/地域に必要なビューにアプリケーションを準拠できます。既定では、要求で定義していない場合でも、View パラメーターは "Unified" に設定されます。ユーザーの場所を特定し、その場所を正しく View パラメーターを設定するのはユーザーの責任です。または、要求の IP アドレスに基づいてマップデータを返す 'View = Auto' を設定することもできます。 Azure Mapsの View パラメーターは、マップ、画像、その他のデータ、Azure Maps経由でアクセスする権限を持つ第三者のコンテンツが利用可能になる国/地域のマッピングに関する法律を含む、適用される法律に準拠して使用する必要があります。例: view=IN。詳細については、「サポートされているビュー」を参照し、使用可能なビューを参照してください。
MatchType	逆アドレス検索操作の一致の種類。
OperatingHours	POI (目的地) の営業時間。
OperatingHoursRange	POI (ポイントオブインタレスト) の操作時間。操作時間の可用性は、使用可能なデータによって異なります。渡されない場合、営業時間情報は返されません。サポートされている値: nextSevenDays
OperatingHoursTime	日付と時刻を表します
OperatingHoursTimeRange	1 日のオープン時間範囲
PointOfInterest	名前、電話番号、URL アドレス、分類などの情報を含む、返される POI の詳細。
PointOfInterestCategorySet	POI カテゴリ
QueryType	返されるクエリの種類: NEARBY または NON_NEAR。
ResponseFormat	応答の目的の形式。値には json または xml を指定できます。
SearchAddressResult	このオブジェクトは、正常なSearch呼び出しから返されます。
SearchAddressResultItem	Search API 応答の結果オブジェクト。
SearchAddressResultType	つぎのいずれかです。 POI Street [地理的な場所] ポイント住所アドレス範囲交差道路
SearchAlongRouteRequest	この型は、Search Along Route サービスの要求本文を表します。
SearchSummary	Search API 応答の Summary オブジェクト。

Address

結果のアドレス

名前	型	説明
boundingBox	BoundingBoxCompassNotation	場所の境界ボックス。
buildingNumber	string	通りの建物番号。非推奨です。代わりに streetNumber を使用してください。
country	string	国/地域名
countryCode	string	国 (注: 国/地域名ではなく、2 文字のコードです)。
countryCodeISO3	string	ISO alpha-3 国コード
countrySecondarySubdivision	string	County
countrySubdivision	string	都道府県
countrySubdivisionCode	string	`countrySubdivisionCode` プレフィックスは `countryCode` ( countryCode-countrySubdivisionCode ) で、ハイフンは ISO 3166-2 コードを形成します。例: テキサス州の場合は TX、スコットランドの場合は SCT、オンタリオ州の場合は ON。
countrySubdivisionName	string	国/地域管理階層の最初のレベルの完全名。このフィールドは、countrySubdivision が省略形で表示される場合にのみ表示されます。米国、カナダ、英国でのみサポートされています。
countryTertiarySubdivision	string	名前付き領域
crossStreet	string	交差している通りの名前。
extendedPostalCode	string	拡張郵便番号 (利用可能期間は地域によって異なります)。
freeformAddress	string	結果の元の国/地域の書式設定規則に従って書式設定された住所行、または国/地域の場合は完全な国/地域名。
localName	string	管理単位でなくても、アドレス指定の目的で複数のアドレス指定可能オブジェクトをグループ化する地理的領域または地域の名前を表すアドレスコンポーネント。このフィールドは、プロパティをビルドするために使用されます `freeformAddress` 。 `localName` は郵便市区町村を表します。場所に応じて、 `localName` は都市または町の一般的に知られている名前です。都市または町の一般的に知られている名前の場合は、ではなく `municipality`を使用`localName`します。
municipality	string	市区町村注: `municipality` は、居住区を表します。場所によっては、値が `municipality` 都市または町の一般的に知られている名前とは異なる場合があります。市区町村の一般的に知られている名前の場合は、値の代わりに`municipality`値を`localName`使用することをお勧めします。
municipalitySubdivision	string	サブ/スーパーシティ
neighbourhood	string	近隣は、都市または町内の地理的にローカライズされた地域であり、住民間の独特の特徴と社会的相互作用があります。
postalCode	string	郵便番号/郵便番号
routeNumbers	string[]	道路を明確に識別するために使用されるコード
street	string	通りの名前。非推奨です。代わりに streetName を使用してください。
streetName	string	通りの名前。
streetNameAndNumber	string	番地の名前と番号。
streetNumber	string	通りの建物番号。

AddressRanges

検索結果の番地の両側のアドレス範囲について説明します。アドレス範囲の開始位置と終了位置の座標が含まれます。

名前	型	説明
from	LatLongPairAbbreviated	短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。
rangeLeft	string	通りの左側の住所範囲。
rangeRight	string	通りの右側の住所範囲。
to	LatLongPairAbbreviated	短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。

BoundingBox

ビューポートの左上と右下の座標で表される結果をカバーするビューポート。

名前	型	説明
btmRightPoint	LatLongPairAbbreviated	短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。
topLeftPoint	LatLongPairAbbreviated	短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。

BoundingBoxCompassNotation

場所の境界ボックス。

名前	型	説明
entity	Entity	境界ボックスのエンティティ型ソース。逆ジオコーディングの場合、これは常に位置と等しくなります。
northEast	string	北東緯度、境界ボックスの経度座標 (コンマ区切り浮動小数点数)
southWest	string	南西緯度、境界ボックスの経度座標 (コンマ区切り浮動小数点数)

Brand

POI に関連付けられているブランド

名前	型	説明
name	string	ブランドの名前

Classification

返される POI の分類

名前	型	説明
code	string	code プロパティ
names	ClassificationName[]	Names 配列

ClassificationName

分類の名前

名前	型	説明
name	string	Name プロパティ
nameLocale	string	Name Locale プロパティ

DataSources

省略可能なセクション。 Get Search Polygon API で使用する参照 ID。

名前	型	説明
geometry	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	位置エンティティ

EntryPoint

返される POI のエントリポイント。

名前	型	説明
position	LatLongPairAbbreviated	短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。
type	EntryPointType	エントリポイントの種類。値には、メインまたはマイナーのいずれかを指定できます。

EntryPointType

エントリポイントの種類。値には、メインまたはマイナーのいずれかを指定できます。

名前	型	説明
main	string
minor	string

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

GeographicEntityType

Geography エンティティ型。 entityType が要求され、使用可能な場合にのみ表示されます。

名前	型	説明
Country	string	国/地域名
CountrySecondarySubdivision	string	County
CountrySubdivision	string	都道府県
CountryTertiarySubdivision	string	名前付き領域
Municipality	string	市区町村
MunicipalitySubdivision	string	サブ/スーパーシティ
Neighbourhood	string	近所
PostalCodeArea	string	郵便番号/郵便番号

GeoJsonLineString

有効な GeoJSON LineString geometry 型。詳細については、 RFC 7946 を参照してください。

名前	型	説明
coordinates	number[]	ジオメトリの `GeoJson LineString` 座標。
type	string: LineString	型を指定します `GeoJSON` 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

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	OperatingHoursTimeRange[]	次の 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	OperatingHoursTime	特定の POI が閉じられている次の 7 日間の範囲のポイント、または範囲の前に閉じられた場合は範囲の先頭。
startTime	OperatingHoursTime	特定の POI を開くときの次の 7 日間の範囲のポイント、または範囲の前に開かれた場合は範囲の先頭。

PointOfInterest

名前、電話番号、URL アドレス、分類などの情報を含む、返される POI の詳細。

名前	型	説明
brands	Brand[]	ブランド配列。返される POI のブランド名。
categories	string[]	Categories 配列
categorySet	PointOfInterestCategorySet[]	最も具体的な POI カテゴリの一覧
classifications	Classification[]	分類配列
name	string	POI プロパティの名前
openingHours	OperatingHours	POI (目的地) の営業時間。
phone	string	電話番号プロパティ
url	string	Web サイトの URL プロパティ

PointOfInterestCategorySet

POI カテゴリ

名前	型	説明
id	integer	カテゴリ ID。

QueryType

返されるクエリの種類: NEARBY または NON_NEAR。

名前	型	説明
NEARBY	string	Searchは、定義された半径を持つ特定の緯度と経度を中心に実行されました
NON_NEAR	string	Searchは、特定の緯度と経度に偏らず、半径が定義されていない、グローバルに実行されました

ResponseFormat

応答の目的の形式。値には json または xml を指定できます。

名前	型	説明
json	string	JavaScript オブジェクト表記データ交換形式
xml	string	拡張可能なマークアップ言語

SearchAddressResult

このオブジェクトは、正常なSearch呼び出しから返されます。

名前	型	説明
results	SearchAddressResultItem[]	SEARCH API の結果の一覧。
summary	SearchSummary	Search API 応答の Summary オブジェクト

SearchAddressResultItem

Search API 応答の結果オブジェクト。

名前	型	説明
address	Address	結果のアドレス
addressRanges	AddressRanges	検索結果の番地の両側のアドレス範囲について説明します。アドレス範囲の開始位置と終了位置の座標が含まれます。
dataSources	DataSources	省略可能なセクション。 Get Search Polygon API で使用する参照ジオメトリ ID。
detourTime	integer	迂回時間 (秒単位)。 Search Along Route API の呼び出しに対してのみ返されます。
dist	number	結果とジオビアスの位置の間の直線距離 (メートル単位)。
entityType	GeographicEntityType	Geography エンティティ型。 entityType が要求され、使用可能な場合にのみ表示されます。
entryPoints	EntryPoint[]	EntryPoints の配列。これらは、場所で利用可能な入り口の種類を説明します。種類は、フロントドアやロビーなどのメインの入り口には "メイン"、サイドドアとバックドアの場合は "マイナー" です。
id	string	Id プロパティ
info	string	結果の元のデータソースに関する情報。サポート要求に使用されます。
matchType	MatchType	一致の種類に関する情報。つぎのいずれかです。 AddressPoint HouseNumberRange Street
poi	PointOfInterest	名前、電話番号、URL アドレス、分類などの情報を含む、返される POI の詳細。
position	LatLongPairAbbreviated	短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。
score	number	結果セット内の値。結果間の相対的な一致スコアを示します。これを使用して、x の値が y の値の 2 倍の場合、結果 x が結果 y の 2 倍の関連性を持つ可能性があることを判断できます。値はクエリによって異なり、1 つの結果セットの相対値としてのみ使用されます。
type	SearchAddressResultType	つぎのいずれかです。 POI Street [地理的な場所] ポイント住所アドレス範囲交差道路
viewport	BoundingBox	ビューポートの左上と右下の座標で表される結果をカバーするビューポート。

SearchAddressResultType

つぎのいずれかです。

POI
Street
[地理的な場所]
ポイント住所
アドレス範囲
交差道路

名前	型	説明
Address Range	string
Cross Street	string
Geography	string
POI	string
Point Address	string
Street	string

SearchAlongRouteRequest

この型は、Search Along Route サービスの要求本文を表します。

名前	型	説明
route	GeoJsonLineString	有効な `GeoJSON LineString` geometry 型。詳細については、 RFC 7946 を参照してください。

SearchSummary

Search API 応答の Summary オブジェクト。

名前	型	説明
fuzzyLevel	integer	結果を提供するために必要な最大あいまいレベル。
geoBias	LatLongPairAbbreviated	内部検索エンジンが地理空間バイアスを適用して結果のランク付けを向上させるタイミングを示します。一部のメソッドでは、lat パラメーターと lon パラメーターを使用可能な場合に設定すると、これが影響を受ける可能性があります。それ以外の場合は、純粋に内部的です。
limit	integer	返される応答の最大数
numResults	integer	応答の結果の数。
offset	integer	完全な結果セット内の返された結果の開始オフセット。
query	string	これらの検索結果を生成するために使用されたクエリパラメーター。
queryTime	integer	クエリの解決に費やされた時間 (ミリ秒単位)。
queryType	QueryType	返されるクエリの種類: NEARBY または NON_NEAR。
totalResults	integer	検出された結果の合計数。