Method: computeRoutes

Zwraca trasę podstawową wraz z opcjonalnymi trasami alternatywnymi ze względu na zbiór terminali i pośrednich punktów pośrednich.

UWAGA: ta metoda wymaga podania w danych wejściowych maski pola odpowiedzi. Możesz podać maskę pola odpowiedzi, używając parametru URL $fields lub fields albo nagłówka HTTP/gRPC X-Goog-FieldMask (patrz dostępne parametry i nagłówki URL). Wartość to lista ścieżek pól rozdzielonych przecinkami. Zapoznaj się ze szczegółową dokumentacją tworzenia ścieżek pól.

Na przykład w tej metodzie:

  • Maska pól wszystkich dostępnych pól (do ręcznej kontroli): X-Goog-FieldMask: *
  • Maska pola z czasem trwania na poziomie trasy, odległością i linią łamaną (przykładowa konfiguracja produkcyjna): X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline.encodedPolyline

Google odradza korzystanie z maski pola odpowiedzi z symbolem wieloznacznym (*) ani określania maski pola na najwyższym poziomie (routes), ponieważ:

  • Wybranie tylko tych pól, których potrzebujesz, pomaga naszemu serwerowi oszczędzać cykle obliczeniowe, dzięki czemu możemy zwrócić Ci wyniki z krótszym czasem oczekiwania.
  • Wybór tylko tych pól, które są potrzebne w zadaniu produkcyjnym, zapewnia stabilną wydajność opóźnień. W przyszłości możemy dodać więcej pól odpowiedzi, a to może wydłużyć czas obliczeń. Jeśli wybierzesz wszystkie pola lub wszystkie pola na najwyższym poziomie, wydajność może się zmniejszyć, ponieważ nowe pola, które dodamy, będą automatycznie uwzględniane w odpowiedzi.
  • Jeśli wybierzesz tylko te pola, których potrzebujesz, rozmiar odpowiedzi będzie mniejszy, a tym samym większa przepustowość sieci.

Żądanie HTTP

POST https://routespreferred.googleapis.com/v1:computeRoutes

Adres URL używa składni transkodowania gRPC.

Treść żądania

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

Zapis JSON 
{
  "origin": {
    object (Waypoint)
  },
  "destination": {
    object (Waypoint)
  },
  "intermediates": [
    {
      object (Waypoint)
    }
  ],
  "travelMode": enum (RouteTravelMode),
  "routingPreference": enum (RoutingPreference),
  "polylineQuality": enum (PolylineQuality),
  "polylineEncoding": enum (PolylineEncoding),
  "departureTime": string,
  "computeAlternativeRoutes": boolean,
  "routeModifiers": {
    object (RouteModifiers)
  },
  "languageCode": string,
  "units": enum (Units),
  "optimizeWaypointOrder": boolean
}
Pola
origin

object (Waypoint)

Wymagane. Punkt pośredni na trasie.
destination

object (Waypoint)

Wymagane. Punkt docelowy.
intermediates[]

object (Waypoint)

Opcjonalnie: Zestaw punktów na trasie (z wyłączeniem punktów końcowych) do zatrzymania się na lub przejechania. Obsługiwanych jest maksymalnie 25 punktów pośrednich.
travelMode

enum (RouteTravelMode)

Opcjonalnie: Określa środek transportu.
routingPreference

enum (RoutingPreference)

Opcjonalnie: Określa sposób obliczania trasy. Serwer próbuje użyć wybranego ustawienia routingu do obliczenia trasy. Jeśli ustawienie routingu powoduje błąd lub bardzo długie opóźnienie, zwracany jest błąd. Możesz określić tę opcję tylko wtedy, gdy travelMode ma wartość DRIVE lub TWO_WHEELER. W przeciwnym razie żądanie się nie powiedzie.
polylineQuality

enum (PolylineQuality)

Opcjonalnie: Określa preferowaną jakość polilinii.
polylineEncoding

enum (PolylineEncoding)

Opcjonalnie: Określa preferowane kodowanie wieloboku.
departureTime

string (Timestamp format)

Opcjonalnie: Godzina wyjazdu. Jeśli nie ustawisz tej wartości, zostanie ona domyślnie ustawiona na czas wysłania żądania. Jeśli ustawisz tę wartość na czas, który już minął, żądanie zakończy się niepowodzeniem.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu” z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
computeAlternativeRoutes

boolean

Opcjonalnie: Określa, czy oprócz trasy mają być obliczane alternatywne trasy. W przypadku żądań z punktami pośrednimi nie są zwracane żadne alternatywne trasy.
routeModifiers

object (RouteModifiers)

Opcjonalnie: Zestaw warunków, które należy spełnić, a które wpływają na sposób obliczania tras.
languageCode

string

Opcjonalnie: Kod języka BCP-47, na przykład „en-US” lub „sr-Latn”. Więcej informacji znajdziesz w artykule Identyfikator języka w standardzie Unicode. Listę obsługiwanych języków znajdziesz w sekcji Obsługa języków. Jeśli nie podasz tej wartości, język wyświetlania zostanie wywnioskowany na podstawie lokalizacji żądania trasy.
units

enum (Units)

Opcjonalnie: Określa jednostki miary dla pól wyświetlanych. Obejmuje to pole instruction w NavigationInstruction. Ta wartość nie ma wpływu na jednostki miary używane w przypadku trasy, etapu, odległości kroku i czasu trwania. Jeśli nie podasz tej wartości, wyświetlane jednostki zostaną wywnioskowane na podstawie lokalizacji żądania.
optimizeWaypointOrder

boolean

Jeśli parametr OptimizeWaypointOrder ma wartość true (prawda), podejmowana jest próba zmiany kolejności określonych pośrednich punktów pośrednich w celu zminimalizowania całkowitego kosztu trasy. Jeśli któryś z punktów pośrednich jest punktem pośrednim, żądanie się nie powiedzie. Aby znaleźć nową kolejność, użyj ComputeRoutesResponse.Routes.optimized_intermediate_waypoint_index. Jeśli w nagłówku X-Goog-FieldMask nie jest żądane routes.optimized_intermediate_waypoint_index, żądanie się nie powiedzie. Jeśli optimizeWaypointOrder ma wartość Fałsz, ComputeRoutesResponse.optimized_intermediate_waypoint_index jest pusta.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu ComputeRoutesResponse.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie protokołu OAuth 2.0.