Compartilhar via

Route - Post Route Directions

Serviço:
Maps
Versão da API:
2025-01-01

Use para obter a melhor rota entre uma origem e um destino para automóveis, caminhões comerciais e rotas a pé.

A API Route Directions é uma solicitação HTTP POST que retorna a rota ideal entre uma origem e um destino para automóveis (condução), caminhões comerciais e rotas a pé. A rota passa por uma série de pontos de passagem, se especificado. Um ponto de passagem é uma localização geográfica definida por longitude e latitude que é usada para fins de navegação. A rota considera fatores como o tráfego atual e as velocidades típicas da estrada no dia solicitado da semana e hora do dia.

A API retorna a distância, o tempo de viagem estimado e uma representação da geometria da rota. Mais informações de roteamento, como uma ordem de ponto de passagem otimizada ou instruções por turno, também estão disponíveis, dependendo dos parâmetros usados.

O Route Directions considera leis locais, dimensões de veículos, tipo de carga, velocidade máxima, alturas de ponte e túnel para calcular as rotas específicas do caminhão e evitar manobras complexas e estradas difíceis. Nem todos os caminhões podem percorrer as mesmas rotas que outros veículos devido a determinadas restrições com base no perfil do veículo ou no tipo de carga. Por exemplo, as rodovias geralmente têm limites de velocidade separados para caminhões, algumas estradas não permitem caminhões com materiais inflamáveis ou perigosos, e pode haver restrição de altura e peso nas pontes.

Até 150 waypoints e 10 viaWaypoints entre quaisquer dois waypoints são suportados. Cada conjunto de pontos de passagem cria uma leg de rota separada. Os ViaWaypoints definem o caminho da rota e podem ser usados para a criação de rotas por meio de locais específicos, mas não criam pernas de rota.

Para obter informações sobre a disponibilidade de roteamento em países/regiões, consulte cobertura de roteamento do Azure Mapas.

POST https://atlas.microsoft.com/route/directions?api-version=2025-01-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
api-version
 query True

string

Número de versão da API do Azure Mapas.

Cabeçalho da solicitação

Media Types: "application/geo+json"

Nome Obrigatório Tipo Description
x-ms-client-id

string

Indica a conta destinada ao uso com o modelo de segurança de ID do Microsoft Entra. Essa ID exclusiva para a conta do Azure Mapas pode ser obtida na API da conta do plano de gerenciamento do Azure Mapas. Para obter mais informações sobre como usar a segurança de ID do Microsoft Entra no Azure Mapas, consulte Gerenciar autenticação no Azure Mapas.
Accept-Language

string

Idioma no qual os resultados do roteamento devem ser retornados.

Para obter mais informações, consulte Suporte à Localização no Azure Mapas.

Corpo da solicitação

Media Types: "application/geo+json"

Nome Obrigatório Tipo Description
features True

InputWaypointFeaturesItem[]

As rotas de carro, caminhada e caminhão são definidas por um conjunto de waypoints (paradas) e viaWaypoints (locais intermediários pelos quais a rota deve passar). Você pode ter no máximo 150 waypoints e no máximo 10 viaWaypoints entre cada conjunto de waypoints.

Uma rota deve ter um mínimo de dois pontos de passagem e os pontos de início e de término da rota não podem ser viaWaypoints.

Os locais de waypoint e viaWaypoint devem ser especificados como um objeto de recurso válido do Ponto GeoJSON, juntamente com pointIndex que especifica a ordem dos locais. Para obter mais informações sobre o formato GeoJSON, consulte RFC 7946.
type True

FeatureTypeEnum

Especifica o tipo de GeoJSON. O único tipo de objeto com suporte é FeatureCollection. Para obter mais informações, consulte RFC 7946.
arriveAt

string (date-time)

A data e a hora da chegada no ponto de destino formatado como um valor dateTime definido por RFC 3339, seção 5.6. Quando um deslocamento de fuso horário não for especificado, o UTC será assumido.

O parâmetro arriveAt não pode ser usado em conjunto com departAt.

Exemplo: "arriveAt": "2023-06-01T09:30:00.000-07:00"
avoid

AvoidEnum[]

Especifica as restrições que o cálculo de rota deve respeitar ao determinar a rota. Evite dar suporte a vários valores em uma solicitação e só tem suporte para a condução e o caminhão travelMode.

Exemplo: "evite": ["limitedAccessHighways", "tollRoads"]
departAt

string (date-time)

A data e hora da partida do ponto de origem formatada como um valor dateTime definido por RFC 3339, seção 5.6. Quando um deslocamento de fuso horário não for especificado, o UTC será assumido.

Se o departAt não estiver definido, o valor padrão será a hora atual.

Example:

"departAt": "2023-06-01T09:30:00.000-07:00"
heading

integer (int64)

minimum: 0
maximum: 359

O título direcional inicial do veículo em graus começando no verdadeiro Norte e continuando na direção horário. Norte é 0 graus, leste é 90 graus, sul é 180 graus, oeste é 270 graus.
maxRouteCount

integer (int64)

minimum: 1
maximum: 6

O número máximo de rotas a serem retornadas. Disponível para os modos de viagem de caminhão e de condução.

Padrão: "maxRouteCount":1
optimizeRoute

RouteDirectionOptimizeRouteEnum

Especifica o parâmetro a ser usado para otimizar a rota. Se não for definido, o padrão será "fastestWithoutTraffic", que retorna a rota para minimizar o tempo de viagem sem usar as informações de tráfego atuais.

Exemplo: "optimizeRoute":"shortest"
optimizeWaypointOrder

boolean

Solicite novamente os pontos de passagem de rota usando um algoritmo heurístico rápido para reduzir o custo de rota especificado com o parâmetro de otimização. A origem e o destino são excluídos do ponto de passagem otimizado e sua posição é considerada fixa. Valores aceitáveis são verdadeiros ou falsos.
routeOutputOptions

RouteOutputOptionEnum[]

Inclua as informações de rota desejadas da resposta. Por padrão, o itinerário é incluído na resposta.

Suporta vários valores, como "routeOutputOptions": ["routePath", "itinerary"]
travelMode

TravelModeEnum

O modo de viagem para a rota solicitada. Se não for definido, o valor padrão será "dirigir" que retorna a rota otimizada para carros.

Note: para o caminhão travelMode, a rota de caminhão solicitada pode não estar disponível para toda a rota. Quando a rota do caminhão não estiver disponível para uma seção específica, o elemento travelMode da resposta dessa seção será "outro".

Exemplo: "travelMode":"driving"
vehicleSpec

RouteDirectionVehicleSpec

Especifica os atributos do veículo, como tamanho, peso, velocidade máxima, tipo de carga, etc. somente para roteamento de caminhão. Isso ajuda a evitar baixas liberações de ponte, restrições de estrada, curvas à direita difíceis para fornecer a rota otimizada do caminhão com base nas especificações do veículo.

Note: com suporte apenas para o caminhão travelMode

Respostas

Nome Tipo Description
200 OK

RouteDirectionsResponse

OK

Media Types: "application/geo+json", "application/json"
Other Status Codes

MapsErrorResponse

Ocorreu um erro inesperado.

Media Types: "application/geo+json", "application/json"

Cabeçalhos

x-ms-error-code: string

Segurança

AADToken

Estas são as Fluxos de do Microsoft Entra OAuth 2.0. Quando emparelhado com acesso baseado em função do Azure controle, ele pode ser usado para controlar o acesso às APIs REST do Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais sub-recursos ou conta de recurso do Azure Mapas. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para APIs REST do Azure Mapas.

Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de controlar o acesso em APIs e escopos específicos.

