Search - Get Polygon

Usługa:: Maps

Wersja interfejsu API:: 2026-01-01

Służy do pobierania danych wielokątnych kształtu obszaru geograficznego, takiego jak miasto lub region kraju.
Interfejs Get Polygon API to żądanie HTTP GET , które dostarcza dane poligonów konspektu obszaru geograficznego, takiego jak miasto lub region kraju.

GET {endpoint}/search/polygon?api-version=2026-01-01&coordinates={coordinates}

Z parametrami opcjonalnymi:

GET {endpoint}/search/polygon?api-version=2026-01-01&coordinates={coordinates}&view={view}&resultType={resultType}&resolution={resolution}

Parametry identyfikatora URI

Nazwisko	W	Wymagane	Typ	Opis
endpoint	path	True	string (uri)	Nazwa hosta usługi Azure Maps. Użyj `https://atlas.microsoft.com` do Azure chmury publicznej. Aby skupić się na konkretnej Azure Maps geografii lub chmurze suwerennej, zobacz Azure Maps zakres geograficzny.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.
coordinates	query	True	number[]	Punkt na Ziemi określony jako długość i szerokość geograficzna. Przykład: współrzędne &=lon,lat
resolution	query		ResolutionEnum	Rozdzielczość określa liczbę punktów do odesłania. Jeśli nie zostanie określona, domyślna będzie średnia rozdzielczość.
resultType	query		BoundaryResultTypeEnum	Koncepcja geopolityczna, dla której należy przywrócić granicę. Jeśli nie zostanie określony, wartość domyślna to `countryRegion` typ wyniku.
view	query		string	Ciąg reprezentujący kod ISO 3166-1 Alfa-2 w regionie/kraju. Spowoduje to zmianę spornych geopolitycznych granic i etykiet w celu dopasowania ich do określonego regionu użytkownika. Domyślnie parametr Widok jest ustawiony na wartość "Auto", nawet jeśli nie zdefiniowano go w żądaniu. Aby uzyskać szczegółowe informacje, zobacz Obsługiwane widoki, aby uzyskać szczegółowe informacje i wyświetlić dostępne widoki.

Nagłówek żądania

Nazwisko	Wymagane	Typ	Opis
x-ms-client-id		string	Określa, które konto jest przeznaczone do użycia w połączeniu z modelem bezpieczeństwa Azure AD. Reprezentuje unikalny identyfikator dla konta Azure Maps i można go pobrać z API konta Azure Maps management plane. Więcej informacji na temat korzystania z Microsoft Entra ID zabezpieczeń w Azure Maps można znaleźć w Manage authentication in Azure Maps.
Accept-Language		string	Język, w którym powinny być zwracane wyniki wyszukiwania. Aby uzyskać szczegółowe informacje, zobacz Obsługiwane języki.

Nazwisko

Wymagane

Typ

Opis

x-ms-client-id

string

Określa, które konto jest przeznaczone do użycia w połączeniu z modelem bezpieczeństwa Azure AD. Reprezentuje unikalny identyfikator dla konta Azure Maps i można go pobrać z API konta Azure Maps management plane. Więcej informacji na temat korzystania z Microsoft Entra ID zabezpieczeń w Azure Maps można znaleźć w Manage authentication in Azure Maps.

Accept-Language

string

Język, w którym powinny być zwracane wyniki wyszukiwania.

Aby uzyskać szczegółowe informacje, zobacz Obsługiwane języki.

Odpowiedzi

Nazwisko	Typ	Opis
200 OK	Boundary	Żądanie zakończyło się pomyślnie. Media Types: "application/geo+json", "application/json"
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Nieoczekiwana odpowiedź na błąd. Media Types: "application/geo+json", "application/json" Nagłówki x-ms-error-code: string

Nazwisko

Typ

Opis

200 OK

Boundary

Żądanie zakończyło się pomyślnie.

Media Types: "application/geo+json", "application/json"

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Media Types: "application/geo+json", "application/json"

Nagłówki

x-ms-error-code: string

Zabezpieczenia

AadToken

