В этом документе описывается, как составить список средств доставки.
Среды и ограничения
Вы можете перечислить средства доставки с сервера или из среды браузера. Driver SDK не поддерживает перечисление средств доставки.
Листинг средств доставки требует широкого доступа к средствам доставки и предназначен только для доверенных пользователей. Используйте токены Delivery Fleet Reader или Fleet Engine Delivery Admin при составлении запросов на список транспортных средств для доставки.
Следующие поля в списке средств доставки удалены из-за их влияния на размер ответа:
-
CurrentRouteSegment -
RemainingVehicleJourneySegments
Использование
Вы можете составить список транспортных средств по фильтрам атрибутов и границам области просмотра. Если вы не укажете фильтр или область просмотра, ответ будет включать все средства доставки.
Список с фильтрами атрибутов
Вы можете перечислить средства доставки по фильтру, используя их свойство attributes . Например, чтобы запросить атрибут с ключом my_key и значением my_value , используйте attributes.my_key = my_value . Чтобы запросить несколько атрибутов, объедините запросы, используя логические операторы AND и OR , как в attributes.key1 = value1 AND attributes.key2 = value2 . См. AIP-160 для полного описания синтаксиса запроса фильтра. Если вы объединяете фильтры с границами области просмотра, фильтр действует как оператор AND для границы области просмотра. Подробности см. в разделе Запросы фильтров атрибутов транспортных средств .
Список с границами области просмотра
Вы можете фильтровать перечисленные средства доставки по местоположению, используя параметр запроса viewport . Параметр запроса viewport определяет области просмотра с использованием двух ограничивающих координат: пары координат high (северо-восток) и low (юго-запад) широты и долготы. Запросы отклоняются, если они содержат высокую широту, которая географически ниже низкой широты.
Список ответов
Списки средств доставки по умолчанию разбиты на страницы с использованием разумного размера страницы. Если вы укажете размер страницы, запрос вернет только количество транспортных средств, указанное в лимите, или меньше. Если запрошенный размер страницы превышает внутреннее максимальное значение, используется внутренний максимум. Размер страницы по умолчанию и максимальный размер страницы — 100 автомобилей.
Список средств доставки может включать в себя токен для чтения следующей страницы результатов. Токен страницы присутствует в ответе только тогда, когда для получения доступны дополнительные страницы средств доставки. Чтобы получить следующую страницу задач, используйте токен страницы с запросом, который в остальном идентичен предыдущему запросу.
Перечислить примеры транспортных средств
Вы можете использовать библиотеку Java gRPC или REST для получения списка средств доставки в определенном регионе с определенным атрибутом. Успешный ответ все равно может быть пустым. Когда это происходит, это означает, что в указанном окне просмотра не существует транспортных средств с указанным атрибутом.
Ява
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;
}
ОТДЫХ
# 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"
Если поиск успешен, тело ответа содержит данные следующей структуры:
// JSON representation
{
"deliveryVehicles": [
{
object (DeliveryVehicle)
}
],
"nextPageToken": string,
"totalSize": integer
}