Visão geral da API Routes

A API Routes é um serviço que aceita uma solicitação HTTPS e retorna o trajeto ideal entre dois locais ou as distâncias e os tempos de viagem para uma matriz de trajetos entre diferentes locais de origem e destino.

Por que usar a API Routes

Com a API Routes, você recebe rotas e informações de viagem precisas usando detalhes do transporte, condições atualizadas de trânsito e das vias e preferências de trajeto:

  • Tipo e recursos dos diferentes meios de transporte

  • Para qual direção um veículo está indo

  • Lado da via para embarques e desembarques

  • Condições de trânsito e vias interditadas

  • Preocupações de segurança, como evitar áreas perigosas ou disponibilizar áreas de embarque seguras.

  • Equilibre latência, qualidade e custo de acordo com suas necessidades de trajeto com recursos opcionais, como pedágios e metadados das viagens, como tempo e distância e economia de combustível.

Também é possível determinar os trajetos mais eficientes para a programação de despacho, como:

  • a melhor forma de atribuir um conjunto de workers para selecionar uma série de pacotes.

  • Determinar o melhor warehouse de onde enviar pacotes para o destino final

O que você pode fazer com a API Routes?

Com a API Routes, você tem duas categorias principais de informações de trajeto:

  • Trajetos de um local para um ou vários destinos

  • Uma matriz de trajetos possíveis entre vários locais de partida e chegada.

Ver rotas para um ou vários destinos

Com o método Compute Routes da API Routes, você pode calcular entre locais:

  • Veja rotas para diferentes maneiras de viajar e para um ou vários destinos:

    • Modos de transporte, incluindo transporte público, condução, veículos de duas rodas, caminhada ou bicicleta.

    • Uma série de waypoints, que podem ser otimizados na ordem mais eficiente de viagem.

  • Várias maneiras de especificar origens, destinos e waypoints:

    • Strings de texto. Por exemplo: "Chicago, IL", "Darwin, NT, Austrália", "1800 Amphitheatre Parkway, Mountain View, CA 94043" ou "CWF6+FWX Mountain View, Califórnia"

    • IDs de lugares

    • Coordenadas de latitude e longitude, opcionalmente com a orientação do veículo

  • Ajuste suas opções de trajeto com base nas suas necessidades e metas:

  • Controle a latência e a qualidade solicitando apenas os dados necessários usando uma máscara de campo. Isso ajuda a evitar tempo de processamento desnecessário e taxas de faturamento de solicitações mais altas. Para mais detalhes, consulte Escolher quais informações retornar.

Gerar uma matriz de possíveis trajetos

O método Compute Route Matrix da API Routes fornece uma matriz de informações para rotas recomendadas entre vários pontos de partida e chegada, incluindo distância e horários de chegada estimados, para ajudar você a escolher as melhores origens e destinos com base nas necessidades da sua empresa. Você pode solicitar os seguintes tipos de dados de distância:

  • Distância de um meio de transporte selecionado

  • Distância em quilômetros ou milhas

  • Tempo estimado de viagem no trânsito

Com os dados de distância, é possível determinar a maneira mais eficiente de rotear passageiros, encomendas ou trabalhadores entre várias origens e destinos possíveis.

É possível transmitir elementos da resposta antes que toda a matriz seja calculada, reduzindo a latência de resposta.

Você pode especificar várias origens e destinos por solicitação do lado do servidor com o número de origens vezes o número de destinos, até 625.

Como a API Routes funciona

A API Routes tem dois métodos: ComputeRoutes e ComputeRouteMatrix.

ComputeRoutes

O método ComputeRoutes da API Routes aceita uma solicitação HTTP POST com um corpo de solicitação JSON que contenha os detalhes da solicitação. É obrigatório informar uma origem, um destino, um TravelMode e uma máscara de campo para especificar quais campos retornar.

Exemplo

curl -X POST -d '{
    "origin": {
      "address": "1800 Amphitheatre Parkway, Mountain View, CA 94043"
    },
    "destination": {
      "address": "Sloat Blvd &, Upper Great Hwy, San Francisco, CA 94132"
    },
  "travelMode": "DRIVE"
  }' \
  -H 'Content-Type: application/json' -H 'X-Goog-Api-Key: YOUR_API_KEY' \
  -H 'X-Goog-FieldMask: routes.duration,routes.distanceMeters' \
  'https://routes.googleapis.com/directions/v2:computeRoutes'

Em seguida, o serviço calcula a rota solicitada e retorna os campos solicitados.

ComputeRouteMatrix

O ComputeRouteMatrix da API Routes aceita uma solicitação HTTP POST com um corpo de solicitação JSON que contenha os detalhes da solicitação. São obrigatórios pelo menos uma origem, dois ou mais destinos, o TravelMode e uma máscara de campo para especificar quais campos retornar.

Exemplo

curl -X POST -d '{
  "origins": [
    {
      "waypoint": {
        "location": {
          "latLng": {
            "latitude": 37.420761,
            "longitude": -122.081356
          }
        }
      }
    },
    {
      "waypoint": {
        "location": {
          "latLng": {
            "latitude": 37.403184,
            "longitude": -122.097371
          }
        }
      }
    }
  ],
  "destinations": [
    {
      "waypoint": {
        "location": {
          "latLng": {
            "latitude": 37.420999,
            "longitude": -122.086894
          }
        }
      }
    },
    {
      "waypoint": {
        "location": {
          "latLng": {
            "latitude": 37.383047,
            "longitude": -122.044651
          }
        }
      }
    }
  ],
  "travelMode": "DRIVE"
}' \
-H 'Content-Type: application/json' -H 'X-Goog-Api-Key: YOUR_API_KEY' \
-H 'X-Goog-FieldMask: originIndex,destinationIndex,duration,distanceMeters,status,condition' \
'https://routes.googleapis.com/distanceMatrix/v2:computeRouteMatrix'

A resposta contém as rotas possíveis para a combinação de todos os waypoints de origem e destino.

Recursos

A tabela a seguir resume os recursos disponíveis pela API Routes e os dados retornados por ela.

Recursos de dados Dados retornados Formato de devolução
ComputeRoutes Retorna trajetos, trechos e etapas de um trajeto, com trajetos alternativos, se solicitado. JSON
ComputeRouteMatrix Retorna uma matriz de trajetos de um waypoint de origem para um waypoint de destino.

Como usar a API Routes

1 Configuração Comece com Configure seu projeto do Google Cloud e conclua as instruções de configuração a seguir.
2 Calcular uma rota e analisar a resposta Para mais informações, consulte Ver uma rota e Analisar as respostas da rota.
3 Calcular a matriz de rotas e analisar a resposta Para mais informações, consulte Ver uma matriz de rota e Analisar a resposta da matriz de rota.

Bibliotecas de clientes disponíveis

Para ver uma lista das bibliotecas de cliente disponíveis para a API Routes, consulte Bibliotecas de cliente.

A seguir