Note

  • Essa definição de segurança requer o uso do cabeçalho x-ms-client-id para indicar a qual recurso do Azure Mapas o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento do Mapas.
  • O Authorization URL é específico para a instância de nuvem pública do Azure. Nuvens soberanas têm URLs de autorização exclusivas e configurações de ID do Microsoft Entra.
  • O controle de acesso baseado em função do Azure é configurado do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.
  • O uso do SDK da Web do do Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.
  • Para obter mais informações sobre a plataforma de identidade da Microsoft, consulte visão geral da plataforma de identidade da Microsoft.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Essa é uma chave compartilhada provisionada ao criar um recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.

Com essa chave, qualquer aplicativo está autorizado a acessar todas as APIs REST. Em outras palavras, elas podem atualmente ser tratadas como chaves mestras para a conta para a qual são emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar o acesso de servidor a servidor de APIs REST do Azure Mapas, em que essa chave pode ser armazenada com segurança.

Tipo: apiKey
Em: header

SAS Token

Esse é um token de assinatura de acesso compartilhado criado a partir da operação LISTA SAS no recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.

Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado para expiração, taxa e região(s) de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de forma mais protegida do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no de recursos da conta de mapa de para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

Successfully retrieve a route between an origin and a destination with additional parameters in the body

Solicitação de exemplo

POST https://atlas.microsoft.com/route/directions?api-version=2025-01-01

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "coordinates": [
          -122.201399,
          47.608678
        ],
        "type": "Point"
      },
      "properties": {
        "pointIndex": 0,
        "pointType": "waypoint"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "coordinates": [
          -122.20687,
          47.612002
        ],
        "type": "Point"
      },
      "properties": {
        "pointIndex": 1,
        "pointType": "viaWaypoint"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "coordinates": [
          -122.201669,
          47.615076
        ],
        "type": "Point"
      },
      "properties": {
        "pointIndex": 2,
        "pointType": "waypoint"
      }
    }
  ],
  "optimizeRoute": "fastestWithTraffic",
  "routeOutputOptions": [
    "routePath"
  ],
  "maxRouteCount": 3,
  "travelMode": "driving"
}

Resposta de exemplo

Código de status:
200 
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.20147,
          47.60868
        ]
      },
      "properties": {
        "routePathPoint": {
          "legIndex": 0,
          "pointIndex": 0
        },
        "order": {
          "inputIndex": 0
        },
        "type": "Waypoint"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.2016,
          47.61508
        ]
      },
      "properties": {
        "routePathPoint": {
          "legIndex": 0,
          "pointIndex": 64
        },
        "order": {
          "inputIndex": 2
        },
        "type": "Waypoint"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "MultiLineString",
        "coordinates": [
          [
            [
              -122.20147,
              47.60868
            ],
            [
              -122.20148,
              47.60884
            ],
            [
              -122.20148,
              47.60906
            ],
            [
              -122.20148,
              47.60919
            ],
            [
              -122.20148,
              47.60953
            ],
            [
              -122.20148,
              47.60967
            ],
            [
              -122.20149,
              47.60997
            ],
            [
              -122.2015,
              47.61011
            ],
            [
              -122.2015,
              47.61019
            ],
            [
              -122.20192,
              47.61021
            ],
            [
              -122.20199,
              47.61021
            ],
            [
              -122.20252,
              47.61019
            ],
            [
              -122.20264,
              47.61018
            ],
            [
              -122.20271,
              47.61015
            ],
            [
              -122.20276,
              47.61015
            ],
            [
              -122.20281,
              47.61015
            ],
            [
              -122.20286,
              47.61015
            ],
            [
              -122.20329,
              47.61016
            ],
            [
              -122.20346,
              47.61016
            ],
            [
              -122.20414,
              47.61017
            ],
            [
              -122.20416,
              47.61057
            ],
            [
              -122.20418,
              47.61083
            ],
            [
              -122.20418,
              47.61092
            ],
            [
              -122.20419,
              47.61103
            ],
            [
              -122.20419,
              47.61121
            ],
            [
              -122.2042,
              47.61126
            ],
            [
              -122.20478,
              47.61127
            ],
            [
              -122.20555,
              47.61128
            ],
            [
              -122.20569,
              47.61128
            ],
            [
              -122.20596,
              47.61128
            ],
            [
              -122.20617,
              47.61127
            ],
            [
              -122.20624,
              47.61125
            ],
            [
              -122.2066,
              47.61126
            ],
            [
              -122.20669,
              47.61127
            ],
            [
              -122.20686,
              47.61129
            ],
            [
              -122.20687,
              47.61158
            ],
            [
              -122.20689,
              47.61187
            ],
            [
              -122.20691,
              47.61233
            ],
            [
              -122.20691,
              47.61247
            ],
            [
              -122.20694,
              47.61317
            ],
            [
              -122.20695,
              47.61342
            ],
            [
              -122.20696,
              47.61362
            ],
            [
              -122.20697,
              47.61384
            ],
            [
              -122.20683,
              47.61384
            ],
            [
              -122.20638,
              47.61384
            ],
            [
              -122.20612,
              47.61384
            ],
            [
              -122.20568,
              47.61383
            ],
            [
              -122.20559,
              47.6138
            ],
            [
              -122.20467,
              47.61379
            ],
            [
              -122.20443,
              47.61379
            ],
            [
              -122.20405,
              47.61379
            ],
            [
              -122.20325,
              47.6138
            ],
            [
              -122.203,
              47.6138
            ],
            [
              -122.20274,
              47.6138
            ],
            [
              -122.20241,
              47.61381
            ],
            [
              -122.20222,
              47.6138
            ],
            [
              -122.20202,
              47.6138
            ],
            [
              -122.20193,
              47.6138
            ],
            [
              -122.20181,
              47.61386
            ],
            [
              -122.20167,
              47.61386
            ],
            [
              -122.20155,
              47.61386
            ],
            [
              -122.20158,
              47.61464
            ],
            [
              -122.20159,
              47.61475
            ],
            [
              -122.2016,
              47.61503
            ],
            [
              -122.2016,
              47.61508
            ]
          ]
        ]
      },
      "properties": {
        "distanceInMeters": 1520,
        "durationInSeconds": 307,
        "departureAt": "2025-06-17T09:08:10+00:00",
        "arrivalAt": "2025-06-17T09:13:10+00:00",
        "durationTrafficInSeconds": 300,
        "trafficCongestion": "Medium",
        "type": "RoutePath",
        "legs": [
          {
            "distanceInMeters": 1520,
            "durationInSeconds": 307,
            "durationTrafficInSeconds": 300,
            "departureAt": "2025-06-17T09:08:10+00:00",
            "arrivalAt": "2025-06-17T09:13:10+00:00",
            "routePathRange": {
              "legIndex": 0,
              "range": [
                0,
                64
              ]
            }
          }
        ]
      },
      "bbox": [
        -122.20697,
        47.60868,
        -122.20147,
        47.61508
      ]
    }
  ],
  "alternativeRoutes": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.20147,
              47.60868
            ]
          },
          "properties": {
            "routePathPoint": {
              "legIndex": 0,
              "pointIndex": 0
            },
            "order": {
              "inputIndex": 0
            },
            "type": "Waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.2016,
              47.61508
            ]
          },
          "properties": {
            "routePathPoint": {
              "legIndex": 0,
              "pointIndex": 29
            },
            "order": {
              "inputIndex": 1
            },
            "type": "Waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "type": "MultiLineString",
            "coordinates": [
              [
                [
                  -122.20147,
                  47.60868
                ],
                [
                  -122.20148,
                  47.60884
                ],
                [
                  -122.20148,
                  47.60906
                ],
                [
                  -122.20148,
                  47.60919
                ],
                [
                  -122.20148,
                  47.60953
                ],
                [
                  -122.20148,
                  47.60967
                ],
                [
                  -122.20149,
                  47.60997
                ],
                [
                  -122.2015,
                  47.61011
                ],
                [
                  -122.2015,
                  47.61019
                ],
                [
                  -122.20151,
                  47.61072
                ],
                [
                  -122.20152,
                  47.61092
                ],
                [
                  -122.20152,
                  47.61097
                ],
                [
                  -122.20149,
                  47.611
                ],
                [
                  -122.20147,
                  47.61104
                ],
                [
                  -122.20145,
                  47.61117
                ],
                [
                  -122.20145,
                  47.61122
                ],
                [
                  -122.20145,
                  47.61126
                ],
                [
                  -122.20146,
                  47.61149
                ],
                [
                  -122.20147,
                  47.61166
                ],
                [
                  -122.20148,
                  47.61197
                ],
                [
                  -122.20148,
                  47.61203
                ],
                [
                  -122.2015,
                  47.61268
                ],
                [
                  -122.20151,
                  47.61289
                ],
                [
                  -122.20152,
                  47.61297
                ],
                [
                  -122.20153,
                  47.61338
                ],
                [
                  -122.20155,
                  47.61386
                ],
                [
                  -122.20158,
                  47.61464
                ],
                [
                  -122.20159,
                  47.61475
                ],
                [
                  -122.2016,
                  47.61503
                ],
                [
                  -122.2016,
                  47.61508
                ]
              ]
            ]
          },
          "properties": {
            "distanceInMeters": 713,
            "durationInSeconds": 92,
            "departureAt": "2025-06-17T09:08:10+00:00",
            "arrivalAt": "2025-06-17T09:09:40+00:00",
            "durationTrafficInSeconds": 90,
            "trafficCongestion": "Medium",
            "type": "RoutePath",
            "legs": [
              {
                "distanceInMeters": 713,
                "durationInSeconds": 92,
                "durationTrafficInSeconds": 90,
                "departureAt": "2025-06-17T09:08:10+00:00",
                "arrivalAt": "2025-06-17T09:09:40+00:00",
                "routePathRange": {
                  "legIndex": 0,
                  "range": [
                    0,
                    29
                  ]
                }
              }
            ]
          },
          "bbox": [
            -122.2016,
            47.60868,
            -122.20145,
            47.61508
          ]
        }
      ]
    }
  ]
}