Są to przepływy Microsoft Entra OAuth 2.0. W połączeniu z Azure zarządzaniem dostępem opartym na rolach może być używany do kontroli dostępu do Azure Maps API REST. Kontrola dostępu oparta na rolach Azure służy do wyznaczania dostępu do jednego lub więcej kont zasobów lub podzasobów Azure Maps. Każdy użytkownik, grupa lub jednostka usługi mogą mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do interfejsów API REST usługi Azure Maps.

Aby zaimplementować scenariusze, zalecamy wyświetlenie koncepcji uwierzytelniania . Podsumowując, ta definicja zabezpieczeń zawiera rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.

Note

Ta definicja zabezpieczeń wymaga użycia nagłówka x-ms-client-id w celu wskazania, do którego zasobu usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania usługami Maps.
Authorization URL jest specyficzna dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikalne adresy URL autoryzacji oraz konfiguracje Microsoft Entra ID.
Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana na podstawie płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.
Użycie zestawu Web SDK usługi Azure Maps umożliwia skonfigurowanie aplikacji na podstawie konfiguracji dla wielu przypadków użycia.
Aby uzyskać więcej informacji na temat platformy tożsamości firmy Microsoft, zobacz Platforma tożsamości Microsoft overview.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwisko	Opis
https://atlas.microsoft.com/.default

subscription-key

Jest to klucz wspólny aprowizowany podczas tworzenie konta usługi Azure Maps w witrynie Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsu API REST.

Za pomocą tego klucza każda aplikacja może uzyskiwać dostęp do całego interfejsu API REST. Innymi słowy, ten klucz może służyć jako klucz główny na koncie, w którym są wystawiane.

W przypadku publicznie uwidocznionych aplikacji zalecamy użycie poufnych aplikacji klienckich podejście do uzyskiwania dostępu do interfejsów API REST usługi Azure Maps, aby klucz mógł być bezpiecznie przechowywany.

Typ: apiKey
W: header

SAS Token

Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji List SAS na zasobie usługi Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.

Dzięki temu tokenowi każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure i szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token SAS może służyć do umożliwienia aplikacjom kontrolowania dostępu w sposób bardziej zabezpieczony niż klucz wspólny.

W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie Mapowanie konta w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SAS.

Typ: apiKey
W: header

Przykłady

Get polygon for a city at coordinates -122.204141,47.612560

Przykładowe żądanie

HTTP

GET https://atlas.microsoft.com/search/polygon?api-version=2026-01-01&coordinates=-122.204141,47.61256&resultType=locality&resolution=small

Przykładowa odpowiedź

Kod stanu:: 200

Content-Type: application/geo+json

