Search - Post Search Inside Geometry
Służy do wykonywania wolnych wyszukiwań formularzy wewnątrz jeszcze jednej geometrii.
Interfejs Post Search Inside Geometry
API to i POST request that allows you to perform a free form search inside a single geometry or multiple geometries. The search results that fall inside the geometry/geometries will be returned.<br><br>To send the geometry you will use a
http POSTrequest where the request body will contain the
geometryobject represented as a
GeoJSONtype and the
Content-Typeheader will be set to
application/json. The geographical features to be searched can be modeled as Polygon and/or Circle geometries represented using any one of the following
GeoJSON Geometrycan be represented as a
GeoJSONtypes:<ul><li>**GeoJSON FeatureCollection** <br>The
FeatureCollection FeatureCollectionobject. This is the recommended option if the geometry contains both Polygons and Circles. The
can contain a max of 50
Funkcja Funkcji GeoJSONobjects. Each
Funkcjaobject should represent either a Polygon or a Circle with the following conditions:<ul style="list-style-type:none"><li>A
object for the Circle geometry is composed of a _center_ represented using a
object for the Polygon geometry can have a max of 50 coordinates and it's properties must be empty.</li><li>A
funkcji GeoJSON Funkcja funkcji GeoJSON Funkcja Funkcji GeoJSONtype and a _radius_ value (in meters) which must be specified in the object's properties along with the _subType_ property whose value should be 'Circle'.</li></ul><br> Please see the Examples section below for a sample
representation.<br><br></li><li>**GeoJSON GeometryCollection**<br>The
Geometriacan be represented as a
GeoJSON GeometryCollectionobject. This is the recommended option if the geometry contains a list of Polygons only. The
GeoJSON Polygonobjects. Each
object can have a max of 50 coordinates. Please see the Examples section below for a sample
GeometryCollectionrepresentation.<br><br></li><li>**GeoJSON Polygon**<br>The
GeoJSON Geometriacan contain a max of 50
GeoJSON Geometriacan be represented as a
GeoJSON Polygonobject. This is the recommended option if the geometry contains a single Polygon. The
object can have a max of 50 coordinates. Please see the Examples section below for a sample
Reprezentacja wielokąta.
.
POST https://atlas.microsoft.com/search/geometry/{format}?api-version=1.0&query={query}
POST https://atlas.microsoft.com/search/geometry/{format}?api-version=1.0&query={query}&limit={limit}&language={language}&categorySet={categorySet}&extendedPostalCodesFor={extendedPostalCodesFor}&idxSet={idxSet}&view={view}&openingHours=nextSevenDays
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
format
|
path | True |
Żądany format odpowiedzi. Wartość może być json lub xml. |
|
api-version
|
query | True |
string |
Numer wersji interfejsu API Azure Maps. |
query
|
query | True |
string |
Nazwa POI do wyszukania (np. "pomnik wolności", "starbucks", "pizza"). Musi być poprawnie zakodowany adres URL. |
category
|
query |
integer[] |
Rozdzielona przecinkami lista identyfikatorów zestawów kategorii, których można użyć do ograniczenia wyniku do określonych kategorii Punktów orientacyjnych. Kolejność identyfikatorów nie ma znaczenia. Maksymalna liczba obsługiwanych
|
|
extended
|
query |
Indeksy, dla których należy uwzględnić rozszerzone kody pocztowe w wynikach. Dostępne indeksy to: Addr = zakresy adresów Geo = Geografie PAD = adresy punktów POI = punkty orientacyjne Str = ulice XStr = Cross Streets (skrzyżowania) Wartość powinna być rozdzielaną przecinkami listą typów indeksów (w dowolnej kolejności) lub Brak dla żadnych indeksów. Domyślnie rozszerzone kody pocztowe są uwzględniane dla wszystkich indeksów z wyjątkiem geo. Rozszerzone listy kodów pocztowych dla lokalizacji geograficznych mogą być dość długie, więc w razie potrzeby muszą być jawnie żądane. Przykłady użycia: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Rozszerzony kod pocztowy jest zwracany jako właściwość extendedPostalCode adresu. Dostępność jest zależna od regionu. |
||
idx
|
query |
Rozdzielona przecinkami lista indeksów, które powinny być używane do wyszukiwania. Kolejność elementów nie ma znaczenia. Dostępne indeksy to: Addr = Interpolacja zakresu adresów, Geo = Geographies, PAD = Point Address, POI = Punkty orientacyjne, Str = Streets, Xstr = Cross Streets (skrzyżowania) |
||
language
|
query |
string |
Język, w którym powinny być zwracane wyniki wyszukiwania. Powinien być jednym z obsługiwanych tagów języka IETF, bez uwzględniania wielkości liter. Gdy dane w określonym języku nie są dostępne dla określonego pola, używany jest język domyślny. Aby uzyskać szczegółowe informacje, zobacz Obsługiwane języki . |
|
limit
|
query |
integer |
Maksymalna liczba odpowiedzi, które zostaną zwrócone. Wartość domyślna: 10, minimalna: 1 i maksymalna: 100 |
|
opening
|
query |
Godziny operacji dla interfejsu poi (punkty orientacyjne). Dostępność godzin pracy będzie się różnić w zależności od dostępnych danych. Jeśli nie zostanie przekazana, nie zostaną zwrócone żadne informacje o godzinach otwarcia. Obsługiwana wartość: nextSevenDays |
||
view
|
query |
Parametr View (nazywany również parametrem "region użytkownika") umożliwia wyświetlanie poprawnych map dla określonego kraju/regionu dla regionów spornych geopolitycznie. Różne kraje/regiony mają różne widoki takich regionów, a parametr View umożliwia aplikacji zgodność z widokiem wymaganym przez kraj/region, który aplikacja będzie obsługiwać. Domyślnie parametr Widok jest ustawiony na "Unified", nawet jeśli nie zdefiniowano go w żądaniu. Twoim zadaniem jest określenie lokalizacji użytkowników, a następnie poprawne ustawienie parametru View dla tej lokalizacji. Alternatywnie możesz ustawić opcję "View=Auto", która zwróci dane mapy na podstawie adresu IP żądania. Parametr View w Azure Maps musi być używany zgodnie z obowiązującymi przepisami, w tym z tymi dotyczącymi mapowania, kraju/regionu, w którym są dostępne mapy, obrazy i inne dane oraz zawartość innych firm, do których masz uprawnienia dostępu za pośrednictwem Azure Maps. Przykład: view=IN. Aby uzyskać szczegółowe informacje, zapoznaj się z tematem Obsługiwane widoki i zobacz dostępne widoki. |
Nagłówek żądania
Nazwa | Wymagane | Typ | Opis |
---|---|---|---|
x-ms-client-id |
string |
Określa, które konto jest przeznaczone do użycia w połączeniu z modelem zabezpieczeń Tożsamość Microsoft Entra. Reprezentuje unikatowy identyfikator konta Azure Maps i można go pobrać z interfejsu API konta płaszczyzny zarządzania Azure Maps. Aby użyć zabezpieczeń Tożsamość Microsoft Entra w usłudze Azure Maps, zobacz następujące artykuły, aby uzyskać wskazówki. |
Treść żądania
Nazwa | Typ | Opis |
---|---|---|
geometry | GeoJsonObject: |
Prawidłowy |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Wystąpił nieoczekiwany błąd. |
Zabezpieczenia
AADToken
Są to przepływy protokołu OAuth 2.0 Microsoft Entra. W połączeniu z kontrolą dostępu opartą na rolach platformy Azure może służyć do kontrolowania dostępu do interfejsów API REST Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobów Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi może mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do Azure Maps interfejsów API REST.
Aby zaimplementować scenariusze, zalecamy wyświetlenie pojęć dotyczących uwierzytelniania. Podsumowując, ta definicja zabezpieczeń udostępnia 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.
Uwaga
- Ta definicja zabezpieczeń wymaga użycia nagłówka
x-ms-client-id
, aby wskazać, do którego zasobu Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania mapami . - Element
Authorization URL
jest specyficzny dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje Tożsamość Microsoft Entra. - Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana z płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.
- Użycie Azure Maps zestawu Web SDK umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach użycia.
- Aby uzyskać więcej informacji na temat Platforma tożsamości Microsoft, zobacz omówienie Platforma tożsamości Microsoft.
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresy
Nazwa | Opis |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Jest to klucz wspólny aprowizowany podczas tworzenia konta Azure Maps w Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsu API REST.
Przy użyciu tego klucza każda aplikacja może uzyskać dostęp do całego interfejsu API REST. Innymi słowy, ten klucz może być używany jako klucz główny na koncie, w którym są wystawiane.
W przypadku publicznie uwidocznionych aplikacji zalecamy użycie podejścia do poufnych aplikacji klienckich w celu uzyskania dostępu do interfejsów API REST Azure Maps w celu bezpiecznego przechowywania klucza.
Typ:
apiKey
W:
query
SAS Token
Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji listy sygnatur dostępu współdzielonego w zasobie Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.
Przy użyciu tego tokenu 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 sygnatury dostępu współdzielonego może służyć do umożliwienia aplikacjom kontrolowania dostępu w bardziej bezpieczny sposób niż klucz wspólny.
W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie konta mapy w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SYGNATURy dostępu współdzielonego.
Typ:
apiKey
W:
header
Przykłady
Search for burger joints inside a geometry represented as a GeoJSON GeometryCollection type
Przykładowe żądanie
POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=burger&limit=2&openingHours=nextSevenDays
{
"geometry": {
"type": "GeometryCollection",
"geometries": [
{
"type": "Polygon",
"coordinates": [
[
[
-122.43576049804686,
37.7524152343544
],
[
-122.43301391601562,
37.70660472542312
],
[
-122.36434936523438,
37.712059855877314
],
[
-122.43576049804686,
37.7524152343544
]
]
]
},
{
"type": "Polygon",
"coordinates": [
[
[
-123.43576049804686,
37.7524152343544
],
[
-123.43301391601562,
37.70660472542312
],
[
-123.36434936523438,
37.712059855877314
],
[
-123.43576049804686,
37.7524152343544
]
]
]
}
]
}
}
Przykładowa odpowiedź
{
"summary": {
"query": "burger",
"queryType": "NON_NEAR",
"queryTime": 21,
"numResults": 2,
"offset": 0,
"totalResults": 4,
"fuzzyLevel": 1
},
"results": [
{
"type": "POI",
"id": "9P2i9inRyndAA-_V40J8oA",
"score": 2.0041828156,
"info": "search:ta:840061003419653-US",
"poi": {
"name": "Burger Joint",
"phone": "+1 415-349-4331",
"categorySet": [
{
"id": 7315015
}
],
"categories": [
"fast food",
"restaurant"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "restaurant"
},
{
"nameLocale": "en-US",
"name": "fast food"
}
]
}
]
},
"address": {
"streetNumber": "167",
"streetName": "Leland Avenue",
"municipality": "San Francisco",
"neighbourhood": "Visitacion Valley",
"countrySecondarySubdivision": "San Francisco",
"countrySubdivisionName": "California",
"countrySubdivisionCode": "CA",
"postalCode": "94134",
"extendedPostalCode": "94134-2844",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "167 Leland Avenue, San Francisco, CA 94134",
"localName": "San Francisco"
},
"position": {
"lat": 37.712228,
"lon": -122.407022
},
"viewport": {
"topLeftPoint": {
"lat": 37.71313,
"lon": -122.40816
},
"btmRightPoint": {
"lat": 37.71133,
"lon": -122.40589
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 37.71241,
"lon": -122.40693
}
}
]
},
{
"type": "POI",
"id": "hkr-N07YS6Gv2dOciQ9lwA",
"score": 2.0041515827,
"info": "search:ta:840067000526682-US",
"poi": {
"name": "Sound of Burgers",
"categorySet": [
{
"id": 7315
}
],
"categories": [
"restaurant"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "167",
"streetName": "Leland Avenue",
"municipality": "San Francisco",
"neighbourhood": "Visitacion Valley",
"countrySecondarySubdivision": "San Francisco",
"countrySubdivision": "CA",
"countrySubdivisionName": "California",
"countrySubdivisionCode": "CA",
"postalCode": "94134",
"extendedPostalCode": "94134-2844",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "167 Leland Avenue, San Francisco, CA 94134",
"localName": "San Francisco"
},
"position": {
"lat": 37.712228,
"lon": -122.407022
},
"viewport": {
"topLeftPoint": {
"lat": 37.71313,
"lon": -122.40816
},
"btmRightPoint": {
"lat": 37.71133,
"lon": -122.40589
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 37.71241,
"lon": -122.40693
}
}
]
}
]
}
Search for pizza places inside a geometry represented as a GeoJSON FeatureCollection type
Przykładowe żądanie
POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=pizza&limit=2&openingHours=nextSevenDays
{
"geometry": {
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-122.143035,
47.653536
],
[
-122.187164,
47.617556
],
[
-122.114981,
47.570599
],
[
-122.132756,
47.654009
],
[
-122.143035,
47.653536
]
]
]
},
"properties": {}
},
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-122.126986,
47.639754
]
},
"properties": {
"subType": "Circle",
"radius": 100
}
}
]
}
}
Przykładowa odpowiedź
{
"summary": {
"query": "pizza",
"queryType": "NON_NEAR",
"queryTime": 34,
"numResults": 2,
"offset": 0,
"totalResults": 21,
"fuzzyLevel": 1
},
"results": [
{
"type": "POI",
"id": "-UuwTye4GGsea4KmCLvoqQ",
"score": 2.1455535889,
"info": "search:ta:840537000108972-US",
"poi": {
"name": "Biryani & Pizza House",
"categorySet": [
{
"id": 7315036
}
],
"categories": [
"pizza",
"restaurant"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "restaurant"
},
{
"nameLocale": "en-US",
"name": "pizza"
}
]
}
]
},
"address": {
"streetNumber": "15025",
"streetName": "Northeast 24th Street",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countrySubdivision": "WA",
"countrySubdivisionName": "Washington",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "98052-5531",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15025 Northeast 24th Street, Redmond, WA 98052",
"localName": "Redmond"
},
"position": {
"lat": 47.630786,
"lon": -122.139302
},
"viewport": {
"topLeftPoint": {
"lat": 47.63169,
"lon": -122.14064
},
"btmRightPoint": {
"lat": 47.62989,
"lon": -122.13797
}
},
"entryPoints": [
{
"type": "minor",
"position": {
"lat": 47.63079,
"lon": -122.13931
}
},
{
"type": "main",
"position": {
"lat": 47.63147,
"lon": -122.13935
}
}
]
},
{
"type": "POI",
"id": "7r095LCcCSkdoGoeLcnvsQ",
"score": 2.1454992294,
"info": "search:ta:840537000103468-US",
"poi": {
"name": "Pagliacci Pizza",
"categorySet": [
{
"id": 7315036
}
],
"url": "www.pagliacci.com/",
"categories": [
"pizza",
"restaurant"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "restaurant"
},
{
"nameLocale": "en-US",
"name": "pizza"
}
]
}
],
"openingHours": {
"mode": "nextSevenDays",
"timeRanges": [
{
"startTime": {
"date": "2024-03-14",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-14",
"hour": 11,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-17",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-17",
"hour": 11,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-18",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-18",
"hour": 11,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-19",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-19",
"hour": 11,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-20",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-20",
"hour": 11,
"minute": 0
}
}
]
}
},
"address": {
"streetNumber": "15238",
"streetName": "Bel Red Road",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countrySubdivision": "WA",
"countrySubdivisionName": "Washington",
"countrySubdivisionCode": "WA",
"postalCode": "98007",
"extendedPostalCode": "98007-3815",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15238 Bel Red Road, Bellevue, WA 98007",
"localName": "Bellevue"
},
"position": {
"lat": 47.628008,
"lon": -122.13646
},
"viewport": {
"topLeftPoint": {
"lat": 47.62891,
"lon": -122.13779
},
"btmRightPoint": {
"lat": 47.62711,
"lon": -122.13513
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.6283,
"lon": -122.13611
}
}
]
}
]
}
Search for subs joints inside a geometry represented as a GeoJSON Polygon type
Przykładowe żądanie
POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=subs&limit=2&openingHours=nextSevenDays
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-122.43576049804686,
37.7524152343544
],
[
-122.43301391601562,
37.70660472542312
],
[
-122.36434936523438,
37.712059855877314
],
[
-122.43576049804686,
37.7524152343544
]
]
]
}
}
Przykładowa odpowiedź
{
"summary": {
"query": "subs",
"queryType": "NON_NEAR",
"queryTime": 42,
"numResults": 2,
"offset": 0,
"totalResults": 5,
"fuzzyLevel": 1
},
"results": [
{
"type": "POI",
"id": "HOIWGiNwVv0z6bF8MO3EbA",
"score": 2.1455111504,
"info": "search:ta:840069009512242-US",
"poi": {
"name": "Adams Grub Truck",
"phone": "+1 415-307-8844",
"categorySet": [
{
"id": 7315042
}
],
"categories": [
"restaurant",
"sandwich"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "sandwich"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "1465",
"streetName": "Carroll Avenue",
"municipality": "San Francisco",
"neighbourhood": "Bayview",
"countrySecondarySubdivision": "San Francisco",
"countrySubdivisionName": "California",
"countrySubdivisionCode": "CA",
"postalCode": "94124",
"extendedPostalCode": "94124-3604",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1465 Carroll Avenue, San Francisco, CA 94124",
"localName": "San Francisco"
},
"position": {
"lat": 37.72328,
"lon": -122.39091
},
"viewport": {
"topLeftPoint": {
"lat": 37.72418,
"lon": -122.39205
},
"btmRightPoint": {
"lat": 37.72238,
"lon": -122.38977
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 37.72348,
"lon": -122.39073
}
}
]
},
{
"type": "POI",
"id": "bXbc0QxTRlkSo8GnU7EU-Q",
"score": 2.1454677582,
"info": "search:ta:840061001992959-US",
"poi": {
"name": "SUBWAY San Francisco San Francisco",
"phone": "+1 415-657-9898",
"brands": [
{
"name": "SUBWAY"
}
],
"categorySet": [
{
"id": 7315042
}
],
"categories": [
"restaurant",
"sandwich"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "sandwich"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
],
"openingHours": {
"mode": "nextSevenDays",
"timeRanges": [
{
"startTime": {
"date": "2024-03-13",
"hour": 7,
"minute": 0
},
"endTime": {
"date": "2024-03-13",
"hour": 21,
"minute": 30
}
},
{
"startTime": {
"date": "2024-03-14",
"hour": 7,
"minute": 0
},
"endTime": {
"date": "2024-03-14",
"hour": 21,
"minute": 30
}
},
{
"startTime": {
"date": "2024-03-15",
"hour": 7,
"minute": 0
},
"endTime": {
"date": "2024-03-15",
"hour": 21,
"minute": 30
}
},
{
"startTime": {
"date": "2024-03-16",
"hour": 9,
"minute": 0
},
"endTime": {
"date": "2024-03-16",
"hour": 21,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-17",
"hour": 9,
"minute": 0
},
"endTime": {
"date": "2024-03-17",
"hour": 21,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-18",
"hour": 8,
"minute": 0
},
"endTime": {
"date": "2024-03-18",
"hour": 20,
"minute": 30
}
},
{
"startTime": {
"date": "2024-03-19",
"hour": 7,
"minute": 0
},
"endTime": {
"date": "2024-03-19",
"hour": 21,
"minute": 30
}
}
]
}
},
"address": {
"streetNumber": "2599",
"streetName": "San Bruno Avenue",
"municipality": "San Francisco",
"neighbourhood": "Portola",
"countrySecondarySubdivision": "San Francisco",
"countrySubdivision": "CA",
"countrySubdivisionName": "California",
"countrySubdivisionCode": "CA",
"postalCode": "94134",
"extendedPostalCode": "94134-1504",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "2599 San Bruno Avenue, San Francisco, CA 94134",
"localName": "San Francisco"
},
"position": {
"lat": 37.729004,
"lon": -122.403956
},
"viewport": {
"topLeftPoint": {
"lat": 37.7299,
"lon": -122.40509
},
"btmRightPoint": {
"lat": 37.7281,
"lon": -122.40282
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 37.72892,
"lon": -122.40414
}
}
]
}
]
}
Definicje
Nazwa | Opis |
---|---|
Address |
Adres wyniku |
Address |
Opisuje zakres adresów po obu stronach ulicy dla wyniku wyszukiwania. Uwzględniane są współrzędne dla lokalizacji początkowej i końcowej zakresu adresów. |
Bounding |
Port widoków, który obejmuje wynik reprezentowany przez współrzędne w lewym górnym i prawym dolnym rogu panelu widoków. |
Bounding |
Pole ograniczenia lokalizacji. |
Brand |
Marka skojarzona z interfejsem POI |
Classification |
Klasyfikacja zwracanego interfejsu użytkownika |
Classification |
Nazwa klasyfikacji |
Data |
Sekcja opcjonalna. Identyfikatory odwołań do użycia z interfejsem API Get Search Polygon. |
Entity |
Źródło typu jednostki pola ograniczenia. W przypadku odwrotnego geokodowania jest to zawsze równe pozycji. |
Entry |
Punkt wejścia dla zwracanego punktu weryfikacji koncepcji. |
Entry |
Typ punktu wejścia. Wartość może być główna lub pomocnicza. |
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
Error |
Szczegóły błędu. |
Error |
Odpowiedź na błąd |
Geographic |
Typ jednostki Geografia. Występuje tylko wtedy, gdy żądano właściwości entityType i jest dostępna. |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Geometry |
Informacje o kształcie geometrycznym wyniku. Występuje tylko wtedy, gdy typ == Geography. |
Lat |
Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon". |
Localized |
Parametr View (nazywany również parametrem "region użytkownika") umożliwia wyświetlanie poprawnych map dla określonego kraju/regionu dla regionów spornych geopolitycznie. Różne kraje/regiony mają różne widoki takich regionów, a parametr View umożliwia aplikacji zgodność z widokiem wymaganym przez kraj/region, który aplikacja będzie obsługiwać. Domyślnie parametr Widok jest ustawiony na "Unified", nawet jeśli nie zdefiniowano go w żądaniu. Twoim zadaniem jest określenie lokalizacji użytkowników, a następnie poprawne ustawienie parametru View dla tej lokalizacji. Alternatywnie możesz ustawić opcję "View=Auto", która zwróci dane mapy na podstawie adresu IP żądania. Parametr View w Azure Maps musi być używany zgodnie z obowiązującymi przepisami, w tym z tymi dotyczącymi mapowania, kraju/regionu, w którym są dostępne mapy, obrazy i inne dane oraz zawartość innych firm, do których masz uprawnienia dostępu za pośrednictwem Azure Maps. Przykład: view=IN. Aby uzyskać szczegółowe informacje, zapoznaj się z tematem Obsługiwane widoki i zobacz dostępne widoki. |
Match |
Typy dopasowania dla operacji wyszukiwania odwrotnego adresu. |
Operating |
Godziny otwarcia dla weryfikacji koncepcji (punkty orientacyjne). |
Operating |
Godziny operacji dla interfejsu poi (punkty orientacyjne). Dostępność godzin pracy będzie się różnić w zależności od dostępnych danych. Jeśli nie zostanie przekazana, nie zostaną zwrócone żadne informacje o godzinach otwarcia. Obsługiwana wartość: nextSevenDays |
Operating |
Reprezentuje datę i godzinę |
Operating |
Zakres czasu otwierania na dzień |
Point |
Szczegóły zwróconego interfejsu poI, w tym informacje, takie jak nazwa, telefon, adres URL i klasyfikacje. |
Point |
Kategoria poi |
Query |
Zwracany typ zapytania: W POBLIŻU lub NON_NEAR. |
Response |
Żądany format odpowiedzi. Wartość może być json lub xml. |
Search |
Ten obiekt jest zwracany z pomyślnych wywołań Search. |
Search |
Obiekt wyniku odpowiedzi interfejsu API Search. |
Search |
Jeden z:
|
Search |
Indeksy, dla których należy uwzględnić rozszerzone kody pocztowe w wynikach. Dostępne indeksy to: Addr = zakresy adresów Geo = Geografie PAD = adresy punktów POI = punkty orientacyjne Str = ulice XStr = Cross Streets (skrzyżowania) Wartość powinna być rozdzielaną przecinkami listą typów indeksów (w dowolnej kolejności) lub Brak dla żadnych indeksów. Domyślnie rozszerzone kody pocztowe są uwzględniane dla wszystkich indeksów z wyjątkiem geo. Rozszerzone listy kodów pocztowych dla lokalizacji geograficznych mogą być dość długie, więc w razie potrzeby muszą być jawnie żądane. Przykłady użycia: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Rozszerzony kod pocztowy jest zwracany jako właściwość extendedPostalCode adresu. Dostępność jest zależna od regionu. |
Search |
Ten typ reprezentuje treść żądania dla usługi Search Inside Geometry. |
Search |
Obiekt podsumowania odpowiedzi interfejsu API Search. |
Address
Adres wyniku
Nazwa | Typ | Opis |
---|---|---|
boundingBox |
Pole ograniczenia lokalizacji. |
|
buildingNumber |
string |
Numer budynku na ulicy. PRZESTARZAŁE użyj streetNumber zamiast tego. |
country |
string |
nazwa kraju/regionu |
countryCode |
string |
Kraj (Uwaga: jest to dwuliterowy kod, a nie nazwa kraju/regionu). |
countryCodeISO3 |
string |
Kod kraju ISO alfa-3 |
countrySecondarySubdivision |
string |
Powiat |
countrySubdivision |
string |
Stan lub prowincja |
countrySubdivisionCode |
string |
|
countrySubdivisionName |
string |
Pełna nazwa pierwszego poziomu hierarchii administracyjnej kraju/regionu. To pole jest wyświetlane tylko w przypadku, gdy countrySubdivision jest prezentowana w skróconej formie. Obsługiwane tylko dla Stanów Zjednoczonych, Kanady i Wielkiej Brytanii. |
countryTertiarySubdivision |
string |
Nazwany obszar |
crossStreet |
string |
Nazwa ulicy, która jest skrzyżowana. |
extendedPostalCode |
string |
Rozszerzony kod pocztowy (dostępność jest zależna od regionu). |
freeformAddress |
string |
Wiersz adresu sformatowany zgodnie z regułami formatowania kraju/regionu wynikowego pochodzenia lub w przypadku kraju/regionu pełna nazwa kraju/regionu. |
localName |
string |
Składnik adresu, który reprezentuje nazwę obszaru geograficznego lub lokalizacji, który grupuje wiele obiektów adresowalnych do celów adresowania, bez jednostki administracyjnej. To pole służy do kompilowania |
municipality |
string |
Miasto /Miasto |
municipalitySubdivision |
string |
Sub / Super City |
neighbourhood |
string |
Dzielnica jest geograficznie zlokalizowanym obszarem w mieście lub mieście z charakterystycznymi cechami i interakcjami społecznymi między mieszkańcami. |
postalCode |
string |
Kod pocztowy/kod pocztowy |
routeNumbers |
string[] |
Kody używane do jednoznacznej identyfikacji ulicy |
street |
string |
Nazwa ulicy. PRZESTARZAŁE zamiast tego użyj streetName. |
streetName |
string |
Nazwa ulicy. |
streetNameAndNumber |
string |
Nazwa ulicy i numer. |
streetNumber |
string |
Numer budynku na ulicy. |
AddressRanges
Opisuje zakres adresów po obu stronach ulicy dla wyniku wyszukiwania. Uwzględniane są współrzędne dla lokalizacji początkowej i końcowej zakresu adresów.
Nazwa | Typ | Opis |
---|---|---|
from |
Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon". |
|
rangeLeft |
string |
Zakres adresów po lewej stronie ulicy. |
rangeRight |
string |
Zakres adresów po prawej stronie ulicy. |
to |
Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon". |
BoundingBox
Port widoków, który obejmuje wynik reprezentowany przez współrzędne w lewym górnym i prawym dolnym rogu panelu widoków.
Nazwa | Typ | Opis |
---|---|---|
btmRightPoint |
Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon". |
|
topLeftPoint |
Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon". |
BoundingBoxCompassNotation
Pole ograniczenia lokalizacji.
Nazwa | Typ | Opis |
---|---|---|
entity |
Źródło typu jednostki pola ograniczenia. W przypadku odwrotnego geokodowania jest to zawsze równe pozycji. |
|
northEast |
string |
Szerokość geograficzna północno-wschodnia, współrzędna długości geograficznej pola ograniczenia jako rozdzielane przecinkami liczby zmiennoprzecinkowe |
southWest |
string |
Szerokość geograficzna południowo-zachodnia,współrzędna długości geograficznej pola ograniczenia jako rozdzielane przecinkami liczby zmiennoprzecinkowe |
Brand
Marka skojarzona z interfejsem POI
Nazwa | Typ | Opis |
---|---|---|
name |
string |
Nazwa marki |
Classification
Klasyfikacja zwracanego interfejsu użytkownika
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Właściwość Code |
names |
Tablica nazw |
ClassificationName
Nazwa klasyfikacji
Nazwa | Typ | Opis |
---|---|---|
name |
string |
Name — Właściwość |
nameLocale |
string |
Nazwa właściwości ustawień regionalnych |
DataSources
Sekcja opcjonalna. Identyfikatory odwołań do użycia z interfejsem API Get Search Polygon.
Nazwa | Typ | Opis |
---|---|---|
geometry |
Informacje o kształcie geometrycznym wyniku. Występuje tylko wtedy, gdy typ == Geography. |
Entity
Źródło typu jednostki pola ograniczenia. W przypadku odwrotnego geokodowania jest to zawsze równe pozycji.
Nazwa | Typ | Opis |
---|---|---|
position |
string |
Pozycja jednostki |
EntryPoint
Punkt wejścia dla zwracanego punktu weryfikacji koncepcji.
Nazwa | Typ | Opis |
---|---|---|
position |
Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon". |
|
type |
Typ punktu wejścia. Wartość może być główna lub pomocnicza. |
EntryPointType
Typ punktu wejścia. Wartość może być główna lub pomocnicza.
Nazwa | Typ | Opis |
---|---|---|
main |
string |
|
minor |
string |
ErrorAdditionalInfo
Dodatkowe informacje o błędzie zarządzania zasobami.
Nazwa | Typ | Opis |
---|---|---|
info |
object |
Dodatkowe informacje. |
type |
string |
Dodatkowy typ informacji. |
ErrorDetail
Szczegóły błędu.
Nazwa | Typ | Opis |
---|---|---|
additionalInfo |
Dodatkowe informacje o błędzie. |
|
code |
string |
Kod błędu. |
details |
Szczegóły błędu. |
|
message |
string |
Komunikat o błędzie. |
target |
string |
Element docelowy błędu. |
ErrorResponse
Odpowiedź na błąd
Nazwa | Typ | Opis |
---|---|---|
error |
Obiekt błędu. |
GeographicEntityType
Typ jednostki Geografia. Występuje tylko wtedy, gdy żądano właściwości entityType i jest dostępna.
Nazwa | Typ | Opis |
---|---|---|
Country |
string |
nazwa kraju/regionu |
CountrySecondarySubdivision |
string |
Powiat |
CountrySubdivision |
string |
Stan lub prowincja |
CountryTertiarySubdivision |
string |
Nazwany obszar |
Municipality |
string |
Miasto /Miasto |
MunicipalitySubdivision |
string |
Sub / Super City |
Neighbourhood |
string |
Sąsiedztwa |
PostalCodeArea |
string |
Kod pocztowy/kod pocztowy |
GeoJsonFeature
Prawidłowy GeoJSON Feature
typ obiektu. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
featureType |
string |
Typ funkcji. Wartość zależy od modelu danych, do której należy bieżąca funkcja. Niektóre modele danych mogą mieć pustą wartość. |
geometry | GeoJsonGeometry: |
Prawidłowy |
id |
string |
Identyfikator funkcji. |
type |
string:
Feature |
Określa |
GeoJsonFeatureCollection
Prawidłowy GeoJSON FeatureCollection
typ obiektu. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
features |
Zawiera listę prawidłowych |
|
type |
string:
Feature |
Określa |
GeoJsonGeometry
Prawidłowy GeoJSON
obiekt geometryczny. Typ musi być jednym z siedmiu prawidłowych typów geometrii GeoJSON — Punkt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon i GeometryCollection. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
type |
Geo |
Określa |
GeoJsonGeometryCollection
Prawidłowy GeoJSON GeometryCollection
typ obiektu. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
geometries | GeoJsonGeometry[]: |
Zawiera listę prawidłowych |
type |
string:
Geometry |
Określa |
GeoJsonLineString
Prawidłowy GeoJSON LineString
typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
coordinates |
number[] |
Współrzędne geometrii |
type |
string:
Line |
Określa |
GeoJsonMultiLineString
Prawidłowy GeoJSON MultiLineString
typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
coordinates |
number[] |
Współrzędne geometrii |
type |
string:
Multi |
Określa |
GeoJsonMultiPoint
Prawidłowy GeoJSON MultiPoint
typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
coordinates |
number[] |
Współrzędne geometrii |
type |
string:
Multi |
Określa |
GeoJsonMultiPolygon
Prawidłowy GeoJSON MultiPolygon
typ obiektu. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
coordinates |
number[] |
Zawiera listę prawidłowych |
type |
string:
Multi |
Określa |
GeoJsonPoint
Prawidłowy GeoJSON Point
typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
coordinates |
number[] |
A |
type |
string:
Point |
Określa |
GeoJsonPolygon
Prawidłowy GeoJSON Polygon
typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
coordinates |
number[] |
Współrzędne dla |
type |
string:
Polygon |
Określa |
Geometry
Informacje o kształcie geometrycznym wyniku. Występuje tylko wtedy, gdy typ == Geography.
Nazwa | Typ | Opis |
---|---|---|
id |
string |
Przekaż go jako geometryId do interfejsu API Get Search Polygon, aby pobrać informacje o geometrii dla tego wyniku. |
LatLongPairAbbreviated
Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".
Nazwa | Typ | Opis |
---|---|---|
lat |
number |
Właściwość Szerokość geograficzna |
lon |
number |
Właściwość Długość geograficzna |
LocalizedMapView
Parametr View (nazywany również parametrem "region użytkownika") umożliwia wyświetlanie poprawnych map dla określonego kraju/regionu dla regionów spornych geopolitycznie. Różne kraje/regiony mają różne widoki takich regionów, a parametr View umożliwia aplikacji zgodność z widokiem wymaganym przez kraj/region, który aplikacja będzie obsługiwać. Domyślnie parametr Widok jest ustawiony na "Unified", nawet jeśli nie zdefiniowano go w żądaniu. Twoim zadaniem jest określenie lokalizacji użytkowników, a następnie poprawne ustawienie parametru View dla tej lokalizacji. Alternatywnie możesz ustawić opcję "View=Auto", która zwróci dane mapy na podstawie adresu IP żądania. Parametr View w Azure Maps musi być używany zgodnie z obowiązującymi przepisami, w tym z tymi dotyczącymi mapowania, kraju/regionu, w którym są dostępne mapy, obrazy i inne dane oraz zawartość innych firm, do których masz uprawnienia dostępu za pośrednictwem Azure Maps. Przykład: view=IN.
Aby uzyskać szczegółowe informacje, zapoznaj się z tematem Obsługiwane widoki i zobacz dostępne widoki.
Nazwa | Typ | Opis |
---|---|---|
AE |
string |
Zjednoczone Emiraty Arabskie (widok arabski) |
AR |
string |
Argentyna (widok argentyński) |
Auto |
string |
Zwróć dane mapy na podstawie adresu IP żądania. |
BH |
string |
Bahrajn (widok arabski) |
IN |
string |
Indie (Widok indyjski) |
IQ |
string |
Irak (widok arabski) |
JO |
string |
Jordania (widok arabski) |
KW |
string |
Kuwejt (widok arabski) |
LB |
string |
Liban (widok arabski) |
MA |
string |
Maroko (widok marokański) |
OM |
string |
Oman (widok arabski) |
PK |
string |
Pakistan (Widok pakistanu) |
PS |
string |
Autonomia Palestyńska (widok arabski) |
QA |
string |
Katar (widok arabski) |
SA |
string |
Arabia Saudyjska (widok arabski) |
SY |
string |
Syria (widok arabski) |
Unified |
string |
Ujednolicony widok (inne) |
YE |
string |
Jemen (widok arabski) |
MatchType
Typy dopasowania dla operacji wyszukiwania odwrotnego adresu.
Nazwa | Typ | Opis |
---|---|---|
AddressPoint |
string |
|
HouseNumberRange |
string |
|
Street |
string |
OperatingHours
Godziny otwarcia dla weryfikacji koncepcji (punkty orientacyjne).
Nazwa | Typ | Opis |
---|---|---|
mode |
string |
Wartość używana w żądaniu: brak lub "nextSevenDays" |
timeRanges |
Lista zakresów czasu dla następnych 7 dni |
OperatingHoursRange
Godziny operacji dla interfejsu poi (punkty orientacyjne). Dostępność godzin pracy będzie się różnić w zależności od dostępnych danych. Jeśli nie zostanie przekazana, nie zostaną zwrócone żadne informacje o godzinach otwarcia. Obsługiwana wartość: nextSevenDays
Nazwa | Typ | Opis |
---|---|---|
nextSevenDays |
string |
Pokazuje godziny operacji w następnym tygodniu, począwszy od bieżącego dnia w czasie lokalnym interfejsu użytkownika. |
OperatingHoursTime
Reprezentuje datę i godzinę
Nazwa | Typ | Opis |
---|---|---|
date |
string |
Reprezentuje bieżącą datę kalendarza w strefie czasowej POI, np. "2019-02-07". |
hour |
integer |
Godziny są w formacie 24 godziny w czasie lokalnym weryfikacji koncepcji; możliwe wartości to 0–23. |
minute |
integer |
Minuty są w czasie lokalnym weryfikacji koncepcji; możliwe wartości to 0–59. |
OperatingHoursTimeRange
Zakres czasu otwierania na dzień
Nazwa | Typ | Opis |
---|---|---|
endTime |
Punkt w ciągu najbliższych 7 dni od momentu zamknięcia danego interfejsu wiersza polecenia lub początku zakresu, jeśli został zamknięty przed zakresem. |
|
startTime |
Punkt w ciągu najbliższych 7 dni od otwarcia danego interfejsu wiersza polecenia lub początku zakresu, jeśli został otwarty przed zakresem. |
PointOfInterest
Szczegóły zwróconego interfejsu poI, w tym informacje, takie jak nazwa, telefon, adres URL i klasyfikacje.
Nazwa | Typ | Opis |
---|---|---|
brands |
Brand[] |
Tablica marek. Nazwa marki dla zwracanego interfejsu POI. |
categories |
string[] |
Tablica kategorii |
categorySet |
Lista najbardziej specyficznych kategorii poI |
|
classifications |
Tablica klasyfikacji |
|
name |
string |
Nazwa właściwości POI |
openingHours |
Godziny otwarcia punktu zakupu (punkty orientacyjne). |
|
phone |
string |
Właściwość numeru telefonu |
url |
string |
Właściwość adresu URL witryny internetowej |
PointOfInterestCategorySet
Kategoria poi
Nazwa | Typ | Opis |
---|---|---|
id |
integer |
Identyfikator kategorii |
QueryType
Zwracany typ zapytania: W POBLIŻU lub NON_NEAR.
Nazwa | Typ | Opis |
---|---|---|
NEARBY |
string |
Search wykonano wokół określonej szerokości i długości geograficznej ze zdefiniowanym promieniem |
NON_NEAR |
string |
Search wykonano globalnie bez uprzedzeń do określonej szerokości geograficznej i długości geograficznej oraz bez zdefiniowanego promienia |
ResponseFormat
Żądany format odpowiedzi. Wartość może być json lub xml.
Nazwa | Typ | Opis |
---|---|---|
json |
string |
|
xml |
string |
SearchAddressResult
Ten obiekt jest zwracany z pomyślnych wywołań Search.
Nazwa | Typ | Opis |
---|---|---|
results |
Lista wyników interfejsu API Search. |
|
summary |
Obiekt podsumowania odpowiedzi interfejsu API Search |
SearchAddressResultItem
Obiekt wyniku odpowiedzi interfejsu API Search.
Nazwa | Typ | Opis |
---|---|---|
address |
Adres wyniku |
|
addressRanges |
Opisuje zakres adresów po obu stronach ulicy dla wyniku wyszukiwania. Uwzględniane są współrzędne dla lokalizacji początkowych i końcowych zakresu adresów. |
|
dataSources |
Sekcja opcjonalna. Identyfikator geometrii odwołania do użycia z interfejsem API Get Search Polygon. |
|
detourTime |
integer |
Czas objazdu w sekundach. Zwrócono tylko wywołania interfejsu API Search Wzdłuż trasy. |
dist |
number |
Odległość linii prostej między lokalizacją wyniku a geobiasami w metrach. |
entityType |
Typ jednostki Geografia. Występuje tylko wtedy, gdy żądano właściwości entityType i jest dostępna. |
|
entryPoints |
Tablica punktów wejścia. Opisują one typy wejść dostępnych w lokalizacji. Typ może być "główny" dla głównych wejść, takich jak drzwi wejściowe, lub hol, i "drobne", dla drzwi bocznych i tylnych. |
|
id |
string |
Właściwość Id |
info |
string |
Informacje o oryginalnym źródle danych wyniku. Służy do obsługi żądań pomocy technicznej. |
matchType |
Informacje o typie dopasowania. Jeden z:
|
|
poi |
Szczegóły zwróconego interfejsu poI, w tym informacje, takie jak nazwa, telefon, adres URL i klasyfikacje. |
|
position |
Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon". |
|
score |
number |
Wartość w zestawie wyników wskazująca względny wynik dopasowania między wynikami. Można to użyć, aby określić, że wynik x jest dwa razy bardziej prawdopodobny w wyniku y, jeśli wartość x wynosi 2x wartość y. Wartości różnią się między zapytaniami i są przeznaczone tylko jako wartość względna dla jednego zestawu wyników. |
type |
Jeden z:
|
|
viewport |
Widokport, który obejmuje wynik reprezentowany przez współrzędne w lewym górnym i prawym dolnym rogu portu widoku. |
SearchAddressResultType
Jeden z:
- UM
- Ulica
- Lokalizacja geograficzna
- Adres punktu
- Zakres adresów
- Cross Street
Nazwa | Typ | Opis |
---|---|---|
Address Range |
string |
|
Cross Street |
string |
|
Geography |
string |
|
POI |
string |
|
Point Address |
string |
|
Street |
string |
SearchIndexes
Indeksy, dla których należy uwzględnić rozszerzone kody pocztowe w wynikach.
Dostępne indeksy to:
Addr = zakresy adresów
Geo = Geografie
PAD = adresy punktów
POI = punkty orientacyjne
Str = ulice
XStr = Cross Streets (skrzyżowania)
Wartość powinna być rozdzielaną przecinkami listą typów indeksów (w dowolnej kolejności) lub Brak dla żadnych indeksów.
Domyślnie rozszerzone kody pocztowe są uwzględniane dla wszystkich indeksów z wyjątkiem geo. Rozszerzone listy kodów pocztowych dla lokalizacji geograficznych mogą być dość długie, więc w razie potrzeby muszą być jawnie żądane.
Przykłady użycia:
extendedPostalCodesFor=POI
extendedPostalCodesFor=PAD,Addr,POI
extendedPostalCodesFor=None
Rozszerzony kod pocztowy jest zwracany jako właściwość extendedPostalCode adresu. Dostępność jest zależna od regionu.
Nazwa | Typ | Opis |
---|---|---|
Addr |
string |
|
Geo |
string |
|
PAD |
string |
|
POI |
string |
|
Str |
string |
|
Xstr |
string |
SearchInsideGeometryRequest
Ten typ reprezentuje treść żądania dla usługi Search Inside Geometry.
Nazwa | Typ | Opis |
---|---|---|
geometry | GeoJsonObject: |
Prawidłowy |
SearchSummary
Obiekt podsumowania odpowiedzi interfejsu API Search.
Nazwa | Typ | Opis |
---|---|---|
fuzzyLevel |
integer |
Maksymalny poziom rozmyty wymagany do udostępnienia wyników. |
geoBias |
Wskazanie, kiedy wewnętrzna wyszukiwarka zastosowała stronniczość geoprzestrzenną, aby poprawić klasyfikację wyników. W niektórych metodach może to mieć wpływ, ustawiając parametry lat i lon, jeśli są dostępne. W innych przypadkach jest to wyłącznie wewnętrzne. |
|
limit |
integer |
Maksymalna liczba odpowiedzi, które zostaną zwrócone |
numResults |
integer |
Liczba wyników w odpowiedzi. |
offset |
integer |
Przesunięcie początkowe zwróconych wyników w pełnym zestawie wyników. |
query |
string |
Parametr zapytania, który został użyty do wygenerowania tych wyników wyszukiwania. |
queryTime |
integer |
Czas spędzony na rozpoznawaniu zapytania w milisekundach. |
queryType |
Zwracany typ zapytania: W POBLIŻU lub NON_NEAR. |
|
totalResults |
integer |
Łączna liczba znalezionych wyników. |