SearchNearbyPointOfInterestOptions interface
Opcje wyszukiwania pobliskich punktów orientacyjnych
- Rozszerzenie
Właściwości
| country |
Filtry liczników ograniczające wyszukiwanie do określonych krajów |
| radius |
Promień w metrach dla wyników, które mają być ograniczone do zdefiniowanego obszaru, Wartość minimalna to 1, Wartość maksymalna to 50000. |
Właściwości dziedziczone
| abort |
Sygnał, który może służyć do przerwania żądań. |
| brand |
Rozdzielona przecinkami lista nazw marek, których można użyć do ograniczenia wyniku do określonych marek. Kolejność elementów nie ma znaczenia. Po podaniu wielu marek zostaną zwrócone tylko wyniki należące do (co najmniej) jednej z podanych list. Marki, które zawierają "", w ich nazwie należy umieścić w cudzysłowie. Przykłady użycia: |
| category |
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. Po podaniu wielu identyfikatorów kategorii zostaną zwrócone tylko elementy POI należące do (co najmniej) jednej z kategorii z podanej listy. Listę obsługiwanych kategorii można znaleźć za pomocą interfejsu API kategorii POI. Przykłady użycia: |
| electric |
Rozdzielona przecinkami lista typów łączników, których można użyć do ograniczenia wyniku do stacji pojazdów elektrycznych obsługujących określone typy łączników. Kolejność elementów nie ma znaczenia. Po podaniu wielu typów łączników zostaną zwrócone tylko wyniki należące do (co najmniej) jednej z podanych list. Przykłady użycia: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached |
| extended |
Indeksy, dla których należy uwzględnić rozszerzone kody pocztowe w wynikach |
| language | Język, w którym powinny być zwracane wyniki wyszukiwania. |
| 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. |
| on |
Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy. |
| request |
Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji. |
| serializer |
Opcje zastępowania zachowania serializacji/deseralizacji. |
| skip | Przesunięcie początkowe zwróconych wyników w pełnym zestawie wyników. Ustawienie domyślne: 0, minimum: 0 i maksimum: 1900 |
| top | Maksymalna liczba odpowiedzi, które zostaną zwrócone. Ustawienie domyślne: 10, minimum: 1 i maksimum: 100 |
| tracing |
Opcje używane podczas śledzenia są włączone. |
Szczegóły właściwości
countryCodeFilter
Filtry liczników ograniczające wyszukiwanie do określonych krajów
countryCodeFilter?: string[]
Wartość właściwości
string[]
radiusInMeters
Promień w metrach dla wyników, które mają być ograniczone do zdefiniowanego obszaru, Wartość minimalna to 1, Wartość maksymalna to 50000.
radiusInMeters?: number
Wartość właściwości
number
Szczegóły właściwości dziedziczonej
abortSignal
Sygnał, który może służyć do przerwania żądań.
abortSignal?: AbortSignalLike
Wartość właściwości
dziedziczone z OperationOptions.abortSignal
brandFilter
Rozdzielona przecinkami lista nazw marek, których można użyć do ograniczenia wyniku do określonych marek. Kolejność elementów nie ma znaczenia. Po podaniu wielu marek zostaną zwrócone tylko wyniki należące do (co najmniej) jednej z podanych list. Marki, które zawierają "", w ich nazwie należy umieścić w cudzysłowie.
Przykłady użycia: brandSet=FoobrandSet=Foo,BarbrandSet="A,B,C Comma",Bar
brandFilter?: string[]
Wartość właściwości
string[]
Odziedziczone poSearchExtraFilterOptions.brandFilter
categoryFilter
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. Po podaniu wielu identyfikatorów kategorii zostaną zwrócone tylko elementy POI należące do (co najmniej) jednej z kategorii z podanej listy. Listę obsługiwanych kategorii można znaleźć za pomocą interfejsu API kategorii POI.
Przykłady użycia: categorySet=7315(Szukaj użytecznych miejsc w kategorii Restauracja) categorySet=7315025,7315017(Szukaj użytecznych miejsc w kategorii Restauracja włoska lub francuska)
categoryFilter?: number[]
Wartość właściwości
number[]
Odziedziczone poSearchExtraFilterOptions.categoryFilter
electricVehicleConnectorFilter
Rozdzielona przecinkami lista typów łączników, których można użyć do ograniczenia wyniku do stacji pojazdów elektrycznych obsługujących określone typy łączników. Kolejność elementów nie ma znaczenia. Po podaniu wielu typów łączników zostaną zwrócone tylko wyniki należące do (co najmniej) jednej z podanych list.
Przykłady użycia: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
electricVehicleConnectorFilter?: string[]
Wartość właściwości
string[]
Odziedziczone poSearchExtraFilterOptions.electricVehicleConnectorFilter
extendedPostalCodesFor
Indeksy, dla których należy uwzględnić rozszerzone kody pocztowe w wynikach
extendedPostalCodesFor?: string[]
Wartość właściwości
string[]
Odziedziczone poSearchBaseOptions.extendedPostalCodesFor
language
Język, w którym powinny być zwracane wyniki wyszukiwania.
language?: string
Wartość właściwości
string
Odziedziczone poSearchBaseOptions.language
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.
localizedMapView?: string
Wartość właściwości
string
Odziedziczone poSearchBaseOptions.localizedMapView
onResponse
Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy.
onResponse?: RawResponseCallback
Wartość właściwości
dziedziczone z OperationOptions.onResponse
requestOptions
Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji.
requestOptions?: OperationRequestOptions
Wartość właściwości
dziedziczone z OperationOptions.requestOptions
serializerOptions
Opcje zastępowania zachowania serializacji/deseralizacji.
serializerOptions?: SerializerOptions
Wartość właściwości
dziedziczone z OperationOptions.serializerOptions
skip
Przesunięcie początkowe zwróconych wyników w pełnym zestawie wyników. Ustawienie domyślne: 0, minimum: 0 i maksimum: 1900
skip?: number
Wartość właściwości
number
Odziedziczone poSearchBaseOptions.skip
top
Maksymalna liczba odpowiedzi, które zostaną zwrócone. Ustawienie domyślne: 10, minimum: 1 i maksimum: 100
top?: number
Wartość właściwości
number
Odziedziczone poSearchBaseOptions.top
tracingOptions
Opcje używane podczas śledzenia są włączone.
tracingOptions?: OperationTracingOptions
Wartość właściwości
dziedziczone z OperationOptions.tracingOptions