Definições

Nome Description
Address

O distrito administrativo e a região do país para os pontos de passagem e pontos de manobra na rota.
AdminDistrict

O nome da subdivisão no país ou região para um endereço. Esse elemento normalmente é tratado como a subdivisão administrativa de primeira ordem, mas em alguns casos também contém a subdivisão de segunda, terceira ou quarta ordem em um país, dependência ou região.
AdrTunnelRestrictionCodeEnum

O código de restrição do túnel ADR. A ADR é um acordo europeu relativo ao transporte internacional de mercadorias perigosas por estrada. O código de restrição do túnel ADR é usado para determinar se um veículo tem permissão para passar por um túnel com restrições no transporte de mercadorias perigosas.
AvoidEnum

Especifica as restrições que o cálculo de rota deve respeitar ao determinar a rota. Evite dar suporte a vários valores em uma solicitação e só tem suporte para a condução e o caminhão travelMode.

Exemplo: "evite": ["limitedAccessHighways", "tollRoads"]
CountryRegion

Representa um país ou região, contendo detalhes relacionados.
DirectionsRequest

Esse objeto é o corpo da solicitação.
DrivingSideEnum

Indica a direção esquerda versus direita no ponto da manobra.
FeatureCollection

GeoJSON FeatureCollection objeto que contém uma lista de Recursos. Para obter mais informações, consulte RFC 7946, seção 3.3.
FeaturesItem

Objeto de recurso GeoJSON que contém o objeto Geometry e propriedades adicionais da rota.
FeaturesItemTypeEnum

Especifica o tipo de GeoJSON. O único tipo de objeto com suporte é o Recurso. Para obter mais informações, consulte RFC 7946.
FeatureTypeEnum

Especifica o tipo de GeoJSON. O único tipo de objeto com suporte é FeatureCollection. Para obter mais informações, consulte RFC 7946.
GeoJsonPoint

Um tipo de geometria de GeoJSON Point válido. Consulte RFC 7946 para obter detalhes.
InputWaypointFeaturesItem

Especifica o ponto de entrada e o viaWaypoint GeoJSON objeto de recurso e propriedades adicionais. Para obter mais informações, consulte RFC 7946.
InputWaypointProperties

Especifica as propriedades de um ponto de passagem que é um local ou ponto específico ao longo de uma rota ou viagem que serve como referência ou ponto de parada.
InputWaypointTypeEnum

Tipo de ponto de passagem na rota. Pode ser uma parada ou um local intermediário pelo qual a rota deve passar.
Instruction

Uma descrição de uma manobra em um conjunto de direções.
Leg

Informações sobre uma seção de uma rota entre dois pontos de passagem. Mais informações sobre os campos contidos em uma etapa de rota:
ManeuverPointProperties

Especifica as instruções de condução e as propriedades adicionais para cada ponto de manobra na rota Leg.
ManeuverTypeEnum

O tipo de manobra descrito nesta coleção detalhada. O ManeuverType fornece informações para uma parte da manobra especificada pela instrução correspondente. Por exemplo, o maneuverType de uma instrução pode especificar TurnLeftThenTurnRight, enquanto os itens de detalhes associados podem fornecer detalhes sobre as manobras TurnLeft e TurnRight
MapsErrorDetail

O detalhe do erro.
MapsErrorResponse

Resposta de erro comum para AS APIs do Azure Mapas retornarem detalhes de erro para operações com falha.
MapsInnerError

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
MultiLineStringGeometry

Especifica o objeto GeoJSON MultiLineString Geometry. Para obter mais informações, consulte RFC 7946.
OptimizedWaypoint

Objeto de ponto de passagem otimizado.
Order

Sequência para visitar waypoints.
PointGeometry

O ponto de origem passado como um objeto de geometria GeoJSON válido, do qual o polígono de intervalo deve ser calculado. Consulte RFC 7946 para obter detalhes.

Note: a API ajustará o ponto de origem solicitado à rede rodoviária mais próxima e usará isso para cálculo de intervalo. Ele será retornado como um ponto center na resposta.
RouteDirectionOptimizeRouteEnum

Especifica o parâmetro a ser usado para otimizar a rota. Se não for definido, o padrão será "fastestWithoutTraffic", que retorna a rota para minimizar o tempo de viagem sem usar as informações de tráfego atuais.

Exemplo: "optimizeRoute":"shortest"
RouteDirectionsResponse

Esse objeto é retornado de uma chamada bem-sucedida.
RouteDirectionVehicleSpec

Especifica os atributos do veículo, como tamanho, peso, velocidade máxima, tipo de carga, etc. somente para roteamento de caminhão. Isso ajuda a evitar baixas liberações de ponte, restrições de estrada, curvas à direita difíceis para fornecer a rota otimizada do caminhão com base nas especificações do veículo.

ISNote: compatível apenas com o caminhão travelMode.
RouteOutputOptionEnum

