Search - Get Search Polygon

を使用して、都市や国の地域などの地理的エリア図形の多角形データを取得します。

Get Polygon API は、以前に GeoJSON 形式のオンライン検索要求から取得した一連のエンティティの市区町村や国/地域のアウトラインなどのジオメトリ データを返す HTTP GET 要求です。 geometry ID は、Search Address または Search Fuzzy 呼び出しの "geometry" と "id" の下のオブジェクトで返されますsourceGeometry

オンライン検索エンドポイントから取得されたジオメトリ ID の有効期間は限られています。後で紹介するために、ジオメトリ ID を永続ストレージに格納することはお勧めしません。 Polygon メソッドへの要求は、ID を提供したオンライン検索メソッドに対する要求から数分以内に行われる必要があります。 このサービスでは、最大 20 個の識別子をバッチ要求できます。

GET https://atlas.microsoft.com/search/polygon/json?api-version=1.0&geometries={geometries}

URI パラメーター

名前 / 必須 説明
format
path True

JsonFormat

応答の目的の形式。 サポートされているのは json 形式のみです。

api-version
query True

string

Azure Maps API のバージョン番号。

geometries
query True

string[]

オンライン検索要求から以前に取得したジオメトリ UUID のコンマ区切りリスト。

要求ヘッダー

名前 必須 説明
x-ms-client-id

string

Microsoft Entra ID セキュリティ モデルと組み合わせて使用するアカウントを指定します。 Azure Maps アカウントの一意の ID を表し、Azure Maps管理プレーン アカウント API から取得できます。 Azure MapsでMicrosoft Entra IDセキュリティを使用するには、ガイダンスについては、次の記事を参照してください。

応答

名前 説明
200 OK

PolygonResult

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

型: 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

要求のサンプル

GET https://atlas.microsoft.com/search/polygon/json?api-version=1.0&geometries=8bceafe8-3d98-4445-b29b-fd81d3e9adf5,00005858-5800-1200-0000-0000773694ca

応答のサンプル

{
  "additionalData": [
    {
      "providerID": "1111-2222-32-4444444444444",
      "geometryData": {
        "type": "FeatureCollection",
        "features": [
          {
            "type": "Feature",
            "properties": {},
            "geometry": {
              "type": "Polygon",
              "coordinates": [
                [
                  [
                    -122.0665062,
                    47.6496252
                  ],
                  [
                    -122.0664863,
                    47.6496113
                  ],
                  [
                    -122.0664843,
                    47.6496014
                  ],
                  [
                    -122.0663693,
                    47.6495247
                  ],
                  [
                    -122.0663017,
                    47.6494664
                  ],
                  [
                    -122.0662679,
                    47.6494247
                  ],
                  [
                    -122.0661647,
                    47.6493314
                  ],
                  [
                    -122.067177,
                    47.649298
                  ],
                  [
                    -122.090715,
                    47.6543598
                  ],
                  [
                    -122.0907846,
                    47.6542921
                  ],
                  [
                    -122.0908284,
                    47.6542603
                  ]
                ]
              ]
            },
            "id": "1111-2222-32-4444444444444"
          }
        ]
      }
    }
  ]
}

定義

名前 説明
ErrorAdditionalInfo

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

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

GeoJsonFeature

有効な GeoJSON Feature オブジェクト型。 詳細については、 RFC 7946 を参照してください。

GeoJsonFeatureCollection

有効な GeoJSON FeatureCollection オブジェクト型。 詳細については、 RFC 7946 を参照してください。

GeoJsonGeometry

有効な GeoJSON geometry オブジェクト。 この型は、Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection の 7 つの有効な GeoJSON ジオメトリ型のいずれかである必要があります。 詳細については、 RFC 7946 を参照してください。

GeoJsonGeometryCollection

有効な GeoJSON GeometryCollection オブジェクト型。 詳細については、 RFC 7946 を参照してください。

GeoJsonLineString

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

