Method: places.searchNearby

wyszukiwać miejsca 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 (LocationRestriction)
  },
  "rankPreference": enum (RankPreference),
  "routingParameters": {
    object (RoutingParameters)
  },
  "includeFutureOpeningBusinesses": boolean
}
Pola
languageCode

string

Informacje o miejscu będą wyświetlane w preferowanym języku, jeśli jest on dostępny. Jeśli kod języka jest nieokreślony lub nierozpoznany, mogą zostać zwrócone szczegóły miejsca w dowolnym języku, z preferencją dla języka angielskiego, jeśli takie szczegóły istnieją.

Aktualna lista obsługiwanych języków: https://developers.google.com/maps/faq#languagesupport.

regionCode

string

Kod Unicode kraju lub regionu (CLDR) lokalizacji, z której pochodzi żądanie. Ten parametr służy do wyświetlania szczegółów miejsca, np. nazwy miejsca w danym regionie, jeśli jest dostępna. W zależności od obowiązujących przepisów parametr może wpływać na wyniki.

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[]

string

Typ miejsca (np. „restaurant” lub „gas_station”) z https://developers.google.com/maps/documentation/places/web-service/place-types.

Możesz określić maksymalnie 50 typów z tabeli A.

Jeśli występują typy powodujące konflikt, tzn. typ pojawia się zarówno w polu includedTypes, jak i excludedTypes, zwracany jest błąd INVALID_ARGUMENT.

Jeśli typ miejsca jest określony z kilkoma ograniczeniami typu, zwracane są tylko miejsca, które spełniają wszystkie ograniczenia. Jeśli na przykład mamy {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, zwrócone miejsca oferują usługi związane z „restauracjami”, ale nie działają głównie jako „restauracje”.

excludedTypes[]

string

Wykluczony typ miejsca (np. „restaurant” lub „gas_station”) ze strony https://developers.google.com/maps/documentation/places/web-service/place-types.

Możesz określić maksymalnie 50 typów z tabeli A.

Jeśli klient poda zarówno includedTypes (np. restauracja), jak i excludedTypes (np. kawiarnia), odpowiedź powinna zawierać miejsca, które są restauracjami, ale nie kawiarniami. Odpowiedź zawiera miejsca, które pasują do co najmniej jednego z typów includedTypes i do żadnego z typów excludedTypes.

Jeśli występują typy powodujące konflikt, tzn. typ pojawia się zarówno w polu includedTypes, jak i excludedTypes, zwracany jest błąd INVALID_ARGUMENT.

Jeśli typ miejsca jest określony z kilkoma ograniczeniami typu, zwracane są tylko miejsca, które spełniają wszystkie ograniczenia. Jeśli na przykład mamy {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, zwrócone miejsca oferują usługi związane z „restauracjami”, ale nie działają głównie jako „restauracje”.

includedPrimaryTypes[]

string

Główny typ miejsca (np. „restaurant” lub „gas_station”) z listy https://developers.google.com/maps/documentation/places/web-service/place-types. Miejsce może mieć tylko jeden typ podstawowy z tabeli obsługiwanych typów.

Możesz określić maksymalnie 50 typów z tabeli A.

Jeśli występują sprzeczne typy podstawowe, tzn. typ pojawia się zarówno w polu includedPrimaryTypes, jak i w polu excludedPrimaryTypes, zwracany jest błąd INVALID_ARGUMENT.

Jeśli typ miejsca jest określony z kilkoma ograniczeniami typu, zwracane są tylko miejsca, które spełniają wszystkie ograniczenia. Jeśli na przykład mamy {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, zwrócone miejsca oferują usługi związane z „restauracjami”, ale nie działają głównie jako „restauracje”.

excludedPrimaryTypes[]

string

Wykluczony podstawowy typ miejsca (np. „restaurant” lub „gas_station”) ze strony https://developers.google.com/maps/documentation/places/web-service/place-types.

Możesz określić maksymalnie 50 typów z tabeli A.

Jeśli występują sprzeczne typy podstawowe, tzn. typ pojawia się zarówno w polu includedPrimaryTypes, jak i w polu excludedPrimaryTypes, zwracany jest błąd INVALID_ARGUMENT.

Jeśli typ miejsca jest określony z kilkoma ograniczeniami typu, zwracane są tylko miejsca, które spełniają wszystkie ograniczenia. Jeśli na przykład mamy {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, zwrócone miejsca oferują usługi związane z „restauracjami”, ale nie działają głównie jako „restauracje”.

maxResultCount

integer

Maksymalna liczba wyników do zwrócenia. Musi mieścić się w przedziale od 1 do 20 (wartość domyślna) włącznie. Jeśli liczba nie jest ustawiona, wraca do górnego limitu. Jeśli liczba jest ujemna lub przekracza górny limit, zwracany jest błąd INVALID_ARGUMENT.

locationRestriction

object (LocationRestriction)

Wymagane. Region, w którym ma się odbywać wyszukiwanie.

rankPreference

enum (RankPreference)

Określa kolejność wyników w odpowiedzi.

routingParameters

object (RoutingParameters)

Opcjonalnie. Parametry, które wpływają na kierowanie do wyników wyszukiwania.

includeFutureOpeningBusinesses

boolean

Opcjonalnie. Jeśli tak, uwzględnij firmy, które nie są jeszcze otwarte, ale zostaną otwarte w przyszłości.

Treść odpowiedzi

Plik proto odpowiedzi na żądanie wyszukiwania w pobliżu.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON
{
  "places": [
    {
      object (Place)
    }
  ],
  "routingSummaries": [
    {
      object (RoutingSummary)
    }
  ]
}
Pola
places[]

object (Place)

Lista miejsc spełniających wymagania użytkownika, takie jak typy miejsc, liczba miejsc i ograniczenie dotyczące konkretnej lokalizacji.

routingSummaries[]

object (RoutingSummary)

Lista podsumowań routingu, w której każdy wpis jest powiązany z odpowiednim miejscem o tym samym indeksie w polu places. Jeśli podsumowanie wyznaczania trasy jest niedostępne w przypadku jednego z miejsc, będzie zawierać pusty wpis. Jeśli jest to wymagane, lista powinna zawierać tyle samo pozycji co lista miejsc.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/cloud-platform

LocationRestriction

Region, w którym ma się odbywać wyszukiwanie.

Zapis JSON
{

  // Union field type can be only one of the following:
  "circle": {
    object (Circle)
  }
  // End of list of possible types for union field type.
}
Pola

Pole zbiorcze type.

Pole type może mieć tylko jedną z tych wartości:

circle

object (Circle)

Okrąg zdefiniowany przez punkt środkowy i promień.

RankPreference

Określa kolejność wyników w odpowiedzi.

Wartości w polu enum
RANK_PREFERENCE_UNSPECIFIED Wartość RankPreference nie została ustawiona. Domyślnie będzie używana ranga według POPULARNOŚCI.
DISTANCE Uporządkuj wyniki według odległości.
POPULARITY Wyniki są wyświetlane według popularności.