Method: computeRoutes

Retorna o trajeto principal entre a origem e o destino solicitados para o meio de transporte solicitado.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON
{
  "origin": {
    object (Waypoint)
  },
  "destination": {
    object (Waypoint)
  },
  "travelMode": enum (RouteTravelMode),
  "intermediateWaypoints": [
    {
      object (Waypoint)
    }
  ],
  "routingPreference": enum (RoutingPreference),
  "locationBias": {
    object (LatLng)
  },
  "includePolyline": boolean,
  "computeAlternativeRoutes": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "departureTime": string,
  "arrivalTime": string
  // End of mutually exclusive fields.
}
Campos
origin

object (Waypoint)

Obrigatório. Waypoint de origem.

destination

object (Waypoint)

Obrigatório. Waypoint de destino.

travelMode

enum (RouteTravelMode)

Opcional. Especifica o meio de transporte.

intermediateWaypoints[]

object (Waypoint)

Opcional. Paradas intermediárias entre a origem e o destino que precisam ser feitas em ordem. Até 25 waypoints intermediários são aceitos.

Especificar mais de 10 waypoints intermediários vai gerar um custo maior e uma latência mais alta. Os waypoints intermediários não são aceitos quando travelMode é TRANSIT.

routingPreference

enum (RoutingPreference)

Opcional. Determina como os dados de trânsito são usados para calcular o trajeto. ROUTING_PREFERENCE_TRAFFIC_AWARE_OPTIMAL não é compatível quando travelMode é WALK ou BICYCLE. Para TRANSIT, ele ativa dados de transporte público em tempo real, como atrasos e cancelamentos.

locationBias

object (LatLng)

Opcional. Um local para priorizar os resultados da pesquisa, por exemplo, para eliminar ambiguidades em consultas de texto de waypoints.

includePolyline

boolean

Opcional. Define se a polilinha codificada será incluída nas rotas de resposta. O valor padrão é false. Quando definido como true, Route.encoded_polyline é retornado.

computeAlternativeRoutes

boolean

Opcional. Se é preciso calcular rotas alternativas além da recomendada. O padrão é "false", em que apenas o trajeto recomendado é retornado. Quando definido como verdadeiro, todas as rotas disponíveis são retornadas, mas as alternativas podem não estar disponíveis para todas as solicitações.

Especifica quando sair da origem ou chegar ao waypoint final. O padrão é a partida no horário atual, se não for especificado. Para TRANSIT, o horário precisa ser de no máximo 7 dias no passado e no máximo 100 dias no futuro. Para outros meios de transporte, o horário não pode ser no passado e precisa ser de, no máximo, 365 dias no futuro. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
departureTime

string (Timestamp format)

Opcional. Indica que o trajeto deve ser calculado com base no horário de partida.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

arrivalTime

string (Timestamp format)

Opcional. Indica que o trajeto deve ser calculado com base no horário de chegada.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

Fim dos campos mutuamente exclusivos.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de ComputeRoutesResponse.

Escopos de autorização

Requer o seguinte escopo OAuth:

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