Para seguir este documento, é preciso ter familiaridade com os seguintes tópicos:
- Criar tarefas de remessa
- Introdução às Tarefas agendadas, que aborda a relação entre tarefas, paradas e veículos em detalhes.
Conforme descrito em Tarefas agendadas no Com o Fleet Engine Essentials, você cria tarefas e as associa a um veículo. para como uma forma de modelar a associação real entre a tarefa e o local em que se espera que o veículo pare para que o motorista possa concluir a tarefa.
A partir daí, você gerencia o progresso das tarefas ao longo do ciclo de vida delas envio de atualizações ao Fleet Engine para que ele possa realizar melhor as tarefas de roteamento e status atualizações ao longo da jornada das tarefas. Uma maneira importante de fazer isso é atualizar o veículo para quando ele se aproxima, chega e sai da parada. Isso permite a geração de relatórios e a análise sobre o progresso da tarefa para ambos Operadores de frota e usuários finais. Essas atualizações de status são as seguintes:
- A caminho: o tipo enumerado
STATE
paraVehicleStop
usaENROUTE
para indicar que a parada é a próxima na lista do itinerário do veículo. Do ponto de vista da tarefa, significa qualquer tarefa associada à parada é o próximo item da lista a ser concluído. - Chegada: o tipo enumerado
STATE
paraVehicleStop
usaARRIVED
para indicar que o veículo chegou na parada. Da perspectiva da tarefa, isso significa que qualquer tarefa associada à parada em que está sendo trabalhada ativamente. - Concluída: para marcar uma parada como concluída, ela deve ser removida da lista de paradas para o veículo. Ao fazer isso, o Fleet Engine marca automaticamente todas as tarefas associadas como CLOSED. Para mais detalhes sobre como encerrar tarefas, consulte Finalizar tarefas.
Este documento descreve como o status de interrupção da atualização usando abordagens do lado do servidor. Você também pode fazer isso a partir do seu aplicativo do motorista se você fornecer ao motorista a capacidade de gerenciar tarefas usando um dispositivo confiável. Use apenas um método para evitar disputas e manter uma única fonte de verdade.
O veículo está a caminho da parada
Seu sistema deve notificar o Fleet Engine quando o veículo iniciar o trajeto até o a próxima parada. Isso melhora o HEC e os cálculos de rotas.
Campos obrigatórios para atualizações de paradas
O Fleet Engine ignora todos os outros campos na entidade da notificação.
Campo | Valor |
---|---|
remainingVehicleJourneySegments
|
Lista de paradas de veículos restantes com os estados marcados como State.NEW. |
Exemplo de direção para parada
Os exemplos a seguir mostram como notificar o Fleet Engine de que um veículo está
direcionar para a próxima parada, usando a biblioteca Java gRPC ou um
Chamada REST para UpdateDeliveryVehicle
.Todas as outras paradas estão marcadas como novas.
gRPC
static final String PROJECT_ID = "my-delivery-co-gcp-project";
static final String VEHICLE_ID = "vehicle-8241890";
DeliveryServiceBlockingStub deliveryService =
DeliveryServiceGrpc.newBlockingStub(channel);
// Vehicle settings
DeliveryVehicle deliveryVehicle = DeliveryVehicle.newBuilder()
// Next stop marked as ENROUTE
.addRemainingVehicleJourneySegments(VehicleJourneySegment.newBuilder() // 1st stop
.setStop(VehicleStop.newBuilder()
.setPlannedLocation(LocationInfo.newBuilder()
.setPoint(LatLng.newBuilder()
.setLatitude(37.7749)
.setLongitude(122.4194)))
.addTasks(TaskInfo.newBuilder().setTaskId(TASK1_ID))
.setState(VehicleStop.State.ENROUTE)))
// All other stops marked as NEW
.addRemainingVehicleJourneySegments(VehicleJourneySegment.newBuilder() // 2nd stop
.setStop(VehicleStop.newBuilder()
.setPlannedLocation(LocationInfo.newBuilder()
.setPoint(LatLng.newBuilder()
.setLatitude(37.3382)
.setLongitude(121.8863)))
.addTasks(TaskInfo.newBuilder().setTaskId(TASK2_ID))
.setState(VehicleStop.State.NEW)))
.build();
// DeliveryVehicle request
UpdateDeliveryVehicleRequest updateDeliveryVehicleRequest =
UpdateDeliveryVehicleRequest.newBuilder() // No need for the header
.setName(vehicleName)
.setDeliveryVehicle(deliveryVehicle)
.setUpdateMask(FieldMask.newBuilder().addPaths("remaining_vehicle_journey_segments"))
.build();
try {
DeliveryVehicle updatedDeliveryVehicle =
deliveryService.updateDeliveryVehicle(updateDeliveryVehicleRequest);
} catch (StatusRuntimeException e) {
Status s = e.getStatus();
switch (s.getCode()) {
case NOT_FOUND:
break;
case PERMISSION_DENIED:
break;
}
return;
}
REST
PATCH https://fleetengine.googleapis.com/v1/providers/<project_id>/deliveryVehicles/<id>?updateMask=remainingVehicleJourneySegments`
- <id> é um identificador exclusivo para a tarefa.
- O cabeçalho da solicitação precisa conter um campo Authorization com o valor. Bearer <token>, em que <token> é emitido pelo seu servidor de acordo com as diretrizes descritas nos Papéis da conta de serviço e Tokens JSON da Web.
- O corpo da solicitação precisa conter uma entidade
DeliveryVehicle
:
Comando curl
de exemplo:
# Set JWT, PROJECT_ID, VEHICLE_ID, TASK1_ID, and TASK2_ID in the local
# environment
curl -X PATCH "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/deliveryVehicles/${VEHICLE_ID}?updateMask=remainingVehicleJourneySegments" \
-H "Content-type: application/json" \
-H "Authorization: Bearer ${JWT}" \
--data-binary @- << EOM
{
"remainingVehicleJourneySegments": [
{
"stop": {
"state": "ENROUTE",
"plannedLocation": {
"point": {
"latitude": 37.7749,
"longitude": -122.084061
}
},
"tasks": [
{
"taskId": "${TASK1_ID}"
}
]
}
},
{
"stop": {
"state": "NEW",
"plannedLocation": {
"point": {
"latitude": 37.3382,
"longitude": 121.8863
}
},
"tasks": [
{
"taskId": "${TASK2_ID}"
}
]
}
}
]
}
EOM
O veículo chega na parada
O Fleet Engine precisa ser notificado quando um veículo chega a uma parada.
Campos obrigatórios para atualizações de paradas
O Fleet Engine ignora todos os outros campos na entidade da notificação.
Campo | Valor |
---|---|
remainingVehicleJourneySegments
|
Lista de paradas de veículos restantes com os estados marcados como State.NEW. |
Exemplo de chegada à parada
Os exemplos a seguir mostram como notificar o Fleet Engine de que um veículo chegou
na parada, usando a biblioteca Java gRPC ou uma chamada HTTP REST para
UpdateDeliveryVehicle
Todas as outras paradas estão marcadas como novas.
gRPC
static final String PROJECT_ID = "my-delivery-co-gcp-project";
static final String VEHICLE_ID = "vehicle-8241890";
DeliveryServiceBlockingStub deliveryService =
DeliveryServiceGrpc.newBlockingStub(channel);
// Vehicle settings
String vehicleName = "providers/" + PROJECT_ID + "/deliveryVehicles/" + VEHICLE_ID;
DeliveryVehicle deliveryVehicle = DeliveryVehicle.newBuilder()
// Marking the arrival at stop.
.addRemainingVehicleJourneySegments(VehicleJourneySegment.newBuilder()
.setStop(VehicleStop.newBuilder()
.setPlannedLocation(LocationInfo.newBuilder()
.setPoint(LatLng.newBuilder()
.setLatitude(37.7749)
.setLongitude(122.4194)))
.addTasks(TaskInfo.newBuilder().setTaskId(TASK1_ID))
.setState(VehicleStop.State.ARRIVED)))
// All other remaining stops marked as NEW.
.addRemainingVehicleJourneySegments(VehicleJourneySegment.newBuilder() // 2nd stop
.setStop(VehicleStop.newBuilder()
.setPlannedLocation(LocationInfo.newBuilder()
.setPoint(LatLng.newBuilder()
.setLatitude(37.3382)
.setLongitude(121.8863)))
.addTasks(TaskInfo.newBuilder().setTaskId(TASK2_ID))
.setState(VehicleStop.State.NEW))) // Remaining stops must be NEW.
.build();
// DeliveryVehicle request
UpdateDeliveryVehicleRequest updateDeliveryVehicleRequest =
UpdateDeliveryVehicleRequest.newBuilder() // No need for the header
.setName(vehicleName)
.setDeliveryVehicle(deliveryVehicle)
.setUpdateMask(FieldMask.newBuilder()
.addPaths("remaining_vehicle_journey_segments"))
.build();
try {
DeliveryVehicle updatedDeliveryVehicle =
deliveryService.updateDeliveryVehicle(updateDeliveryVehicleRequest);
} catch (StatusRuntimeException e) {
Status s = e.getStatus();
switch (s.getCode()) {
case NOT_FOUND:
break;
case PERMISSION_DENIED:
break;
}
return;
}
REST
`PATCH https://fleetengine.googleapis.com/v1/providers/<project_id>/deliveryVehicles/<id>?updateMask=remainingVehicleJourneySegments`
- <id> é um identificador exclusivo para a tarefa.
- O cabeçalho da solicitação precisa conter um campo Authorization com o valor. Bearer <token>, em que <token> é emitido pelo seu servidor de acordo com as diretrizes descritas nos Papéis da conta de serviço e Tokens JSON da Web.
- O corpo da solicitação precisa conter uma entidade
DeliveryVehicle
:
Comando curl
de exemplo:
# Set JWT, PROJECT_ID, VEHICLE_ID, TASK1_ID, and TASK2_ID in the local
# environment
curl -X PATCH "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/deliveryVehicles/${VEHICLE_ID}?updateMask=remainingVehicleJourneySegments" \
-H "Content-type: application/json" \
-H "Authorization: Bearer ${JWT}" \
--data-binary @- << EOM
{
"remainingVehicleJourneySegments": [
{
"stop": {
"state": "ARRIVED",
"plannedLocation": {
"point": {
"latitude": 37.7749,
"longitude": -122.084061
}
},
"tasks": [
{
"taskId": "${TASK1_ID}"
}
]
}
},
{
"stop": {
"state": "NEW",
"plannedLocation": {
"point": {
"latitude": 37.3382,
"longitude": 121.8863
}
},
"tasks": [
{
"taskId": "${TASK2_ID}"
}
]
}
}
]
}
EOM
O veículo conclui uma parada
O Fleet Engine precisa ser notificado quando um veículo conclui uma parada. Isso faz com que todas as tarefas associadas à parada a serem definidas para o estado CLOSED.
Campos obrigatórios para atualizações de paradas
O Fleet Engine ignora todos os outros campos na entidade da notificação.
Campo | Valor |
---|---|
remainingVehicleJourneySegments |
Lista de paradas de veículos restantes com os estados marcados como State.NEW. A primeira parada da lista precisa ter o estado marcado como State.ENROUTE. |
Completa um exemplo de parada
Os exemplos a seguir mostram como notificar o Fleet Engine de que um veículo chegou
na parada, usando a biblioteca Java gRPC ou uma chamada HTTP REST para
UpdateDeliveryVehicle
Todas as outras paradas estão marcadas como novas.
gRPC
static final String PROJECT_ID = "my-delivery-co-gcp-project";
static final String VEHICLE_ID = "vehicle-8241890";
DeliveryServiceBlockingStub deliveryService =
DeliveryServiceGrpc.newBlockingStub(channel);
// Vehicle settings
String vehicleName = "providers/" + PROJECT_ID + "/deliveryVehicles/" + VEHICLE_ID;
DeliveryVehicle deliveryVehicle = DeliveryVehicle.newBuilder()
// This stop has been completed and is commented out to indicate it
// should be removed from the list of vehicle journey segments.
// .addRemainingVehicleJourneySegments(VehicleJourneySegment.newBuilder()
// .setStop(VehicleStop.newBuilder()
// .setPlannedLocation(LocationInfo.newBuilder()
// .setPoint(LatLng.newBuilder()
// .setLatitude(37.7749)
// .setLongitude(122.4194)))
// .addTasks(TaskInfo.newBuilder().setTaskId(TASK1_ID))
// .setState(VehicleStop.State.ARRIVED)))
// All other remaining stops marked as NEW.
// The next stop could be marked as ENROUTE if the vehicle has begun
// its journey to the next stop.
.addRemainingVehicleJourneySegments(VehicleJourneySegment.newBuilder() // Next stop
.setStop(VehicleStop.newBuilder()
.setPlannedLocation(LocationInfo.newBuilder()
.setPoint(LatLng.newBuilder()
.setLatitude(37.3382)
.setLongitude(121.8863)))
.addTasks(TaskInfo.newBuilder().setTaskId(TASK2_ID))
.setState(VehicleStop.State.NEW)))
.build();
// DeliveryVehicle request
UpdateDeliveryVehicleRequest updateDeliveryVehicleRequest =
UpdateDeliveryVehicleRequest.newBuilder() // no need for the header
.setName(vehicleName)
.setDeliveryVehicle(deliveryVehicle)
.setUpdateMask(FieldMask.newBuilder()
.addPaths("remaining_vehicle_journey_segments"))
.build();
try {
DeliveryVehicle updatedDeliveryVehicle =
deliveryService.updateDeliveryVehicle(updateDeliveryVehicleRequest);
} catch (StatusRuntimeException e) {
Status s = e.getStatus();
switch (s.getCode()) {
case NOT_FOUND:
break;
case PERMISSION_DENIED:
break;
}
return;
}
REST
PATCH https://fleetengine.googleapis.com/v1/providers/<project_id>/deliveryVehicles/<id>?updateMask=remaining_vehicle_journey_segments`
- <id> é um identificador exclusivo para a tarefa.
- O cabeçalho da solicitação precisa conter um campo Authorization com o valor. Bearer <token>, em que <token> é emitido pelo seu servidor de acordo com as diretrizes descritas nos Papéis da conta de serviço e Tokens JSON da Web.
- O corpo da solicitação precisa conter uma entidade
DeliveryVehicle
:
Comando curl
de exemplo:
# Set JWT, PROJECT_ID, VEHICLE_ID, TASK1_ID, and TASK2_ID in the local
# environment
curl -X PATCH "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/deliveryVehicles/${VEHICLE_ID}?updateMask=remainingVehicleJourneySegments" \
-H "Content-type: application/json" \
-H "Authorization: Bearer ${JWT}" \
--data-binary @- << EOM
{
"remainingVehicleJourneySegments": [
{
"stop": {
"state": "NEW",
"plannedLocation": {
"point": {
"latitude": 37.3382,
"longitude": 121.8863
}
},
"tasks": [
{
"taskId": "${TASK2_ID}"
}
]
}
}
]
}
EOM