GeoJsonMultiLineString

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

GeoJsonMultiPoint

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

GeoJsonMultiPolygon

有効な GeoJSON MultiPolygon オブジェクト型。 詳細については、 RFC 7946 を参照してください。

GeoJsonPoint

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

GeoJsonPolygon

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

JsonFormat

応答の目的の形式。 サポートされているのは json 形式のみです。

Polygon
PolygonResult

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

ErrorAdditionalInfo

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

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細です。

message

string

エラー メッセージ。

target

string

エラーのターゲット。

ErrorResponse

エラー応答

名前 説明
error

ErrorDetail

error オブジェクト。

GeoJsonFeature

有効な GeoJSON Feature オブジェクト型。 詳細については、 RFC 7946 を参照してください。

名前 説明
featureType

string

機能の種類です。 この値は、現在の特徴が含まれるデータ モデルによって異なります。 一部のデータ モデルには空の値が含まれる場合があります。

geometry GeoJsonGeometry:

有効な GeoJSON geometry オブジェクト。 この型は、Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection の 7 つの有効な GeoJSON ジオメトリ型のいずれかである必要があります。 詳細については、 RFC 7946 を参照してください。

id

string

機能の識別子。

type string:

Feature

型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonFeatureCollection

有効な GeoJSON FeatureCollection オブジェクト型。 詳細については、 RFC 7946 を参照してください。

名前 説明
features

GeoJsonFeature[]

有効な GeoJSON Feature オブジェクトの一覧を格納します。

type string:

FeatureCollection

型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonGeometry

有効な GeoJSON geometry オブジェクト。 この型は、Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection の 7 つの有効な GeoJSON ジオメトリ型のいずれかである必要があります。 詳細については、 RFC 7946 を参照してください。

名前 説明
type

GeoJsonObjectType

型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonGeometryCollection

有効な GeoJSON GeometryCollection オブジェクト型。 詳細については、 RFC 7946 を参照してください。

名前 説明
geometries GeoJsonGeometry[]:

有効な GeoJSON geometry オブジェクトの一覧を格納します。 GeoJSON の座標は x、y の順序 (経度、緯度) であることに注意してください。

type string:

GeometryCollection

型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

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 オブジェクトの種類のいずれかである必要があります。

GeoJsonMultiLineString

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

名前 説明
coordinates

number[]

ジオメトリの GeoJson MultiLineString 座標。

type string:

MultiLineString

型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonMultiPoint

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

名前 説明
coordinates

number[]

ジオメトリの GeoJson MultiPoint 座標。

type string:

MultiPoint

型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonMultiPolygon

有効な GeoJSON MultiPolygon オブジェクト型。 詳細については、 RFC 7946 を参照してください。

名前 説明
coordinates

number[]

有効な GeoJSON Polygon オブジェクトの一覧を格納します。 GeoJSON の座標は x、y の順序 (経度、緯度) であることに注意してください。

type string:

MultiPolygon

型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonPoint

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

名前 説明
coordinates

number[]

Position 、2 つ以上の要素を持つ数値の配列です。 最初の 2 つの要素は 経度緯度で、正確にはその順序です。 高度/標高 は、省略可能な 3 番目の要素です。 詳細については、 RFC 7946 を参照してください。

type string:

Point

型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonPolygon

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

名前 説明
coordinates

number[]

ジオメトリタイプの GeoJson Polygon 座標。

type string:

Polygon

型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

JsonFormat

応答の目的の形式。 サポートされているのは json 形式のみです。

名前 説明
json

string

JavaScript オブジェクト表記データ交換形式

Polygon

名前 説明
geometryData GeoJsonObject:

GeoJSON 形式のジオメトリ データ。 詳細については、 RFC 7946 を参照してください。 "error" が存在しない場合にのみ表示されます。

providerID

string

返されたエンティティの ID

PolygonResult

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

名前 説明
additionalData

Polygon[]

結果の配列