Search - Get Search Nearby
Użyj polecenia , aby wyszukać punkty orientacyjne w pobliżu określonej lokalizacji.
Interfejs Get Search Nearby
API jest najbardziej przydatnym żądaniem HTTP GET
w przypadku pobierania wyników poi wokół określonej lokalizacji. Ten punkt końcowy zwróci tylko wyniki poi i nie będzie przyjmować parametru zapytania wyszukiwania.
GET https://atlas.microsoft.com/search/nearby/{format}?api-version=1.0&lat={lat}&lon={lon}
GET https://atlas.microsoft.com/search/nearby/{format}?api-version=1.0&lat={lat}&lon={lon}&limit={limit}&ofs={ofs}&categorySet={categorySet}&countrySet={countrySet}&radius={radius}&language={language}&extendedPostalCodesFor={extendedPostalCodesFor}&brandSet={brandSet}&connectorSet={connectorSet}&view={view}
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. |
lat
|
query | True |
number double |
Szerokość geograficzna, w której wyniki powinny być stronnicze. Np. 37.337. |
lon
|
query | True |
number double |
Długość geograficzna, w której wyniki powinny być stronnicze. Np. -121.89. |
brand
|
query |
string[] |
Rozdzielona przecinkami lista nazw marek, których można użyć do ograniczenia wyniku do określonych marek. Kolejność elementów nie ma znaczenia. Po udostępnieniu wielu marek zostaną zwrócone tylko wyniki należące do (co najmniej) jednej z podanych list. Marki, które zawierają "", w ich nazwie powinny być umieszczane w cudzysłowie. Przykłady użycia: brandSet=Foo brandSet=Foo,Bar brandSet="A,B,C Przecinek",Bar |
|
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
|
|
connector
|
query |
Rozdzielona przecinkami lista typów łączników, których można użyć do ograniczenia wyniku do stacji pojazdów elektrycznych obsługujących określone typy łączników. Kolejność elementów nie ma znaczenia. Po podaniu wielu typów łączników zostaną zwrócone tylko wyniki należące do (co najmniej) jednej z podanych list. Dostępne typy łączników to:
Przykłady użycia: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached |
||
country
|
query |
string[] |
Ciąg rozdzielony przecinkami kodów kraju/regionu, np. FR,ES. Spowoduje to ograniczenie wyszukiwania do określonych krajów/regionów |
|
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. |
||
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 |
|
ofs
|
query |
integer |
Przesunięcie początkowe zwróconych wyników w pełnym zestawie wyników. Ustawienie domyślne: 0 |
|
radius
|
query |
integer |
Promień w metrach do wyników, które mają być ograniczone do zdefiniowanego obszaru, Minimalna wartość to 1, Wartość maksymalna to 50000. |
|
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. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Wystąpił nieoczekiwany błąd. |
Zabezpieczenia
AADToken
Są to przepływy Microsoft Entra OAuth 2.0. Po 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 Azure Maps konta zasobu 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ęć związanych z uwierzytelnianiem. Podsumowując, ta definicja zabezpieczeń stanowi 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 any points of interest (POI) within 5 miles of Manhattan NY and return the top 10 results
Przykładowe żądanie
GET https://atlas.microsoft.com/search/nearby/json?api-version=1.0&lat=40.70627&lon=-74.011454&limit=10&radius=8046
Przykładowa odpowiedź
{
"summary": {
"queryType": "NEARBY",
"queryTime": 137,
"numResults": 10,
"offset": 0,
"totalResults": 256620,
"fuzzyLevel": 1,
"geoBias": {
"lat": 40.70627,
"lon": -74.011454
}
},
"results": [
{
"type": "POI",
"id": "US/POI/p1/7652731",
"score": 1,
"dist": 14.736843483489132,
"info": "search:ta:840369002225435-US",
"poi": {
"name": "Ycd Multimedia",
"phone": "+(1)-(212)-5091049",
"categorySet": [
{
"id": 9152
}
],
"classifications": [
{
"code": "NON_GOVERNMENTAL_ORGANIZATION",
"names": [
{
"nameLocale": "en-US",
"name": "non governmental organization"
}
]
}
]
},
"address": {
"streetNumber": "55",
"streetName": "Exchange Pl",
"municipalitySubdivision": "New York City, NYC, New York, Financial District",
"municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10004",
"extendedPostalCode": "100042320",
"countryCode": "US",
"country": "United States Of America",
"countryCodeISO3": "USA",
"freeformAddress": "55 Exchange Pl, New York, NY 10004",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.7064,
"lon": -74.01142
},
"viewport": {
"topLeftPoint": {
"lat": 40.7073,
"lon": -74.01261
},
"btmRightPoint": {
"lat": 40.7055,
"lon": -74.01023
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.70636,
"lon": -74.01145
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/7652732",
"score": 1,
"dist": 14.736843483489132,
"info": "search:ta:840369001882610-US",
"poi": {
"name": "Grubb & Ellis Management Services",
"phone": "+(1)-(212)-7851619",
"categorySet": [
{
"id": 9352039
}
],
"classifications": [
{
"code": "COMPANY",
"names": [
{
"nameLocale": "en-US",
"name": "company"
},
{
"nameLocale": "en-US",
"name": "services"
}
]
}
]
},
"address": {
"streetNumber": "55",
"streetName": "Exchange Pl",
"municipalitySubdivision": "New York City, NYC, New York, Financial District",
"municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10004",
"extendedPostalCode": "100042320",
"countryCode": "US",
"country": "United States Of America",
"countryCodeISO3": "USA",
"freeformAddress": "55 Exchange Pl, New York, NY 10004",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.7064,
"lon": -74.01142
},
"viewport": {
"topLeftPoint": {
"lat": 40.7073,
"lon": -74.01261
},
"btmRightPoint": {
"lat": 40.7055,
"lon": -74.01023
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.70636,
"lon": -74.01145
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/7652735",
"score": 1,
"dist": 14.736843483489132,
"info": "search:ta:840369001322824-US",
"poi": {
"name": "Hispanic Federation",
"phone": "+(1)-(212)-7420480",
"categorySet": [
{
"id": 9910004
}
],
"url": "Hispanicfederation.org",
"classifications": [
{
"code": "AUTOMOTIVE_DEALER",
"names": [
{
"nameLocale": "en-US",
"name": "boat"
},
{
"nameLocale": "en-US",
"name": "automotive dealer"
}
]
}
]
},
"address": {
"streetNumber": "55",
"streetName": "Exchange Pl",
"municipalitySubdivision": "New York City, NYC, New York, Financial District",
"municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10004",
"extendedPostalCode": "100042320",
"countryCode": "US",
"country": "United States Of America",
"countryCodeISO3": "USA",
"freeformAddress": "55 Exchange Pl, New York, NY 10004",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.7064,
"lon": -74.01142
},
"viewport": {
"topLeftPoint": {
"lat": 40.7073,
"lon": -74.01261
},
"btmRightPoint": {
"lat": 40.7055,
"lon": -74.01023
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.70636,
"lon": -74.01145
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/7652736",
"score": 1,
"dist": 14.736843483489132,
"info": "search:ta:840369000631230-US",
"poi": {
"name": "Edwin Gould Foundation",
"phone": "+(1)-(212)-9825200",
"categorySet": [
{
"id": 9152
}
],
"url": "edwingouldfoundation.org",
"classifications": [
{
"code": "NON_GOVERNMENTAL_ORGANIZATION",
"names": [
{
"nameLocale": "en-US",
"name": "non governmental organization"
}
]
}
]
},
"address": {
"streetNumber": "55",
"streetName": "Exchange Pl",
"municipalitySubdivision": "New York City, NYC, New York, Financial District",
"municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10004",
"extendedPostalCode": "100042320",
"countryCode": "US",
"country": "United States Of America",
"countryCodeISO3": "USA",
"freeformAddress": "55 Exchange Pl, New York, NY 10004",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.7064,
"lon": -74.01142
},
"viewport": {
"topLeftPoint": {
"lat": 40.7073,
"lon": -74.01261
},
"btmRightPoint": {
"lat": 40.7055,
"lon": -74.01023
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.70636,
"lon": -74.01145
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/7652737",
"score": 1,
"dist": 14.736843483489132,
"info": "search:ta:840369001196585-US",
"poi": {
"name": "Newmark Grubb Knight Frank",
"phone": "+(1)-(646)-6951990",
"categorySet": [
{
"id": 9361015
}
],
"url": "www.newmarkkf.com",
"classifications": [
{
"code": "SHOP",
"names": [
{
"nameLocale": "en-US",
"name": "shop"
},
{
"nameLocale": "en-US",
"name": "real estate agents"
}
]
}
]
},
"address": {
"streetNumber": "55",
"streetName": "Exchange Pl",
"municipalitySubdivision": "New York City, NYC, New York, Financial District",
"municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10004",
"extendedPostalCode": "100042320",
"countryCode": "US",
"country": "United States Of America",
"countryCodeISO3": "USA",
"freeformAddress": "55 Exchange Pl, New York, NY 10004",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.7064,
"lon": -74.01142
},
"viewport": {
"topLeftPoint": {
"lat": 40.7073,
"lon": -74.01261
},
"btmRightPoint": {
"lat": 40.7055,
"lon": -74.01023
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.70636,
"lon": -74.01145
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/7652738",
"score": 1,
"dist": 14.736843483489132,
"info": "search:ta:840369002164164-US",
"poi": {
"name": "Sponsors For Educational Opportunity",
"phone": "+(1)-(212)-7851361",
"categorySet": [
{
"id": 9152
}
],
"url": "www.seo-usa.org",
"classifications": [
{
"code": "NON_GOVERNMENTAL_ORGANIZATION",
"names": [
{
"nameLocale": "en-US",
"name": "non governmental organization"
}
]
}
]
},
"address": {
"streetNumber": "55",
"streetName": "Exchange Pl",
"municipalitySubdivision": "New York City, NYC, New York, Financial District",
"municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10004",
"extendedPostalCode": "100042320",
"countryCode": "US",
"country": "United States Of America",
"countryCodeISO3": "USA",
"freeformAddress": "55 Exchange Pl, New York, NY 10004",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.7064,
"lon": -74.01142
},
"viewport": {
"topLeftPoint": {
"lat": 40.7073,
"lon": -74.01261
},
"btmRightPoint": {
"lat": 40.7055,
"lon": -74.01023
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.70636,
"lon": -74.01145
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/7373205",
"score": 1,
"dist": 14.736843483489132,
"info": "search:ta:840361001736646-US",
"poi": {
"name": "Visiting Nurse Service",
"phone": "+(1)-(212)-7428259",
"categorySet": [
{
"id": 9663
}
],
"url": "www.vnsny.org",
"classifications": [
{
"code": "HEALTH_CARE_SERVICE",
"names": [
{
"nameLocale": "en-US",
"name": "health care service"
}
]
}
]
},
"address": {
"streetNumber": "55",
"streetName": "Exchange Pl",
"municipalitySubdivision": "New York City, NYC, New York, Financial District",
"municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10004",
"extendedPostalCode": "100042320",
"countryCode": "US",
"country": "United States Of America",
"countryCodeISO3": "USA",
"freeformAddress": "55 Exchange Pl, New York, NY 10004",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.7064,
"lon": -74.01142
},
"viewport": {
"topLeftPoint": {
"lat": 40.7073,
"lon": -74.01261
},
"btmRightPoint": {
"lat": 40.7055,
"lon": -74.01023
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.70636,
"lon": -74.01145
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/7373206",
"score": 1,
"dist": 14.736843483489132,
"info": "search:ta:840361001326915-US",
"poi": {
"name": "Hispanic In Philanthropy",
"phone": "+(1)-(646)-2777101",
"categorySet": [
{
"id": 9152
}
],
"url": "www.hiponline.org",
"classifications": [
{
"code": "NON_GOVERNMENTAL_ORGANIZATION",
"names": [
{
"nameLocale": "en-US",
"name": "non governmental organization"
}
]
}
]
},
"address": {
"streetNumber": "55",
"streetName": "Exchange Pl",
"municipalitySubdivision": "New York City, NYC, New York, Financial District",
"municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10004",
"extendedPostalCode": "100042320",
"countryCode": "US",
"country": "United States Of America",
"countryCodeISO3": "USA",
"freeformAddress": "55 Exchange Pl, New York, NY 10004",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.7064,
"lon": -74.01142
},
"viewport": {
"topLeftPoint": {
"lat": 40.7073,
"lon": -74.01261
},
"btmRightPoint": {
"lat": 40.7055,
"lon": -74.01023
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.70636,
"lon": -74.01145
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/7373207",
"score": 1,
"dist": 14.736843483489132,
"info": "search:ta:840369002316633-US",
"poi": {
"name": "Advantage Technical Resourcing",
"phone": "+(1)-(212)-2691140",
"categorySet": [
{
"id": 9352039
}
],
"classifications": [
{
"code": "COMPANY",
"names": [
{
"nameLocale": "en-US",
"name": "company"
},
{
"nameLocale": "en-US",
"name": "services"
}
]
}
]
},
"address": {
"streetNumber": "55",
"streetName": "Exchange Pl",
"municipalitySubdivision": "New York City, NYC, New York, Financial District",
"municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10004",
"extendedPostalCode": "100042320",
"countryCode": "US",
"country": "United States Of America",
"countryCodeISO3": "USA",
"freeformAddress": "55 Exchange Pl, New York, NY 10004",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.7064,
"lon": -74.01142
},
"viewport": {
"topLeftPoint": {
"lat": 40.7073,
"lon": -74.01261
},
"btmRightPoint": {
"lat": 40.7055,
"lon": -74.01023
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.70636,
"lon": -74.01145
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/7373208",
"score": 1,
"dist": 14.736843483489132,
"info": "search:ta:840369002031974-US",
"poi": {
"name": "Workshop In Bus Opportunities",
"phone": "+(1)-(212)-6840854",
"categorySet": [
{
"id": 9352039
}
],
"url": "www.wibo.org",
"classifications": [
{
"code": "COMPANY",
"names": [
{
"nameLocale": "en-US",
"name": "company"
},
{
"nameLocale": "en-US",
"name": "services"
}
]
}
]
},
"address": {
"streetNumber": "55",
"streetName": "Exchange Pl",
"municipalitySubdivision": "New York City, NYC, New York, Financial District",
"municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10004",
"extendedPostalCode": "100042320",
"countryCode": "US",
"country": "United States Of America",
"countryCodeISO3": "USA",
"freeformAddress": "55 Exchange Pl, New York, NY 10004",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.7064,
"lon": -74.01142
},
"viewport": {
"topLeftPoint": {
"lat": 40.7073,
"lon": -74.01261
},
"btmRightPoint": {
"lat": 40.7055,
"lon": -74.01023
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.70636,
"lon": -74.01145
}
}
]
}
]
}
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. |
Electric |
Rozdzielona przecinkami lista typów łączników, których można użyć do ograniczenia wyniku do stacji pojazdów elektrycznych obsługujących określone typy łączników. Kolejność elementów nie ma znaczenia. Po podaniu wielu typów łączników zostaną zwrócone tylko wyniki należące do (co najmniej) jednej z podanych list. Dostępne typy łączników to:
Przykłady użycia: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached |
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 zażądano parametru entityType i jest dostępny. |
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 |
Reprezentuje datę i godzinę |
Operating |
Zakres czasu otwierania na dzień |
Point |
Szczegóły zwróconego interfejsu użytkownika, w tym informacje, takie jak nazwa, telefon, adres URL i klasyfikacje. |
Point |
Kategoria poi |
Query |
Zwracany typ zapytania: NEARBY 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 |
Wynik obiektu 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 |
Obiekt podsumowania odpowiedzi interfejsu API Search. |
Address
Adres wyniku
Nazwa | Typ | Opis |
---|---|---|
boundingBox |
Pole ograniczenia lokalizacji. |
|
buildingNumber |
string |
Numer budynku na ulicy. PRZESTARZAŁE, zamiast tego użyj streetNumber. |
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 przedstawiany w skróconej formie. Obsługiwane tylko w przypadku Stanów Zjednoczonych, Kanady i Wielkiej Brytanii. |
countryTertiarySubdivision |
string |
Nazwany obszar |
crossStreet |
string |
Nazwa ulicy, która jest przekraczana. |
extendedPostalCode |
string |
Rozszerzony kod pocztowy (dostępność zależy od regionu). |
freeformAddress |
string |
Wiersz adresu sformatowany zgodnie z regułami formatowania kraju/regionu pochodzenia wyniku 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 na potrzeby adresowania, bez jednostki administracyjnej. To pole służy do kompilowania |
municipality |
string |
Miasto/Miasto |
municipalitySubdivision |
string |
Sub/Super City |
neighbourhood |
string |
Sąsiedztwo to geograficznie zlokalizowany obszar w mieście lub mieście o charakterystycznych cechach i interakcjach społecznych 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 nazwy streetName. |
streetName |
string |
Nazwa ulicy. |
streetNameAndNumber |
string |
Nazwa i numer ulicy. |
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. |
ElectricVehicleConnector
Rozdzielona przecinkami lista typów łączników, których można użyć do ograniczenia wyniku do stacji pojazdów elektrycznych obsługujących określone typy łączników. Kolejność elementów nie ma znaczenia. Po podaniu wielu typów łączników zostaną zwrócone tylko wyniki należące do (co najmniej) jednej z podanych list.
Dostępne typy łączników to:
-
StandardHouseholdCountrySpecific
- Są to standardowe łączniki gospodarstw domowych dla określonego regionu. Wszystkie są one pojedynczą fazą AC i standardowym napięciem i standardowym amperażem. Zobacz też: Podłączanie typów gniazd & — światowe standardy. -
IEC62196Type1
- Typ 1 łącznik zdefiniowany w standardzie IEC 62196-2. Nazwany również Yazaki po oryginalnym producencie lub SAE J1772 po standardzie, który po raz pierwszy go opublikował. Najczęściej używane w połączeniu z pojedynczą fazą 120V lub maksymalnie 240V infrastruktury jednofazowej. -
IEC62196Type1CCS
- Łącznik kombi oparty na typie 1, zgodnie z definicją w standardzie IEC 62196-3. Łącznik jest oparty na łączniku typu 1, zgodnie z definicją w standardzie IEC 62196-2, z dwoma dodatkowymi kontaktami prądu bezpośredniego (DC), aby umożliwić szybkie ładowanie DC. -
IEC62196Type2CableAttached
- Łącznik typu 2 zdefiniowany w standardzie IEC 62196-2. Dostarczone jako kabel i podłączona do punktu ładowania. -
IEC62196Type2Outlet
- Łącznik typu 2 zdefiniowany w standardzie IEC 62196-2. Dostarczone jako gniazdo ustawione w punkcie ładowania. -
IEC62196Type2CCS
- Łącznik kombi oparty na typie 2, zgodnie z definicją w standardzie IEC 62196-3. Łącznik jest oparty na łączniku typu 2, zgodnie z definicją w standardzie IEC 62196-2, z dwoma dodatkowymi kontaktami prądu bezpośredniego (DC), aby umożliwić szybkie ładowanie DC. -
IEC62196Type3
- Łącznik typu 3 zdefiniowany w standardzie IEC 62196-2. Również o nazwie Scame po oryginalnym producencie. Najczęściej używane w połączeniu z maksymalnie 240V pojedynczą fazą lub maksymalnie 420V infrastruktury trójfazowej. -
Chademo
- Łącznik CHAdeMO o nazwie od stowarzyszenia utworzonego przez Tokyo Electric Power Company i partnerów przemysłowych. Z tego powodu jest również znany jako łącznik TEPCO. Obsługuje szybkie ładowanie dc. -
IEC60309AC1PhaseBlue
- Łącznik Przemysłowy Niebieski jest łącznikiem zdefiniowanym w standardzie IEC 60309. Czasami jest określany przez połączenie standardu, koloru i faktu, że jest to łącznik z jedną fazą. Łącznik zwykle ma konfigurację "P+N+E, 6h". -
IEC60309DCWhite
- Łącznik przemysłowy Biały jest łącznikiem DC zdefiniowanym w standardzie IEC 60309. -
Tesla
- Łącznik Tesli jest regionalnie specyficzny łącznik Tesla Supercharger. Oznacza to, że odnosi się do zastrzeżonego łącznika Tesli, czasami określanego jako Tesla Port, głównie ograniczone do Ameryka Północna lub zmodyfikowanego typu 2 (DC nad typem 2) w Europie.
Przykłady użycia:
connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
Nazwa | Typ | Opis |
---|---|---|
Chademo |
string |
Łącznik CHAdeMO o nazwie od stowarzyszenia utworzonego przez Tokyo Electric Power Company i partnerów przemysłowych. Z tego powodu jest również znany jako łącznik TEPCO. Obsługuje szybkie ładowanie dc. |
IEC60309AC1PhaseBlue |
string |
Łącznik Industrial Blue jest łącznikiem zdefiniowanym w standardzie IEC 60309. Czasami jest określany przez połączenie standardu, koloru i faktu, że jest to łącznik z jedną fazą. Łącznik zwykle ma konfigurację "P+N+E, 6h". |
IEC60309DCWhite |
string |
Łącznik Przemysłowy Biały jest łącznikiem DC zdefiniowanym w standardzie IEC 60309. |
IEC62196Type1 |
string |
Typ 1 łącznik zdefiniowany w standardzie IEC 62196-2. Nazwany również Yazaki po oryginalnym producencie lub SAE J1772 po standardzie, który po raz pierwszy go opublikował. Najczęściej używane w połączeniu z pojedynczą fazą 120V lub maksymalnie 240V infrastruktury jednofazowej. |
IEC62196Type1CCS |
string |
Łącznik kombi oparty na typie 1, zgodnie z definicją w standardzie IEC 62196-3. Łącznik jest oparty na łączniku typu 1, zgodnie z definicją w standardzie IEC 62196-2, z dwoma dodatkowymi kontaktami prądu bezpośredniego (DC), aby umożliwić szybkie ładowanie DC. |
IEC62196Type2CCS |
string |
Łącznik kombi oparty na typie 2, zgodnie z definicją w standardzie IEC 62196-3. Łącznik jest oparty na łączniku typu 2, zgodnie z definicją w standardzie IEC 62196-2, z dwoma dodatkowymi kontaktami prądu bezpośredniego (DC), aby umożliwić szybkie ładowanie DC. |
IEC62196Type2CableAttached |
string |
Łącznik typu 2 zdefiniowany w standardzie IEC 62196-2. Dostarczone jako kabel i podłączona do punktu ładowania |
IEC62196Type2Outlet |
string |
Łącznik typu 2 zdefiniowany w standardzie IEC 62196-2. Dostarczone jako gniazdo ustawione w punkcie ładowania. |
IEC62196Type3 |
string |
Typ 3 łącznika zdefiniowany w standardzie IEC 62196-2. Również o nazwie Scame po oryginalnym producencie. Najczęściej używane w połączeniu z maksymalnie 240V pojedynczą fazą lub maksymalnie 420V infrastruktury trójfazowej. |
StandardHouseholdCountrySpecific |
string |
Są to standardowe łączniki gospodarstwa domowego dla określonego regionu. Wszystkie są one pojedynczą fazą AC i standardowym napięciem i standardowym amperażem. Zobacz również: Podłączanie typów gniazd & — światowe standardy |
Tesla |
string |
Łącznik Tesli jest regionalnym łącznikiem Tesla Supercharger. Oznacza to, że odnosi się do zastrzeżonego łącznika Tesli, czasami określanego jako Tesla Port, głównie ograniczone do Ameryka Północna lub zmodyfikowanego typu 2 (DC nad typem 2) w Europie. |
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 error. |
GeographicEntityType
Typ jednostki Geografia. Występuje tylko wtedy, gdy zażądano parametru entityType i jest dostępny.
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 |
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 |
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 użytkownika, w tym informacje, takie jak nazwa, telefon, adres URL i klasyfikacje.
Nazwa | Typ | Opis |
---|---|---|
brands |
Brand[] |
Tablica marek. Nazwa marki zwracanej przez weryfikację koncepcji. |
categories |
string[] |
Tablica kategorii |
categorySet |
Lista najbardziej określonych kategorii poi |
|
classifications |
Tablica klasyfikacji |
|
name |
string |
Nazwa właściwości POI |
openingHours |
Godziny otwarcia dla weryfikacji koncepcji (punkty orientacyjne). |
|
phone |
string |
Właściwość numeru telefonu |
url |
string |
Właściwość adresu URL witryny sieci Web |
PointOfInterestCategorySet
Kategoria poi
Nazwa | Typ | Opis |
---|---|---|
id |
integer |
Identyfikator kategorii |
QueryType
Zwracany typ zapytania: NEARBY 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 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
Wynik obiektu 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ątkowej i końcowej zakresu adresów. |
|
dataSources |
Sekcja opcjonalna. Dokumentacja identyfikatora geometrii do użycia z interfejsem API Get Search Polygon. |
|
detourTime |
integer |
Czas objazdu w sekundach. Zwracane tylko w przypadku wywołań interfejsu API Search Wzdłuż trasy. |
dist |
number |
Odległość linii prostej między wynikiem a lokalizacją geobiazy w metrach. |
entityType |
Typ jednostki Geografia. Występuje tylko wtedy, gdy zażądano parametru entityType i jest dostępny. |
|
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 użytkownika, 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 użyć tej funkcji, aby określić, że wynik x jest dwa razy bardziej prawdopodobny w wyniku y, jeśli wartość x jest 2x wartością 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 |
Port widoków, który obejmuje wynik reprezentowany przez współrzędne w lewym górnym i prawym dolnym rogu panelu widoków. |
SearchAddressResultType
Jeden z:
- UM
- Ulica
- Lokalizacja geograficzna
- Adres punktu
- Zakres adresów
- Ulica krzyżowa
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 |
SearchSummary
Obiekt podsumowania odpowiedzi interfejsu API Search.
Nazwa | Typ | Opis |
---|---|---|
fuzzyLevel |
integer |
Maksymalny poziom rozmyty wymagany do dostarczenia 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 na ustawienie parametrów 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: NEARBY lub NON_NEAR. |
|
totalResults |
integer |
Łączna liczba znalezionych wyników. |