Search - Get Search POI Category

  • リファレンス
Service:
Maps
API Version:
1.0

カテゴリ別に関心のあるポイントを検索する場合に使用します。

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

GET https://atlas.microsoft.com/search/poi/category/{format}?api-version=1.0&query={query}
With optional parameters: 
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 Searchカテゴリ ツリー 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 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 - 産業用ホワイト コネクタは、IEC 60309 標準で定義されている DC コネクタです。
  • Tesla - Tesla コネクタは、地域固有の Tesla スーパーチャージャー コネクタです。 つまり、テスラ独自のコネクタを指します。テスラポートは、主に北米に限られているか、ヨーロッパでは修正されたタイプ2(DC over Type 2)と呼ばれることもあります。

使用例:

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
countrySet
 query

string[]

国/地域コードのコンマ区切り文字列 (FR、ES など)。 これにより、指定した国/地域に検索が制限されます
extendedPostalCodesFor
 query

SearchIndexes[]

結果に拡張郵便番号を含める必要があるインデックス。

使用可能なインデックスは次のとおりです。

Addr = アドレス範囲

Geo = Geographies

PAD = ポイント アドレス

POI = 関心のあるポイント

Str = Streets

XStr = クロス ストリート (交差)

値は、インデックスの種類のコンマ区切りのリスト (任意の順序) またはインデックスがない場合 は None にする必要があります。

既定では、Geo を除くすべてのインデックスに拡張郵便番号が含まれます。 地域の拡張郵便番号リストは非常に長い場合があるため、必要に応じて明示的に要求する必要があります。

使用例:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,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
openingHours
 query

OperatingHoursRange

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

integer

結果を定義された領域に制限するための半径 (メートル単位)
topLeft
 query

string

境界ボックスの左上の位置。 例: 37.553、-122.453
typeahead
 query

boolean

ブール型。 typeahead フラグが設定されている場合、クエリは部分的な入力として解釈され、検索は予測モードになります
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セキュリティを使用するには、ガイダンスについては、次の記事を参照してください。

応答

名前 型 説明
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 を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 プラットフォームの概要」を参照してください。

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 ATM's within 2 miles of Times Square NY and return the top 3 results

Sample Request

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

Sample Response

Status code:
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 標準で定義されているタイプ 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 が要求され、使用可能な場合にのみ表示されます。
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
  • [地理的な場所]
  • ポイント住所
  • アドレス範囲
  • 交差道路
SearchIndexes

結果に拡張郵便番号を含める必要があるインデックス。

使用可能なインデックスは次のとおりです。

Addr = アドレス範囲

Geo = Geographies

PAD = ポイント アドレス

POI = 関心のあるポイント

Str = Streets

XStr = クロス ストリート (交差)

値は、インデックスの種類のコンマ区切りのリスト (任意の順序) またはインデックスがない場合 は None にする必要があります。

既定では、Geo を除くすべてのインデックスに拡張郵便番号が含まれます。 地域の拡張郵便番号リストは非常に長い場合があるため、必要に応じて明示的に要求する必要があります。

使用例:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

拡張郵便番号は、住所の extendedPostalCode プロパティとして返されます。 可用性はリージョンによって異なります。
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

国/地域管理階層の第 1 レベルの完全名。 このフィールドは、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[]

名前配列

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

Position エンティティ

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

郵便番号/郵便番号

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

SearchIndexes

結果に拡張郵便番号を含める必要があるインデックス。

使用可能なインデックスは次のとおりです。

Addr = アドレス範囲

Geo = Geographies

PAD = ポイント アドレス

POI = 関心のあるポイント

Str = Streets

XStr = クロス ストリート (交差)

値は、インデックスの種類のコンマ区切りのリスト (任意の順序) またはインデックスがない場合 は None にする必要があります。

既定では、Geo を除くすべてのインデックスに拡張郵便番号が含まれます。 地域の拡張郵便番号リストは非常に長い場合があるため、必要に応じて明示的に要求する必要があります。

使用例:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

拡張郵便番号は、住所の extendedPostalCode プロパティとして返されます。 可用性はリージョンによって異なります。

名前 型 説明
Addr

string

Geo

string

PAD

string

POI

string

Str

string

Xstr

string

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

検出された結果の合計数。