Analisar a resposta do trajeto

Quando a API Routes calcula um trajeto, ela usa os pontos de parada e os parâmetros de configuração que você fornece como entrada. Em seguida, a API retorna uma resposta que contém a rota padrão e uma ou mais rotas alternativas.

Sua resposta pode incluir diferentes tipos de rotas e outros dados, com base nos campos solicitados:

Para conferir a lista completa de opções de entrada, consulte Opções de rota disponíveis e o corpo da solicitação.

Usando a resposta, você pode fornecer aos clientes as informações necessárias para selecionar a rota adequada às necessidades deles.

Sobre máscaras de campo

Ao chamar um método para calcular uma rota, é 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

Sobre rotas, trechos e etapas

Antes de analisar a resposta retornada pela API Routes, você precisa entender os componentes que formam uma rota:

Sua resposta pode conter informações sobre cada um destes componentes do trajeto:

• Trajeto: toda a viagem do ponto de partida, passando por pontos intermediários, até o ponto de destino. Um trajeto consiste em um ou mais trechos.

• Trecho: o caminho de um ponto de referência em um trajeto para o próximo ponto de referência no trajeto. Cada trecho consiste em uma ou mais etapas discretas.

  Uma rota contém um trecho separado para o caminho de cada ponto de referência até o próximo. Por exemplo, se a rota tiver um único ponto de partida e um único ponto de destino, ela terá um único trecho. Para cada ponto de referência adicional que você adiciona à rota após a origem e o destino, chamado de ponto de referência intermediário, a API adiciona um trecho separado.

  A API não adiciona uma etapa para um waypoint intermediário de passagem. Por exemplo, um trajeto que contém um waypoint de origem, um waypoint intermediário de passagem e um waypoint de destino tem apenas um trecho da origem ao destino, passando pelo waypoint. Para mais informações sobre pontos de passagem, consulte Definir um ponto de passagem.

• Etapa: uma única instrução ao longo do trecho de uma rota. Uma etapa é a menor unidade de uma rota. Por exemplo, uma etapa pode indicar "Vire à esquerda na Rua Principal".

O que a resposta contém

O objeto JSON que representa a resposta da API contém as seguintes propriedades de nível superior:

• routes, uma matriz de elementos do tipo Route. A matriz routes contém um elemento para cada trajeto retornado pela API. A matriz pode conter no máximo cinco elementos: a rota padrão, a rota ecológica e até três rotas alternativas.

• geocodingResults, uma matriz de elementos do tipo GeocodingResults. Para cada local na solicitação (origem, destino ou ponto de referência intermediário) especificado como uma string de endereço ou um plus code, a API realiza uma pesquisa de ID de lugar. Cada elemento dessa matriz contém o ID do lugar correspondente a um local. Os locais na solicitação especificados como um ID de lugar ou como coordenadas de latitude/longitude não são incluídos. Se você especificou todos os locais usando IDs de lugar ou coordenadas de latitude e longitude, essa matriz não será fornecida.

• fallbackInfo, do tipo FallbackInfo. Se a API não conseguir calcular um trajeto com base em todas as propriedades de entrada, ela poderá usar outra forma de cálculo. Quando o modo de fallback é usado, esse campo contém informações detalhadas sobre a resposta de fallback. Caso contrário, esse campo não será definido.

A resposta tem o seguinte formato:

{
  // The routes array.
  "routes": [
    {
      object (Route)
    }
  ],
  // The place ID lookup results.
  "geocodingResults": [
    {
      object (GeocodedWaypoint)
    }
  ],
  // The fallback property.
  "fallbackInfo": {
    object (FallbackInfo)
  }
}

Decifrar a matriz de rotas

A resposta contém a matriz routes, em que cada elemento é do tipo Route. Cada elemento da matriz representa um trajeto inteiro da origem ao destino. A API sempre retorna pelo menos um trajeto, chamado de trajeto padrão.

Você pode pedir outras rotas. Se você solicitar um trajeto ecológico, a matriz poderá conter dois elementos: o trajeto padrão e o ecológico. Ou defina computeAlternativeRoutes como true na solicitação para adicionar até três rotas alternativas à resposta.

Cada rota na matriz é identificada com a propriedade de matriz routeLabels:

A matriz legs contém a definição de cada trecho do trajeto. As propriedades restantes, como distanceMeters, duration e polyline,, contêm informações sobre o trajeto como um todo:

{
  "routeLabels": [
    enum (RouteLabel)
  ],
  "legs": [
    {
      object (RouteLeg)
    }
  ],
  "distanceMeters": integer,
  "duration": string,
  "routeLabels": [string],
  "staticDuration": string,
  "polyline": {
    object (Polyline)
  },
  "description": string,
  "warnings": [
    string
  ],
  "viewport": {
    object (Viewport)
  },
  "travelAdvisory": {
    object (RouteTravelAdvisory)
  }
  "routeToken": string
}

Devido às condições de trânsito atuais e a outros fatores, a rota padrão e a rota ecológica podem ser iguais. Nesse caso, o array routeLabels contém os dois rótulos: DEFAULT_ROUTE e FUEL_EFFICIENT.

{
  "routes": [
    {
      "routeLabels": [
        "DEFAULT_ROUTE",
        "FUEL_EFFICIENT"
      ],
     …
    }
  ]
}

Entender a matriz "legs"

Cada route na resposta contém uma matriz legs, em que cada elemento da matriz legs é do tipo RouteLeg. Cada trecho na matriz define o caminho de um ponto de parada para o próximo ao longo do trajeto. Um trajeto sempre contém pelo menos um trecho.

A propriedade legs contém a definição de cada etapa ao longo do trecho na matriz steps. As propriedades restantes, como distanceMeters, duration e polyline, contêm informações sobre o trecho.

