En este documento, se supone que leíste la guía introductoria sobre las tareas programadas en la sección Introducción a Fleet Engine, así como ¿Qué es una tarea programada? en esta sección.
Fleet Engine para tareas programadas proporciona diferentes categorías amplias de tareas:
- Tareas de envío: Se usan para tareas de conducción, como la recolección y la entrega de envíos.
- Tareas de no disponibilidad: Se usan para los momentos en que los conductores no están disponibles, como los descansos obligatorios.
- Tareas de parada programada: Se usan para tareas que no son de conducción en buzones o ubicaciones de clientes, como el tiempo para entrar a un edificio o ubicar un punto de entrega.
En este documento, se explica cómo crear tareas de no envío en tu servidor. Para obtener información sobre los tipos de tareas de envío, consulta Crea tareas de envío.
Campos de tareas para tareas que no son de conducción
En esta sección, se documentan los campos de tareas necesarios para las tareas de indisponibilidad y de detención programada.
Campos de tareas obligatorios
Para cada tarea que crees en Fleet Engine, debes proporcionarle los campos obligatorios y también puedes proporcionar cualquiera de los campos opcionales. Fleet Engine ignora todos los demás campos y arroja una excepción si una solicitud de creación de tareas proporciona un deliveryVehicleId
asignado. Para asignar tareas a un vehículo, usa UpdateDeliveryVehicleRequest
. Para obtener más información, consulta Actualiza tareas.
Campo | Valor |
---|---|
type |
Se establece en el tipo que coincide con el tipo de tarea, que es uno de los siguientes:
|
state |
State.OPEN |
task_id |
Es el ID único de la tarea. No debe ser el número de seguimiento del envío. Si no tienes IDs de tareas en tu sistema, puedes generar un identificador único universal (UUID). Para obtener detalles, consulta IDs de tareas. |
tracking_id |
Solo tareas de PICKUP o DELIVERY :
Es el número o identificador que usas para hacer un seguimiento de un envío. No proporciones este campo para las tareas que no sean de envío. |
planned_location |
Solo tareas de PICKUP , DELIVERY o SCHEDULED_STOP : Es la ubicación en la que se debe completar la tarea. No se requiere para las tareas de UNAVAILABLE . |
task_duration |
Es el tiempo esperado que se agregará para completar la tarea. Por ejemplo, para buscar estacionamiento o caminar hasta la ubicación de entrega. |
Campos opcionales de la tarea de envío
Campo | Valor |
---|---|
target_time_window |
Es el período durante el cual se debe completar la tarea. Este campo no afecta el comportamiento del enrutamiento. |
task_tracking_view_config |
Solo tareas de PICKUP o DELIVERY :
Es la configuración del seguimiento de tareas que especifica qué elementos de datos
son visibles para los usuarios finales en qué circunstancias. |
attributes |
Es una lista de atributos de tareas personalizados. Cada atributo debe tener una clave única. |
Crea una tarea de no disponibilidad
Puedes crear una tarea que indique la no disponibilidad, por ejemplo, para los descansos de los conductores. Para crear una tarea de no disponibilidad, sigue estos lineamientos:
- Establece el tipo de tarea en
UNAVAILABLE
. - No incluyas un ID de seguimiento.
- Aunque no es necesario que proporciones una ubicación para una tarea de no disponibilidad, hacerlo mejora los cálculos de la ETA a lo largo del día.
Se aplican reglas de visibilidad especiales a la ubicación del vehículo cuando se encuentra en una tarea de UNAVAILABLE
para el uso compartido del viaje.
- Apps para consumidores integradas con la biblioteca de Seguimiento de envíos: Cuando el vehículo está en una tarea de no disponibilidad, los usuarios de la app para consumidores no pueden ver la ubicación del vehículo, aunque sí pueden ver la información de estado de su envío.
- Apps de seguimiento de flota integradas en la biblioteca de Fleet Tracking: Cuando el vehículo esté en una tarea de no disponibilidad, los administradores de flota que usen la app de seguimiento de flota podrán ver la ubicación del vehículo para las tareas de no disponibilidad.
En los siguientes ejemplos, se muestra cómo crear una tarea de no disponibilidad programada con la biblioteca de gRPC de Java o cómo realizar una solicitud HTTP de REST a CreateTask
.
gRPC
static final String PROJECT_ID = "my-delivery-co-gcp-project";
DeliveryServiceBlockingStub deliveryService =
DeliveryServiceGrpc.newBlockingStub(channel);
// Task settings
String parent = "providers/" + PROJECT_ID;
Task task = Task.newBuilder()
.setType(Task.Type.UNAVAILABLE)
.setState(Task.State.OPEN)
.setTaskDuration(
Duration.newBuilder().setSeconds(60 * 60)) // 1hr break
.build();
// Task request
CreateTaskRequest createTaskRequest =
CreateTaskRequest.newBuilder() // No need for the header
.setParent(parent) // Avoid using auto-incrementing IDs for the taskId
.setTaskId("task-8241890") // Task ID assigned by the Provider
.setTask(task) // Initial state
.build();
// Error handling
// If Fleet Engine does not have task with that ID and the credentials of the
// requestor pass, the service creates the task successfully.
try {
Task createdTask = deliveryService.createTask(createTaskRequest);
} catch (StatusRuntimeException e) {
Status s = e.getStatus();
switch (s.getCode()) {
case ALREADY_EXISTS:
break;
case PERMISSION_DENIED:
break;
}
return;
}
```
REST
Para crear una tarea de no disponibilidad desde un entorno de servidor, realiza una llamada a CreateTask
con HTTP REST:
POST https://fleetengine.googleapis.com/v1/providers/<project_id>/tasks?taskId=<id>
<id> es un identificador único para la tarea.
El encabezado de la solicitud debe contener un campo Authorization con el valor Bearer <token>, donde <token> lo emite tu servidor según los lineamientos que se describen en Roles de la cuenta de servicio y Tokens web JSON.
El cuerpo de la solicitud debe contener una entidad Task
con los campos adecuados que se describen en Campos de tareas para tareas que no son de conducción.
Comando curl
de ejemplo
# Set $JWT, $PROJECT_ID, and $TASK_ID in the local environment
curl -X POST "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/tasks?taskId=${TASK_ID}" \
-H "Content-type: application/json" \
-H "Authorization: Bearer ${JWT}" \
--data-binary @- << EOM
{
"type": "UNAVAILABLE",
"state": "OPEN",
"plannedLocation": {
"point": {
"latitude": -6.195139,
"longitude": 106.820826
}
},
"taskDuration": "300s"
}
EOM
Crea una tarea de detención programada
Puedes crear una tarea para una parada programada, por ejemplo, para tareas que no impliquen conducir en ubicaciones de clientes, para paradas de reabastecimiento de combustible o para cuando un conductor recibe envíos de un vehículo alimentador. Cuando crees una tarea de parada programada, usa los siguientes lineamientos:
- Establece el tipo de tarea en
- No incluyas un ID de seguimiento.
- De manera opcional, puedes proporcionar una ubicación.
En los siguientes ejemplos, se muestra cómo crear una tarea de no disponibilidad programada con la biblioteca de gRPC de Java o cómo realizar una solicitud HTTP de REST a CreateTask
.
gRPC
static final String PROJECT_ID = "my-delivery-co-gcp-project";
DeliveryServiceBlockingStub deliveryService =
DeliveryServiceGrpc.newBlockingStub(channel);
// Task settings
String parent = "providers/" + PROJECT_ID;
Task task = Task.newBuilder()
.setType(Task.Type.SCHEDULED_STOP)
.setState(Task.State.OPEN)
.setPlannedLocation( // Grand Indonesia East Mall
LocationInfo.newBuilder().setPoint(
LatLng.newBuilder().setLatitude(-6.195139).setLongitude(106.820826)))
.setTaskDuration(
Duration.newBuilder().setSeconds(2 * 60))
.build();
// Task request
CreateTaskRequest createTaskRequest =
CreateTaskRequest.newBuilder() // No need for the header
.setParent(parent)
.setTaskId("task-8241890") // Task ID assigned by the Provider
.setTrip(task) // Initial state
.build();
// Error handling
// If Fleet Engine does not have task with that ID and the credentials of the
// requestor pass, the service creates the task successfully.
try {
Task createdTask = deliveryService.createTask(createTaskRequest);
} catch (StatusRuntimeException e) {
Status s = e.getStatus();
switch (s.getCode()) {
case ALREADY_EXISTS:
break;
case PERMISSION_DENIED:
break;
}
return;
}
```
REST
Para crear una tarea de detención programada desde un entorno de servidor, realiza una llamada a CreateTask
con HTTP REST:
POST https://fleetengine.googleapis.com/v1/providers/<project_id>/tasks?taskId=<id>
<id> es un identificador único para la tarea.
El encabezado de la solicitud debe contener un campo Authorization con el valor Bearer <token>, donde <token> lo emite tu servidor según los lineamientos que se describen en Roles de la cuenta de servicio y Tokens web JSON.
El cuerpo de la solicitud debe contener una entidad Task
:
Comando curl
de ejemplo
# Set $JWT, $PROJECT_ID, and $TASK_ID in the local environment
curl -X POST "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/tasks?taskId=${TASK_ID}" \
-H "Content-type: application/json" \
-H "Authorization: Bearer ${JWT}" \
--data-binary @- << EOM
{
"type": "SCHEDULED_STOP",
"state": "OPEN",
"plannedLocation": {
"point": {
"latitude": -6.195139,
"longitude": 106.820826
}
},
"taskDuration": "600s"
}
EOM