{
  "type": "Feature",
  "geometry": {
    "type": "GeometryCollection",
    "geometries": [
      {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -122.13035,
              47.53502
            ],
            [
              -122.12882,
              47.53567
            ],
            [
              -122.12638000000001,
              47.535140000000006
            ],
            [
              -122.12378000000001,
              47.53717
            ],
            [
              -122.12068000000001,
              47.537620000000004
            ],
            [
              -122.12028000000001,
              47.538000000000004
            ],
            [
              -122.11682,
              47.537940000000006
            ],
            [
              -122.11527000000001,
              47.53609
            ],
            [
              -122.11119000000001,
              47.536080000000005
            ],
            [
              -122.11103000000001,
              47.539280000000005
            ],
            [
              -122.10832,
              47.539530000000006
            ],
            [
              -122.10830000000001,
              47.54057
            ],
            [
              -122.11006,
              47.54055
            ],
            [
              -122.10999000000001,
              47.542640000000006
            ],
            [
              -122.11185,
              47.54298000000001
            ],
            [
              -122.11183000000001,
              47.54426
            ],
            [
              -122.1114,
              47.543800000000005
            ],
            [
              -122.10936000000001,
              47.54379
            ],
            [
              -122.10912,
              47.54462
            ],
            [
              -122.10745000000001,
              47.544830000000005
            ],
            [
              -122.10808000000002,
              47.545190000000005
            ],
            [
              -122.10808000000002,
              47.54656000000001
            ],
            [
              -122.10665000000002,
              47.546580000000006
            ],
            [
              -122.10711,
              47.544700000000006
            ],
            [
              -122.10530000000001,
              47.54473
            ],
            [
              -122.1054,
              47.546910000000004
            ],
            [
              -122.10434000000001,
              47.54693
            ],
            [
              -122.10433,
              47.544830000000005
            ],
            [
              -122.10056000000002,
              47.544940000000004
            ],
            [
              -122.1007,
              47.548500000000004
            ],
            [
              -122.10194000000001,
              47.54849
            ],
            [
              -122.10194000000001,
              47.54883
            ],
            [
              -122.10194000000001,
              47.549510000000005
            ],
            [
              -122.10071,
              47.54883
            ],
            [
              -122.10048,
              47.54849
            ],
            [
              -122.10047000000002,
              47.54883
            ],
            [
              -122.10038000000002,
              47.55904
            ],
            [
              -122.09796000000001,
              47.55923000000001
            ],
            [
              -122.09870000000001,
              47.560570000000006
            ],
            [
              -122.09818000000001,
              47.56248
            ],
            [
              -122.10011000000002,
              47.56839
            ],
            [
              -122.09876000000001,
              47.56884
            ],
            [
              -122.09942000000001,
              47.569900000000004
            ],
            [
              -122.09782000000001,
              47.56983
            ],
            [
              -122.09672,
              47.58019
            ],
            [
              -122.09885000000001,
              47.58666
            ],
            [
              -122.09796000000001,
              47.59503
            ],
            [
              -122.09664000000001,
              47.602230000000006
            ],
            [
              -122.09411000000001,
              47.607240000000004
            ],
            [
              -122.09104,
              47.610240000000005
            ],
            [
              -122.08366000000001,
              47.615660000000005
            ],
            [
              -122.08008000000001,
              47.61939
            ],
            [
              -122.07904,
              47.62201
            ],
            [
              -122.07959000000001,
              47.627520000000004
            ],
            [
              -122.08008000000001,
              47.627520000000004
            ],
            [
              -122.09181000000001,
              47.627520000000004
            ],
            [
              -122.09221000000001,
              47.62717000000001
            ],
            [
              -122.09256,
              47.627520000000004
            ],
            [
              -122.11094000000001,
              47.62765
            ],
            [
              -122.11091,
              47.636720000000004
            ],
            [
              -122.11091,
              47.64609
            ],
            [
              -122.11431,
              47.646060000000006
            ],
            [
              -122.11437000000001,
              47.64533
            ],
            [
              -122.11597,
              47.64374
            ],
            [
              -122.12254000000001,
              47.638510000000004
            ],
            [
              -122.12542,
              47.636720000000004
            ],
            [
              -122.12809000000001,
              47.635200000000005
            ],
            [
              -122.13241000000001,
              47.63515
            ],
            [
              -122.13234000000001,
              47.63268
            ],
            [
              -122.13407000000001,
              47.63156000000001
            ],
            [
              -122.13484000000001,
              47.62935
            ],
            [
              -122.13626000000001,
              47.62820000000001
            ],
            [
              -122.1372,
              47.627860000000005
            ],
            [
              -122.14184000000002,
              47.62787
            ],
            [
              -122.14321000000001,
              47.62713
            ],
            [
              -122.14312000000001,
              47.636720000000004
            ],
            [
              -122.14335000000001,
              47.660590000000006
            ],
            [
              -122.1641,
              47.66077000000001
            ],
            [
              -122.16453000000001,
              47.646370000000005
            ],
            [
              -122.16797000000001,
              47.64621
            ],
            [
              -122.19629,
              47.64643
            ],
            [
              -122.19629,
              47.64289
            ],
            [
              -122.19846000000001,
              47.642860000000006
            ],
            [
              -122.19846000000001,
              47.64242
            ],
            [
              -122.19982000000002,
              47.6424
            ],
            [
              -122.20169000000001,
              47.644600000000004
            ],
            [
              -122.20341,
              47.643190000000004
            ],
            [
              -122.20818000000001,
              47.6435
            ],
            [
              -122.21014000000001,
              47.643130000000006
            ],
            [
              -122.20962000000002,
              47.642920000000004
            ],
            [
              -122.20974000000001,
              47.636720000000004
            ],
            [
              -122.21005000000001,
              47.62107
            ],
            [
              -122.22268000000001,
              47.62106000000001
            ],
            [
              -122.22268000000001,
              47.62066
            ],
            [
              -122.22203,
              47.620470000000005
            ],
            [
              -122.22282000000001,
              47.619890000000005
            ],
            [
              -122.22142000000001,
              47.618570000000005
            ],
            [
              -122.22248,
              47.61838
            ],
            [
              -122.22271,
              47.617200000000004
            ],
            [
              -122.22136,
              47.617180000000005
            ],
            [
              -122.21985000000001,
              47.61643
            ],
            [
              -122.22044000000001,
              47.614470000000004
            ],
            [
              -122.22033,
              47.603840000000005
            ],
            [
              -122.22043000000001,
              47.59682
            ],
            [
              -122.21702,
              47.59038
            ],
            [
              -122.21653,
              47.59042
            ],
            [
              -122.21572,
              47.588240000000006
            ],
            [
              -122.21067000000001,
              47.58375
            ],
            [
              -122.20153,
              47.57887
            ],
            [
              -122.20227000000001,
              47.57864000000001
            ],
            [
              -122.20132000000001,
              47.578770000000006
            ],
            [
              -122.20034000000001,
              47.57822
            ],
            [
              -122.19901000000002,
              47.57592
            ],
            [
              -122.19923000000001,
              47.567460000000004
            ],
            [
              -122.20034000000001,
              47.55962
            ],
            [
              -122.20072,
              47.55966
            ],
            [
              -122.20114000000001,
              47.557520000000004
            ],
            [
              -122.20119000000001,
              47.54943
            ],
            [
              -122.20160000000001,
              47.549440000000004
            ],
            [
              -122.20167000000001,
              47.54883
            ],
            [
              -122.20200000000001,
              47.54609000000001
            ],
            [
              -122.19676000000001,
              47.54621
            ],
            [
              -122.19545000000001,
              47.54609000000001
            ],
            [
              -122.19545000000001,
              47.545750000000005
            ],
            [
              -122.19091000000002,
              47.54580000000001
            ],
            [
              -122.1907,
              47.54216
            ],
            [
              -122.18581,
              47.542100000000005
            ],
            [
              -122.18116,
              47.541140000000006
            ],
            [
              -122.17142000000001,
              47.54086
            ],
            [
              -122.16987,
              47.54008
            ],
            [
              -122.16797000000001,
              47.540060000000004
            ],
            [
              -122.16554000000001,
              47.54005
            ],
            [
              -122.16439000000001,
              47.54281
            ],
            [
              -122.16433,
              47.545480000000005
            ],
            [
              -122.15356000000001,
              47.54538
            ],
            [
              -122.15359000000001,
              47.541760000000004
            ],
            [
              -122.14280000000001,
              47.541520000000006
            ],
            [
              -122.14288,
              47.539370000000005
            ],
            [
              -122.13645000000001,
              47.53826
            ],
            [
              -122.13035,
              47.53502
            ]
          ],
          [
            [
              -122.19957000000001,
              47.58372000000001
            ],
            [
              -122.20448,
              47.583830000000006
            ],
            [
              -122.20585000000001,
              47.586780000000005
            ],
            [
              -122.19654000000001,
              47.586740000000006
            ],
            [
              -122.19655000000002,
              47.58379
            ],
            [
              -122.19957000000001,
              47.58372000000001
            ]
          ]
        ]
      }
    ]
  },
  "properties": {
    "name": "Bellevue",
    "copyright": "© 2022 Microsoft and its suppliers. This API and any results cannot be used or accessed without Microsoft's express written permission.",
    "copyrightUrl": "https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/",
    "geometriesCopyright": [
      {
        "sourceName": "TOM",
        "copyright": "TomTom"
      }
    ]
  }
}

