Search - Get Search POI Category

リファレンス

サービス:: Maps

API バージョン:: 1.0

カテゴリ別に目的地を検索するために使用します。

Get Search POI Category API は、特定のカテゴリから POI の結果を要求できる HTTP GET 要求です。一度に 1 つのカテゴリの POI を照会するのに役立ちます。エンドポイントは、指定されたカテゴリに分類された POI 結果のみを返します。応答には、住所、座標位置、分類などの POI の詳細が含まれます。

GET https://atlas.microsoft.com/search/poi/category/{format}?api-version=1.0&query={query}

省略可能なパラメーターを含む:

GET https://atlas.microsoft.com/search/poi/category/{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	ResponseFormat	応答の目的の形式。値は、json することも、xml することもできます。
api-version	query	True	string	Azure Maps API のバージョン番号。
query	query	True	string	検索する POI カテゴリ (例: "AIRPORT"、"RESTAURANT") は、正しく URL エンコードされている必要があります。サポートされている主なカテゴリは、get Search POI Category Tree API 呼び出すことによって要求できます。使用可能なカテゴリの一覧については、Azure Maps でサポートされているカテゴリを参照してください。 POI 検索カテゴリツリー API を使用して、サポートされているカテゴリを要求することをお勧めします。
brandSet	query		string[]	結果を特定のブランドに制限するために使用できるブランド名のコンマ区切りのリスト。品目の順序は関係ありません。複数のブランドが提供されている場合は、提供されたリストの 1 つ (少なくとも) に属する結果のみが返されます。名前に "," を含むブランドは、引用符で囲む必要があります。使用例: brandSet=Foo brandSet=Foo,Bar brandSet="A,B,C コンマ",Bar
btmRight	query		string	境界ボックスの右下の位置。例: 37.553、-122.453
categorySet	query		integer[]	結果を特定の目的地カテゴリに制限するために使用できるカテゴリセット ID のコンマ区切りのリスト。 ID の順序は関係ありません。要求ごとにサポートされる `categorySet` 値の最大数は 10 です。複数のカテゴリ識別子を指定すると、指定されたリストのカテゴリの 1 つ (少なくとも) に属する POI のみが返されます。サポートされているカテゴリの一覧は、POI カテゴリ API を使用して検出できます。使用例: categorySet=7315 (カテゴリレストランから目的地を検索) categorySet=7315025,7315017 (イタリア料理またはフレンチレストランのカテゴリの目的地を検索)
connectorSet	query		ElectricVehicleConnector[]	特定のコネクタの種類をサポートする電気自動車ステーションに結果を制限するために使用できるコネクタの種類のコンマ区切りの一覧。品目の順序は関係ありません。複数のコネクタの種類が指定されている場合は、指定されたリストの 1 つ (少なくとも) に属する結果のみが返されます。使用可能なコネクタの種類は次のとおりです。 `StandardHouseholdCountrySpecific` - 特定のリージョンの標準的な家庭用コネクタです。それらはすべてAC単相であり、標準的な電圧および標準的なアンペア数である。「プラグ & ソケットタイプ - 世界標準」も参照してください。 `IEC62196Type1` - IEC 62196-2 標準で定義されているタイプ 1 コネクタ。また、最初にそれを公開した標準の後に、元のメーカーまたはSAE J1772の後に矢崎と呼ばれます。主に120V単相または最大240V単相インフラストラクチャと組み合わせて使用されます。 `IEC62196Type1CCS` - IEC 62196-3 標準で定義されているタイプ 1 ベースのコンボコネクタ。コネクタは、IEC 62196-2 標準で定義されている Type 1 コネクタに基づいており、DC 高速充電を可能にする 2 つの追加の直流 (DC) 接点を備えています。 `IEC62196Type2CableAttached` - IEC 62196-2 標準で定義されているタイプ 2 コネクタ。充電ポイントに取り付けられたケーブルとプラグとして提供されます。 `IEC62196Type2Outlet` - IEC 62196-2 標準で定義されているタイプ 2 コネクタ。充電ポイントにセットされたソケットとして提供されます。 `IEC62196Type2CCS` - IEC 62196-3 標準で定義されているタイプ 2 ベースのコンボコネクタ。コネクタは、IEC 62196-2 標準で定義されている Type 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 Supercharger コネクタです。つまり、テスラ独自のコネクタを指します。これは、主に北米に限定されたテスラポートまたはヨーロッパの変更されたタイプ2(DC over Type 2)と呼ばれることもあります。使用例: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
countrySet	query		string[]	国/地域コードのコンマ区切り文字列 (FR、ES など)。これにより、指定した国/地域に検索が制限されます
extendedPostalCodesFor	query		SearchIndexes[]	結果に拡張郵便番号を含める必要があるインデックス。使用可能なインデックスは次のとおりです。 Addr = アドレス範囲 geo = Geographies PAD = ポイントアドレス POI = 目的地 Str = 道路 XStr = クロスストリート (交差点) 値は、インデックスの種類のコンマ区切りのリスト (任意の順序) またはインデックスがない場合は [なし] する必要があります。既定では、Geo を除くすべてのインデックスに拡張郵便番号が含まれます。地域の拡張郵便番号リストは非常に長い場合があるため、必要に応じて明示的に要求する必要があります。使用例: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None 拡張郵便番号は、住所の extendedPostalCode プロパティとして返されます。可用性はリージョンに依存します。
language	query		string	検索結果を返す言語。サポートされている IETF 言語タグの 1 つである必要があります。大文字と小文字は区別されません。指定した言語のデータが特定のフィールドで使用できない場合は、既定の言語が使用されます。詳細については、サポートされている言語のを参照してください。
lat	query		number (double)	結果が偏る緯度。例: 37.337
limit	query		integer minimum: 1 maximum: 100	返される応答の最大数。既定値: 10、最小: 1、最大: 100
lon	query		number (double)	結果をバイアスする必要がある経度。例: -121.89
ofs	query		integer minimum: 0 maximum: 1900	完全な結果セット内の返された結果の開始オフセット。既定値は0
openingHours	query		OperatingHoursRange	POI の操作時間 (目的地)。操作時間の可用性は、使用可能なデータによって異なります。合格しなかった場合、営業時間情報は返されません。サポートされる値: nextSevenDays
radius	query		integer	結果が定義された領域に制限される範囲の半径 (メートル単位)
topLeft	query		string	境界ボックスの左上の位置。例: 37.553、-122.453
typeahead	query		boolean	ブーリアン。先行入力フラグが設定されている場合、クエリは部分的な入力として解釈され、検索は予測モードになります
view	query		LocalizedMapView	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 セキュリティを使用するには、ガイダンス次の記事を参照してください。