Inclua as informações de rota desejadas da resposta. Por padrão, o itinerário é incluído na resposta.

Suporta vários valores, como "routeOutputOptions": ["routePath", "itinerary"]
RoutePathPoint

Refere-se ao índice de um ponto dentro de uma etapa específica de uma rota.
RoutePathProperties

Especifica as propriedades que descrevem o caminho da rota na resposta.
RoutePathRange

Refere-se ao intervalo coberto por uma etapa específica de uma rota ou caminho.
RoutePathTravelModeEnum

O modo de viagem para o caminho da rota na resposta.
SideOfStreetEnum

O lado da rua onde o destino é encontrado com base na direção de chegada. Esse campo se aplica somente ao último maneuverPoint.
Step

Uma etapa de rota contém instruções turno a turno. Uma etapa refere-se a um intervalo de uma rota entre dois maneuverPoint consecutivos.
TrafficCongestionEnum

O nível de congestionamento de tráfego ao longo da rota. Note: com suporte apenas para dirigir travelMode
TravelModeEnum

O modo de viagem para a rota solicitada. Se não for definido, o valor padrão será "dirigir" que retorna a rota otimizada para carros.

Note: para o caminhão travelMode, a rota de caminhão solicitada pode não estar disponível para toda a rota. Quando a rota do caminhão não estiver disponível para uma seção específica, o elemento travelMode da resposta dessa seção será "outro".

Exemplo: "travelMode":"driving"
VehicleLoadTypeEnum

Tipos de carga que podem ser classificadas como materiais perigosos e restritas de algumas estradas. Os valores de vehicleLoadType disponíveis são as classes Hazmat dos EUA de 1 a 9, além de classificações genéricas para uso em outros países. Os valores que começam com USHazmat são para roteamento dos EUA, enquanto outrosHazmat devem ser usados para todos os outros países. vehicleLoadType dá suporte a vários valores em uma solicitação.
WaypointProperties

Especifica as propriedades de um ponto de passagem que é um local ou ponto específico ao longo de uma rota ou viagem que serve como referência ou ponto de parada.

Address

Objeto

O distrito administrativo e a região do país para os pontos de passagem e pontos de manobra na rota.

Nome Tipo Description
adminDistricts

AdminDistrict[]

O nome da subdivisão no país ou região para um endereço. Esse elemento normalmente é tratado como a subdivisão administrativa de primeira ordem, mas em alguns casos também contém a subdivisão de segunda, terceira ou quarta ordem em um país, dependência ou região.
countryRegion

CountryRegion

Representa um país ou região, contendo detalhes relacionados.

AdminDistrict

Objeto

O nome da subdivisão no país ou região para um endereço. Esse elemento normalmente é tratado como a subdivisão administrativa de primeira ordem, mas em alguns casos também contém a subdivisão de segunda, terceira ou quarta ordem em um país, dependência ou região.

Nome Tipo Description
shortName

string

O nome curto do campo adminDistrict correspondente, For adminDistrict[0], pode ser um nome curto de estado, como WA. Isso só está disponível para os EUA, Canadá e México.

AdrTunnelRestrictionCodeEnum

Enumeração

O código de restrição do túnel ADR. A ADR é um acordo europeu relativo ao transporte internacional de mercadorias perigosas por estrada. O código de restrição do túnel ADR é usado para determinar se um veículo tem permissão para passar por um túnel com restrições no transporte de mercadorias perigosas.

Valor Description
B

Os veículos com código B são restritos de estradas com as categorias de túnel ADR B, C, D e E.
C

Os veículos com código C são restritos de estradas com as categorias de túnel ADR C, D e E
D

Os veículos com código D são restritos de estradas com as categorias de túnel ADR D e E.
E

Os veículos com código E são restritos de estradas com a categoria de túnel ADR E.

AvoidEnum

Enumeração

Especifica as restrições que o cálculo de rota deve respeitar ao determinar a rota. Evite dar suporte a vários valores em uma solicitação e só tem suporte para a condução e o caminhão travelMode.

Exemplo: "evite": ["limitedAccessHighways", "tollRoads"]

Valor Description
limitedAccessHighways

Evita o uso de rodovias de acesso limitado na rota.
tollRoads

Evita o uso de estradas pedagiadas na rota.
ferries

Evita o uso de balsas na rota.
tunnels

Evita o uso de túneis na rota.
borderCrossings

Evita cruzar fronteiras do país na rota.
lowEmissionZones

Evita zonas de baixa emissão na rota.
unpavedRoads

Evita estradas não pavimentadas na rota.

CountryRegion

Objeto

Representa um país ou região, contendo detalhes relacionados.

Nome Tipo Description
ISO

string

ISO do país/região representa um código de região/país ISO 3166-1 Alpha-2
name

string

nome do país/região

DirectionsRequest

Objeto

Esse objeto é o corpo da solicitação.

Nome Tipo Valor padrão Description
arriveAt

string (date-time)

A data e a hora da chegada no ponto de destino formatado como um valor dateTime definido por RFC 3339, seção 5.6. Quando um deslocamento de fuso horário não for especificado, o UTC será assumido.

O parâmetro arriveAt não pode ser usado em conjunto com departAt.

Exemplo: "arriveAt": "2023-06-01T09:30:00.000-07:00"
avoid

AvoidEnum[]

Especifica as restrições que o cálculo de rota deve respeitar ao determinar a rota. Evite dar suporte a vários valores em uma solicitação e só tem suporte para a condução e o caminhão travelMode.

Exemplo: "evite": ["limitedAccessHighways", "tollRoads"]
departAt

string (date-time)

A data e hora da partida do ponto de origem formatada como um valor dateTime definido por RFC 3339, seção 5.6. Quando um deslocamento de fuso horário não for especificado, o UTC será assumido.

Se o departAt não estiver definido, o valor padrão será a hora atual.

Example:

"departAt": "2023-06-01T09:30:00.000-07:00"
features

InputWaypointFeaturesItem[]

As rotas de carro, caminhada e caminhão são definidas por um conjunto de waypoints (paradas) e viaWaypoints (locais intermediários pelos quais a rota deve passar). Você pode ter no máximo 150 waypoints e no máximo 10 viaWaypoints entre cada conjunto de waypoints.

Uma rota deve ter um mínimo de dois pontos de passagem e os pontos de início e de término da rota não podem ser viaWaypoints.

Os locais de waypoint e viaWaypoint devem ser especificados como um objeto de recurso válido do Ponto GeoJSON, juntamente com pointIndex que especifica a ordem dos locais. Para obter mais informações sobre o formato GeoJSON, consulte RFC 7946.
heading

integer (int64)

minimum: 0
maximum: 359

O título direcional inicial do veículo em graus começando no verdadeiro Norte e continuando na direção horário. Norte é 0 graus, leste é 90 graus, sul é 180 graus, oeste é 270 graus.
maxRouteCount

integer (int64)

minimum: 1
maximum: 6

O número máximo de rotas a serem retornadas. Disponível para os modos de viagem de caminhão e de condução.

Padrão: "maxRouteCount":1
optimizeRoute

RouteDirectionOptimizeRouteEnum

fastestWithoutTraffic

Especifica o parâmetro a ser usado para otimizar a rota. Se não for definido, o padrão será "fastestWithoutTraffic", que retorna a rota para minimizar o tempo de viagem sem usar as informações de tráfego atuais.

Exemplo: "optimizeRoute":"shortest"
optimizeWaypointOrder

boolean

False