Definicje

Nazwisko	Opis
Azure.Core.Foundations.Error	Obiekt błędu.
Azure.Core.Foundations.ErrorResponse	Odpowiedź zawierająca szczegóły błędu.
Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z Azure wytycznymi API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.
Boundary	Udana jednostka odpowiedzi zwrócona przez `Get Polygon`. Zakodowane jako , który jest jednym lub więcej `MultiPolygonPolygon` lub kształtami opisującymi zarys żądanego obszaru geograficznego, a które `properties` noszą nazwę wyświetlaną obszaru oraz przypis praw autorskich.`GeometryCollectiongeometryGeoJSON Feature`
BoundaryProperties	Ładunek `properties` .`Boundary` Zawiera nazwę wyświetlaną zwróconego obszaru geograficznego wraz z atrybucją praw autorskich, zarówno ogłoszenie API, jak i przypisy dostawcy danych dla każdej geometrii.
BoundaryResultTypeEnum	Poziom hierarchii geograficznej wymagany podczas wywoływania `Get Polygon`. Wartość ta jest podawana jako `resultType` parametr zapytania i wybiera, na którym poziomie hierarchii administracyjnej lub pocztowej zwrócony `Boundary` wielokąt wyznacza kontur. Domyślną wartością jest `countryRegion`, jeśli nie określono inaczej.
FeatureTypeEnum	Typ obiektu `GeoJSON` dla `Feature` obiektów. Oznacza każdy wpis wewnątrz tablicy `featuresFeatureCollection` odpowiedzi (geokodowanie, geokodowanie odwrotne, autouzupełnianie) i pojawia się u podstawy `Get Polygon` odpowiedzi. Jedyną wartością `Feature`jest , zgodnie z definicją RFC 7946.
GeoJsonGeometryCollection	Prawidłowy typ obiektu `GeoJSON GeometryCollection`. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonLineString	Prawidłowy typ geometrii `GeoJSON LineString`. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonMultiLineString	Prawidłowy typ geometrii `GeoJSON MultiLineString`. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonMultiPoint	Prawidłowy typ geometrii `GeoJSON MultiPoint`. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonMultiPolygon	Prawidłowy typ obiektu `GeoJSON MultiPolygon`. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonObjectType	Określa typ `GeoJSON`. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.
GeoJsonPoint	Prawidłowy typ geometrii `GeoJSON Point`. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonPolygon	Prawidłowy typ geometrii `GeoJSON Polygon`. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeometryCopyright	Pojedynczy wpis atrybucji dostawcy danych dla każdej geometrii w obrębie `BoundaryProperties.geometriesCopyright`. Identyfikuje źródło jednej z geometrii w tablicy nadrzędnej `Boundary.geometry.geometries` .
ResolutionEnum	Poziom szczegółowości użyty dla `Boundary` wielokąta zwracany przez `Get Polygon`. Podany jako `resolution` parametr zapytania wartość ta określa, ile punktów wyznacza granicę, w kolejności rosnącej: `small`, `medium`, `large`, . `huge` Wyższe poziomy zużywają tyle samo punktów co kolejne niższe poziomy lub więcej. Domyślną wartością jest `medium`, jeśli nie określono inaczej.