応答

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

セキュリティ

AADToken

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

シナリオを実装するには、認証の概念表示することをお勧めします。要約すると、このセキュリティ定義は、特定の 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 ATM's within 2 miles of Times Square NY and return the top 3 results

要求のサンプル

HTTP

GET https://atlas.microsoft.com/search/poi/category/json?api-version=1.0&query=atm&limit=3&lat=40.758953&lon=-73.985263&radius=3200&openingHours=nextSevenDays

応答のサンプル

状態コード:: 200

{
  "summary": {
    "query": "atm",
    "queryType": "NON_NEAR",
    "queryTime": 28,
    "numResults": 3,
    "offset": 0,
    "totalResults": 3696,
    "fuzzyLevel": 1,
    "geoBias": {
      "lat": 40.758953,
      "lon": -73.985263
    }
  },
  "results": [
    {
      "type": "POI",
      "id": "US/POI/p0/7014613",
      "score": 2.575,
      "dist": 10.743802093311858,
      "info": "search:ta:840369001846523-US",
      "poi": {
        "name": "FISERV MASTERMONEY",
        "categorySet": [
          {
            "id": 7397
          }
        ],
        "classifications": [
          {
            "code": "CASH_DISPENSER",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "cash dispenser"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "1560",
        "streetName": "Broadway",
        "municipalitySubdivision": "Times Square, New York, Midtown",
        "municipality": "New York, Manhattan",
        "countrySecondarySubdivision": "New York",
        "countryTertiarySubdivision": "Manhattan",
        "countrySubdivisionCode": "NY",
        "postalCode": "10036",
        "extendedPostalCode": "100361517",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "1560 Broadway, New York, NY 10036",
        "localName": "New York",
        "countrySubdivisionName": "New York"
      },
      "position": {
        "lat": 40.75901,
        "lon": -73.98516
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 40.75991,
          "lon": -73.98635
        },
        "btmRightPoint": {
          "lat": 40.75811,
          "lon": -73.98397
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 40.75902,
            "lon": -73.98522
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "US/POI/p1/6830011",
      "score": 2.575,
      "dist": 58.68107354501256,
      "info": "search:ta:840369011803697-US",
      "poi": {
        "name": "METABANK",
        "categorySet": [
          {
            "id": 7397
          }
        ],
        "classifications": [
          {
            "code": "CASH_DISPENSER",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "cash dispenser"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "1567",
        "streetName": "Broadway",
        "municipalitySubdivision": "Times Square, New York, Midtown",
        "municipality": "New York, Manhattan",
        "countrySecondarySubdivision": "New York",
        "countryTertiarySubdivision": "Manhattan",
        "countrySubdivisionCode": "NY",
        "postalCode": "10036",
        "extendedPostalCode": "100361517",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "1567 Broadway, New York, NY 10036",
        "localName": "New York",
        "countrySubdivisionName": "New York"
      },
      "position": {
        "lat": 40.75937,
        "lon": -73.98569
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 40.76027,
          "lon": -73.98688
        },
        "btmRightPoint": {
          "lat": 40.75847,
          "lon": -73.9845
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 40.75924,
            "lon": -73.98513
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "US/POI/p1/6830013",
      "score": 2.575,
      "dist": 55.009653221373966,
      "info": "search:ta:840369010525390-US",
      "poi": {
        "name": "ATM",
        "categorySet": [
          {
            "id": 7397
          }
        ],
        "classifications": [
          {
            "code": "CASH_DISPENSER",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "cash dispenser"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "1552",
        "streetName": "Broadway",
        "municipalitySubdivision": "Times Square, New York, Midtown",
        "municipality": "New York, Manhattan",
        "countrySecondarySubdivision": "New York",
        "countryTertiarySubdivision": "Manhattan",
        "countrySubdivisionCode": "NY",
        "postalCode": "10036",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "1552 Broadway, New York, NY 10036",
        "localName": "New York",
        "countrySubdivisionName": "New York"
      },
      "position": {
        "lat": 40.75873,
        "lon": -73.98468
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 40.75963,
          "lon": -73.98587
        },
        "btmRightPoint": {
          "lat": 40.75783,
          "lon": -73.98349
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 40.7588,
            "lon": -73.98492
          }
        }
      ]
    }
  ]
}

定義

名前	説明
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 標準で定義されている Type 1 コネクタに基づいており、DC 高速充電を可能にする 2 つの追加の直流 (DC) 接点を備えています。 `IEC62196Type2CableAttached` - IEC 62196-2 標準で定義されているタイプ 2 コネクタ。充電ポイントに取り付けられたケーブルとプラグとして提供されます。 `IEC62196Type2Outlet` - IEC 62196-2 標準で定義されているタイプ 2 コネクタ。充電ポイントにセットされたソケットとして提供されます。 `IEC62196Type2CCS` - IEC 62196-3 標準で定義されているタイプ 2 ベースのコンボコネクタ。コネクタは、IEC 62196-2 標準で定義されている Type 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 Supercharger コネクタです。つまり、テスラ独自のコネクタを指します。これは、主に北米に限定されたテスラポートまたはヨーロッパの変更されたタイプ2(DC over Type 2)と呼ばれることもあります。使用例: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
Entity	境界ボックスのエンティティ型ソース。逆ジオコーディングの場合、これは常に位置と等しくなります。
EntryPoint	返される POI のエントリポイント。
EntryPointType	エントリポイントの種類。値は、メインすることも、マイナーすることもできます。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
GeographicEntityType	Geography エンティティ型。 entityType が要求され、使用可能な場合にのみ存在します。
Geometry	結果の幾何学的形状に関する情報。型 == Geography の場合にのみ存在します。
LatLongPairAbbreviated	短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。
LocalizedMapView	View パラメーター ("ユーザーリージョン" パラメーターとも呼ばれます) を使用すると、地政学的に紛争が生じしている地域の特定の国/地域の正しいマップを表示できます。このようなリージョンのビューは国や地域によって異なります。また、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 通り地理学ポイント住所アドレス範囲交差道路
SearchIndexes	結果に拡張郵便番号を含める必要があるインデックス。使用可能なインデックスは次のとおりです。 Addr = アドレス範囲 geo = Geographies PAD = ポイントアドレス POI = 目的地 Str = 道路 XStr = クロスストリート (交差点) 値は、インデックスの種類のコンマ区切りのリスト (任意の順序) またはインデックスがない場合は [なし] する必要があります。既定では、Geo を除くすべてのインデックスに拡張郵便番号が含まれます。地域の拡張郵便番号リストは非常に長い場合があるため、必要に応じて明示的に要求する必要があります。使用例: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None 拡張郵便番号は、住所の extendedPostalCode プロパティとして返されます。可用性はリージョンに依存します。
SearchSummary	Search API 応答の概要オブジェクト。

Address

Object

結果のアドレス

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

AddressRanges

Object

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

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

BoundingBox

Object

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

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

BoundingBoxCompassNotation

Object

場所の境界ボックス。

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

Brand

Object

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

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

Classification

Object

返される POI の分類

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

ClassificationName

Object

分類の名前

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

DataSources

Object

省略可能なセクション。 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 標準で定義されている Type 1 コネクタに基づいており、DC 高速充電を可能にする 2 つの追加の直流 (DC) 接点を備えています。
IEC62196Type2CableAttached - IEC 62196-2 標準で定義されているタイプ 2 コネクタ。充電ポイントに取り付けられたケーブルとプラグとして提供されます。
IEC62196Type2Outlet - IEC 62196-2 標準で定義されているタイプ 2 コネクタ。充電ポイントにセットされたソケットとして提供されます。
IEC62196Type2CCS - IEC 62196-3 標準で定義されているタイプ 2 ベースのコンボコネクタ。コネクタは、IEC 62196-2 標準で定義されている Type 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 Supercharger コネクタです。つまり、テスラ独自のコネクタを指します。これは、主に北米に限定されたテスラポートまたはヨーロッパの変更されたタイプ2(DC over Type 2)と呼ばれることもあります。

使用例:

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached

値	説明
Chademo	東京電力と産業パートナーが設立した協会にちなんだCHAdeMOコネクタ。このため、東京電力のコネクタとも呼ばれています。これは、高速DC充電をサポートしています。
IEC60309AC1PhaseBlue	Industrial Blue コネクタは、IEC 60309 標準で定義されているコネクタです。これは、標準、色、および単一フェーズコネクタであるという事実の何らかの組み合わせによって呼ばれることがあります。コネクタには通常、"P+N+E, 6h" 構成があります。
IEC60309DCWhite	産業用ホワイトコネクタは、IEC 60309 標準で定義されている DC コネクタです。
IEC62196Type1	IEC 62196-2 標準で定義されているタイプ 1 コネクタ。また、最初にそれを公開した標準の後に、元のメーカーまたはSAE J1772の後に矢崎と呼ばれます。主に120V単相または最大240V単相インフラストラクチャと組み合わせて使用されます。
IEC62196Type1CCS	IEC 62196-3 標準で定義されているタイプ 1 ベースのコンボコネクタ。コネクタは、IEC 62196-2 標準で定義されている Type 1 コネクタに基づいており、DC 高速充電を可能にする 2 つの追加の直流 (DC) 接点を備えています。
IEC62196Type2CCS	IEC 62196-3 標準で定義されているタイプ 2 ベースのコンボコネクタ。コネクタは、IEC 62196-2 標準で定義されている Type 2 コネクタに基づいており、DC 高速充電を可能にする 2 つの追加の直流 (DC) 接点を備えています。
IEC62196Type2CableAttached	IEC 62196-2 標準で定義されているタイプ 2 コネクタ。充電ポイントに取り付けられたケーブルとプラグとして提供
IEC62196Type2Outlet	IEC 62196-2 標準で定義されているタイプ 2 コネクタ。充電ポイントにセットされたソケットとして提供されます。
IEC62196Type3	IEC 62196-2 標準で定義されているタイプ 3 コネクタ。また、元のメーカーの後にスカメと呼ばれます。主に最大240Vの単相または最大420Vの3相インフラストラクチャと組み合わせて使用されます。
StandardHouseholdCountrySpecific	これらは、特定のリージョンの標準的な家庭用コネクタです。それらはすべてAC単相であり、標準的な電圧および標準的なアンペア数である。「プラグ & ソケットタイプ - 世界標準
Tesla	Tesla コネクタは、地域固有の Tesla Supercharger コネクタです。つまり、テスラ独自のコネクタを指します。これは、主に北米に限定されたテスラポートまたはヨーロッパの変更されたタイプ2(DC over Type 2)と呼ばれることもあります。

Entity

列挙

境界ボックスのエンティティ型ソース。逆ジオコーディングの場合、これは常に位置と等しくなります。

値	説明
position	位置エンティティ

EntryPoint

Object

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

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

EntryPointType

列挙

エントリポイントの種類。値は、メインすることも、マイナーすることもできます。

値	説明
main
minor

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

GeographicEntityType

列挙

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

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

Geometry

Object

結果の幾何学的形状に関する情報。型 == Geography の場合にのみ存在します。

名前	型	説明
id	string	これを geometryId として Get Search Polygon API に渡して、この結果のジオメトリ情報をフェッチします。

LatLongPairAbbreviated

Object

短い名前 '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

Object

POI (目的地) の営業時間。

名前	型	説明
mode	string	要求で使用される値: none または "nextSevenDays"
timeRanges	OperatingHoursTimeRange[]	次の 7 日間の時間範囲の一覧

OperatingHoursRange

列挙

POI の操作時間 (目的地)。操作時間の可用性は、使用可能なデータによって異なります。合格しなかった場合、営業時間情報は返されません。サポートされる値: nextSevenDays

値	説明
nextSevenDays	POI の現地時刻の現在の日から始まる、次の週の操作時間を示します。

OperatingHoursTime

Object

日付と時刻を表します

名前	型	説明
date	string	POI タイムゾーンの現在のカレンダー日付を表します (例: "2019-02-07")。
hour	integer	時間は POI の現地時刻の 24 時間形式です。指定できる値は 0 から 23 です。
minute	integer	分は POI の現地時刻です。指定できる値は 0 から 59 です。

OperatingHoursTimeRange

Object

1 日の開いている時間範囲

名前	型	説明
endTime	OperatingHoursTime	特定の POI が閉じられているときの次の 7 日間の範囲のポイント。範囲の前に閉じられた場合は範囲の先頭。
startTime	OperatingHoursTime	特定の POI を開くときの次の 7 日間の範囲のポイント。範囲の前に開かれた場合は範囲の先頭。

PointOfInterest

Object

名前、電話番号、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

Object

POI カテゴリ

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

QueryType

列挙

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

値	説明
NEARBY	半径が定義された特定の緯度と経度を中心に検索が実行されました
NON_NEAR	特定の緯度と経度に偏らず、半径が定義されていない、グローバルに検索が実行されました

ResponseFormat

列挙

応答の目的の形式。値は、json することも、xml することもできます。

値	説明
json	JavaScript オブジェクト表記データ交換形式をする
xml	拡張マークアップ言語をする

SearchAddressResult

Object

このオブジェクトは、成功した Search 呼び出しから返されます。

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

SearchAddressResultItem

Object

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

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

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

SearchSummary

Object

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

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

次の方法で共有

Search - Get Search POI Category

URI パラメーター

要求ヘッダー

応答

セキュリティ

AADToken

スコープ

subscription-key

SAS Token

例

Search for ATM's within 2 miles of Times Square NY and return the top 3 results

要求のサンプル

応答のサンプル

定義

Address

AddressRanges

BoundingBox

BoundingBoxCompassNotation

Brand

Classification

ClassificationName

DataSources

ElectricVehicleConnector

Entity

EntryPoint

EntryPointType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeographicEntityType

Geometry

LatLongPairAbbreviated

LocalizedMapView

MatchType

OperatingHours

OperatingHoursRange

OperatingHoursTime

OperatingHoursTimeRange

PointOfInterest

PointOfInterestCategorySet

QueryType

ResponseFormat

SearchAddressResult

SearchAddressResultItem

SearchAddressResultType

SearchIndexes

SearchSummary