Wyszukiwanie miejsc w pobliżu lokalizacji.
Żądanie HTTP
POST https://places.googleapis.com/v1/places:searchNearby
Adres URL używa składni transkodowania gRPC.
Treść żądania
Treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{ "languageCode": string, "regionCode": string, "includedTypes": [ string ], "excludedTypes": [ string ], "includedPrimaryTypes": [ string ], "excludedPrimaryTypes": [ string ], "maxResultCount": integer, "locationRestriction": { object ( |
Pola | |
---|---|
languageCode |
Szczegóły miejsca będą wyświetlane w preferowanym języku, jeśli będzie on dostępny. Jeśli kod języka jest nieokreślony lub nierozpoznany, mogą zostać zwrócone szczegółowe informacje o miejscu w dowolnym języku, a w zależności od potrzeb – preferowany język angielski. Aktualna lista obsługiwanych języków: https://developers.google.com/maps/faq#languagesupport. |
regionCode |
Kod Unicode kraju/regionu (CLDR) lokalizacji, z której pochodzi żądanie. Służy on do wyświetlania szczegółowych informacji o miejscu, takich jak nazwa miejsca w konkretnym regionie, jeśli jest dostępna. Parametr może wpływać na wyniki w zależności od obowiązującego prawa. Więcej informacji znajdziesz na stronie https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html. Pamiętaj, że 3-cyfrowe kody regionów nie są obecnie obsługiwane. |
includedTypes[] |
Uwzględniony typ miejsca (np. „restauracja” lub „stacja benzynowa”) ze strony https://developers.google.com/maps/documentation/places/web-service/place-types. Można określić do 50 typów z tabeli A. Jeśli występują konflikty typów, tj. dany typ występuje zarówno w elementachincludes, jak i excludedTypes, zostanie zwrócony błąd TRUE_śr. Jeśli typ miejsca jest określony z wieloma ograniczeniami typów, zwracane są tylko miejsca, które spełniają wszystkie te ograniczenia. Jeśli na przykład mamy {includedTypes = ["restauracja"], negativePrimaryTypes = ["restauracja"]}, zwrócone miejsca świadczą usługi związane z „restauracją”, ale nie działają głównie jako „restauracje”. |
excludedTypes[] |
Wykluczony typ miejsca (np. „restauracja” lub „stacja benzynowa”) ze strony https://developers.google.com/maps/documentation/places/web-service/place-types. Można określić do 50 typów z tabeli A. Jeśli klient poda zarówno obiekty includeType (np. restauracja), jak i wykluczone typy (np. kawiarnia), w odpowiedzi powinna pojawić się informacja o miejscach, które są restauracją, ale nie kawiarnią. Odpowiedź zawiera miejsca, które pasują do co najmniej 1 z uwzględnionych typów i żadnego z wykluczonych typów. Jeśli występują konflikty typów, tj. dany typ występuje zarówno w elementachincludes, jak i excludedTypes, zostanie zwrócony błąd TRUE_śr. Jeśli typ miejsca jest określony z wieloma ograniczeniami typów, zwracane są tylko miejsca, które spełniają wszystkie te ograniczenia. Jeśli na przykład mamy {includedTypes = ["restauracja"], negativePrimaryTypes = ["restauracja"]}, zwrócone miejsca świadczą usługi związane z „restauracją”, ale nie działają głównie jako „restauracje”. |
includedPrimaryTypes[] |
Uwzględniony główny typ miejsca (np. „restauracja” lub „stacja benzynowa”) ze strony https://developers.google.com/maps/documentation/places/web-service/place-types. Miejsce może mieć tylko 1 typ podstawowy z powiązanej z nim tabeli obsługiwanych typów. Można określić do 50 typów z tabeli A. Jeśli występują konflikty typów podstawowych, tj. dany typ występuje zarówno w elementach uwzględnianychPrimaryTypes, jak iexcludedPrimaryTypes, zwracany jest błąd Część_śr. Jeśli typ miejsca jest określony z wieloma ograniczeniami typów, zwracane są tylko miejsca, które spełniają wszystkie te ograniczenia. Jeśli na przykład mamy {includedTypes = ["restauracja"], negativePrimaryTypes = ["restauracja"]}, zwrócone miejsca świadczą usługi związane z „restauracją”, ale nie działają głównie jako „restauracje”. |
excludedPrimaryTypes[] |
Wykluczony podstawowy typ miejsca (np. „restauracja” lub „stacja benzynowa”) ze strony https://developers.google.com/maps/documentation/places/web-service/place-types. Można określić do 50 typów z tabeli A. Jeśli występują konflikty typów podstawowych, tj. dany typ występuje zarówno w elementach uwzględnianychPrimaryTypes, jak iexcludedPrimaryTypes, zwracany jest błąd Część_śr. Jeśli typ miejsca jest określony z wieloma ograniczeniami typów, zwracane są tylko miejsca, które spełniają wszystkie te ograniczenia. Jeśli na przykład mamy {includedTypes = ["restauracja"], negativePrimaryTypes = ["restauracja"]}, zwrócone miejsca świadczą usługi związane z „restauracją”, ale nie działają głównie jako „restauracje”. |
maxResultCount |
Maksymalna liczba wyników do zwrócenia. Musi mieścić się w zakresie od 1 do 20 (domyślnie) włącznie. Jeśli wartość jest nieskonfigurowana, wartość spada do górnej granicy. Jeśli liczba jest ustawiona na wartość ujemną lub przekracza górny limit, zwracany jest błąd TRUE_ADDRESS. |
locationRestriction |
To pole jest wymagane. Region do przeszukania. |
rankPreference |
sposób ustalania kolejności wyników w odpowiedzi; |
Treść odpowiedzi
Odpowiedź proto dotycząca wyszukiwania w pobliżu.
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{
"places": [
{
object ( |
Pola | |
---|---|
places[] |
Lista miejsc spełniających wymagania użytkownika, takie jak typ miejsc, liczba miejsc i ograniczenia dotyczące lokalizacji. |
LocationRestriction
Region do przeszukania.
Zapis JSON |
---|
{ // Union field |
Pola | |
---|---|
Pole sumy
|
|
circle |
Okrąg określone przez punkt środkowy i promień. |
RankPreference
sposób ustalania kolejności wyników w odpowiedzi;
Wartości w polu enum | |
---|---|
RANK_PREFERENCE_UNSPECIFIED |
Nie ustawiono wartości Pozycja Preferred. Domyślnie używana jest pozycja według POPULARNOŚCI. |
DISTANCE |
Ranking wyników według odległości. |
POPULARITY |
Ranking wyników według popularności. |