Azure.Core.Foundations.Error

Objekt

Obiekt błędu.

Nazwisko	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Azure.Core.Foundations.Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

Azure.Core.Foundations.ErrorResponse

Objekt

Odpowiedź zawierająca szczegóły błędu.

Nazwisko	Typ	Opis
error	Azure.Core.Foundations.Error	Obiekt błędu.

Azure.Core.Foundations.InnerError

Objekt

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z Azure wytycznymi API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nazwisko	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
innererror	Azure.Core.Foundations.InnerError	Błąd wewnętrzny.

Boundary

Objekt

Udana jednostka odpowiedzi zwrócona przez Get Polygon. Zakodowane jako , który jest jednym lub więcej MultiPolygonPolygon lub kształtami opisującymi zarys żądanego obszaru geograficznego, a które properties noszą nazwę wyświetlaną obszaru oraz przypis praw autorskich.GeometryCollectiongeometryGeoJSON Feature

Nazwisko	Typ	Opis
geometry	GeoJsonGeometryCollection	A `GeometryCollection` z jednego lub więcej `PolygonMultiPolygon` kształtów, których współrzędne definiują zarys żądanego obszaru w kolejności długości i szerokości WGS 84, zgodnie z definicją RFC 7946.
properties	BoundaryProperties	Nazwa wyświetlana i przypis praw autorskich dla zwróconej części. Zobacz `BoundaryProperties` kształt przypadający na własność.
type	FeatureTypeEnum	Typ `GeoJSON` obiektu. Zawsze `Feature`, zgodnie z definicją RFC 7946.

BoundaryProperties

Objekt

