Method: geocode.destinations.searchDestinations

Ta metoda wyszukuje miejsca docelowe i zwraca ich listę.

Żądanie HTTP

POST https://geocode.googleapis.com/v4alpha/geocode/destinations

Adres URL używa składni transkodowania gRPC.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "travelModes": [
    enum (NavigationPoint.TravelMode)
  ],
  "languageCode": string,
  "regionCode": string,

  // Union field primary_query can be only one of the following:
  "place": string,
  "addressQuery": {
    object (SearchDestinationsRequest.AddressQuery)
  },
  "locationQuery": {
    object (SearchDestinationsRequest.LocationQuery)
  }
  // End of list of possible types for union field primary_query.
}
Pola
travelModes[]

enum (NavigationPoint.TravelMode)

Opcjonalnie. Tryby podróży, dla których mają być filtrowane punkty nawigacyjne. Ma to wpływ na pole navigationPoints zwracane w odpowiedzi. Jeśli to pole jest puste, można zwrócić punkty nawigacyjne wszystkich środków transportu.
languageCode

string

Opcjonalnie. Język, w którym mają być zwracane wyniki.
regionCode

string

Opcjonalnie. Kod regionu. Kod regionu określony jako dwuznakowa wartość ccTLD („domena najwyższego poziomu”). Ten parametr wpływa na wyniki na podstawie obowiązujących przepisów. Ten parametr ma też wpływ na wyniki z usługi, ale nie ogranicza ich w pełni.

Pole unii primary_query. Wyszukaj główne miejsce docelowe. Może to być miejsce, pełny adres lub lokalizacja LatLng. Niektóre miejsca i adresy z minimalną ilością informacji nie będą mogły zostać przekształcone w miejsce docelowe.

Miejsca docelowe są tworzone na podstawie określonego zapytania głównego.

Uwaga: obsługiwane są tylko miejsca i adresy, które mogą być miejscem docelowym nawigacji. Na przykład miejsce, które reprezentuje dom lub kompleks apartamentów, może być użyte jako główne zapytanie, ale miejsca, które reprezentują miejscowość lub obszar administracyjny, nie mogą być użyte jako główne zapytanie. primary_query może mieć tylko jedną z tych wartości:
place

string

Nazwa zasobu miejsca w formacie places/{placeId}.
addressQuery

object (SearchDestinationsRequest.AddressQuery)

Ulica i numer.
locationQuery

object (SearchDestinationsRequest.LocationQuery)

dokładną lokalizację,

Treść odpowiedzi

Wiadomość z odpowiedzią dla usługi DestinationService.SearchDestinations.

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

Zapis JSON 
{
  "destinations": [
    {
      object (Destination)
    }
  ]
}
Pola
destinations[]

object (Destination)

Lista miejsc docelowych.

Jeśli na podstawie głównego zapytania można jednoznacznie określić główne miejsce docelowe, usługa zwraca 1 wynik. W przeciwnym razie usługa może zwrócić wiele wyników w celu usunięcia niejednoznaczności lub nie zwrócić żadnych wyników.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

SearchDestinationsRequest.AddressQuery

Adres ulicy, który chcesz wyszukać. Adresy należy podawać w formacie używanym przez krajową pocztę w danym kraju.

Zapis JSON 
{

  // Union field kind can be only one of the following:
  "address": {
    object (PostalAddress)
  },
  "addressQuery": string
  // End of list of possible types for union field kind.
}
Pola
Pole unii kind. Zapytanie o adres. kind może mieć tylko jedną z tych wartości:
address

object (PostalAddress)

Adres w formacie adresu pocztowego.
addressQuery

string

Adres sformatowany w jednym wierszu.

SearchDestinationsRequest.LocationQuery

zapytanie o lokalizację, które pozwala określić pobliskie miejsce docelowe;

Uwaga: jeśli zapytanie o lokalizację dotyczy budynku, w którym znajdują się podlokale, zwrócone miejsce główne może być podlokalem. W takich przypadkach pole containingPlaces będzie zawierać budynek.

