En este documento, se describe cómo enumerar vehículos de entrega.
Entornos y limitaciones
Puedes enumerar los vehículos de entrega desde un servidor o un entorno de navegador. El SDK de Driver no admite la enumeración de vehículos de entrega.
La solicitud de enumeración de vehículos de reparto requiere un acceso amplio a los vehículos de reparto y solo está destinada a usuarios de confianza. Usa tokens de Delivery Fleet Reader o Fleet Engine Delivery Admin cuando realices solicitudes de lista de vehículos de entrega.
Los vehículos de reparto que se enumeran tienen los siguientes campos ocultos debido a su impacto en el tamaño de la respuesta:
CurrentRouteSegmentRemainingVehicleJourneySegments
Uso
Puedes enumerar vehículos por filtros de atributos y límites de la ventana gráfica. Si no especificas ningún filtro ni ninguna ventana gráfica, la respuesta incluirá todos los vehículos de reparto.
Lista con filtros de atributos
Puedes enumerar los vehículos de reparto por filtro usando su propiedad attributes. Por ejemplo, para consultar un atributo con la clave my_key y el valor my_value, usa attributes.my_key = my_value. Para consultar varios atributos, une las consultas con los operadores lógicos AND y OR, como en attributes.key1 = value1 AND
attributes.key2 = value2. Consulta AIP-160 para obtener una descripción completa de la sintaxis de las consultas de filtro. Si combinas filtros con límites de la ventana gráfica, el filtro actúa como un operador AND para el límite de la ventana gráfica. Consulta Consultas de filtro de atributos del vehículo para obtener más detalles.
Lista con límites de la ventana gráfica
Puedes filtrar los vehículos de reparto que se enumeran por ubicación con el parámetro de solicitud viewport. El parámetro de solicitud viewport define las ventanas gráficas con dos coordenadas de límite: un par de coordenadas de latitud y longitud high (noreste) y low (suroeste). Las solicitudes se rechazan si contienen una latitud alta que es geográficamente más baja que una latitud baja.
Respuestas de la lista
De forma predeterminada, las listas de vehículos de reparto se paginan con un tamaño de página razonable. Si especificas un tamaño de página, la solicitud solo devolverá la cantidad de vehículos especificada por el límite o menos. Si el tamaño de página solicitado supera un valor máximo interno, se usa el valor máximo interno. El tamaño de página predeterminado y máximo es de 100 vehículos.
Una lista de vehículos de reparto puede incluir un token para leer la siguiente página de resultados. Un token de página solo está presente en una respuesta cuando hay más páginas de vehículos de reparto disponibles para recuperar. Para recuperar la siguiente página de tareas, usa el token de página con una solicitud que, de lo contrario, sea idéntica a la solicitud anterior.
Ejemplos de cómo enumerar vehículos
Puedes usar la biblioteca de gRPC de Java o REST para enumerar los vehículos de reparto en una región específica con un atributo determinado. Una respuesta correcta puede estar vacía. Cuando eso sucede, significa que no hay vehículos con el atributo especificado en el viewport indicado.
Java
static final String PROJECT_ID = "my-delivery-co-gcp-project";
DeliveryServiceBlockingStub deliveryService =
DeliveryServiceGrpc.newBlockingStub(channel);
// Tasks request
String parent = "providers/" + PROJECT_ID;
ListDeliveryVehiclesRequest listDeliveryVehiclesRequest =
ListDeliveryVehiclesRequest.newBuilder() // No need for the header
.setParent(parent)
.setViewport(
Viewport.newBuilder()
.setHigh(LatLng.newBuilder()
.setLatitude(37.45)
.setLongitude(-122.06)
.build())
.setLow(LatLng.newBuilder()
.setLatitude(37.41)
.setLongitude(-122.11)
.build())
.setFilter("attributes.my_key = my_value")
.build();
try {
ListDeliveryVehiclesResponse listDeliveryVehiclesResponse =
deliveryService.listDeliveryVehicles(listDeliveryVehiclesRequest);
} catch (StatusRuntimeException e) {
Status s = e.getStatus();
switch (s.getCode()) {
case NOT_FOUND:
break;
case PERMISSION_DENIED:
break;
}
return;
}
REST
# HTTP request
html GET https://fleetengine.googleapis.com/v1/providers/<project_id>/deliveryVehicles
# Request with a filter
# Request sets JWT, PROJECT_ID, and VEHICLE_ID in the local environment
curl -H "Authorization: Bearer ${JWT}" \
"https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/deliveryVehicles?filter=attributes.my_key%20%3D%20my_value%20&viewport.high.latitude=37.45&viewport.high.longitude=-122.06&viewport.low.latitude=37.41&viewport.low.longitude=-122.11"
Si la búsqueda se realiza correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
// JSON representation
{
"deliveryVehicles": [
{
object (DeliveryVehicle)
}
],
"nextPageToken": string,
"totalSize": integer
}