Ładunek properties .Boundary Zawiera nazwę wyświetlaną zwróconego obszaru geograficznego wraz z atrybucją praw autorskich, zarówno ogłoszenie API, jak i przypisy dostawcy danych dla każdej geometrii.

Nazwisko	Typ	Opis
copyright	string	Powiadomienie o prawach autorskich i użyciu API Azure Maps, które mają zastosowanie do tej odpowiedzi. Różni się od przypisów dostawców danych dla poszczególnych geometrii w `geometriesCopyright`.
copyrightUrl	string	URL do informacji o prawach autorskich i licencjonowaniu Azure Maps dla API oraz jego źródeł danych.
geometriesCopyright	GeometryCopyright[]	Przypisywanie dostawcy danych na podstawie pojedynczej geometrii. Każdy element odpowiada pozycyjnie dopasowanemu kształtowi w tablicy nadrzędnej `Boundary.geometry.geometries` — wpis `i` opisuje źródło geometrii `i`.
name	string	Na przykład nazwa wyświetlana obszaru geograficznego, `"Bellevue"` na przykład dla granicy miasta.

BoundaryResultTypeEnum

Wyliczenie

Poziom hierarchii geograficznej wymagany podczas wywoływania Get Polygon. Wartość ta jest podawana jako resultType parametr zapytania i wybiera, na którym poziomie hierarchii administracyjnej lub pocztowej zwrócony Boundary wielokąt wyznacza kontur. Domyślną wartością jest countryRegion, jeśli nie określono inaczej.

Wartość	Opis
countryRegion	Kraj lub region.
adminDistrict	Pierwszy poziom administracyjny w kraju/regionie, na przykład w stanie lub prowincji.
adminDistrict2	Drugi poziom administracyjny w kraju/regionie, na przykład w hrabstwie.
postalCode	Najmniejsza kategoria kodu pocztowego, na przykład kod pocztowy.
postalCode2	Kolejna największa kategoria `postalCode` kodów pocztowych powstała przez agregację `postalCode` obszarów.
postalCode3	Kolejna największa kategoria `postalCode2` kodów pocztowych powstała przez agregację `postalCode2` obszarów.
postalCode4	Kolejna największa kategoria `postalCode3` kodów pocztowych powstała przez agregację `postalCode3` obszarów.
neighborhood	Lokalnie uznany obszar w obrębie zamieszkanego miejsca, często z nieformalnymi lub kulturowo określonymi granicami.
locality	Skoncentrowany obszar osadnictwa ludzkiego, taki jak miasto, miasteczko lub wieś.

FeatureTypeEnum

Wyliczenie

Typ obiektu GeoJSON dla Feature obiektów. Oznacza każdy wpis wewnątrz tablicy featuresFeatureCollection odpowiedzi (geokodowanie, geokodowanie odwrotne, autouzupełnianie) i pojawia się u podstawy Get Polygon odpowiedzi. Jedyną wartością Featurejest , zgodnie z definicją RFC 7946.

Wartość	Opis
Feature	Typ `GeoJSON Feature` obiektu. Pojawia się na każdej funkcji w `FeatureCollection` odpowiedzi oraz u jej podstawy `Get Polygon` .

GeoJsonGeometryCollection

Objekt

Prawidłowy typ obiektu GeoJSON GeometryCollection. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.

Nazwisko	Typ	Opis
bbox	number[] (double)	Obwiedni. Używane projekcje — EPSG:3857. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Zawiera listę prawidłowych obiektów geometrii `GeoJSON`. Uwaga, że współrzędne w formacie GeoJSON znajdują się w kolejności x, y (długość geograficzna, szerokość geograficzna).
type	string: GeometryCollection	Określa typ `GeoJSON`. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeoJsonLineString

Objekt

Prawidłowy typ geometrii GeoJSON LineString. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.

Nazwisko	Typ	Opis
bbox	number[] (double)	Obwiedni. Używane projekcje — EPSG:3857. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
coordinates	number[] (double)	Współrzędne geometrii `GeoJson LineString`.
type	string: LineString	Określa typ `GeoJSON`. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeoJsonMultiLineString

Objekt

Prawidłowy typ geometrii GeoJSON MultiLineString. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.

