Method: computeCustomRoutes

Com um conjunto de pontos de passagem finais e intermediários e um objetivo de rota, calcula a melhor rota para o objetivo. Também retorna o trajeto mais rápido e o mais curto como trajetos de referência.

Observação: esse método exige que você especifique uma máscara de campo de resposta na entrada. É possível fornecer a máscara de campo de resposta usando o parâmetro de URL $fields ou fields, ou o cabeçalho HTTP/gRPC X-Goog-FieldMask. Consulte os cabeçalhos e parâmetros de URL disponíveis. O valor é uma lista separada por vírgulas de caminhos de campo. Consulte esta documentação detalhada sobre como criar os caminhos de campo.

Por exemplo, neste método:

  • Máscara de campo de todos os campos disponíveis (para inspeção manual): X-Goog-FieldMask: *
  • Máscara de campo de informações de distância, durações, token e pedágio do trajeto: X-Goog-FieldMask: routes.route.distanceMeters,routes.route.duration,routes.token,routes.route.travelAdvisory.tollInfo

O Google desaconselha o uso da máscara de campo de resposta com caractere curinga (*) ou a especificação da máscara de campo no nível superior (routes) porque:

  • Selecionar apenas os campos necessários ajuda nosso servidor a economizar ciclos de computação, permitindo que retornemos o resultado para você com uma latência menor.
  • Selecionar apenas os campos necessários para o job de produção garante um desempenho de latência estável. Talvez adicionemos mais campos de resposta no futuro, e esses novos campos podem exigir mais tempo de computação. Se você selecionar todos os campos ou todos os campos no nível superior, poderá haver uma degradação no desempenho, porque qualquer campo novo que adicionarmos será incluído automaticamente na resposta.
  • Selecionar apenas os campos necessários resulta em uma resposta menor e, portanto, em maior capacidade de rede.

Solicitação HTTP

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

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)
  },
  "intermediates": [
    {
      object (Waypoint)
    }
  ],
  "travelMode": enum (RouteTravelMode),
  "routingPreference": enum (RoutingPreference),
  "polylineQuality": enum (PolylineQuality),
  "polylineEncoding": enum (PolylineEncoding),
  "departureTime": string,
  "routeModifiers": {
    object (RouteModifiers)
  },
  "routeObjective": {
    object (RouteObjective)
  },
  "languageCode": string,
  "units": enum (Units)
}
Campos
origin

object (Waypoint)

Obrigatório. Ponto de referência da origem.
destination

object (Waypoint)

Obrigatório. Ponto de passagem de destino.
intermediates[]

object (Waypoint)

Opcional. Um conjunto de waypoints ao longo do trajeto (excluindo pontos de terminal), para parada ou passagem. Até 25 waypoints intermediários são permitidos.
travelMode

enum (RouteTravelMode)

Opcional. Especifica o meio de transporte. Somente DRIVE e "TWO_WHEELER" são aceitos.
routingPreference

enum (RoutingPreference)

Opcional. Especifica como calcular a rota. O servidor tenta usar a preferência de roteamento selecionada para calcular a rota. Se a preferência de roteamento resultar em um erro ou em uma latência extralonga, um erro será retornado. Essa opção só pode ser especificada quando travelMode é DRIVE ou TWO_WHEELER. Caso contrário, a solicitação falha.
polylineQuality

enum (PolylineQuality)

Opcional. Especifica sua preferência pela qualidade da polilinha.
polylineEncoding

enum (PolylineEncoding)

Opcional. Especifica a codificação preferida para a polilinha.
departureTime

string (Timestamp format)

Opcional. O horário de partida. Se você não definir esse valor, ele será usado como padrão para a hora em que a solicitação foi feita. Se você definir esse valor para um horário que já ocorreu, a solicitação falhará.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
routeModifiers

object (RouteModifiers)

Opcional. Um conjunto de condições que afetam a forma como as rotas são calculadas.
routeObjective

object (RouteObjective)

Obrigatório. Um objetivo de rota para otimização.
languageCode

string

Opcional. O código de idioma BCP-47, como "pt-BR" ou "en-US". Para saber mais, consulte Identificador de localidade Unicode. Consulte Compatibilidade de idiomas para ver a lista de idiomas compatíveis. Quando você não fornece esse valor, o idioma de exibição é inferido com base no local da solicitação de rota.
units

enum (Units)

Opcional. Especifica as unidades de medida para os campos de exibição. Isso inclui o campo instruction em NavigationInstruction. As unidades de medida usadas para trajeto, trecho, distância do passo e duração não são afetadas por esse valor. Se você não fornecer esse valor, as unidades de exibição serão inferidas com base no local da solicitação.

Corpo da resposta

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

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.