Solicite novamente os pontos de passagem de rota usando um algoritmo heurístico rápido para reduzir o custo de rota especificado com o parâmetro de otimização. A origem e o destino são excluídos do ponto de passagem otimizado e sua posição é considerada fixa. Valores aceitáveis são verdadeiros ou falsos.
routeOutputOptions

RouteOutputOptionEnum[]

[ "itinerary" ]

Inclua as informações de rota desejadas da resposta. Por padrão, o itinerário é incluído na resposta.

Suporta vários valores, como "routeOutputOptions": ["routePath", "itinerary"]
travelMode

TravelModeEnum

driving

O modo de viagem para a rota solicitada. Se não for definido, o valor padrão será "dirigir" que retorna a rota otimizada para carros.

Note: para o caminhão travelMode, a rota de caminhão solicitada pode não estar disponível para toda a rota. Quando a rota do caminhão não estiver disponível para uma seção específica, o elemento travelMode da resposta dessa seção será "outro".

Exemplo: "travelMode":"driving"
type

FeatureTypeEnum

Especifica o tipo de GeoJSON. O único tipo de objeto com suporte é FeatureCollection. Para obter mais informações, consulte RFC 7946.
vehicleSpec

RouteDirectionVehicleSpec

Especifica os atributos do veículo, como tamanho, peso, velocidade máxima, tipo de carga, etc. somente para roteamento de caminhão. Isso ajuda a evitar baixas liberações de ponte, restrições de estrada, curvas à direita difíceis para fornecer a rota otimizada do caminhão com base nas especificações do veículo.

Note: com suporte apenas para o caminhão travelMode

DrivingSideEnum

Enumeração

Indica a direção esquerda versus direita no ponto da manobra.

Valor Description
Left

Direção do lado esquerdo.
Right

Direção do lado direito.

FeatureCollection

Objeto

GeoJSON FeatureCollection objeto que contém uma lista de Recursos. Para obter mais informações, consulte RFC 7946, seção 3.3.

Nome Tipo Description
features

FeaturesItem[]

GeoJSON objeto de recurso que contém o objeto Geometry e propriedades adicionais. Para obter mais informações, consulte RFC 7946, Seção 3.2.
type

FeatureTypeEnum

Especifica o tipo de GeoJSON. O único tipo de objeto com suporte é FeatureCollection. Para obter mais informações, consulte RFC 7946.

FeaturesItem

Objeto

Objeto de recurso GeoJSON que contém o objeto Geometry e propriedades adicionais da rota.

Nome Tipo Description
bbox

number[] (double)

Uma área retangular na Terra definida como um objeto de caixa delimitadora. Os lados dos retângulos são definidos por valores de latitude e longitude. Para obter mais informações, consulte RFC 7946, Seção 5.

Exemplo: "bbox": [-10.0, -10.0, 10.0, 10.0]
geometry RouteDirectionsGeometry:

Um objeto GeoJSON Geometry válido. Para obter mais informações, consulte RFC 7946.
properties FeatureProperties:

Especifica as propriedades de recurso da rota, como itinerário, rota Pernas e geometria, resumo da viagem.
type

FeaturesItemTypeEnum

Especifica o tipo de GeoJSON. O único tipo de objeto com suporte é o Recurso. Para obter mais informações, consulte RFC 7946.

FeaturesItemTypeEnum

Enumeração

Especifica o tipo de GeoJSON. O único tipo de objeto com suporte é o Recurso. Para obter mais informações, consulte RFC 7946.

Valor Description
Feature

Especifica o tipo de objeto GeoJSON Feature.

FeatureTypeEnum

Enumeração

Especifica o tipo de GeoJSON. O único tipo de objeto com suporte é FeatureCollection. Para obter mais informações, consulte RFC 7946.

Valor Description
FeatureCollection

Especifica o tipo de objeto GeoJSONFeatureCollection.

GeoJsonPoint

Objeto

Um tipo de geometria de GeoJSON Point válido. Consulte RFC 7946 para obter detalhes.

Nome Tipo Description
coordinates

number[] (double)

Um Position é uma matriz de números com dois ou mais elementos. Os dois primeiros elementos são de longitude e de latitude, precisamente nessa ordem. altitude/elevação é um terceiro elemento opcional. Consulte RFC 7946 para obter detalhes.
type string:

Point

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

InputWaypointFeaturesItem

Objeto

Especifica o ponto de entrada e o viaWaypoint GeoJSON objeto de recurso e propriedades adicionais. Para obter mais informações, consulte RFC 7946.

Nome Tipo Description
geometry GeoJsonPoint:

PointGeometry

Um tipo de geometria de GeoJSON Point válido. Consulte RFC 7946 para obter detalhes.
properties

InputWaypointProperties

Especifica as propriedades de um ponto de passagem que é um local ou ponto específico ao longo de uma rota ou viagem que serve como referência ou ponto de parada.
type

FeaturesItemTypeEnum

Especifica o tipo de GeoJSON. O único tipo de objeto com suporte é o Recurso. Para obter mais informações, consulte RFC 7946.

InputWaypointProperties

Objeto

Especifica as propriedades de um ponto de passagem que é um local ou ponto específico ao longo de uma rota ou viagem que serve como referência ou ponto de parada.

Nome Tipo Valor padrão Description
pointIndex

integer (int64)

Identifique e ordene a sequência de pontos de passagem na rota. O valor padrão é o index value de uma matriz de recursos.
pointType

InputWaypointTypeEnum

waypoint

Tipo de ponto de passagem na rota. Pode ser uma parada ou um local intermediário pelo qual a rota deve passar.

InputWaypointTypeEnum

Enumeração

Tipo de ponto de passagem na rota. Pode ser uma parada ou um local intermediário pelo qual a rota deve passar.

Valor Description
waypoint

Um ponto de passagem é um local ou ponto específico ao longo de uma rota ou viagem que serve como referência ou ponto de parada.
viaWaypoint

Um viaWaypoint é um ponto de passagem específico que deve ser passado ou visitado ao longo de uma rota ou viagem.

Instruction

Objeto

Uma descrição de uma manobra em um conjunto de direções.

Nome Tipo Description
drivingSide

DrivingSideEnum

Indica a direção esquerda versus direita no ponto da manobra.
formattedText

string

A descrição de texto formatada da instrução.
maneuverType

ManeuverTypeEnum

O tipo de manobra descrito nesta coleção detalhada. O ManeuverType fornece informações para uma parte da manobra especificada pela instrução correspondente. Por exemplo, o maneuverType de uma instrução pode especificar TurnLeftThenTurnRight, enquanto os itens de detalhes associados podem fornecer detalhes sobre as manobras TurnLeft e TurnRight
text

string

A descrição de texto sem formatação da instrução.

Leg

Objeto

Informações sobre uma seção de uma rota entre dois pontos de passagem. Mais informações sobre os campos contidos em uma etapa de rota:

Nome Tipo Description
arrivalAt

string (date-time)

A hora de chegada estimada para a perna, que leva em conta as condições de tráfego, é formatada como um valor dateTime definido por RFC 3339, seção 5.6. Ele fará referência ao deslocamento de fuso horário departAt ou arrivalAt. Caso contrário, a hora UTC será usada.
departureAt

string (date-time)

A hora de partida estimada para a perna, que leva em conta as condições de tráfego, é formatada como um valor dateTime definido por RFC 3339, seção 5.6. Ele fará referência ao deslocamento de fuso horário departAt ou arrivalAt. Caso contrário, a hora UTC será usada.
distanceInMeters

number

A distância física em metros cobertos por uma perna de rota.
durationInSeconds

