Analisar a resposta da matriz de rota

Uma solicitação de matriz de rotas usa como entrada uma matriz de pontos de referência de origem e destino. Em seguida, a API Routes calcula o trajeto de cada waypoint de origem para cada waypoint de destino. Por exemplo, se você especificar dois waypoints de origem e dois de destino, a API vai calcular quatro rotas separadas.

A resposta da API contém uma matriz, em que cada elemento corresponde à rota de um ponto de referência de origem para um ponto de referência de destino. Portanto, se você especificar dois waypoints de origem e dois de destino, a matriz de resposta vai conter quatro elementos, um para cada trajeto calculado.

Usando a resposta, você pode oferecer aos clientes diferentes opções de rotas e deixar que o usuário selecione a rota adequada para os requisitos dele.

Sobre máscaras de campo

Ao chamar um método para calcular um trajeto, é necessário especificar uma máscara de campo que defina quais campos você quer que sejam retornados na resposta. Não há uma lista padrão de campos retornados. Se você omitir essa lista, os métodos vão retornar um erro.

Os exemplos neste documento mostram o objeto de resposta inteiro sem considerar as máscaras de campo. Em um ambiente de produção, sua resposta incluiria apenas os campos especificados explicitamente na máscara de campo.

Para mais informações, consulte Escolher quais informações retornar.

Sobre a exibição de direitos autorais

Inclua a seguinte declaração de direitos autorais ao mostrar os resultados aos usuários:

Powered by Google, ©YEAR Google

Exemplo:

Powered by Google, ©2023 Google

Identifique a rota na resposta

Use as propriedades de resposta originIndex e destinationIndex para identificar cada rota na resposta. Essas propriedades contêm o índice baseado em zero dos pontos de parada de origem e destino usados para calcular o trajeto. Isso significa que o primeiro ponto de partida e o primeiro ponto de destino na solicitação estão no índice 0 da matriz.

Por exemplo, uma rota na resposta contém:

"originIndex": 1,
"destinationIndex": 0

Essas propriedades indicam que a rota foi calculada do ponto de referência de origem no índice 1 da matriz de entrada e do ponto de referência de destino no índice 0.

Para o próximo trajeto:

"originIndex": 4,
"destinationIndex": 1

O trajeto foi calculado com base no ponto de parada de origem no índice 4 da matriz de entrada e no ponto de parada de destino no índice 1 da matriz de entrada.

Sobre a resposta

O objeto JSON que representa a resposta da API contém uma matriz, em que cada elemento define a rota de um ponto de partida até um ponto de destino.

Além das propriedades originIndex e destinationIndex, cada trajeto 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)
    }
  }
  …
]