Search - Post Search Inside Geometry
Służy do wykonywania wolnych wyszukiwań formularzy wewnątrz jeszcze jednej geometrii.
Interfejs Post Search Inside Geometry API to żądanie HTTP POST , które umożliwia wyszukiwanie w dowolnym formularzu wewnątrz jednej geometrii lub wielu geometrii. Zostaną zwrócone wyniki wyszukiwania, które mieszczą się w geometrii/geometriach.
Aby wysłać geometrię, użyjesz żądania POST, w którym treść żądania będzie zawierać geometry obiekt reprezentowany jako GeoJSON, a nagłówek Content-Type zostanie ustawiony na application/json. Obiekty geograficzne, które mają być wyszukiwane, można modelować jako geometrie wielokątów i/lub okręgów reprezentowane przy użyciu jednego z następujących typów GeoJSON:
-
Kolekcja funkcji GeoJSON
Możegeometrybyć reprezentowany jako obiekt GeoJSONFeatureCollection. Jest to zalecana opcja, jeśli geometria zawiera zarówno wielokąty, jak i okręgi. MożeFeatureCollectionzawierać do 50 obiektów GeoJSONFeature. KażdyFeatureobiekt powinien reprezentować wielokąt lub okrąg z następującymi warunkami:- Obiekt
Featuredla geometrii wielokąta może mieć do 50 współrzędnych, a jego właściwości muszą być puste. - Obiekt
Featuredla geometrii okręgu składa się ze środka reprezentowanego przy użyciu typu GeoJSONPointi wartości promienia (w metrach), która musi być określona we właściwościach obiektu wraz z właściwością subType , której wartość powinna być równa "Okrąg".
Zapoznaj się z przykładami , aby zapoznać się z przykładowąFeatureCollectionreprezentacją. - Obiekt
-
GeoJSON GeometryCollection
Możegeometrybyć reprezentowany jako obiekt GeoJSONGeometryCollection. Jest to zalecana opcja, jeśli geometria zawiera tylko listę wielokątów. MożeGeometryCollectionzawierać do 50 obiektów GeoJSONPolygon. KażdyPolygonobiekt może mieć maksymalnie 50 współrzędnych. Zapoznaj się z przykładami , aby zapoznać się z przykładowąGeometryCollectionreprezentacją. -
Wielokąt GeoJSON
Możegeometrybyć reprezentowany jako obiekt GeoJSONPolygon. Jest to zalecana opcja, jeśli geometria zawiera pojedynczy wielokąt. ObiektPolygonmoże mieć do 50 współrzędnych. Zapoznaj się z przykładami , aby zapoznać się z przykładowąPolygonreprezentacją.
POST https://atlas.microsoft.com/search/geometry/{format}?api-version=1.0&query={query}
POST https://atlas.microsoft.com/search/geometry/{format}?api-version=1.0&query={query}&limit={limit}&language={language}&categorySet={categorySet}&extendedPostalCodesFor={extendedPostalCodesFor}&idxSet={idxSet}&view={view}&openingHours=nextSevenDays
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
format
|
path | True |
Żądany format odpowiedzi. Wartość może być json lub xml. |
|
|
api-version
|
query | True |
string |
Numer wersji interfejsu API usługi Azure Maps. |
|
query
|
query | True |
string |
Nazwa POI do wyszukania (np. "statua wolności", "starbucks", "pizza"). Musi być poprawnie zakodowany adres URL. |
|
category
|
query |
integer[] |
Rozdzielona przecinkami lista identyfikatorów zestawów kategorii, których można użyć do ograniczenia wyniku do określonych kategorii Punktów orientacyjnych. Kolejność identyfikatorów nie ma znaczenia. Maksymalna liczba obsługiwanych wartości
|
|
|
extended
|
query |
Indeksy, dla których powinny zostać uwzględnione rozszerzone kody pocztowe w wynikach. Dostępne indeksy to: dodatku = zakresy adresów Geo = Geografie PAD = adresy punktów POI = punkty orientacyjne Str = Ulice XStr = Cross Streets (skrzyżowania) Wartość powinna być rozdzielona przecinkami lista 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 muszą być jawnie żądane w razie potrzeby. Przykłady użycia: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=Brak Rozszerzony kod pocztowy jest zwracany jako właściwość extendedPostalCode adresu. Dostępność jest zależna od regionu. |
||
|
idx
|
query |
Rozdzielona przecinkami lista indeksów, które powinny być używane do wyszukiwania. Kolejność elementów nie ma znaczenia. Dostępne indeksy to: Addr = Interpolacja zakresu adresów, Geo = Geographies, PAD = Point Addresses, POI = Points of interest, Str = Streets, Xstr = Cross Streets (skrzyżowania) |
||
|
language
|
query |
string |
Język, w którym powinny być zwracane wyniki wyszukiwania. Powinien być jednym z obsługiwanych tagów języka IETF, bez uwzględniania wielkości liter. Jeśli 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 minimum: 1maximum: 100 |
Maksymalna liczba odpowiedzi, które zostaną zwrócone. Ustawienie domyślne: 10, minimum: 1 i maksimum: 100 |
|
|
opening
|
query |
Godziny operacji dla weryfikacji koncepcji (punkty orientacyjne). Dostępność godzin operacji będzie się różnić w zależności od dostępnych danych. Jeśli nie zostanie przekazana, nie zostaną zwrócone żadne informacje o godzinach otwarcia. Obsługiwana wartość: nextSevenDays |
||
|
view
|
query |
Parametr View (nazywany również parametrem "region użytkownika") umożliwia wyświetlanie poprawnych map dla określonego kraju/regionu dla regionów spornych geopolitycznie. Różne kraje/regiony mają różne widoki takich regionów, a parametr View umożliwia aplikacji zgodność z widokiem wymaganym przez kraj/region, który będzie obsługiwać aplikacja. Domyślnie parametr Widok jest ustawiony na wartość "Unified", nawet jeśli nie zdefiniowano go w żądaniu. Twoim zadaniem jest określenie lokalizacji użytkowników, a następnie poprawne ustawienie parametru Wyświetl dla tej lokalizacji. Alternatywnie możesz ustawić opcję "View=Auto", która zwróci dane mapy na podstawie adresu IP żądania. Parametr View w usłudze Azure Maps musi być używany zgodnie z obowiązującymi przepisami, w tym z przepisami dotyczącymi mapowania kraju/regionu, w którym udostępniane są mapy, obrazy i inne dane oraz zawartość innych firm, do których masz uprawnienia dostępu za pośrednictwem usługi Azure Maps. Przykład: view=IN. Aby uzyskać szczegółowe informacje, zobacz Obsługiwane widoki, aby uzyskać szczegółowe informacje i wyświetlić dostępne widoki. |
Nagłówek żądania
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| x-ms-client-id |
string |
Wskazuje konto przeznaczone do użycia z modelem zabezpieczeń Microsoft Entra ID. Ten unikatowy identyfikator konta Azure Maps można uzyskać z interfejsu API konta płaszczyzny zarządzania Azure Maps. Aby uzyskać więcej informacji na temat korzystania z zabezpieczeń Microsoft Entra ID w Azure Maps, zobacz Zarządzanie uwierzytelnianiem w Azure Maps. |
Treść żądania
| Nazwa | Typ | Opis |
|---|---|---|
| geometry | GeoJsonObject: |
Prawidłowy obiekt |
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 dostępem opartym na rolach platformy Azure kontroli może służyć do kontrolowania dostępu do interfejsów API REST usługi Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobu usługi Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi mogą mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do interfejsów API REST usługi Azure Maps.
Aby zaimplementować scenariusze, zalecamy wyświetlenie koncepcji uwierzytelniania . Podsumowując, ta definicja zabezpieczeń zawiera rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.
Uwaga
- Ta definicja zabezpieczeń wymaga użycia nagłówka
x-ms-client-idw celu wskazania, do którego zasobu usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania Maps. -
Authorization URLjest specyficzna dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje identyfikatorów Entra firmy Microsoft. - Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana na podstawie płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.
- Użycie zestawu Web SDK usługi Azure Maps umożliwia skonfigurowanie aplikacji na podstawie konfiguracji dla wielu przypadków użycia.
- Aby uzyskać więcej informacji na temat platformy tożsamości firmy Microsoft, zobacz Microsoft identity platform overview.
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 tworzenie konta usługi Azure Maps w witrynie Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsu API REST.
Za pomocą tego klucza każda aplikacja może uzyskiwać dostęp do całego interfejsu API REST. Innymi słowy, ten klucz może służyć jako klucz główny na koncie, w którym są wystawiane.
W przypadku publicznie uwidocznionych aplikacji zalecamy użycie poufnych aplikacji klienckich podejście do uzyskiwania dostępu do interfejsów API REST usługi Azure Maps, aby klucz mógł być bezpiecznie przechowywany.
Typ:
apiKey
W:
query
SAS Token
Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji List SAS na zasobie usługi Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.
Dzięki temu tokenowi każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure i szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token SAS może służyć do umożliwienia aplikacjom kontrolowania dostępu w sposób bardziej zabezpieczony niż klucz wspólny.
W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie Mapowanie konta w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SAS.
Typ:
apiKey
W:
header
Przykłady
Search for burger joints inside a geometry represented as a GeoJSON GeometryCollection type
Przykładowe żądanie
POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=burger&limit=2&openingHours=nextSevenDays
{
"geometry": {
"type": "GeometryCollection",
"geometries": [
{
"type": "Polygon",
"coordinates": [
[
[
-122.43576049804686,
37.7524152343544
],
[
-122.43301391601562,
37.70660472542312
],
[
-122.36434936523438,
37.712059855877314
],
[
-122.43576049804686,
37.7524152343544
]
]
]
},
{
"type": "Polygon",
"coordinates": [
[
[
-123.43576049804686,
37.7524152343544
],
[
-123.43301391601562,
37.70660472542312
],
[
-123.36434936523438,
37.712059855877314
],
[
-123.43576049804686,
37.7524152343544
]
]
]
}
]
}
}
Przykładowa odpowiedź
{
"summary": {
"query": "burger",
"queryType": "NON_NEAR",
"queryTime": 21,
"numResults": 2,
"offset": 0,
"totalResults": 4,
"fuzzyLevel": 1
},
"results": [
{
"type": "POI",
"id": "9P2i9inRyndAA-_V40J8oA",
"score": 2.0041828156,
"info": "search:ta:840061003419653-US",
"poi": {
"name": "Burger Joint",
"phone": "+1 415-349-4331",
"categorySet": [
{
"id": 7315015
}
],
"categories": [
"fast food",
"restaurant"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "restaurant"
},
{
"nameLocale": "en-US",
"name": "fast food"
}
]
}
]
},
"address": {
"streetNumber": "167",
"streetName": "Leland Avenue",
"municipality": "San Francisco",
"neighbourhood": "Visitacion Valley",
"countrySecondarySubdivision": "San Francisco",
"countrySubdivisionName": "California",
"countrySubdivisionCode": "CA",
"postalCode": "94134",
"extendedPostalCode": "94134-2844",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "167 Leland Avenue, San Francisco, CA 94134",
"localName": "San Francisco"
},
"position": {
"lat": 37.712228,
"lon": -122.407022
},
"viewport": {
"topLeftPoint": {
"lat": 37.71313,
"lon": -122.40816
},
"btmRightPoint": {
"lat": 37.71133,
"lon": -122.40589
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 37.71241,
"lon": -122.40693
}
}
]
},
{
"type": "POI",
"id": "hkr-N07YS6Gv2dOciQ9lwA",
"score": 2.0041515827,
"info": "search:ta:840067000526682-US",
"poi": {
"name": "Sound of Burgers",
"categorySet": [
{
"id": 7315
}
],
"categories": [
"restaurant"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "167",
"streetName": "Leland Avenue",
"municipality": "San Francisco",
"neighbourhood": "Visitacion Valley",
"countrySecondarySubdivision": "San Francisco",
"countrySubdivision": "CA",
"countrySubdivisionName": "California",
"countrySubdivisionCode": "CA",
"postalCode": "94134",
"extendedPostalCode": "94134-2844",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "167 Leland Avenue, San Francisco, CA 94134",
"localName": "San Francisco"
},
"position": {
"lat": 37.712228,
"lon": -122.407022
},
"viewport": {
"topLeftPoint": {
"lat": 37.71313,
"lon": -122.40816
},
"btmRightPoint": {
"lat": 37.71133,
"lon": -122.40589
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 37.71241,
"lon": -122.40693
}
}
]
}
]
}
Search for pizza places inside a geometry represented as a GeoJSON FeatureCollection type
Przykładowe żądanie
POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=pizza&limit=2&openingHours=nextSevenDays
{
"geometry": {
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-122.143035,
47.653536
],
[
-122.187164,
47.617556
],
[
-122.114981,
47.570599
],
[
-122.132756,
47.654009
],
[
-122.143035,
47.653536
]
]
]
},
"properties": {}
},
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-122.126986,
47.639754
]
},
"properties": {
"subType": "Circle",
"radius": 100
}
}
]
}
}
Przykładowa odpowiedź
{
"summary": {
"query": "pizza",
"queryType": "NON_NEAR",
"queryTime": 34,
"numResults": 2,
"offset": 0,
"totalResults": 21,
"fuzzyLevel": 1
},
"results": [
{
"type": "POI",
"id": "-UuwTye4GGsea4KmCLvoqQ",
"score": 2.1455535889,
"info": "search:ta:840537000108972-US",
"poi": {
"name": "Biryani & Pizza House",
"categorySet": [
{
"id": 7315036
}
],
"categories": [
"pizza",
"restaurant"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "restaurant"
},
{
"nameLocale": "en-US",
"name": "pizza"
}
]
}
]
},
"address": {
"streetNumber": "15025",
"streetName": "Northeast 24th Street",
"municipality": "Redmond",
"countrySecondarySubdivision": "King",
"countrySubdivision": "WA",
"countrySubdivisionName": "Washington",
"countrySubdivisionCode": "WA",
"postalCode": "98052",
"extendedPostalCode": "98052-5531",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15025 Northeast 24th Street, Redmond, WA 98052",
"localName": "Redmond"
},
"position": {
"lat": 47.630786,
"lon": -122.139302
},
"viewport": {
"topLeftPoint": {
"lat": 47.63169,
"lon": -122.14064
},
"btmRightPoint": {
"lat": 47.62989,
"lon": -122.13797
}
},
"entryPoints": [
{
"type": "minor",
"position": {
"lat": 47.63079,
"lon": -122.13931
}
},
{
"type": "main",
"position": {
"lat": 47.63147,
"lon": -122.13935
}
}
]
},
{
"type": "POI",
"id": "7r095LCcCSkdoGoeLcnvsQ",
"score": 2.1454992294,
"info": "search:ta:840537000103468-US",
"poi": {
"name": "Pagliacci Pizza",
"categorySet": [
{
"id": 7315036
}
],
"url": "www.pagliacci.com/",
"categories": [
"pizza",
"restaurant"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "restaurant"
},
{
"nameLocale": "en-US",
"name": "pizza"
}
]
}
],
"openingHours": {
"mode": "nextSevenDays",
"timeRanges": [
{
"startTime": {
"date": "2024-03-14",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-14",
"hour": 11,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-17",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-17",
"hour": 11,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-18",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-18",
"hour": 11,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-19",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-19",
"hour": 11,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-20",
"hour": 10,
"minute": 0
},
"endTime": {
"date": "2024-03-20",
"hour": 11,
"minute": 0
}
}
]
}
},
"address": {
"streetNumber": "15238",
"streetName": "Bel Red Road",
"municipality": "Bellevue",
"countrySecondarySubdivision": "King",
"countrySubdivision": "WA",
"countrySubdivisionName": "Washington",
"countrySubdivisionCode": "WA",
"postalCode": "98007",
"extendedPostalCode": "98007-3815",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "15238 Bel Red Road, Bellevue, WA 98007",
"localName": "Bellevue"
},
"position": {
"lat": 47.628008,
"lon": -122.13646
},
"viewport": {
"topLeftPoint": {
"lat": 47.62891,
"lon": -122.13779
},
"btmRightPoint": {
"lat": 47.62711,
"lon": -122.13513
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.6283,
"lon": -122.13611
}
}
]
}
]
}
Search for subs joints inside a geometry represented as a GeoJSON Polygon type
Przykładowe żądanie
POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=subs&limit=2&openingHours=nextSevenDays
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-122.43576049804686,
37.7524152343544
],
[
-122.43301391601562,
37.70660472542312
],
[
-122.36434936523438,
37.712059855877314
],
[
-122.43576049804686,
37.7524152343544
]
]
]
}
}
Przykładowa odpowiedź
{
"summary": {
"query": "subs",
"queryType": "NON_NEAR",
"queryTime": 42,
"numResults": 2,
"offset": 0,
"totalResults": 5,
"fuzzyLevel": 1
},
"results": [
{
"type": "POI",
"id": "HOIWGiNwVv0z6bF8MO3EbA",
"score": 2.1455111504,
"info": "search:ta:840069009512242-US",
"poi": {
"name": "Adams Grub Truck",
"phone": "+1 415-307-8844",
"categorySet": [
{
"id": 7315042
}
],
"categories": [
"restaurant",
"sandwich"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "sandwich"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "1465",
"streetName": "Carroll Avenue",
"municipality": "San Francisco",
"neighbourhood": "Bayview",
"countrySecondarySubdivision": "San Francisco",
"countrySubdivisionName": "California",
"countrySubdivisionCode": "CA",
"postalCode": "94124",
"extendedPostalCode": "94124-3604",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1465 Carroll Avenue, San Francisco, CA 94124",
"localName": "San Francisco"
},
"position": {
"lat": 37.72328,
"lon": -122.39091
},
"viewport": {
"topLeftPoint": {
"lat": 37.72418,
"lon": -122.39205
},
"btmRightPoint": {
"lat": 37.72238,
"lon": -122.38977
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 37.72348,
"lon": -122.39073
}
}
]
},
{
"type": "POI",
"id": "bXbc0QxTRlkSo8GnU7EU-Q",
"score": 2.1454677582,
"info": "search:ta:840061001992959-US",
"poi": {
"name": "SUBWAY San Francisco San Francisco",
"phone": "+1 415-657-9898",
"brands": [
{
"name": "SUBWAY"
}
],
"categorySet": [
{
"id": 7315042
}
],
"categories": [
"restaurant",
"sandwich"
],
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "sandwich"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
],
"openingHours": {
"mode": "nextSevenDays",
"timeRanges": [
{
"startTime": {
"date": "2024-03-13",
"hour": 7,
"minute": 0
},
"endTime": {
"date": "2024-03-13",
"hour": 21,
"minute": 30
}
},
{
"startTime": {
"date": "2024-03-14",
"hour": 7,
"minute": 0
},
"endTime": {
"date": "2024-03-14",
"hour": 21,
"minute": 30
}
},
{
"startTime": {
"date": "2024-03-15",
"hour": 7,
"minute": 0
},
"endTime": {
"date": "2024-03-15",
"hour": 21,
"minute": 30
}
},
{
"startTime": {
"date": "2024-03-16",
"hour": 9,
"minute": 0
},
"endTime": {
"date": "2024-03-16",
"hour": 21,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-17",
"hour": 9,
"minute": 0
},
"endTime": {
"date": "2024-03-17",
"hour": 21,
"minute": 0
}
},
{
"startTime": {
"date": "2024-03-18",
"hour": 8,
"minute": 0
},
"endTime": {
"date": "2024-03-18",
"hour": 20,
"minute": 30
}
},
{
"startTime": {
"date": "2024-03-19",
"hour": 7,
"minute": 0
},
"endTime": {
"date": "2024-03-19",
"hour": 21,
"minute": 30
}
}
]
}
},
"address": {
"streetNumber": "2599",
"streetName": "San Bruno Avenue",
"municipality": "San Francisco",
"neighbourhood": "Portola",
"countrySecondarySubdivision": "San Francisco",
"countrySubdivision": "CA",
"countrySubdivisionName": "California",
"countrySubdivisionCode": "CA",
"postalCode": "94134",
"extendedPostalCode": "94134-1504",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "2599 San Bruno Avenue, San Francisco, CA 94134",
"localName": "San Francisco"
},
"position": {
"lat": 37.729004,
"lon": -122.403956
},
"viewport": {
"topLeftPoint": {
"lat": 37.7299,
"lon": -122.40509
},
"btmRightPoint": {
"lat": 37.7281,
"lon": -122.40282
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 37.72892,
"lon": -122.40414
}
}
]
}
]
}
Definicje
| Nazwa | Opis |
|---|---|
| Address |
Adres wyniku. |
|
Address |
Opisuje zakres adresów po obu stronach ulicy dla wyniku wyszukiwania. Uwzględniane są współrzędne dla lokalizacji początkowych i końcowych 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 API. |
| Entity |
Źródło typu jednostki pola ograniczenia. W przypadku odwrotnego geokodowania jest to zawsze równe pozycji. |
|
Entry |
Punkt wejścia zwracanego interfejsu użytkownika. |
|
Entry |
Typ punktu wejścia. Wartość może być głównym lub pomocniczym. |
|
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
|
Error |
Szczegóły błędu. |
|
Error |
Odpowiedź na błąd |
|
Geographic |
Typ jednostki Geografia. Prezentuj tylko wtedy, gdy zażądano parametru entityType i jest dostępny. |
|
Geo |
Prawidłowy typ obiektu |
|
Geo |
Prawidłowy typ obiektu |
|
Geo |
Prawidłowy obiekt geometrii |
|
Geo |
Prawidłowy typ obiektu |
|
Geo |
Prawidłowy typ geometrii |
|
Geo |
Prawidłowy typ geometrii |
|
Geo |
Prawidłowy typ geometrii |
|
Geo |
Prawidłowy typ obiektu |
|
Geo |
Prawidłowy typ geometrii |
|
Geo |
Prawidłowy typ geometrii |
| 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 będzie obsługiwać aplikacja. Domyślnie parametr Widok jest ustawiony na wartość "Unified", nawet jeśli nie zdefiniowano go w żądaniu. Twoim zadaniem jest określenie lokalizacji użytkowników, a następnie poprawne ustawienie parametru Wyświetl dla tej lokalizacji. Alternatywnie możesz ustawić opcję "View=Auto", która zwróci dane mapy na podstawie adresu IP żądania. Parametr View w usłudze Azure Maps musi być używany zgodnie z obowiązującymi przepisami, w tym z przepisami dotyczącymi mapowania kraju/regionu, w którym udostępniane są mapy, obrazy i inne dane oraz zawartość innych firm, do których masz uprawnienia dostępu za pośrednictwem usługi Azure Maps. Przykład: view=IN. Aby uzyskać szczegółowe informacje, zobacz Obsługiwane widoki, aby uzyskać szczegółowe informacje i wyświetlić dostępne widoki. |
|
Match |
Typy dopasowania dla operacji wyszukiwania odwrotnego adresu. |
|
Operating |
Godziny otwarcia poi (punkty orientacyjne). |
|
Operating |
Godziny operacji dla weryfikacji koncepcji (punkty orientacyjne). Dostępność godzin operacji będzie się różnić w zależności od dostępnych danych. Jeśli nie zostanie przekazana, nie zostaną zwrócone żadne informacje o godzinach otwarcia. Obsługiwana wartość: nextSevenDays |
|
Operating |
Reprezentuje datę i godzinę |
|
Operating |
Zakres czasu otwarcia na dzień |
|
Point |
Szczegółowe informacje o zwracanym interfejsie użytkownika, w tym informacje, takie jak nazwa, telefon, adres URL i klasyfikacje. |
|
Point |
Kategoria poi |
|
Query |
Zwracany typ zapytania: W POBLIŻU lub NON_NEAR. Ważne: Ta własność jest przestarzała i może zostać pominięta w odpowiedzi. |
|
Response |
Żądany format odpowiedzi. Wartość może być json lub xml. |
|
Search |
Ten obiekt jest zwracany z pomyślnych wywołań wyszukiwania. |
|
Search |
Wynik obiektu odpowiedzi interfejsu API wyszukiwania. |
|
Search |
Jeden z:
|
|
Search |
Indeksy, dla których powinny zostać uwzględnione rozszerzone kody pocztowe w wynikach. Dostępne indeksy to: dodatku = zakresy adresów Geo = Geografie PAD = adresy punktów POI = punkty orientacyjne Str = Ulice XStr = Cross Streets (skrzyżowania) Wartość powinna być rozdzielona przecinkami lista 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 muszą być jawnie żądane w razie potrzeby. Przykłady użycia: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=Brak Rozszerzony kod pocztowy jest zwracany jako właściwość extendedPostalCode adresu. Dostępność jest zależna od regionu. |
|
Search |
Ten typ reprezentuje treść żądania dla usługi Search Inside Geometry. |
|
Search |
Obiekt podsumowania odpowiedzi interfejsu API wyszukiwania. |
Address
Adres wyniku.
| Nazwa | Typ | Opis |
|---|---|---|
| boundingBox |
Definiuje obwiednię lokalizacji. Ta właściwość jest zwracana tylko przez interfejsy API odwrotnego adresu wyszukiwania. Wszystkie inne interfejsy API wyszukiwania zwracają |
|
| buildingNumber |
string |
Numer budynku na ulicy.
Ważne: ta właściwość jest przestarzała. Użyj |
| country |
string |
Nazwa kraju/regionu. |
| countryCode |
string |
Dwuliterowy kod alfabetyczny określony przez normę ISO 3166-1 Alpha-2, reprezentujący kraj/region oraz zależne terytoria. |
| countryCodeISO3 |
string |
Trzyliterowy kod alfabetyczny zdefiniowany przez normę ISO 3166-1 Alpha-3, reprezentujący kraj/region oraz terytoria zależne. |
| countrySecondarySubdivision |
string |
Drugi poziom podziału administracyjnego w ramach kraju/regionu. Identyfikuje podział położony poniżej głównego podziału, na przykład stan lub prowincja, ale powyżej mniejszych jednostek, takich jak gminy czy dzielnice. Przykłady to hrabstwo w Stanach Zjednoczonych oraz Dystrykt w Wielkiej Brytanii. |
| countrySubdivision |
string |
Podstawowy podział administracyjny w obrębie kraju, takiego jak stan, prowincja. Służy do reprezentowania podziału pierwszego poziomu poniżej poziomu krajowego. |
| countrySubdivisionCode |
string |
Ta własność nie jest dostępna w |
| countrySubdivisionName |
string |
Reprezentuje pełną nazwę jednostki administracyjnej pierwszego poziomu (takiej jak stan, prowincja lub region) w obrębie kraju lub regionu. Ta nieruchomość jest uwzględniona tylko wtedy, gdy wartość |
| countryTertiarySubdivision |
string |
Podział administracyjny trzeciego poziomu w obrębie kraju/regionu. Zapewnia jeszcze bardziej szczegółową szczegółowość niż podział drugorzędny (np. hrabstwo lub dystrykt). Przykładami są gminy takie jak miasto, miasteczko, wieś, borough lub gmina oraz dzielnice mniejsze, nieformalne obszary geograficzne w obrębie gminy, takie jak Capitol Hill, Green Lake czy Wallingford w Seattle. |
| crossStreet |
string |
Nazwa ulicy, która jest przekraczana. Ta właściwość jest dostępna wyłącznie w |
| extendedPostalCode |
string |
Rozszerzony kod pocztowy odnosi się do formatu kodu pocztowego, który wykracza poza standardowy zestaw cyfr, aby zapewnić większą precyzję lokalizacji. Jest powszechnie stosowany w systemach takich jak kod U.S. ZIP+4 lub podobnych rozszerzonych formatach w innych krajach/regionach. Dostępność zależy od regionu. Nie jest dostępne w |
| freeformAddress |
string |
Linia adresowa sformatowana zgodnie z zasadami formatowania kraju/regionu pochodzenia wyniku, lub w przypadku kraju/regionu – pełnej nazwy kraju/regionu. |
| localName |
string |
Składnik adresu reprezentujący nazwę obszaru geograficznego lub lokalności, który grupuje wiele obiektów adresowalnych na potrzeby adresowania, bez jednostki administracyjnej. To pole służy do kompilowania właściwości |
| municipality |
string |
Miasto/ Miasto |
| municipalitySubdivision |
string |
Podział administracyjny w ramach gminy. Reprezentuje mniejszą jednostkę administracyjną lub geograficzną w obrębie miasta, miasteczka lub innej jednostki miejskiej. |
| neighbourhood |
string |
Sąsiedztwo to geograficznie zlokalizowany obszar w mieście lub mieście z charakterystycznymi cechami i interakcjami społecznymi między mieszkańcami. |
| postalCode |
string |
Seria cyfr lub liter (lub oba) dodawana do adresu, aby pomóc zidentyfikować konkretny obszar geograficzny. Kod pocztowy to amerykańska wersja kodu pocztowego, inne kraje/regiony używają innych formatów, takich jak kod pocztowy, kod pocztowy i PLZ. |
| routeNumbers |
string[] |
Kody używane do jednoznacznej identyfikacji ulicy. Dostępne tylko dla odwrotnych interfejsów API wyszukiwania adresów. |
| street |
string |
Nazwa ulicy.
Ważne: ta właściwość jest przestarzała. Użyj |
| streetName |
string |
Nazwa ulicy. |
| streetNameAndNumber |
string |
Nazwa ulicy i numer. Dostępne tylko dla odwrotnych interfejsów API wyszukiwania adresów. |
| streetNumber |
string |
Numer budynku na ulicy. Nie jest dostępne w |
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". |
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 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 użytkownika
| Nazwa | Typ | Opis |
|---|---|---|
| code |
string |
Właściwość kodu |
| names |
Tablica nazw |
ClassificationName
Nazwa klasyfikacji
| Nazwa | Typ | Opis |
|---|---|---|
| name |
string |
Właściwość Nazwa |
| nameLocale |
string |
Nazwa właściwości Ustawień regionalnych |
DataSources
Sekcja opcjonalna. Identyfikatory odwołań do użycia z interfejsem API Get Search Polygon API.
| Nazwa | Typ | Opis |
|---|---|---|
| geometry |
Informacje o kształcie geometrycznym wyniku. Występuje tylko wtedy, gdy typ == Geography. |
Entity
Źródło typu jednostki pola ograniczenia. W przypadku odwrotnego geokodowania jest to zawsze równe pozycji.
| Wartość | Opis |
|---|---|
| position |
Pozycja jednostki |
EntryPoint
Punkt wejścia zwracanego interfejsu użytkownika.
| 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łównym lub pomocniczym. |
EntryPointType
Typ punktu wejścia. Wartość może być głównym lub pomocniczym.
| Wartość | Opis |
|---|---|
| main | |
| minor |
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. Prezentuj tylko wtedy, gdy zażądano parametru entityType i jest dostępny.
| Wartość | Opis |
|---|---|
| Country |
nazwa kraju/regionu |
| CountrySubdivision |
Stan lub prowincja |
| CountrySecondarySubdivision |
Powiat |
| CountryTertiarySubdivision |
Nazwany obszar |
| Municipality |
Miasto/ Miasto |
| MunicipalitySubdivision |
Sub/Super City |
| Neighbourhood |
Sąsiedztwo |
| PostalCodeArea |
Kod pocztowy/kod pocztowy |
GeoJsonFeature
Prawidłowy typ obiektu GeoJSON Feature. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
| Nazwa | Typ | Opis |
|---|---|---|
| featureType |
string |
Typ funkcji. Wartość zależy od modelu danych, do której należy bieżąca funkcja. Niektóre modele danych mogą mieć pustą wartość. |
| geometry | GeoJsonGeometry: |
Prawidłowy obiekt geometrii |
| id |
string |
Identyfikator funkcji. |
| type |
string:
Feature |
Określa typ |
GeoJsonFeatureCollection
Prawidłowy typ obiektu GeoJSON FeatureCollection. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
| Nazwa | Typ | Opis |
|---|---|---|
| features |
Zawiera listę prawidłowych obiektów |
|
| type |
string:
Feature |
Określa typ |
GeoJsonGeometry
Prawidłowy obiekt geometrii GeoJSON. Typ musi być jednym z siedmiu prawidłowych typów geometrii GeoJSON — Punkt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon i GeometryCollection. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
| Nazwa | Typ | Opis |
|---|---|---|
| type |
Geo |
Określa typ |
GeoJsonGeometryCollection
Prawidłowy typ obiektu GeoJSON GeometryCollection. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
| Nazwa | Typ | Opis |
|---|---|---|
| geometries | GeoJsonGeometry[]: |
Zawiera listę prawidłowych obiektów geometrii |
| type |
string:
Geometry |
Określa typ |
GeoJsonLineString
Prawidłowy typ geometrii GeoJSON LineString. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
| Nazwa | Typ | Opis |
|---|---|---|
| coordinates |
number[] (double) |
Współrzędne geometrii |
| type |
string:
Line |
Określa typ |
GeoJsonMultiLineString
Prawidłowy typ geometrii GeoJSON MultiLineString. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
| Nazwa | Typ | Opis |
|---|---|---|
| coordinates |
number[] (double) |
Współrzędne geometrii |
| type |
string:
Multi |
Określa typ |
GeoJsonMultiPoint
Prawidłowy typ geometrii GeoJSON MultiPoint. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
| Nazwa | Typ | Opis |
|---|---|---|
| coordinates |
number[] (double) |
Współrzędne geometrii |
| type |
string:
Multi |
Określa typ |
GeoJsonMultiPolygon
Prawidłowy typ obiektu GeoJSON MultiPolygon. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
| Nazwa | Typ | Opis |
|---|---|---|
| coordinates |
number[] (double) |
Zawiera listę prawidłowych obiektów |
| type |
string:
Multi |
Określa typ |
GeoJsonPoint
Prawidłowy typ geometrii GeoJSON Point. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
| Nazwa | Typ | Opis |
|---|---|---|
| coordinates |
number[] (double) |
|
| type |
string:
Point |
Określa typ |
GeoJsonPolygon
Prawidłowy typ geometrii GeoJSON Polygon. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
| Nazwa | Typ | Opis |
|---|---|---|
| coordinates |
number[] (double) |
Współrzędne typu geometrii |
| type |
string:
Polygon |
Określa typ |
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 geometryczne 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 (double) |
Właściwość Szerokość geograficzna |
| lon |
number (double) |
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 będzie obsługiwać aplikacja. Domyślnie parametr Widok jest ustawiony na wartość "Unified", nawet jeśli nie zdefiniowano go w żądaniu. Twoim zadaniem jest określenie lokalizacji użytkowników, a następnie poprawne ustawienie parametru Wyświetl dla tej lokalizacji. Alternatywnie możesz ustawić opcję "View=Auto", która zwróci dane mapy na podstawie adresu IP żądania. Parametr View w usłudze Azure Maps musi być używany zgodnie z obowiązującymi przepisami, w tym z przepisami dotyczącymi mapowania kraju/regionu, w którym udostępniane są mapy, obrazy i inne dane oraz zawartość innych firm, do których masz uprawnienia dostępu za pośrednictwem usługi Azure Maps. Przykład: view=IN.
Aby uzyskać szczegółowe informacje, zobacz Obsługiwane widoki, aby uzyskać szczegółowe informacje i wyświetlić dostępne widoki.
| Wartość | Opis |
|---|---|
| AE |
Zjednoczone Emiraty Arabskie (widok arabski) |
| AR |
Argentyna (Widok argentyński) |
| BH |
Bahrajn (widok arabski) |
| IN |
Indie (Widok indyjski) |
| IQ |
Irak (widok arabski) |
| JO |
Jordania (widok arabski) |
| KW |
Kuwejt (widok arabski) |
| LB |
Liban (widok arabski) |
| MA |
Maroko (widok marokański) |
| OM |
Oman (widok arabski) |
| PK |
Pakistan (Pakistański Punkt Widzenia) |
| PS |
Autonomia Palestyńska (widok arabski) |
| QA |
Katar (widok arabski) |
| SA |
Arabia Saudyjska (widok arabski) |
| SY |
Syria (widok arabski) |
| US |
Stany Zjednoczone Ameryki |
| YE |
Jemen (widok arabski) |
| Auto |
Zwróć dane mapy na podstawie adresu IP żądania. |
| Unified |
Ujednolicony widok (inne) |
MatchType
Typy dopasowania dla operacji wyszukiwania odwrotnego adresu.
| Wartość | Opis |
|---|---|
| AddressPoint | |
| HouseNumberRange | |
| Street |
OperatingHours
Godziny otwarcia poi (punkty orientacyjne).
| Nazwa | Typ | Opis |
|---|---|---|
| mode |
string |
Wartość użyta w żądaniu: brak lub "nextSevenDays" |
| timeRanges |
Lista zakresów czasu dla następnych 7 dni |
OperatingHoursRange
Godziny operacji dla weryfikacji koncepcji (punkty orientacyjne). Dostępność godzin operacji będzie się różnić w zależności od dostępnych danych. Jeśli nie zostanie przekazana, nie zostaną zwrócone żadne informacje o godzinach otwarcia. Obsługiwana wartość: nextSevenDays
| Wartość | Opis |
|---|---|
| nextSevenDays |
Pokazuje godziny operacji dla następnego tygodnia, począwszy od bieżącego dnia w czasie lokalnym interfejsu użytkownika. |
OperatingHoursTime
Reprezentuje datę i godzinę
| Nazwa | Typ | Opis |
|---|---|---|
| date |
string |
Reprezentuje bieżącą datę kalendarza w strefie czasowej POI, np. "2019-02-07". |
| hour |
integer |
Godziny są w formacie 24 godziny w czasie lokalnym poi; możliwe wartości to 0–23. |
| minute |
integer |
Minuty są w czasie lokalnym poi; możliwe wartości to 0–59. |
OperatingHoursTimeRange
Zakres czasu otwarcia na dzień
| 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, gdy dany poI jest otwierany, lub początek zakresu, jeśli został otwarty przed zakresem. |
PointOfInterest
Szczegółowe informacje o zwracanym interfejsie użytkownika, w tym informacje, takie jak nazwa, telefon, adres URL i klasyfikacje.
| Nazwa | Typ | Opis |
|---|---|---|
| brands |
Brand[] |
Tablica marek. Nazwa marki zwracanej przez interfejs użytkownika. |
| 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 poi (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: W POBLIŻU lub NON_NEAR.
Ważne: Ta własność jest przestarzała i może zostać pominięta w odpowiedzi.
| Wartość | Opis |
|---|---|
| NEARBY |
Wyszukiwanie przeprowadzano wokół określonej szerokości i długości geograficznej o określonym promieniu. |
| NON_NEAR |
Wyszukiwanie zostało wykonane globalnie, bez stronniczo do określonej szerokości geograficznej i długości geograficznej i bez zdefiniowanego promienia |
ResponseFormat
Żądany format odpowiedzi. Wartość może być json lub xml.
| Wartość | Opis |
|---|---|
| json | |
| xml |
SearchAddressResult
Ten obiekt jest zwracany z pomyślnych wywołań wyszukiwania.
| Nazwa | Typ | Opis |
|---|---|---|
| results |
Lista wyników interfejsu API wyszukiwania. |
|
| summary |
Obiekt podsumowania odpowiedzi interfejsu API wyszukiwania |
SearchAddressResultItem
Wynik obiektu odpowiedzi interfejsu API wyszukiwania.
| 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 do użycia z interfejsem API Get Search Polygon API. |
|
| detourTime |
integer |
Czas objazdu w sekundach. Zwracane tylko dla wywołań interfejsu API wyszukiwania wzdłuż trasy. |
| dist |
number (double) |
Odległość linii prostej między wynikiem a lokalizacją geobiazy w metrach. |
| entityType |
Typ jednostki Geografia. Prezentuj 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ółowe informacje o zwracanym interfejsie 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 (double) |
Wartość w zestawie wyników wskazująca względny wynik dopasowania między wynikami. Za pomocą tej opcji można określić, że wynik x jest dwa razy bardziej prawdopodobny w wyniku y, jeśli wartość x to 2x wartość y. Wartości różnią się między zapytaniami i są przeznaczone tylko jako wartość względna dla jednego zestawu wyników. Ważne: Ta własność jest przestarzała i może zostać pominięta w odpowiedzi. |
| 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:
- punkt orientacyjny
- Ulica
- Geografia
- Adres punktu
- Zakres adresów
- Ulica poprzeczna
| Wartość | Opis |
|---|---|
| POI | |
| Street | |
| Geography | |
| Point Address | |
| Address Range | |
| Cross Street |
SearchIndexes
Indeksy, dla których powinny zostać uwzględnione rozszerzone kody pocztowe w wynikach.
Dostępne indeksy to:
dodatku = zakresy adresów
Geo = Geografie
PAD = adresy punktów
POI = punkty orientacyjne
Str = Ulice
XStr = Cross Streets (skrzyżowania)
Wartość powinna być rozdzielona przecinkami lista 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 muszą być jawnie żądane w razie potrzeby.
Przykłady użycia:
extendedPostalCodesFor=POI
extendedPostalCodesFor=PAD,Addr,POI
extendedPostalCodesFor=Brak
Rozszerzony kod pocztowy jest zwracany jako właściwość extendedPostalCode adresu. Dostępność jest zależna od regionu.
| Wartość | Opis |
|---|---|
| Addr | |
| Geo | |
| PAD | |
| POI | |
| Str | |
| Xstr |
SearchInsideGeometryRequest
Ten typ reprezentuje treść żądania dla usługi Search Inside Geometry.
| Nazwa | Typ | Opis |
|---|---|---|
| geometry | GeoJsonObject: |
Prawidłowy obiekt |
SearchSummary
Obiekt podsumowania odpowiedzi interfejsu API wyszukiwania.
| Nazwa | Typ | Opis |
|---|---|---|
| fuzzyLevel |
integer |
Maksymalny poziom rozmyte 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 rozwiązywaniu zapytania w milisekundach. |
| queryType |
Zwracany typ zapytania: W POBLIŻU lub NON_NEAR. Ważne: Ta własność jest przestarzała i może zostać pominięta w odpowiedzi. |
|
| totalResults |
integer |
Całkowita liczba znalezionych wyników. |