integer (int64)

Tempo estimado de viagem em segundos que não inclui atrasos na rota devido às condições de tráfego.
durationTrafficInSeconds

integer (int64)

O tempo que leva, em segundos, para percorrer um TravelDistance correspondente com as condições de tráfego atuais. Esse valor será fornecido se optimizeRoute incluir considerações de tráfego.
routePathRange

RoutePathRange

Refere-se ao intervalo coberto por uma etapa específica de uma rota ou caminho.

ManeuverPointProperties

Objeto

Especifica as instruções de condução e as propriedades adicionais para cada ponto de manobra na rota Leg.

Nome Tipo Valor padrão Description
address

Address

O distrito administrativo e a região do país para os pontos de passagem e pontos de manobra na rota.
distanceInMeters

number

A distância física em medidores cobertos por esta etapa de rota.
durationInSeconds

integer (int64)

O tempo que leva, em segundos, para percorrer um TravelDistancecorrespondente .
exitIdentifier

string

O nome ou o número da saída associada a esta etapa de rota.
instruction

Instruction

Uma descrição de uma manobra em um conjunto de direções.
order

Order

Sequência para visitar waypoints.
routePathPoint

RoutePathPoint

Refere-se ao índice de um ponto dentro de uma etapa específica de uma rota.
sideOfStreet

SideOfStreetEnum

O lado da rua onde o destino é encontrado com base na direção de chegada. Esse campo se aplica somente ao último maneuverPoint.
signs

string[]

Texto de sinalização para a rota. Pode haver mais de um valor de sinal.
steps

Step[]

Etapas entre dois pontos de manobra consecutivos.
towardsRoadName

string

O nome da rua para a qual a rota vai na primeira ManeuverPoint.
travelMode

RoutePathTravelModeEnum

driving

O modo de viagem para o caminho da rota na resposta.
type string:

ManeuverPoint

Tipo de saída.

ManeuverTypeEnum

Enumeração

O tipo de manobra descrito nesta coleção detalhada. O ManeuverType fornece informações para uma parte da manobra especificada pela instrução correspondente. Por exemplo, o maneuverType de uma instrução pode especificar TurnLeftThenTurnRight, enquanto os itens de detalhes associados podem fornecer detalhes sobre as manobras TurnLeft e TurnRight

Valor Description
ArriveFinish

Chegue ao destino final.
ArriveIntermediate

Chegue a um ponto de passagem intermediário.
BearLeft

Vire à esquerda.
BearLeftThenBearLeft

Urso esquerda e, em seguida, urso esquerda novamente.
BearLeftThenBearRight

Urso para a esquerda e, em seguida, urso para a direita.
BearLeftThenTurnLeft

Urso à esquerda e depois vire para a esquerda.
BearLeftThenTurnRight

Bear para a esquerda e depois vire para a direita.
BearRight

Vire à direita.
BearRightThenBearLeft

Urso para a direita e, em seguida, urso para a esquerda.
BearRightThenBearRight

Bear direita e, em seguida, urso direita novamente.
BearRightThenTurnLeft

Fique com a direita e vire para a esquerda.
BearRightThenTurnRight

Fique com a direita e vire para a direita.
BearThenKeep

Instrução bear e, em seguida, uma instrução keep
BearThenMerge

Instrução bear e, em seguida, uma instrução de mesclagem.
Continue

Continue na estrada atual.
DepartIntermediateStop

Deixe um ponto de passagem intermediário em uma direção e estrada diferentes do que você chegou.
DepartIntermediateStopReturning

Deixe um ponto de passagem intermediário na mesma direção e na mesma estrada em que você chegou.
DepartStart

Deixe o ponto de partida.
EnterRoundabout

Insira uma rotatória.
ExitRoundabout

Saia de uma rotatória.
EnterThenExitRoundabout

Insira e saia de uma rotatória.
ExitRoundaboutRight

Na rotatória, pegue a saída à direita.
ExitRoundaboutLeft

Na rotatória, pegue a saída à esquerda.
Follow

Follow.
GoAroundRoundabout

Vá ao redor da rotatória.
KeepLeft

Mantenha-se à esquerda em uma estrada diferente.
KeepOnRampLeft

Mantenha a esquerda e continue na rampa.
KeepOnRampRight

Mantenha a direita e continue na rampa.
KeepOnRampStraight

Mantenha-se em linha reta e continue na rampa.
KeepRight

Mantenha-se em uma estrada diferente.
KeepStraight

Mantenha-se em uma estrada diferente.
KeepToStayLeft

Mantenha a esquerda para ficar na mesma estrada.
KeepToStayRight

Mantenha a direita para ficar na mesma estrada.
KeepToStayStraight

Mantenha-se em linha reta para ficar na mesma estrada.
MergeFreeway

Mesclar em uma auto-estrada.
MergeHighway

Mesclar em uma rodovia.
MergeMotorway

Mesclar em uma auto-estrada.
MotorwayExitLeft

Pegue a saída à esquerda.
MotorwayExitRight

Pegue a saída para a direita.
None

Nenhuma instrução.
RampThenHighwayLeft

Pegue a rampa esquerda para a rodovia. Isso faz parte de uma instrução combinada.
RampThenHighwayRight

Pegue a rampa direita para a rodovia. Isso faz parte de uma instrução combinada.
RampThenHighwayStraight

Fique em linha reta para pegar rampa na rodovia. Isso faz parte de uma instrução combinada.
RoadNameChange

Alterações no nome da estrada.
SwitchToParallelRoad

Alterne para a estrada paralela.
SwitchToMainRoad

Alterne para a estrada principal.
Take

Pegue a estrada. Esta instrução é usada quando você está entrando ou saindo de uma balsa.
TakeFerry

Pegue a balsa.
TakeExit

Pegue a saída.
TakeRamp

Pegue a rampa.
TakeRampLeft

Pegue a rampa para a esquerda.
TakeRampRight

Pegue a rampa para a direita.
TakeRampStraight

Fique em linha reta para pegar rampa.
TurnBack

Volte bruscamente.
TurnLeft

Vire à esquerda.
TurnLeftSharp

Faça uma curva afiada para a esquerda.
TurnLeftThenBearLeft

Vire para a esquerda e, em seguida, a esquerda do urso.
TurnLeftThenBearRight

Vire para a esquerda e, em seguida, fique à direita.
TurnLeftThenTurnLeft

Vire para a esquerda e vire para a esquerda novamente.
TurnLeftThenTurnRight

Vire para a esquerda e vire para a direita.
TurnRight

Vire à direita.
TurnRightSharp

Dê uma curva afiada à direita.
TurnRightThenBearLeft

Vire para a direita e, em seguida, a esquerda.
TurnRightThenBearRight

Vire para a direita e, em seguida, fique à direita.
TurnRightThenTurnLeft

Vire para a direita e vire para a esquerda.
TurnRightThenTurnRight

Vire à direita e vire para a direita novamente
TurnThenMerge

Vire a instrução seguida de uma instrução de mesclagem.
TurnToStayLeft

Vire para a esquerda para ficar na mesma estrada.
TurnToStayRight

Vire à direita para ficar na mesma estrada.
Unknown

A instrução é desconhecida.
UTurn

Faça uma curva para ir na direção oposta.
Wait

Wait
Walk

Walk

MapsErrorDetail

Objeto

O detalhe do erro.

Nome Tipo Description
code

string

Um de um conjunto definido pelo servidor de códigos de erro.
details

MapsErrorDetail[]

Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror

MapsInnerError

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message

string

