Faça sua primeira solicitação de otimização de rotas

Este documento mostra como fazer sua primeira solicitação à API Route Optimization usando um cenário de caso de uso real.

Para simplificar, o exemplo usa HTTP e JSON para demonstrar a API REST. No entanto, para o ambiente de produção, a recomendação geral é usar o gRPC devido aos benefícios de performance. No entanto, o gRPC requer alguma instalação. Para mais informações, consulte Bibliotecas de cliente da API Route Optimization.

Cenário

Você administra um serviço de creche para cachorros das 7h às 19h em São Francisco. Hoje de manhã, você precisa buscar dois cachorros em locais diferentes da cidade. Os dois donos de cachorros deram um período de busca entre 7h30 e 9h30.

Você tem uma van para o trabalho e paga ao motorista US$ 27 por hora. O motorista e a van começam o dia na creche às 7h e precisam voltar das buscas da manhã até as 12h para um intervalo de almoço.

Hoje é 13 de fevereiro de 2024, e o motorista tem as seguintes tarefas:

• Buscar o Bernese Mountain Dog perto da Coit Tower.
• Retirar o Chihuahua no South Sunset Playground Park.
• Deixar os dois cachorros na creche no Mission Dolores Park.

Você precisa de uma rota que minimize o tempo que os cachorros passam na van, atendendo aos requisitos de busca e entrega.

Antes de começar

Para executar o código neste cenário de exemplo, primeiro conclua as instruções em Configurar a API Route Optimization.

1. Escolha sua abordagem de otimização de rotas

A API Route Optimization tem vários métodos para você escolher, dependendo da complexidade do problema de otimização.

Como esse cenário de creche para cachorros é uma solicitação pequena e direta, use um método de bloqueio, como optimizeTours, que oferece resultados rápidos para solicitações pequenas. Para mais informações sobre os métodos da API Route Optimization, consulte Endpoints síncronos e assíncronos.

Use o URL a seguir para fazer uma solicitação HTTP POST para o optimizeTours método:

https://routeoptimization.googleapis.com/v1/projects/PROJECT_OR_ID:optimizeTours

Você também precisa definir as configurações de tempo limite e prazo para serem curtas para reduzir qualquer tempo de espera desnecessário. Para esse cenário de creche para cachorros, o otimizador não precisa de muito tempo para responder à sua solicitação. Portanto, use as seguintes configurações:

• Defina o timeout parâmetro como 2 segundos.
• Mantenha as configurações de prazo no padrão, que é de 60 segundos para solicitações REST.

2. Construir o corpo da mensagem de solicitação

Depois de escolher o método de bloqueio optimizeTours e definir as configurações de tempo limite e prazo, a próxima etapa é construir o corpo da mensagem de solicitação.

Para esse cenário, a solicitação é uma mensagem OptimizeToursRequest codificada como JSON na API REST.

Para construir a mensagem de solicitação, siga estas etapas:

1. Comece com a estrutura de solicitação básica, que é a seguinte:

   {
     "timeout": ...,
     "model": {
       "shipments": [...],
       "vehicles": [...],
       "globalStartTime": "...",
       "globalEndTime": "..."
     }
   }
   

   Para mais informações sobre a estrutura, consulte o guia de conceitos principais para estrutura básica (ShipmentModel, Shipment e Vehicle).

2. Defina os envios. No campo shipments, adicione uma mensagem Shipment para cada cachorro que precisa ser buscado e entregue pela manhã. É aqui que você define o local e os horários de retirada preferidos de cada dono de cachorro e o local e os horários da creche para deixar os cachorros.

   1. Para cada cachorro, crie um VisitRequest para buscas e outro para as entregas, que, para esse cenário, é chamado de entrega da creche.

      • Nas retiradas, defina o arrivalWaypoint como o local de retirada do cachorro (Coit Tower para o Bernese Mountain Dog ou South Sunset Playground Park para o Chihuahua) e o timeWindows para o horário de retirada solicitado pelo proprietário (7h30 às 9h30).

      • Nas entregas, defina o arrivalWaypoint como a creche e o timeWindows para o horário de entrega necessário (9h30 às 11h30).

      Para mais informações sobre janelas de tempo, consulte Janelas de tempo.

   2. Você pode usar o campo label para adicionar um identificador para cada envio, como "Bernese Mountain Dog" e "Chihuahua". Isso pode ajudar a identificar os envios na resposta.

   Para mais informações sobre como definir envios, consulte Envio.