{
  "distanceMeters": integer,
  "duration": string,
  "staticDuration": string,
  "polyline": {
    object (Polyline)
  },
  "startLocation": {
    object (Location)
  },
  "endLocation": {
    object (Location)
  },
  "steps": [
    {
      object (RouteLegStep)
    }
  ],
  "travelAdvisory": {
    object (RouteLegTravelAdvisory)
  }
}

Entender a matriz de etapas

Cada trecho na resposta contém uma matriz steps, em que cada elemento da matriz steps é do tipo RouteLegStep. Uma etapa corresponde a uma única instrução ao longo do trecho. Um trecho sempre contém pelo menos uma etapa.

Cada elemento na matriz steps inclui a propriedade navigationInstruction, do tipo NavigationInstruction, que contém a instrução da etapa. Exemplo:

"navigationInstruction": {
  "maneuver": "TURN_LEFT",
  "instructions": "Turn left toward Frontage Rd"
}

O instructions pode conter mais informações sobre a etapa. Por exemplo:

"navigationInstruction": {
  "maneuver": "TURN_SLIGHT_LEFT",
  "instructions": "Slight left (signs for I-90 W/Worcester)nParts of this road may be closed at certain times or days"
}

As propriedades restantes na etapa descrevem informações sobre ela, como distanceMeters, duration e polyline:

{
  "distanceMeters": integer,
  "staticDuration": string,
  "polyline": {
    object (Polyline)
  },
  "startLocation": {
    object (Location)
  },
  "endLocation": {
    object (Location)
  },
  "navigationInstruction": {
    object (NavigationInstruction)
  }
}

Especificar o idioma das instruções da etapa

A API retorna informações de rota no idioma local, transliteradas para um script legível pelo usuário, se necessário, respeitando o idioma preferido. Todos os componentes de endereço são retornados no mesmo idioma.

• Use o parâmetro languageCode de uma solicitação para definir explicitamente o idioma da rota na lista de idiomas aceitos. O Google atualiza os idiomas compatíveis com frequência. Portanto, esta lista pode não estar completa.

• Se um nome não estiver disponível no idioma especificado, a API usará a correspondência mais próxima.

• O idioma especificado pode influenciar o conjunto de resultados que a API escolhe retornar e a ordem em que eles são retornados. O geocodificador interpreta abreviações de maneira diferente dependendo do idioma, como as abreviações de tipos de rua ou sinônimos que podem ser válidos em um idioma, mas não em outro. Por exemplo, utca e tér são sinônimos de rua em húngaro.

Entender a matriz "geocodingResults"

Para cada local na solicitação (origem, destino ou ponto de parada intermediário) especificado como uma string de endereço ou um plus code, a API tenta encontrar o local mais relevante com um ID de lugar correspondente. Cada elemento da matriz geocodingResults contém o campo placeID com o local como um ID do lugar e um campo type especificando o tipo de local, como street_address, premise ou airport.

A matriz geocodingResults contém três campos:

• origin: se foi especificado como uma string de endereço ou um Plus Code, o ID do lugar de origem. Caso contrário, esse campo será omitido da resposta.

• destination: se ele foi especificado como uma string de endereço ou um Plus Code, o ID do lugar de destino. Caso contrário, esse campo será omitido da resposta.

• intermediates: uma matriz que contém o ID do lugar de todos os pontos de referência intermediários especificados como uma string de endereço ou um Plus Code. Se você especificar um ponto de parada intermediário usando um ID de lugar ou coordenadas de latitude e longitude, ele será omitido da resposta. Use a propriedade intermediateWaypointRequestIndex na resposta para determinar qual ponto de referência intermediário na solicitação corresponde ao ID do lugar na resposta.

"geocodingResults": {
    "origin": {
        "geocoderStatus": {},
        "type": [
             enum (Type)
        ],
        "placeId": string
    },
    "destination": {
        "geocoderStatus": {},
        "type": [
            enum (Type)
        ],
        "placeId": string
    },
    "intermediates": [
        {
            "geocoderStatus": {},
            "intermediateWaypointRequestIndex": integer,
            "type": [
                enum (Type)
            ],
            "placeId": string
        },
        {
           "geocoderStatus": {},
           "intermediateWaypointRequestIndex": integer,
            "type": [
                enum (Type)
            ],
            "placeId": string
        }
    ]
}

Entender os valores de resposta localizados

Os valores de resposta localizados são um campo de resposta adicional que fornece texto localizado para valores de parâmetros retornados. O texto localizado é fornecido para duração, distância e sistema de unidades (métrico ou imperial) da viagem. Você solicita valores localizados usando uma máscara de campo e pode especificar o idioma e o sistema de unidades ou usar os valores inferidos pela API. Para mais detalhes, consulte LocalizedValues.

Por exemplo, se você especificar um código de idioma para alemão (de) e unidades imperiais, vai receber um valor de distanceMeters de 49889,7, mas também um texto localizado que fornece essa medição de distância em alemão e unidades imperiais, ou seja, "31 Meile".

Confira um exemplo do que você veria para valores localizados:

{ "localized_values":
  {
    "distance": { "text": "31,0 Meile/n" },
    "duration": { "text": 38 Minuten}.
    "static_duration": { "text": 36 Minuten}.
  }
}

Se você não especificar o idioma ou o sistema de unidades, a API vai inferir o idioma e as unidades da seguinte forma:

• O método ComputeRoutes infere as unidades de local e distância do ponto de referência de origem. Assim, para uma solicitação de rotas nos EUA, a API infere o idioma en-US e as unidades IMPERIAL.
• O método ComputeRouteMatrix usa por padrão o idioma "en-US" e unidades MÉTRICAS.