Nazwisko	Typ	Opis
bbox	number[] (double)	Obwiedni. Używane projekcje — EPSG:3857. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
coordinates	number[] (double)	Współrzędne geometrii `GeoJson MultiLineString`.
type	string: MultiLineString	Określa typ `GeoJSON`. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeoJsonMultiPoint

Objekt

Prawidłowy typ geometrii GeoJSON MultiPoint. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.

Nazwisko	Typ	Opis
bbox	number[] (double)	Obwiedni. Używane projekcje — EPSG:3857. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
coordinates	number[] (double)	Współrzędne geometrii `GeoJson MultiPoint`.
type	string: MultiPoint	Określa typ `GeoJSON`. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeoJsonMultiPolygon

Objekt

Prawidłowy typ obiektu GeoJSON MultiPolygon. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.

Nazwisko	Typ	Opis
bbox	number[] (double)	Obwiedni. Używane projekcje — EPSG:3857. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
coordinates	number[] (double)	Zawiera listę prawidłowych obiektów `GeoJSON Polygon`. Uwaga, że współrzędne w formacie GeoJSON znajdują się w kolejności x, y (długość geograficzna, szerokość geograficzna).
type	string: MultiPolygon	Określa typ `GeoJSON`. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeoJsonObjectType

Wyliczenie

Określa typ GeoJSON. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

Wartość	Opis
Point	`GeoJSON Point` geometrii.
MultiPoint	`GeoJSON MultiPoint` geometrii.
LineString	`GeoJSON LineString` geometrii.
MultiLineString	`GeoJSON MultiLineString` geometrii.
Polygon	`GeoJSON Polygon` geometrii.
MultiPolygon	`GeoJSON MultiPolygon` geometrii.
GeometryCollection	`GeoJSON GeometryCollection` geometrii.
Feature	`GeoJSON Feature` obiekt.
FeatureCollection	`GeoJSON FeatureCollection` obiekt.

GeoJsonPoint

Objekt

Prawidłowy typ geometrii GeoJSON Point. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.

Nazwisko	Typ	Opis
bbox	number[] (double)	Obwiedni. Używane projekcje — EPSG:3857. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
coordinates	number[] (double)	`Position` to tablica liczb z co najmniej dwoma elementami. Dwa pierwsze elementy to długości geograficznej i szerokości geograficznej, dokładnie w tej kolejności. wysokości/wysokości jest opcjonalnym trzecim elementem. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
type	string: Point	Określa typ `GeoJSON`. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeoJsonPolygon

Objekt

Prawidłowy typ geometrii GeoJSON Polygon. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.

Nazwisko	Typ	Opis
bbox	number[] (double)	Obwiedni. Używane projekcje — EPSG:3857. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
coordinates	number[] (double)	Współrzędne typu geometrii `GeoJson Polygon`.
type	string: Polygon	Określa typ `GeoJSON`. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeometryCopyright

Objekt

Pojedynczy wpis atrybucji dostawcy danych dla każdej geometrii w obrębie BoundaryProperties.geometriesCopyright. Identyfikuje źródło jednej z geometrii w tablicy nadrzędnej Boundary.geometry.geometries .

Nazwisko	Typ	Opis
copyright	string	Czytelny ciąg atrybucji dla dostawcy danych. Na przykład `"TomTom"`. Może to być nazwa dostawcy lub pełniejsze zawiadomienie o prawach autorskich.
sourceName	string	Identyfikator dostawcy danych, który dostarczył tę geometrię.

ResolutionEnum

Wyliczenie

Poziom szczegółowości użyty dla Boundary wielokąta zwracany przez Get Polygon. Podany jako resolution parametr zapytania wartość ta określa, ile punktów wyznacza granicę, w kolejności rosnącej: small, medium, large, . huge Wyższe poziomy zużywają tyle samo punktów co kolejne niższe poziomy lub więcej. Domyślną wartością jest medium, jeśli nie określono inaczej.

Wartość	Opis
small	Zwraca geometrię brzegu z najmniejszą liczbą punktów.
medium	Zwraca geometrię brzegową z taką samą liczbą punktów co `small` lub więcej.
large	Zwraca geometrię brzegową z taką samą liczbą punktów co `medium` lub więcej.
huge	Zwraca geometrię brzegową z taką samą liczbą punktów co `large` lub więcej.