3. Defina os veículos. No campo vehicles, adicione uma mensagem Vehicle para sua van com a creche como pontos de partida e de chegada, o custo do salário do motorista e as horas de operação da van.

   1. Defina o startWaypoint e o endWaypoint da van para os locais de início e término do dia, que é a creche perto do Mission Dolores Park.

   2. Para minimizar os custos de operação, você precisa definir as restrições de custo da sua empresa. Defina o parâmetro de custo costPerHour como 27, que é o valor que você paga ao motorista para dirigir a van da creche. Para mais informações sobre parâmetros de custo, consulte Modelo de custo.

   3. Para garantir que o otimizador crie um trajeto dentro das horas de operação da van, defina o startTimeWindows como o intervalo aceitável para o motorista começar a operar a van e o endTimeWindows como o intervalo aceitável para quando o motorista precisa retornar à creche. Para mais informações sobre janelas de tempo, consulte Janelas de tempo.

   Para mais informações sobre como definir veículos, consulte Veículo.

4. Defina uma janela de tempo global. A janela de tempo global representa o período em que a van pode fazer buscas e entregas para sua creche ao longo do dia. Para esse cenário, defina globalStartTime como 7h e globalEndTime como 19h para 13 de fevereiro de 2024, que representam as horas de operação da creche.

3. Enviar a solicitação

A seguir, apresentamos uma solicitação curl simples com base no cenário de creche para cachorros e que usa o método de bloqueio optimizeTours.

Antes de enviar a solicitação, substitua PROJECT_NUMBER_OR_ID no exemplo de código pelo seu ID do projeto do Google Cloud.

curl -X POST 'https://routeoptimization.googleapis.com/v1/projects/PROJECT_NUMBER_OR_ID:optimizeTours' \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
--data @- << EOM
{
  "timeout": "2s",
  "model": {
    "shipments": [
      {
        "pickups": [
          {
            "arrivalWaypoint": {
              "location": {
                "latLng": {
                  "latitude": 37.802395,
                  "longitude": -122.405822
                }
              }
            },
            "timeWindows": [
              {
                "startTime": "2024-02-13T07:30:00Z",
                "endTime": "2024-02-13T09:30:00Z"
              }
            ]
          }
        ],
        "deliveries": [
          {
            "arrivalWaypoint": {
              "location": {
                "latLng": {
                  "latitude": 37.760202,
                  "longitude": -122.426796
                }
              }
            },
            "timeWindows": [
              {
                "startTime": "2024-02-13T09:30:00Z",
                "endTime": "2024-02-13T11:30:00Z"
              }
            ]
          }
        ],
        "label": "Bernese mountain dog"
      },
      {
        "pickups": [
          {
            "arrivalWaypoint": {
              "location": {
                "latLng": {
                  "latitude": 37.738067,
                  "longitude": -122.498593
                }
              }
            },
            "timeWindows": [
              {
                "startTime": "2024-02-13T07:30:00Z",
                "endTime": "2024-02-13T09:30:00Z"
              }
            ]
          }
        ],
        "deliveries": [
          {
            "arrivalWaypoint": {
              "location": {
                "latLng": {
                  "latitude": 37.760202,
                  "longitude": -122.426796
                }
              }
            },
            "timeWindows": [
              {
                "startTime": "2024-02-13T09:30:00Z",
                "endTime": "2024-02-13T11:30:00Z"
              }
            ]
          }
        ],
        "label": "Chihuahua"
      }
    ],
    "vehicles": [
      {
        "startWaypoint": {
          "location": {
            "latLng": {
              "latitude": 37.760202,
              "longitude": -122.426796
            }
          }
        },
        "endWaypoint": {
          "location": {
            "latLng": {
              "latitude": 37.760202,
              "longitude": -122.426796
            }
          }
        },
        "costPerHour": 27,
        "startTimeWindows": [
          {
            "startTime": "2024-02-13T07:00:00Z",
            "endTime": "2024-02-13T07:15:00Z"
          }
        ],
        "endTimeWindows": [
          {
            "startTime": "2024-02-13T11:45:00Z",
            "endTime": "2024-02-13T12:00:00Z"
          }
        ]
      }
    ],
    "globalStartTime": "2024-02-13T07:00:00Z",
    "globalEndTime": "2024-02-13T19:00:00Z"
  }
}
EOM

Parâmetros de solicitação usados na solicitação

A tabela a seguir descreve os parâmetros de solicitação usados no corpo da solicitação do cenário de exemplo. Você pode filtrar o conteúdo por pai ou por pesquisa de texto.

Avançar

Interpretar a respostaarrow_forward