Search - Post Search Fuzzy Batch
Służy do wysyłania partii zapytań do interfejsu API rozmytego Search w jednym żądaniu asynchronicznym.
Interfejs Post Search Fuzzy Batch
API to żądanie HTTPPOST
, które wysyła partie zapytań do Search interfejsu API rozmytego w jednym wywołaniu asynchronicznym. Możesz wywołać Search interfejsu API fuzzy Batch, aby uruchomić asynchronicznie (asynchronicznie) lub synchronicznie (synchronizacja). Interfejs API asynchroniczny umożliwia obiektowi wywołującego dzielenie na partie do 10 000 zapytań i synchronizowanie interfejsu API do 100 zapytań.
Przesyłanie synchronicznego żądania usługi Batch
Interfejs API synchroniczny jest zalecany w przypadku lekkich żądań wsadowych. Gdy usługa otrzyma żądanie, odpowie natychmiast po obliczeniu elementów wsadowych i nie będzie możliwości późniejszego pobrania wyników. Interfejs API synchroniczny zwróci błąd limitu czasu (odpowiedź 408), jeśli żądanie trwa dłużej niż 60 sekund. Liczba elementów wsadowych jest ograniczona do 100 dla tego interfejsu API.
POST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0&subscription-key={subscription-key}
Przesyłanie asynchronicznego żądania usługi Batch
Interfejs API asynchroniczny jest odpowiedni do przetwarzania dużych woluminów stosunkowo złożonych żądań wyszukiwania
- Umożliwia pobieranie wyników w osobnym wywołaniu (możliwe jest wiele pobrań).
- Interfejs API asynchroniczny jest zoptymalizowany pod kątem niezawodności i nie oczekuje się przekroczenia limitu czasu.
- Liczba elementów wsadowych jest ograniczona do 10 000 dla tego interfejsu API.
Gdy wysyłasz żądanie przy użyciu żądania asynchronicznego, domyślnie usługa zwraca kod odpowiedzi 202 wraz z adresem URL przekierowania w polu Lokalizacja nagłówka odpowiedzi. Ten adres URL powinien być okresowo sprawdzany do momentu udostępnienia danych odpowiedzi lub informacji o błędzie. Odpowiedzi asynchroniczne są przechowywane przez 14 dni. Adres URL przekierowania zwraca odpowiedź 404, jeśli zostanie użyta po upływie okresu ważności.
Należy pamiętać, że asynchroniczne żądanie wsadowe jest długotrwałą operacją. Oto typowa sekwencja operacji:
- Klient wysyła żądanie usługi Search Fuzzy Batch
POST
do Azure Maps.
POST https://atlas.microsoft.com/search/fuzzy/batch/json?api-version=1.0&subscription-key={subscription-key}
Serwer odpowie jednym z następujących elementów:
HTTP
202 Accepted
— żądanie usługi Batch zostało zaakceptowane.HTTP
Error
— wystąpił błąd podczas przetwarzania żądania usługi Batch. Może to być400 Bad Request
inny kod stanu lub .Error
Jeśli żądanie wsadowe zostało zaakceptowane pomyślnie,
Location
nagłówek w odpowiedzi zawiera adres URL umożliwiający pobranie wyników żądania wsadowego. Ten identyfikator URI stanu wygląda następująco:
GET https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
- Klient wystawia
GET
żądanie w adresie URL pobierania uzyskanym w kroku 3 w celu pobrania wyników wsadowych.
Treść POST dla żądania wsadowego
Aby wysłać zapytania rozmyte wyszukiwania , użyj POST
żądania, w którym treść żądania będzie zawierać batchItems
tablicę w json
formacie, a Content-Type
nagłówek zostanie ustawiony na application/json
wartość . Oto przykładowa treść żądania zawierająca 5 zapytań rozmytych wyszukiwania :
{
"batchItems": [
{"query": "?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5"},
{"query": "?query=Statue Of Liberty&limit=2"},
{"query": "?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000"},
{"query": "?query=Space Needle"},
{"query": "?query=pizza&limit=10"}
]
}
Zapytanie rozmyte wyszukiwania w partii to tylko częściowy adres URL bez protokołu, podstawowego adresu URL, ścieżki, wersji interfejsu API i klucza subskrypcji. Może zaakceptować dowolny z obsługiwanych parametrów identyfikatora URI wyszukiwania rozmytego. Wartości ciągu w kwerendzie rozmytej wyszukiwania muszą być poprawnie uniknięte (np. znak powinien zostać uniknięty znakiem \ ), a także powinien być poprawnie zakodowany pod adresem URL.
Interfejs API asynchroniczny umożliwia obiektowi wywołującego dzielenie na partie do 10 000 zapytań i synchronizowanie interfejsu API do 100 zapytań, a partia powinna zawierać co najmniej 1 zapytanie.
Pobieranie asynchronicznych wyników usługi Batch
Aby pobrać wyniki asynchronicznego pobierania wsadowego GET
, należy wysłać żądanie do punktu końcowego pobierania wsadowego. Ten adres URL pobierania można uzyskać z Location
nagłówka pomyślnego POST
żądania wsadowego i wygląda następująco:
https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
Oto typowa sekwencja operacji pobierania wyników wsadowych:
Klient wysyła
GET
żądanie przy użyciu adresu URL pobierania.Serwer odpowie jednym z następujących elementów:
HTTP
202 Accepted
— żądanie usługi Batch zostało zaakceptowane, ale nadal jest przetwarzane. Spróbuj ponownie za jakiś czas.HTTP
200 OK
— pomyślnie przetworzone żądanie usługi Batch. Treść odpowiedzi zawiera wszystkie wyniki wsadowe.
Model odpowiedzi wsadowej
Zwrócona zawartość danych jest podobna dla żądań asynchronicznych i synchronizacji. Podczas pobierania wyników asynchronicznego żądania wsadowego, jeśli partia zakończyła przetwarzanie, treść odpowiedzi zawiera odpowiedź wsadową. Ta odpowiedź wsadowa summary
zawiera składnik wskazujący, które były częścią oryginalnego żądania wsadowego totalRequests
i successfulRequests
zapytania, które zostały wykonane pomyślnie. Odpowiedź wsadowa zawiera również tablicę zawierającą batchItems
odpowiedź dla każdego zapytania w żądaniu wsadowym. Element batchItems
będzie zawierać wyniki w dokładnie takiej samej kolejności, w jaki oryginalne zapytania zostały wysłane w żądaniu wsadowym. Każdy element w pliku batchItems
zawiera statusCode
pola i response
. Każdy response
element w batchItems
jest jednym z następujących typów:
SearchAddressResult
— Jeśli zapytanie zostało ukończone pomyślnie.Error
— Jeśli zapytanie nie powiodło się. Odpowiedź będzie zawierać elementcode
imessage
w tym przypadku.
Oto przykładowa odpowiedź wsadowa z wynikiem 2 pomyślnym i 1 niepowodzeniem :
{
"summary": {
"successfulRequests": 2,
"totalRequests": 3
},
"batchItems": [
{
"statusCode": 200,
"response":
{
"summary": {
"query": "atm"
},
"results": [
{
"type": "POI",
"poi": {
"name": "ATM at Wells Fargo"
},
"address": {
"country": "United States Of America",
"freeformAddress": "3240 157th Ave NE, Redmond, WA 98052"
}
}
]
}
},
{
"statusCode": 200,
"response":
{
"summary": {
"query": "statue of liberty"
},
"results": [
{
"type": "POI",
"poi": {
"name": "Statue of Liberty"
},
"address": {
"country": "United States Of America",
"freeformAddress": "New York, NY 10004"
}
}
]
}
},
{
"statusCode": 400,
"response":
{
"error":
{
"code": "400 BadRequest",
"message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
}
}
}
]
}
POST https://atlas.microsoft.com/search/fuzzy/batch/json?api-version=1.0
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
format
|
path | True |
Żądany format odpowiedzi. Obsługiwany jest tylko |
|
api-version
|
query | True |
string |
Numer wersji interfejsu API Azure Maps. |
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 |
---|---|---|
batchItems |
Lista zapytań do przetworzenia. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
OK |
|
202 Accepted |
Obsługiwane tylko w przypadku żądania asynchronicznego. Zaakceptowano żądanie: żądanie zostało zaakceptowane do przetwarzania. Użyj adresu URL w nagłówku lokalizacji, aby ponowić próbę lub uzyskać dostęp do wyników. Nagłówki Location: string |
|
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
w celu wskazania, do którego zasobu Azure Maps aplikacja żąda dostępu. Można to uzyskać z poziomu interfejsu API zarządzania usługami Maps . - 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 poziomu płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.
- Użycie zestawu AZURE MAPS Web SDK umożliwia skonfigurowanie aplikacji na podstawie konfiguracji dla wielu przypadków 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ółużytkowany podczas tworzenia konta Azure Maps w Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsu API REST.
Za pomocą tego klucza każda aplikacja może uzyskiwać dostęp do wszystkich interfejsów API REST. Innymi słowy, ten klucz może służyć jako klucz główny na koncie, w którym są wystawiane.
W przypadku publicznie uwidocznionych aplikacji zalecamy użycie podejścia do poufnych aplikacji klienckich w celu uzyskania dostępu Azure Maps interfejsów API REST, aby klucz mógł być bezpiecznie przechowywany.
Typ:
apiKey
W:
query
SAS Token
Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji list sygnatur dostępu współdzielonego na zasobie Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.
Dzięki temu tokenowi każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure oraz szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token SAS może służyć do umożliwienia aplikacjom kontrolowania dostępu w sposób bardziej bezpieczny 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 SAS.
Typ:
apiKey
W:
header
Przykłady
A Search Fuzzy Batch API call containing 5 Search Fuzzy API queries
Przykładowe żądanie
POST https://atlas.microsoft.com/search/fuzzy/batch/json?api-version=1.0
{
"batchItems": [
{
"query": "?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5"
},
{
"query": "?query=Statue Of Liberty&limit=2"
},
{
"query": "?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000"
}
]
}
Przykładowa odpowiedź
{
"batchItems": [
{
"statusCode": 200,
"response": {
"summary": {
"query": "atm",
"queryType": "NON_NEAR",
"queryTime": 5,
"numResults": 5,
"offset": 0,
"totalResults": 262,
"fuzzyLevel": 1,
"geoBias": {
"lat": 47.639769,
"lon": -122.128362
}
},
"results": [
{
"type": "POI",
"id": "US/POI/p0/3656546",
"score": 2.671,
"dist": 1336.1815386162032,
"info": "search:ta:840539002005905-US",
"poi": {
"name": "US Bank ATM-MONEYPASS",
"brands": [
{
"name": "US Bank ATM"
}
],
"categorySet": [
{
"id": 7397
}
],
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "14808",
"streetName": "NE 24th St",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "14808 NE 24th St, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.63229,
"lon": -122.14232
},
"viewport": {
"topLeftPoint": {
"lat": 47.63319,
"lon": -122.14365
},
"btmRightPoint": {
"lat": 47.63139,
"lon": -122.14099
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.63154,
"lon": -122.1423
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/8673325",
"score": 2.671,
"dist": 1206.8488178244172,
"info": "search:ta:840539002022072-US",
"poi": {
"name": "US Bank ATM NATIONAL ASSOCIATION",
"brands": [
{
"name": "US Bank ATM"
}
],
"categorySet": [
{
"id": 7397
}
],
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "15000",
"streetName": "Northeast 24Th Street",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980525522",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15000 Northeast 24Th Street, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.63265,
"lon": -122.14052
},
"viewport": {
"topLeftPoint": {
"lat": 47.63355,
"lon": -122.14185
},
"btmRightPoint": {
"lat": 47.63175,
"lon": -122.13919
}
},
"entryPoints": [
{
"type": "minor",
"position": {
"lat": 47.63156,
"lon": -122.14056
}
},
{
"type": "minor",
"position": {
"lat": 47.63156,
"lon": -122.14058
}
},
{
"type": "main",
"position": {
"lat": 47.63156,
"lon": -122.14048
}
},
{
"type": "main",
"position": {
"lat": 47.6324,
"lon": -122.13938
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/2736315",
"score": 2.671,
"dist": 864.7591776519859,
"info": "search:ta:840539002187855-US",
"poi": {
"name": "US Bank ATM-MONEYPASS",
"brands": [
{
"name": "US Bank ATM"
}
],
"categorySet": [
{
"id": 7397
}
],
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "15521",
"streetName": "Bel Red Rd",
"municipalitySubdivision": "Redmond, Northeast Bellevue, Bellevue",
"municipality": "Redmond, Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980525501",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15521 Bel Red Rd, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.63259,
"lon": -122.1328
},
"viewport": {
"topLeftPoint": {
"lat": 47.63349,
"lon": -122.13413
},
"btmRightPoint": {
"lat": 47.63169,
"lon": -122.13147
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.63255,
"lon": -122.13275
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/3656412",
"score": 2.67,
"dist": 2140.198538580941,
"info": "search:ta:840539001998867-US",
"poi": {
"name": "US Bank ATM NATIONAL ASSOCIATION",
"brands": [
{
"name": "US Bank ATM"
}
],
"categorySet": [
{
"id": 7397
}
],
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "1128",
"streetName": "156th Ave NE",
"municipalitySubdivision": "Crossroads, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98007",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1128 156th Ave NE, Bellevue, WA 98007",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.62069,
"lon": -122.13213
},
"viewport": {
"topLeftPoint": {
"lat": 47.62159,
"lon": -122.13346
},
"btmRightPoint": {
"lat": 47.61979,
"lon": -122.1308
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.62069,
"lon": -122.13236
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/2736876",
"score": 2.67,
"dist": 2140.198538580941,
"info": "search:ta:840539001396789-US",
"poi": {
"name": "US Bank ATM",
"phone": "+(1)-(800)-8722657",
"brands": [
{
"name": "US Bank ATM"
}
],
"categorySet": [
{
"id": 7397
}
],
"url": "www.usbank.com",
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "1128",
"streetName": "156th Ave NE",
"municipalitySubdivision": "Crossroads, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98007",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1128 156th Ave NE, Bellevue, WA 98007",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.62069,
"lon": -122.13213
},
"viewport": {
"topLeftPoint": {
"lat": 47.62159,
"lon": -122.13346
},
"btmRightPoint": {
"lat": 47.61979,
"lon": -122.1308
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.62069,
"lon": -122.13236
}
}
]
}
]
}
},
{
"statusCode": 200,
"response": {
"summary": {
"query": "statue of liberty",
"queryType": "NON_NEAR",
"queryTime": 37,
"numResults": 2,
"offset": 0,
"totalResults": 18,
"fuzzyLevel": 1
},
"results": [
{
"type": "POI",
"id": "US/POI/p0/9189660",
"score": 6.942,
"info": "search:ta:840369001174316-US",
"poi": {
"name": "Statue of Liberty",
"categorySet": [
{
"id": 7376003
}
],
"classifications": [
{
"code": "IMPORTANT_TOURIST_ATTRACTION",
"names": [
{
"nameLocale": "en-US",
"name": "monument"
},
{
"nameLocale": "en-US",
"name": "important tourist attraction"
}
]
}
]
},
"address": {
"municipalitySubdivision": "New York",
"municipality": "New York",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10004",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "New York, NY 10004",
"localName": "New York",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.68955,
"lon": -74.04483
},
"viewport": {
"topLeftPoint": {
"lat": 40.69045,
"lon": -74.04602
},
"btmRightPoint": {
"lat": 40.68865,
"lon": -74.04364
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.69001,
"lon": -74.04683
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/3264566",
"score": 6.942,
"info": "search:ta:840019000670588-US",
"poi": {
"name": "Statue of Liberty",
"phone": "+(1)-(205)-9700251",
"categorySet": [
{
"id": 7376003
}
],
"url": "www.1bsa.org",
"classifications": [
{
"code": "IMPORTANT_TOURIST_ATTRACTION",
"names": [
{
"nameLocale": "en-US",
"name": "important tourist attraction"
}
]
}
]
},
"address": {
"streetNumber": "516",
"streetName": "Liberty Pkwy",
"municipalitySubdivision": "Vestavia Hills",
"municipality": "Vestavia Hills, Birmingham",
"countrySecondarySubdivision": "Jefferson",
"countryTertiarySubdivision": "Leeds",
"countrySubdivisionCode": "AL",
"postalCode": "35242",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "516 Liberty Pkwy, Vestavia Hills, AL 35242",
"localName": "Vestavia Hills",
"countrySubdivisionName": "Alabama"
},
"position": {
"lat": 33.48234,
"lon": -86.70719
},
"viewport": {
"topLeftPoint": {
"lat": 33.48324,
"lon": -86.70827
},
"btmRightPoint": {
"lat": 33.48144,
"lon": -86.70611
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 33.48129,
"lon": -86.7065
}
}
]
}
]
}
},
{
"statusCode": 200,
"response": {
"summary": {
"query": "starbucks",
"queryType": "NON_NEAR",
"queryTime": 35,
"numResults": 10,
"offset": 0,
"totalResults": 17,
"fuzzyLevel": 1,
"geoBias": {
"lat": 47.639769,
"lon": -122.128362
}
},
"results": [
{
"type": "POI",
"id": "US/POI/p0/153678",
"score": 2.671,
"dist": 1206.8488178244172,
"info": "search:ta:840531000006554-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-8695816",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "15000",
"streetName": "NE 24th St",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980525522",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15000 NE 24th St, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.63265,
"lon": -122.14052
},
"viewport": {
"topLeftPoint": {
"lat": 47.63355,
"lon": -122.14185
},
"btmRightPoint": {
"lat": 47.63175,
"lon": -122.13919
}
},
"entryPoints": [
{
"type": "minor",
"position": {
"lat": 47.63156,
"lon": -122.14056
}
},
{
"type": "minor",
"position": {
"lat": 47.63156,
"lon": -122.14058
}
},
{
"type": "main",
"position": {
"lat": 47.63156,
"lon": -122.14048
}
},
{
"type": "main",
"position": {
"lat": 47.6324,
"lon": -122.13938
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/152316",
"score": 2.67,
"dist": 2315.294397491255,
"info": "search:ta:840539000484552-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-6436471",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/store/15097",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "15600",
"streetName": "NE 8th St",
"municipalitySubdivision": "Crossroads, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98008",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15600 NE 8th St, Bellevue, WA 98008",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.61896,
"lon": -122.12945
},
"viewport": {
"topLeftPoint": {
"lat": 47.61986,
"lon": -122.13078
},
"btmRightPoint": {
"lat": 47.61806,
"lon": -122.12812
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.619,
"lon": -122.12945
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/167545",
"score": 2.67,
"dist": 1979.2222952267998,
"info": "search:ta:840539001950429-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-7470690",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "1350",
"streetName": "156th Ave NE",
"municipalitySubdivision": "Crossroads, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98007",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1350 156th Ave NE, Bellevue, WA 98007",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.62212,
"lon": -122.13179
},
"viewport": {
"topLeftPoint": {
"lat": 47.62302,
"lon": -122.13312
},
"btmRightPoint": {
"lat": 47.62122,
"lon": -122.13046
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.62213,
"lon": -122.13236
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/168519",
"score": 2.67,
"dist": 2490.3337046455963,
"info": "search:ta:840539001015090-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-4556500",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "https://www.starbucks.com/store-locator/store/15901",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "1645",
"streetName": "140th Ave NE",
"municipalitySubdivision": "Crossroads, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98005",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1645 140th Ave NE, Bellevue, WA 98005",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.62626,
"lon": -122.15487
},
"viewport": {
"topLeftPoint": {
"lat": 47.62716,
"lon": -122.1562
},
"btmRightPoint": {
"lat": 47.62536,
"lon": -122.15354
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.62645,
"lon": -122.15446
}
},
{
"type": "minor",
"position": {
"lat": 47.62579,
"lon": -122.15377
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/152428",
"score": 2.668,
"dist": 3529.7080738812224,
"info": "search:ta:840539001033722-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-3789496",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "180",
"streetName": "148th Ave SE",
"municipalitySubdivision": "West Lake Hills, Bellevue",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98007",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "180 148th Ave SE, Bellevue, WA 98007",
"localName": "Bellevue",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.60901,
"lon": -122.14
},
"viewport": {
"topLeftPoint": {
"lat": 47.60991,
"lon": -122.14133
},
"btmRightPoint": {
"lat": 47.60811,
"lon": -122.13867
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.60901,
"lon": -122.14008
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/167147",
"score": 2.668,
"dist": 3479.393294615887,
"info": "search:ta:840539000326896-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-8619198",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "7425",
"streetName": "166th Ave NE",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980526288",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "7425 166th Ave NE, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.67055,
"lon": -122.12001
},
"viewport": {
"topLeftPoint": {
"lat": 47.67145,
"lon": -122.12135
},
"btmRightPoint": {
"lat": 47.66965,
"lon": -122.11867
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.67069,
"lon": -122.11889
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/153695",
"score": 2.667,
"dist": 3622.441074618729,
"info": "search:ta:840531000006551-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-8822881",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/store/15022",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "7625",
"streetName": "170th Ave NE",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980520910",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "7625 170th Ave NE, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.67086,
"lon": -122.11392
},
"viewport": {
"topLeftPoint": {
"lat": 47.67176,
"lon": -122.11526
},
"btmRightPoint": {
"lat": 47.66996,
"lon": -122.11258
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.67073,
"lon": -122.1135
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/167420",
"score": 2.667,
"dist": 3818.293513029088,
"info": "search:ta:840539000640782-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-8853323",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "17246",
"streetName": "Redmond Way",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980524403",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "17246 Redmond Way, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.67174,
"lon": -122.10976
},
"viewport": {
"topLeftPoint": {
"lat": 47.67264,
"lon": -122.1111
},
"btmRightPoint": {
"lat": 47.67084,
"lon": -122.10842
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.6706,
"lon": -122.11026
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/153686",
"score": 2.666,
"dist": 4009.922205147074,
"info": "search:ta:840531000006548-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-8859590",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "15738",
"streetName": "Redmond Way Pad 3 Redmond Center",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "980523873",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15738 Redmond Way Pad 3 Redmond Center, Redmond, WA 98052",
"localName": "Redmond",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.67583,
"lon": -122.12877
},
"viewport": {
"topLeftPoint": {
"lat": 47.67673,
"lon": -122.13011
},
"btmRightPoint": {
"lat": 47.67493,
"lon": -122.12743
}
},
"entryPoints": [
{
"type": "minor",
"position": {
"lat": 47.67456,
"lon": -122.12887
}
},
{
"type": "main",
"position": {
"lat": 47.67668,
"lon": -122.12829
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/168511",
"score": 2.666,
"dist": 3987.80992387863,
"info": "search:ta:840531000006669-US",
"poi": {
"name": "Starbucks",
"phone": "+(1)-(425)-8818265",
"brands": [
{
"name": "Starbucks"
}
],
"categorySet": [
{
"id": 9376006
}
],
"url": "www.starbucks.com/site-selector",
"classifications": [
{
"code": "CAFE_PUB",
"names": [
{
"nameLocale": "en-US",
"name": "coffee shop"
},
{
"nameLocale": "en-US",
"name": "café/pub"
}
]
}
]
},
"address": {
"streetNumber": "6617",
"streetName": "132Nd Ave Ne Bridle Trails Shopping Center",
"municipalitySubdivision": "Kirkland, Bridle Trails",
"municipality": "Kirkland",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle East",
"countrySubdivisionCode": "WA",
"postalCode": "98033",
"extendedPostalCode": "980338234",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "6617 132Nd Ave Ne Bridle Trails Shopping Center, Kirkland, WA 98033",
"localName": "Kirkland",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.66514,
"lon": -122.16599
},
"viewport": {
"topLeftPoint": {
"lat": 47.66604,
"lon": -122.16733
},
"btmRightPoint": {
"lat": 47.66424,
"lon": -122.16465
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.666,
"lon": -122.16669
}
},
{
"type": "minor",
"position": {
"lat": 47.66553,
"lon": -122.16405
}
}
]
}
]
}
}
],
"summary": {
"successfulRequests": 3,
"totalRequests": 3
}
}
Operation-Location: URL to download the results of the long-running batch request.
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ątkowych i końcowych zakresu adresów. |
Batch |
Ten typ reprezentuje treść żądania dla usługi Batch. |
Batch |
Obiekt żądania usługi Batch |
Bounding |
Widokport, który obejmuje wynik reprezentowany przez współrzędne w lewym górnym i prawym dolnym rogu portu widoku. |
Bounding |
Pole ograniczenia lokalizacji. |
Brand |
Marka skojarzona z interfejsem POI |
Classification |
Klasyfikacja zwracanego interfejsu poi |
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 położenie. |
Entry |
Punkt wejścia zwracanego interfejsu poI. |
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. |
Geometry |
Informacje o kształcie geometrycznym wyniku. Występuje tylko wtedy, gdy typ == Geografia. |
Json |
Żądany format odpowiedzi. Obsługiwany jest tylko |
Lat |
Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon". |
Match |
Typy dopasowania dla operacji wyszukiwania odwrotnego adresu. |
Operating |
Godziny otwarcia punktu zakupu (punkty orientacyjne). |
Operating |
Reprezentuje datę i godzinę |
Operating |
Otwarty zakres czasu dla dnia |
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 |
Wynik zapytania. SearchAddressResult, jeśli zapytanie zostało ukończone pomyślnie, BłądResponse w przeciwnym razie. |
Search |
Element zwrócony z wywołania usługi Batch adresów Search. |
Search |
Ten obiekt jest zwracany z pomyślnego wywołania usługi Batch Search Adres. |
Search |
Obiekt wyniku odpowiedzi interfejsu API Search. |
Search |
Jeden z:
|
Search |
Obiekt podsumowania odpowiedzi interfejsu API Search. |
Summary |
Podsumowanie wyników żądania wsadowego |
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ątkowych i końcowych 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". |
BatchRequest
Ten typ reprezentuje treść żądania dla usługi Batch.
Nazwa | Typ | Opis |
---|---|---|
batchItems |
Lista zapytań do przetworzenia. |
BatchRequestItem
Obiekt żądania usługi Batch
Nazwa | Typ | Opis |
---|---|---|
query |
string |
Ten parametr zawiera ciąg zapytania używany do wykonywania operacji geokodowania bez struktury. Ciąg zapytania zostanie przekazany dosłownie do interfejsu API wyszukiwania na potrzeby przetwarzania. |
BoundingBox
Widokport, który obejmuje wynik reprezentowany przez współrzędne w lewym górnym i prawym dolnym rogu portu widoku.
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 położenie. |
|
northEast |
string |
Szerokość geograficzna północno-wschodnia,współrzędna geograficzna pola ograniczenia jako rozdzielane przecinkami zmiennoprzecinkowe |
southWest |
string |
Szerokość geograficzna południowo-zachodnia,współrzędna geograficzna pola ograniczenia jako rozdzielane przecinkami zmiennoprzecinkowe |
Brand
Marka skojarzona z interfejsem POI
Nazwa | Typ | Opis |
---|---|---|
name |
string |
Nazwa marki |
Classification
Klasyfikacja zwracanego interfejsu poi
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 Ustawienia regionalne |
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 == Geografia. |
Entity
Źródło typu jednostki pola ograniczenia. W przypadku odwrotnego geokodowania jest to zawsze równe położenie.
Nazwa | Typ | Opis |
---|---|---|
position |
string |
Pozycja jednostki |
EntryPoint
Punkt wejścia zwracanego interfejsu poI.
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 |
Geometry
Informacje o kształcie geometrycznym wyniku. Występuje tylko wtedy, gdy typ == Geografia.
Nazwa | Typ | Opis |
---|---|---|
id |
string |
Przekaż ten identyfikator geometryId do interfejsu API get Search Polygon, aby pobrać informacje o geometrii dla tego wyniku. |
JsonFormat
Żądany format odpowiedzi. Obsługiwany jest tylko json
format.
Nazwa | Typ | Opis |
---|---|---|
json |
string |
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 |
MatchType
Typy dopasowania dla operacji wyszukiwania odwrotnego adresu.
Nazwa | Typ | Opis |
---|---|---|
AddressPoint |
string |
|
HouseNumberRange |
string |
|
Street |
string |
OperatingHours
Godziny otwarcia punktu zakupu (punkty orientacyjne).
Nazwa | Typ | Opis |
---|---|---|
mode |
string |
Wartość używana w żądaniu: none 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
Otwarty zakres czasu dla dnia
Nazwa | Typ | Opis |
---|---|---|
endTime |
Punkt w ciągu najbliższych 7 dni, gdy dany poi jest zamykany, lub początek zakresu, jeśli został zamknięty przed zakresem. |
|
startTime |
Punkt w ciągu najbliższych 7 dni od otwarcia danego punktu zakupu 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 |
Response
Wynik zapytania. SearchAddressResult, jeśli zapytanie zostało ukończone pomyślnie, BłądResponse w przeciwnym razie.
Nazwa | Typ | Opis |
---|---|---|
error |
Obiekt błędu. |
|
results |
Lista wyników interfejsu API Search. |
|
summary |
Obiekt podsumowania odpowiedzi interfejsu API Search |
SearchAddressBatchItem
Element zwrócony z wywołania usługi Batch adresów Search.
Nazwa | Typ | Opis |
---|---|---|
response |
Wynik zapytania. SearchAddressResult, jeśli zapytanie zostało ukończone pomyślnie, BłądResponse w przeciwnym razie. |
|
statusCode |
integer |
Kod stanu żądania HTTP. |
SearchAddressBatchProcessResult
Ten obiekt jest zwracany z pomyślnego wywołania usługi Batch Search Adres.
Nazwa | Typ | Opis |
---|---|---|
batchItems |
Tablica zawierająca wyniki wsadowe. |
|
summary |
Podsumowanie wyników żądania wsadowego |
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 |
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. |
Summary
Podsumowanie wyników żądania wsadowego
Nazwa | Typ | Opis |
---|---|---|
successfulRequests |
integer |
Liczba pomyślnych żądań w partii |
totalRequests |
integer |
Łączna liczba żądań w partii |