Zapis JSON 
{

  // Union field kind can be only one of the following:
  "location": {
    object (LatLng)
  }
  // End of list of possible types for union field kind.
}
Pola
Pole unii kind. Zapytanie o lokalizację. kind może mieć tylko jedną z tych wartości:
location

object (LatLng)

Dokładna lokalizacja LatLng.

Miejsce docelowe

miejsce docelowe, Obejmuje to główne miejsce, powiązane miejsca, wejścia i punkty nawigacyjne.

Zapis JSON 
{
  "primary": {
    object (PlaceView)
  },
  "containingPlaces": [
    {
      object (PlaceView)
    }
  ],
  "subDestinations": [
    {
      object (PlaceView)
    }
  ],
  "landmarks": [
    {
      object (Landmark)
    }
  ],
  "entrances": [
    {
      object (Entrance)
    }
  ],
  "navigationPoints": [
    {
      object (NavigationPoint)
    }
  ]
}
Pola
primary

object (PlaceView)

Główne miejsce zidentyfikowane przez parametr primary_query w żądaniu.
containingPlaces[]

object (PlaceView)

Mniej precyzyjne miejsca, w których znajduje się miejsce główne. Na przykład kompleks apartamentów, w którym znajduje się ten budynek.
subDestinations[]

object (PlaceView)

Dokładniejsze podrzędne miejsca docelowe w miejscu głównym. Na przykład jednostki znajdujące się w budynku.

Uwaga: w porównaniu z SubDestination zwracanym przez interfejs Places API ta lista miejsc docelowych jest bardziej wyczerpująca, a każde miejsce docelowe zawiera więcej informacji.
landmarks[]

object (Landmark)

Punkty orientacyjne, które można wykorzystać do przekazania informacji o miejscu docelowym lub ułatwienia dotarcia do niego.
entrances[]

object (Entrance)

Wejścia do tego miejsca docelowego.
navigationPoints[]

object (NavigationPoint)

Punkty nawigacyjne dla tego miejsca docelowego.

PlaceView

Reprezentuje widok miejsca w interfejsie Places API. Zawiera też dodatkowe informacje dotyczące miejsc docelowych, takie jak typ struktury i wielokąt wyświetlania.

W niektórych przypadkach PlaceView o tym samym identyfikatorze miejsca może różnić się od tego, co jest zwracane przez interfejs Places API w polach types i displayName.

Zapis JSON 
{
  "place": string,
  "displayName": {
    object (LocalizedText)
  },
  "primaryType": string,
  "types": [
    string
  ],
  "formattedAddress": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "structureType": enum (PlaceView.StructureType),
  "location": {
    object (LatLng)
  },
  "displayPolygon": {
    object
  }
}
Pola
place

string

Nazwa zasobu tego miejsca w formacie places/{placeId}.
displayName

object (LocalizedText)

Opis miejsca zrozumiały dla człowieka. np. „Brama B”, „McDonalds”.
primaryType

string

Główny typ miejsca. Listę możliwych wartości znajdziesz na stronie https://developers.google.com/maps/documentation/places/web-service/place-types.

Uwaga: to pole nie zawsze jest wypełnione. W takich sytuacjach przygotuj się na użycie pola types.
types[]

string

Wszystkie powiązane typy miejsc tego miejsca. Listę możliwych wartości znajdziesz na stronie https://developers.google.com/maps/documentation/places/web-service/place-types.
formattedAddress

string

Adres w jednym wierszu.
postalAddress

object (PostalAddress)

Ustrukturyzowany adres.
structureType

enum (PlaceView.StructureType)

Rodzaj struktury odpowiadający temu miejscu.
location

object (LatLng)

Lokalizacja tego miejsca. W przypadku miejsc z wielokątami wyświetlania może to być dobre miejsce na umieszczenie znacznika na mapie.
displayPolygon

object (Struct format)

Kontur wielokąta miejsca w formacie GeoJSON, zgodnie z formatem RFC 7946: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6.

Uwaga: format RFC 7946 obsługuje wielokąty, więc jeden displayPolygon obiekt może reprezentować wiele wielokątów.

PlaceView.StructureType

Rodzaj obiektu, który reprezentuje to miejsce.

