Uma solicitação de matriz de rota usa como entrada uma matriz de waypoints de origem e destino. A API Routes calcula o trajeto de cada waypoint de origem até cada waypoint de destino. Por exemplo, se você especificar dois waypoints de origem e dois de destino, a API calculará quatro trajetos separados.
A resposta da API contém uma matriz, em que cada elemento da matriz corresponde à rota de um waypoint de origem para um de destino. Portanto, se você especificar dois waypoints de origem e dois de destino, a matriz de resposta conterá quatro elementos, um para cada trajeto calculado.
Com ela, é possível oferecer aos clientes diferentes opções de trajeto e permitir que o usuário selecione a opção mais adequada às necessidades deles.
Sobre as máscaras de campo
Ao chamar um método para calcular uma rota, especifique uma máscara de campo que defina quais campos você quer retornar na resposta. Não há uma lista padrão de campos retornados. Se você omitir essa lista, os métodos retornarão um erro.
Os exemplos neste documento mostram todo o objeto de resposta sem considerar as máscaras de campo. Em um ambiente de produção, sua resposta incluiria apenas os campos que você especificar explicitamente na máscara de campo.
Para mais informações, consulte Escolher quais informações retornar.
Sobre a exibição de direitos autorais
Você deve incluir a seguinte declaração de direitos autorais ao exibir os resultados para seus usuários:
Powered by Google, ©YEAR Google
Exemplo:
Powered by Google, ©2023 Google
Identifique o trajeto na resposta
Use as propriedades de resposta originIndex e destinationIndex para identificar
cada trajeto na resposta. Essas propriedades contêm o índice baseado em zero dos waypoints origin e destination de entrada usados para calcular a rota. Isso significa que o primeiro waypoint de origem e o primeiro waypoint de destino na solicitação estão no índice de matriz 0.
Por exemplo, uma rota na resposta contém:
"originIndex": 1, "destinationIndex": 0
Essas propriedades indicam que o trajeto foi calculado a partir do waypoint de origem no índice 1 da matriz de entrada e do waypoint de destino no índice 0.
Para o próximo trajeto:
"originIndex": 4, "destinationIndex": 1
O trajeto foi calculado a partir do waypoint de origem no índice 4 na matriz de entrada e do waypoint de destino no índice 1 na matriz de entrada.
Sobre a resposta
O objeto JSON que representa a resposta da API contém uma matriz, em que cada elemento da matriz define o trajeto de um waypoint de origem para um de destino.
Com as propriedades originIndex e destinationIndex, cada rota contém informações específicas, como distanceMeters, duration e travelAdvisory.
A resposta tem o seguinte formato:
[
// One array element for each combination of origin and destination waypoints.
{
// The route for source waypoint 0 and destination waypoint 0.
"originIndex": 0,
"destinationIndex": 0,
"status": {
object (Status)
},
"condition": enum (RouteMatrixElementCondition),
"distanceMeters": integer,
"duration": string,
"staticDuration": string,
"travelAdvisory": {
object (RouteTravelAdvisory)
},
"fallbackInfo": {
object (FallbackInfo)
}
}
{
// The route for source waypoint 0 and destination waypoint 1.
"originIndex": 0,
"destinationIndex": 1,
"status": {
object (Status)
},
"condition": enum (RouteMatrixElementCondition),
"distanceMeters": integer,
"duration": string,
"staticDuration": string,
"travelAdvisory": {
object (RouteTravelAdvisory)
},
"fallbackInfo": {
object (FallbackInfo)
}
}
…
]