Uma representação legível pelo ser humano do erro.
target

string

O destino do erro.

MapsErrorResponse

Objeto

Resposta de erro comum para AS APIs do Azure Mapas retornarem detalhes de erro para operações com falha.

Nome Tipo Description
error

MapsErrorDetail

O detalhe do erro.

MapsInnerError

Objeto

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.

Nome Tipo Description
code

string

O código de erro.
innererror

MapsInnerError

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.

MultiLineStringGeometry

Objeto

Especifica o objeto GeoJSON MultiLineString Geometry. Para obter mais informações, consulte RFC 7946.

Nome Tipo Description
coordinates

number[] (double)

Coordenadas para a geometria GeoJson MultiLineString.
type string:

MultiLineString

Especifica o tipo de geometria para o objeto GeoJSON Geometry. Para obter mais informações, consulte RFC 7946.

OptimizedWaypoint

Objeto

Objeto de ponto de passagem otimizado.

Nome Tipo Description
inputIndex

integer (int64)

Índice de ponto de passagem fornecido pelo usuário.
optimizedIndex

integer (int64)

Índice de ponto de passagem otimizado do sistema.

Order

Objeto

Sequência para visitar waypoints.

Nome Tipo Description
inputIndex

integer (int64)

Índice fornecido pelo usuário para waypoint
optimizedIndex

integer (int64)

Ponto de passagem otimizado pelo sistema

PointGeometry

Objeto

O ponto de origem passado como um objeto de geometria GeoJSON válido, do qual o polígono de intervalo deve ser calculado. Consulte RFC 7946 para obter detalhes.

Note: a API ajustará o ponto de origem solicitado à rede rodoviária mais próxima e usará isso para cálculo de intervalo. Ele será retornado como um ponto center na resposta.

Nome Tipo Description
coordinates

number[] (double)

Um Position é uma matriz de números com dois ou mais elementos. Os dois primeiros elementos são de longitude e de latitude, precisamente nessa ordem. altitude/elevação é um terceiro elemento opcional. Consulte RFC 7946 para obter detalhes.
type string:

Point

Especifica o tipo de geometria para o objeto GeoJSON Geometry. Para obter mais informações, consulte RFC 7946.

RouteDirectionOptimizeRouteEnum

Enumeração

Especifica o parâmetro a ser usado para otimizar a rota. Se não for definido, o padrão será "fastestWithoutTraffic", que retorna a rota para minimizar o tempo de viagem sem usar as informações de tráfego atuais.

Exemplo: "optimizeRoute":"shortest"

Valor Description
short

A rota é calculada para equilibrar o tempo de viagem rápida e a curta distância, em vez de priorizar apenas uma. É otimizado para velocidade e eficiência. As informações de tráfego não são usadas.
shortest

A rota é calculada para minimizar a distância. As informações de tráfego não são usadas.
fastestWithoutTraffic

Localiza a rota mais rápida, sem considerar as informações de tráfego.
fastestWithTraffic

A rota é calculada para minimizar o tempo usando as informações de tráfego atuais. Note: com suporte apenas para a condução e o caminhão travelMode.

RouteDirectionsResponse

Objeto

Esse objeto é retornado de uma chamada bem-sucedida.

Nome Tipo Description
alternativeRoutes

FeatureCollection[]

Rota alternativa.
features

FeaturesItem[]

GeoJSON objeto de recurso que contém o objeto Geometry e propriedades adicionais. Para obter mais informações, consulte RFC 7946, Seção 3.2.
type

FeatureTypeEnum

Especifica o tipo de GeoJSON. O único tipo de objeto com suporte é FeatureCollection. Para obter mais informações, consulte RFC 7946.

RouteDirectionVehicleSpec

Objeto

Especifica os atributos do veículo, como tamanho, peso, velocidade máxima, tipo de carga, etc. somente para roteamento de caminhão. Isso ajuda a evitar baixas liberações de ponte, restrições de estrada, curvas à direita difíceis para fornecer a rota otimizada do caminhão com base nas especificações do veículo.

ISNote: compatível apenas com o caminhão travelMode.

Nome Tipo Valor padrão Description
adrTunnelRestrictionCode

AdrTunnelRestrictionCodeEnum

O código de restrição do túnel ADR. A ADR é um acordo europeu relativo ao transporte internacional de mercadorias perigosas por estrada. O código de restrição do túnel ADR é usado para determinar se um veículo tem permissão para passar por um túnel com restrições no transporte de mercadorias perigosas.
axleCount

integer (int64)

O número de eixos no veículo.
axleWeight

integer (int64)

minimum: 0
maximum: 1000000 		0

Peso por eixo do veículo em kg. Um valor de 0 significa que as restrições de peso por eixo não são consideradas.
height

number (double)

minimum: 0
maximum: 1000000 		0

Altura do veículo em metros. Um valor de 0 significa que as restrições de altura não são consideradas.
isVehicleCommercial

boolean

False

Se o veículo é usado para fins comerciais. Veículos comerciais podem não ter permissão para dirigir em algumas estradas.
length

number (double)

minimum: 0
maximum: 1000000 		0

Comprimento do veículo em metros. Um valor de 0 significa que as restrições de comprimento não são consideradas.
loadType

VehicleLoadTypeEnum[]

Tipos de carga que podem ser classificadas como materiais perigosos e restritas de algumas estradas. Os valores de vehicleLoadType disponíveis são as classes Hazmat dos EUA de 1 a 9, além de classificações genéricas para uso em outros países. Os valores que começam com USHazmat são para roteamento dos EUA, enquanto outrosHazmat devem ser usados para todos os outros países. vehicleLoadType dá suporte a vários valores em uma solicitação.
maxSpeed

integer (int64)

minimum: 0
maximum: 250 		0

Velocidade máxima do veículo em km/hora. A velocidade máxima no perfil do veículo é usada para verificar se um veículo é permitido em auto-estradas.

Um valor de 0 significa que um valor apropriado para o veículo será determinado e aplicado durante o planejamento da rota.

Um valor diferente de zero pode ser substituído durante o planejamento de rota. Por exemplo, o fluxo de tráfego atual é de 60 km/hora. Se a velocidade máxima do veículo for definida como 50 km/hora, o motor de roteamento considerará 60 km/hora, pois essa é a situação atual. Se a velocidade máxima do veículo for fornecida como 80 km/hora, mas o fluxo de tráfego atual for de 60 km/hora, o mecanismo de roteamento usará novamente 60 km/hora.
weight

integer (int64)

minimum: 0
maximum: 1000000 		0

Peso do veículo em quilogramas. Um valor de 0 significa que as restrições de peso não são consideradas.
width

number (double)

minimum: 0
maximum: 1000000 		0

Largura do veículo em metros. Um valor de 0 significa que as restrições de largura não são consideradas.

RouteOutputOptionEnum

Enumeração

Inclua as informações de rota desejadas da resposta. Por padrão, o itinerário é incluído na resposta.

Suporta vários valores, como "routeOutputOptions": ["routePath", "itinerary"]

Valor Description
routeSummary

Inclua apenas o tempo de viagem e a distância da rota e não forneça outras informações.
routePath

Inclua um GEOJSON MultiLineString 7946, seção 3.1.5 que descrevem o caminho da rota na resposta.
itinerary

Inclua instruções detalhadas na resposta. As instruções detalhadas são fornecidas como "ManeuverPoints" e contêm detalhes, como instruções turno a turno.

RoutePathPoint

Objeto

Refere-se ao índice de um ponto dentro de uma etapa específica de uma rota.