Wartości w polu enum
STRUCTURE_TYPE_UNSPECIFIED Nie używane.
POINT Lokalizacja punktowa.
SECTION Podsekcja budynku.
BUILDING budynek,
GROUNDS Duży obszar, na którym zwykle znajduje się wiele budynków, np. kampus uniwersytecki, kompleks apartamentów lub centrum handlowe.

Punkt orientacyjny

Punkty orientacyjne służą do informowania o tym, gdzie znajduje się miejsce docelowe, lub pomagają w dotarciu do niego.

Zapis JSON 
{
  "tags": [
    enum (Landmark.Tag)
  ],

  // Union field landmark can be only one of the following:
  "place": {
    object (PlaceView)
  }
  // End of list of possible types for union field landmark.
}
Pola
tags[]

enum (Landmark.Tag)

Tagi opisujące, jak można wykorzystać punkt orientacyjny w kontekście miejsca docelowego.
Pole unii landmark. Punkt orientacyjny. landmark może mieć tylko jedną z tych wartości:
place

object (PlaceView)

Miejsce reprezentujące ten punkt orientacyjny.

Landmark.Tag

Lista wszystkich możliwych tagów, które opisują, jak można wykorzystać punkt orientacyjny w kontekście miejsca docelowego.

Jeśli adres zawiera zarówno tag ADDRESS, jak i ARRIVAL, oznacza to, że punkt orientacyjny jest zarówno dobrze widoczny w okolicy, jak i znajduje się blisko miejsca docelowego.

Wartości w polu enum
TAG_UNSPECIFIED Nie używane.
ADDRESS lokalnie znane miejsce, które może służyć do określania ogólnej lokalizacji miejsca docelowego. Zwykle w odległości kilkuset metrów od miejsca docelowego. Są one podobne do punktów orientacyjnych zwracanych przez funkcję deskryptorów adresu interfejsu Geocoding API: https://developers.google.com/maps/documentation/geocoding/address-descriptors/requests-address-descriptors.
ARRIVAL Miejsce, które może pomóc w dotarciu do celu. Przydatne podczas nawigacji, gdy jesteś blisko celu. Może to być np. miejsce po drugiej stronie ulicy niż miejsce docelowe. Punkt orientacyjny z tym tagiem jest zwykle bliżej miejsca docelowego niż punkty orientacyjne z tagiem ADDRESS.

Wejście

Wejście to pojedyncza para współrzędnych szerokości i długości geograficznej, która określa lokalizację punktu wejścia i wyjścia w danym miejscu.

Zapis JSON 
{
  "location": {
    object (LatLng)
  },
  "tags": [
    enum (Entrance.Tag)
  ],
  "place": string
}
Pola
location

object (LatLng)

Lokalizacja wejścia.
tags[]

enum (Entrance.Tag)

Lista tagów opisujących wejście.
place

string

Struktura, na której fizycznie znajduje się to wejście, w formacie places/{placeId}.

Entrance.Tag

Cechy opisujące wejście.

Wartości w polu enum
TAG_UNSPECIFIED Nie używane.
PREFERRED

Wejście prawdopodobnie zapewnia fizyczny dostęp do głównego miejsca w zwróconym miejscu docelowym. Miejsce może mieć wiele preferowanych wejść. Jeśli wejście nie ma tego tagu, oznacza to, że znajduje się w tym samym budynku co główne miejsce, ale niekoniecznie zapewnia do niego dostęp.

Jeśli np. głównym miejscem jest restauracja w centrum handlowym, wejścia „PREFEROWANE” to te, które prawdopodobnie prowadzą do samej restauracji, a pozostałe zwrócone wejścia to inne wejścia do budynku, np. do innych restauracji w centrum handlowym.

Jeśli głównym miejscem jest sam budynek, PREFERRED wejścia będą prowadzić do „głównej” części budynku. Na przykład w centrum handlowym wejścia PREFERRED to te, które umożliwiają dostęp do głównego holu, ale jeśli wejście zapewnia dostęp tylko do sklepu z boku budynku, nie będzie to wejście PREFERRED.

Uwaga: wejście PREFERRED może nie zapewniać dostępu do głównego miejsca, a wejście inne niż PREFERRED może zapewniać dostęp do głównego miejsca.