- Żądanie HTTP
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
- SearchDestinationsRequest.AddressQuery
- SearchDestinationsRequest.LocationQuery
- SearchDestinationsRequest.LocationQuery.PlaceFilter
- PlaceView.StructureType
- SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability
- NavigationPoint.TravelMode
- SearchDestinationsRequest.Effort
- Miejsce docelowe
- PlaceView
- PlaceView.AddressComponent
- Punkt orientacyjny
- Landmark.Tag
- Wejście
- Entrance.Tag
- StreetViewThumbnail
- ImageAnnotation
- ImageAnnotation.Coordinate
- NavigationPoint
- NavigationPoint.Usage
- Destination.ParkingOptions
- Destination.ParkingOptions.Availability
- Destination.ParkingOptions.ParkingFacility
- Destination.ArrivalSummary
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 ( |
| Pola | |
|---|---|
travelModes[] |
Opcjonalnie: Środki transportu, dla których mają być filtrowane punkty nawigacyjne. Ma to wpływ na pole |
languageCode |
Opcjonalnie: Język, w którym mają być zwracane wyniki. |
regionCode |
Opcjonalnie: Kod regionu. Kod regionu określony jako dwuznakowa wartość ccTLD („domena najwyższego poziomu”). Parametr wpływa na wyniki zgodnie z obowiązującymi przepisami. Ten parametr wpływa też na wyniki z usługi, ale nie ogranicza ich całkowicie. |
effort |
Opcjonalnie: Poziom nakładu pracy, o który prosi klient. |
Zapytanie dotyczące głównego miejsca docelowego. Może to być miejsce, pełny adres lub lokalizacja LatLng. Niektórych miejsc i adresów z minimalną ilością informacji nie można przekształcić w miejsce docelowe. Miejsca docelowe są tworzone na podstawie określonego zapytania podstawowego. 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żywane jako zapytanie podstawowe, ale miejsca, które reprezentują miejscowość lub region, nie mogą być używane jako zapytanie podstawowe. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól: |
|
place |
Nazwa zasobu miejsca w formacie |
addressQuery |
Ulica i numer. |
locationQuery |
dokładną lokalizację, |
| Koniec pól wykluczających się wzajemnie. | |
Treść odpowiedzi
Komunikat odpowiedzi dla DestinationService.SearchDestinations.
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
| Zapis JSON |
|---|
{
"destinations": [
{
object ( |
| Pola | |
|---|---|
destinations[] |
Lista miejsc docelowych. Usługa zwraca 1 wynik, jeśli na podstawie zapytania podstawowego można jednoznacznie zidentyfikować główne miejsce docelowe. W przeciwnym razie usługa może zwrócić wiele wyników do uściślenia lub nie zwrócić żadnych wyników. |
Zakresy autoryzacji
Wymaga jednego z tych zakresów OAuth:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/maps-platform.geocodehttps://www.googleapis.com/auth/maps-platform.destinations
SearchDestinationsRequest.AddressQuery
Adres, który chcesz wyszukać. Adresy należy podawać w formacie używanym przez krajową pocztę danego kraju.
| Zapis JSON |
|---|
{
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"address": {
object ( |
| Pola | |
|---|---|
| Zapytanie o adres. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól: | |
address |
Adres pocztowy w formacie adresu pocztowego. |
addressQuery |
Adres sformatowany jako pojedynczy wiersz. |
| Koniec pól wykluczających się wzajemnie. | |
SearchDestinationsRequest.LocationQuery
zapytanie o lokalizację, aby zidentyfikować główne miejsce docelowe w pobliżu;
Uwaga: jeśli zapytanie o lokalizację dotyczy budynku, który zawiera podlokale, możliwe, że zwrócone główne miejsce będzie podlokalem. W takich przypadkach pole containingPlaces będzie zawierać budynek.
| Zapis JSON |
|---|
{ "placeFilter": { object ( |
| Pola | |
|---|---|
placeFilter |
Opcjonalnie: Filtry, które mają zostać zastosowane do potencjalnych miejsc docelowych. |
| Zapytanie o lokalizację. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól: | |
location |
Dokładna lokalizacja LatLng. |
| Koniec pól wykluczających się wzajemnie. | |
SearchDestinationsRequest.LocationQuery.PlaceFilter
Filtry, które mają zostać zastosowane do potencjalnych miejsc docelowych.
| Zapis JSON |
|---|
{ "structureType": enum ( |
| Pola | |
|---|---|
structureType |
Opcjonalnie: Jeśli podasz tę wartość, wszystkie miejsca docelowe będą miały główne miejsce o tym typie struktury. Może to spowodować odfiltrowanie niektórych miejsc docelowych lub ich uogólnienie albo uściślenie. Jeśli na przykład podasz Innym zastosowaniem tego pola jest łatwiejsze wyodrębnianie wielokątów wyświetlania budynków. Jeśli na przykład podasz |
addressability |
Opcjonalnie: Jeśli zostanie określony, zwracane będą tylko miejsca docelowe, które spełniają odpowiednie kryteria adresowalności. |
PlaceView.StructureType
Typ struktury, którą reprezentuje to miejsce.
| Wartości w polu enum | |
|---|---|
STRUCTURE_TYPE_UNSPECIFIED |
Nieużywane. |
POINT |
Lokalizacja punktu. |
SECTION |
Podsekcja budynku. |
BUILDING |
Budynek. |
GROUNDS |
Duży obszar, który zwykle obejmuje kilka budynków, np. kampus uniwersytecki, kompleks apartamentów lub centrum handlowe. |
SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability
Definiuje opcje filtrowania adresowalności. W przyszłości mogą zostać dodane nowe wartości.
| Wartości w polu enum | |
|---|---|
ADDRESSABILITY_UNSPECIFIED |
Jeśli nie zostanie określona, usługa wybierze odpowiednią wartość domyślną. |
ANY |
Możliwość adresowania nie jest kryterium filtrowania. Miejsca docelowe są zwracane niezależnie od ich adresowalności. |
PRIMARY |
Wszystkie zwrócone miejsca docelowe będą miały główne miejsce z adresem lub nazwą na poziomie ulicy. |
WEAK |
Wszystkie zwrócone miejsca docelowe będą miały miejsce główne lub miejsce podrzędne z adresem lub nazwą na poziomie ulicy. |
SearchDestinationsRequest.Effort
Poziom nakładu pracy przeznaczonego na rozwiązywanie problemów z miejscami docelowymi.
| Wartości w polu enum | |
|---|---|
EFFORT_UNSPECIFIED |
Wartość domyślna. |
LOW |
Optymalizuje pod kątem najkrótszego czasu odpowiedzi. Wyszukuje bezpośrednio miejsce docelowe bez rozszerzonego przechodzenia przez hierarchię i skomplikowanego uściślania miejsca. |
MEDIUM |
Zapewnia równowagę między szybkością a dokładnością. Większość żądań jest zwracana ze standardowym krótkim czasem oczekiwania. W przypadku niejednoznacznych zapytań, lokalizacji z wieloma budynkami lub trudnych lokalizacji usługa stosuje dodatkowe przetwarzanie, aby określić miejsca docelowe i kontekst hierarchiczny, z ograniczonym opóźnieniem, które może wynosić do kilku sekund. Zalecane w przypadku interaktywnych przepływów pracy, w których użytkownicy mogą zaakceptować krótką przerwę. |
HIGH |
Maksymalizuje dokładność i kompletność określania miejsca docelowego w przypadku złożonych, nieformalnych lub rozległych lokalizacji (takich jak duże kampusy lub kompleksy mieszkalne). Czas odpowiedzi może być znacznie dłuższy. Zalecane w przypadku przepływów pracy związanych z przetwarzaniem w tle, przetwarzaniem wsadowym, wysyłaniem lub logistyką przed przekierowaniem. |
Miejsce docelowe
miejsce docelowe, Obejmuje to miejsce główne, miejsca powiązane, wejścia i punkty nawigacyjne.
| Zapis JSON |
|---|
{ "primary": { object ( |
| Pola | |
|---|---|
primary |
Główne miejsce określone przez |
containingPlaces[] |
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[] |
Bardziej precyzyjne miejsca podrzędne miejsca głównego. Na przykład jednostki znajdujące się w budynku. Uwaga: w porównaniu z obiektem SubDestination zwracanym przez interfejs Places API ta lista miejsc docelowych jest bardziej wyczerpująca, a każde miejsce docelowe zawiera więcej informacji. |
landmarks[] |
Punkty orientacyjne, które mogą pomóc w określeniu lokalizacji miejsca docelowego lub dotarciu do niego. |
entrances[] |
Wejścia do tego miejsca docelowego. |
navigationPoints[] |
Punkty nawigacyjne dla tego miejsca docelowego. |
parkingOptions |
Opcje parkowania w tym miejscu docelowym. |
arrivalSummary |
Wygenerowane przez AI podsumowanie informacji o przybyciu do 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 się różnić od tego, co zwraca interfejs Places API w polach types i displayName.
| Zapis JSON |
|---|
{ "place": string, "placeId": string, "displayName": { object ( |
| Pola | |
|---|---|
place |
Nazwa zasobu tego miejsca w formacie |
placeId |
Unikalny identyfikator miejsca. |
displayName |
Zrozumiały dla człowieka opis miejsca. Na przykład „Bramka B”, „McDonalds” |
primaryType |
Główny typ tego 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[] |
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 |
Adres w jednym wierszu. |
postalAddress |
Uporządkowany adres. |
structureType |
Typ struktury odpowiadającej temu miejscu. |
location |
Lokalizacja tego miejsca. W przypadku miejsc z wyświetlanymi wielokątami może to być dobre miejsce na umieszczenie znacznika na mapie. |
displayPolygon |
Kontur wielokąta miejsca w formacie GeoJSON, przy użyciu formatu RFC 7946: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6. Uwaga: format RFC 7946 obsługuje MultiPolygons, więc jeden obiekt |
addressComponents[] |
Powtarzające się komponenty dla każdego poziomu lokalizacji. |
PlaceView.AddressComponent
Uporządkowane komponenty, które tworzą sformatowany adres, jeśli te informacje są dostępne.
| Zapis JSON |
|---|
{ "longText": string, "shortText": string, "types": [ string ], "languageCode": string } |
| Pola | |
|---|---|
longText |
Pełny opis tekstowy lub nazwa komponentu adresu. Na przykład komponent adresu dla kraju Australia może mieć długą nazwę „Australia”. |
shortText |
Skrócona nazwa tekstowa komponentu adresu, jeśli jest dostępna. Na przykład komponent adresu dla kraju Australia może mieć krótką nazwę „AU”. |
types[] |
Tablica wskazująca typy komponentu adresu. Te wartości pochodzą z tabeli typów adresów i typów komponentów adresowych używanej przez Places API: https://developers.google.com/maps/documentation/places/web-service/place-types#address-types. |
languageCode |
Język używany do formatowania tego komponentu w notacji CLDR. |
Punkt orientacyjny
Punkty orientacyjne służą do wskazywania miejsca docelowego lub ułatwiania dotarcia do niego.
| Zapis JSON |
|---|
{ "relationalDescription": { object ( |
| Pola | |
|---|---|
relationalDescription |
Zrozumiały dla człowieka opis relacji między miejscem docelowym a punktem orientacyjnym. Na przykład: „W pobliżu Pałacu Kultury i Nauki” lub „Naprzeciwko Sejmu”. |
tags[] |
Tagi opisujące, jak można wykorzystać punkt orientacyjny w kontekście miejsca docelowego. |
straightLineDistanceMeters |
Tylko dane wyjściowe. Odległość w linii prostej od tego punktu orientacyjnego do miejsca docelowego w metrach. |
travelDistanceMeters |
Tylko dane wyjściowe. Odległość pieszo od tego punktu orientacyjnego do miejsca docelowego w metrach. |
| Punkt orientacyjny. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól: | |
place |
Miejsce, które reprezentuje ten punkt orientacyjny. |
| Koniec pól wykluczających się wzajemnie. | |
Landmark.Tag
Lista wszystkich możliwych tagów opisujących, 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 ważny lokalnie, jak i znajduje się blisko miejsca docelowego.
| Wartości w polu enum | |
|---|---|
TAG_UNSPECIFIED |
Nieużywane. |
ADDRESS |
Znane miejsce w okolicy, które może służyć do określenia 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 adresów w interfejsie 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 do nawigacji, gdy jesteś blisko celu. Może to być na przykład miejsce po drugiej stronie ulicy od miejsca docelowego. 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 z miejsca.
| Zapis JSON |
|---|
{ "displayName": { object ( |
| Pola | |
|---|---|
displayName |
Nazwa zrozumiała dla człowieka, np. „Bramka B”, „Wejście południowe”, „Wejście od 5 Alei”. |
location |
Lokalizacja wejścia. |
tags[] |
Lista tagów opisujących wejście. |
place |
Budynek, w którym znajduje się wejście, w formacie |
streetViewThumbnail |
Miniatura Street View przedstawiająca wejście. Obraz można pobrać z interfejsu Street View Static API. Więcej informacji znajdziesz na stronie https://developers.google.com/maps/documentation/streetview/request-streetview. |
streetViewAnnotation |
Adnotacja dotycząca wejścia na |
Entrance.Tag
Cechy opisujące wejście.
| Wartości w polu enum | |
|---|---|
TAG_UNSPECIFIED |
Nieużywane. |
PREFERRED |
Wejście prawdopodobnie zapewnia fizyczny dostęp do głównego miejsca w zwróconym miejscu docelowym. Miejsce może mieć kilka preferowanych wejść. Jeśli wejście nie ma tego tagu, oznacza to, że znajduje się ono w tym samym budynku co główne miejsce, ale niekoniecznie zapewnia dostęp do tego miejsca. Jeśli na przykład głównym miejscem jest restauracja w centrum handlowym, wejścia „PREFEROWANE” będą tymi, które prawdopodobnie prowadzą do samej restauracji, a inne zwrócone wejścia będą innymi wejściami do budynku, np. wejściami do innych restauracji w centrum handlowym. Jeśli głównym miejscem jest sam budynek, wejścia do Uwaga: wejście |
StreetViewThumbnail
Parametry reprezentujące miniaturę Google Street View. Te parametry mogą służyć do żądania obrazu Street View z interfejsu Street View Static API. Więcej informacji znajdziesz na stronie https://developers.google.com/maps/documentation/streetview/request-streetview.
| Zapis JSON |
|---|
{ "pano": string, "widthPx": integer, "heightPx": integer, "headingDegree": number, "pitchDegree": number, "fovDegree": number } |
| Pola | |
|---|---|
pano |
Identyfikator konkretnej panoramy. |
widthPx |
Szerokość wyjściowego obrazu miniatury w pikselach. Uwaga: gdy żądasz adnotacji obok miniatury, musisz użyć tych wartości wysokości i szerokości w żądaniu do interfejsu Street View API, aby współrzędne adnotacji były prawidłowo dopasowane do obrazu. |
heightPx |
Wysokość wyjściowego obrazu miniatury w pikselach. Uwaga: gdy żądasz adnotacji obok miniatury, musisz użyć tych wartości wysokości i szerokości w żądaniu do interfejsu Street View API, aby współrzędne adnotacji były prawidłowo dopasowane do obrazu. |
headingDegree |
Orientacja pozioma kamery w stopniach. Zakres [0, 360). 0 oznacza północ, a 90 – wschód. |
pitchDegree |
Orientacja pionowa kamery w stopniach. Zakres [-90, 90]. 0 to horyzont, +90 to prosto w górę, a -90 to prosto w dół. |
fovDegree |
Poziome pole widzenia w stopniach. Zakres (0, 180]. Określa poziom powiększenia. Mniejsze pole widzenia oznacza większe powiększenie. |
ImageAnnotation
Adnotacja na miniaturze obrazu, np. wielokąt obrysowujący wejście.
| Zapis JSON |
|---|
{
"coordinates": [
{
object ( |
| Pola | |
|---|---|
coordinates[] |
Lista współrzędnych, które tworzą wielokąt na obrazie. Współrzędne są uporządkowane w kierunku przeciwnym do ruchu wskazówek zegara. |
ImageAnnotation.Coordinate
Współrzędna piksela punktu na obrazie. Punkt początkowy (0,0) to lewy górny róg lewego górnego piksela obrazu, przy czym oś X jest skierowana w prawo, a oś Y – w dół.
| Zapis JSON |
|---|
{ "xPx": number, "yPx": number } |
| Pola | |
|---|---|
xPx |
Współrzędna X. |
yPx |
Współrzędna Y. |
Destination.ParkingOptions
Informacje o opcjach parkowania w miejscu docelowym.
| Zapis JSON |
|---|
{ "availability": enum ( |
| Pola | |
|---|---|
availability |
Dostępność parkingu w tym miejscu docelowym. |
parkingFacilities[] |
Parkingi w tym miejscu docelowym. |
onsiteParking |
Na miejscu jest parking. |
freeParkingLot |
Bezpłatne miejsca parkingowe. |
paidParkingLot |
Dostępne są płatne parkingi. |
freeStreetParking |
Dostępny jest bezpłatny parking przy ulicy. |
paidStreetParking |
Dostępny jest płatny parking przy ulicy. |
valetParking |
Dostępny jest parking z obsługą. |
freeGarageParking |
Bezpłatny parking w garażu. |
paidGarageParking |
Dostępny jest płatny parking zadaszony. |
Destination.ParkingOptions.Availability
Zbiorcza miara trudności znalezienia miejsca parkingowego podczas wizyty w tym miejscu.
W przyszłości mogą zostać dodane nowe wartości.
| Wartości w polu enum | |
|---|---|
AVAILABILITY_UNSPECIFIED |
Brak informacji o dostępności parkingu. |
PLENTY |
Dostępnych jest wiele miejsc parkingowych. |
SOMEWHAT_DIFFICULT |
Raczej trudno znaleźć miejsce parkingowe. |
DIFFICULT |
Bardzo trudno znaleźć miejsce parkingowe. |
Destination.ParkingOptions.ParkingFacility
Osobna, konkretna opcja parkowania (np. konkretny parking lub garaż) powiązana z miejscem docelowym. Zawiera szczegółowe informacje o konkretnym parkingu, podczas gdy nadrzędny komunikat ParkingOptions zawiera podsumowanie wszystkich dostępnych parkingów.
| Zapis JSON |
|---|
{
"place": {
object ( |
| Pola | |
|---|---|
place |
Reprezentacja miejsca tego konkretnego parkingu. |
onsite |
Określa, czy ten parking znajduje się na terenie głównego miejsca docelowego. Jeśli to pole nie jest skonfigurowane, stan na miejscu jest nieznany. |
popular |
Określa, czy ten parking jest popularnym wyborem wśród osób podróżujących do głównego miejsca docelowego. Jeśli to pole nie jest skonfigurowane, stan popularności jest nieznany. |
straightLineDistanceMeters |
Odległość w linii prostej w metrach od głównego miejsca docelowego do tego parkingu. |
Destination.ArrivalSummary
Wygenerowane przez AI podsumowanie informacji o przybyciu do miejsca docelowego.
| Zapis JSON |
|---|
{ "text": { object ( |
| Pola | |
|---|---|
text |
Podsumowanie informacji o przybyciu do miejsca docelowego. |
flagContentUrl |
Link, za pomocą którego użytkownicy mogą zgłosić problem z podsumowaniem. |
disclosureText |
Tylko dane wyjściowe. Zawiera tekst powiadomienia dotyczącego podsumowania przyjazdu. |