Nome Tipo Description
legIndex

integer (int64)

O índice leg de rota é um número sequencial atribuído a cada Etapa da rota para ajudar a identificar e distinguir entre diferentes segmentos da rota.
pointIndex

integer (int64)

Índice de um ponto dentro de uma perna específica.

RoutePathProperties

Objeto

Especifica as propriedades que descrevem o caminho da rota na resposta.

Nome Tipo Description
arrivalAt

string (date-time)

A hora de chegada estimada da perna, que leva em conta as condições de tráfego, é formatada como um valor dateTime definido por RFC 3339, seção 5.6. Ele fará referência ao deslocamento de fuso horário departAt ou arrivalAt. Caso contrário, a hora UTC será usada.
departureAt

string (date-time)

A hora de partida estimada para a perna, que leva em conta as condições de tráfego, é formatada como um valor dateTime definido por RFC 3339, seção 5.6. Ele fará referência ao deslocamento de fuso horário departAt ou arrivalAt. Caso contrário, a hora UTC será usada.
distanceInMeters

number

A distância física em metros cobertos por toda a rota.
durationInSeconds

integer (int64)

Tempo estimado de viagem em segundos que não inclui atrasos na rota devido às condições de tráfego.
durationTrafficInSeconds

integer (int64)

O tempo que leva, em segundos, para percorrer um TravelDistance correspondente com as condições de tráfego atuais. Esse valor será fornecido se optimizeRoute incluir considerações de tráfego.
legs

Leg[]

Uma matriz de pernas de rota. Verifique a descrição do objeto Leg de rota para obter mais informações.
optimizedWaypoints

OptimizedWaypoint[]

Sequência otimizada de pontos de passagem. Ele mostra o índice da sequência de pontos de passagem fornecida pelo usuário para as listas originais e otimizadas.
trafficCongestion

TrafficCongestionEnum

O nível de congestionamento de tráfego ao longo da rota. Note: com suporte apenas para dirigir travelMode
type string:

RoutePath

Tipo de saída.

RoutePathRange

Objeto

Refere-se ao intervalo coberto por uma etapa específica de uma rota ou caminho.

Nome Tipo Description
legIndex

integer (int64)

O índice leg de rota é um número sequencial atribuído a cada Etapa da rota para ajudar a identificar e distinguir entre diferentes segmentos da rota.
range

integer[] (int64)

Refere-se ao intervalo coberto por uma etapa específica de uma rota ou caminho.

RoutePathTravelModeEnum

Enumeração

O modo de viagem para o caminho da rota na resposta.

Valor Description
driving

Rotas otimizadas para carros.
truck

Rotas otimizadas para caminhões de grande tamanho com base na especificação do veículo.
walking

Rotas otimizadas para pedestres.
other

Route TravelMode é retornado como "outro" para o caminhão travelMode quando a rota do caminhão não está disponível para uma seção específica de uma rota.

SideOfStreetEnum

Enumeração

O lado da rua onde o destino é encontrado com base na direção de chegada. Esse campo se aplica somente ao último maneuverPoint.

Valor Description
Left

Left.
Right

Right.
Unknown

Unknown.

Step

Objeto

Uma etapa de rota contém instruções turno a turno. Uma etapa refere-se a um intervalo de uma rota entre dois maneuverPoint consecutivos.

Nome Tipo Description
maneuverType

ManeuverTypeEnum

O tipo de manobra descrito nesta coleção detalhada. O ManeuverType fornece informações para uma parte da manobra especificada pela instrução correspondente. Por exemplo, o maneuverType de uma instrução pode especificar TurnLeftThenTurnRight, enquanto os itens de detalhes associados podem fornecer detalhes sobre as manobras TurnLeft e TurnRight
names

string[]

Uma rua, rodovia ou cruzamento onde a manobra ocorre. Se a manobra for complexa, poderá haver mais de um campo de nome na coleção de detalhes. O campo de nome também pode não ter valor. Isso pode ocorrer se o nome não for conhecido ou se uma rua, rodovia ou cruzamento não tiver um nome.
routePathRange

RoutePathRange

Refere-se ao intervalo coberto por uma etapa específica de uma rota ou caminho.

TrafficCongestionEnum

Enumeração

O nível de congestionamento de tráfego ao longo da rota. Note: com suporte apenas para dirigir travelMode

Valor Description
Unknown

Unknown.
None

None.
Mild

Mild.
Medium

Medium.
Heavy

Heavy.

TravelModeEnum

Enumeração

O modo de viagem para a rota solicitada. Se não for definido, o valor padrão será "dirigir" que retorna a rota otimizada para carros.

Note: para o caminhão travelMode, a rota de caminhão solicitada pode não estar disponível para toda a rota. Quando a rota do caminhão não estiver disponível para uma seção específica, o elemento travelMode da resposta dessa seção será "outro".

Exemplo: "travelMode":"driving"

Valor Description
driving

As rotas retornadas são otimizadas para carros.
truck

As rotas retornadas são otimizadas para caminhões de grande tamanho com base na especificação do veículo.
walking

As rotas retornadas são otimizadas para pedestres, incluindo o uso de calçadas.

VehicleLoadTypeEnum

Enumeração

Tipos de carga que podem ser classificadas como materiais perigosos e restritas de algumas estradas. Os valores de vehicleLoadType disponíveis são as classes Hazmat dos EUA de 1 a 9, além de classificações genéricas para uso em outros países. Os valores que começam com USHazmat são para roteamento dos EUA, enquanto outrosHazmat devem ser usados para todos os outros países. vehicleLoadType dá suporte a vários valores em uma solicitação.

Valor Description
USHazmatClass1

Explosives
USHazmatClass2

Gás comprimido
USHazmatClass3

Líquidos inflamáveis
USHazmatClass4

Sólidos inflamáveis
USHazmatClass5

Oxidizers
USHazmatClass6

Poisons
USHazmatClass7

Radioactive
USHazmatClass8

Corrosives
USHazmatClass9

Miscellaneous
otherHazmatExplosive

Explosives
otherHazmatGeneral

Miscellaneous
otherHazmatHarmfulToWater

Prejudicial à água

WaypointProperties

Objeto

Especifica as propriedades de um ponto de passagem que é um local ou ponto específico ao longo de uma rota ou viagem que serve como referência ou ponto de parada.

Nome Tipo Valor padrão Description
address

Address

O distrito administrativo e a região do país para os pontos de passagem e pontos de manobra na rota.
distanceInMeters

number

A distância física em medidores cobertos por esta etapa de rota.
durationInSeconds

integer (int64)

O tempo que leva, em segundos, para percorrer um TravelDistancecorrespondente .
exitIdentifier

string

O nome ou o número da saída associada a esta etapa de rota.
instruction

Instruction

Uma descrição de uma manobra em um conjunto de direções.
order

Order

Sequência para visitar waypoints.
routePathPoint

RoutePathPoint

Refere-se ao índice de um ponto dentro de uma etapa específica de uma rota.
sideOfStreet

SideOfStreetEnum

O lado da rua onde o destino é encontrado com base na direção de chegada. Esse campo se aplica somente ao último maneuverPoint.
signs

string[]

Texto de sinalização para a rota. Pode haver mais de um valor de sinal.
steps

Step[]

Etapas entre dois pontos de manobra consecutivos.
towardsRoadName

string

O nome da rua para a qual a rota vai na primeira ManeuverPoint.
travelMode

RoutePathTravelModeEnum

driving

O modo de viagem para o caminho da rota na resposta.
type string:

Waypoint

Tipo de saída.