Обновить поля средства доставки

В этом документе описаны важные поля транспортных средств, которые вы можете обновить при создании транспортных средств и управлении ими.

  • type : Тип этого средства доставки. Это повлияет на маршруты, созданные для этого транспортного средства.
  • attributes[] : Массив опций типа DeliveryVehicleAttribute . Используйте их, чтобы определить пользовательские критерии для транспортных средств в вашем сервисе, чтобы улучшить фильтрацию при поиске или перечислении транспортных средств.

Полный список полей для транспортных средств см. в разделе:

Поле атрибутов автомобиля

Используйте поле attributes транспортного средства, чтобы создать индивидуальные критерии, которые позволят вашим потребителям или операторам автопарка находить транспортные средства в вашем автопарке по более широкому спектру критериев поиска. Это расширяет возможности ваших приложений по обеспечению более точного соответствия транспортных средств по сравнению с использованием критериев поиска, основанных исключительно на других полях транспортных средств. Каждое транспортное средство может иметь не более 100 атрибутов, и каждый из них должен иметь уникальный ключ. Значения могут быть строками, логическими значениями или числами.

Например, вы можете объявить настраиваемый атрибут под названием Zone , чтобы различать, в какой зоне города работают ваши средства доставки. Для представления различных зон можно использовать строковые значения, подобные следующим: 1B , 2C и 3A . Затем вы можете использовать фильтр в отслеживании автопарка, чтобы показывать транспортные средства, работающие в определенной зоне, только оператору, ответственному за эту зону.

Однако значения пользовательских атрибутов не обязательно должны быть взаимоисключающими. Вы можете использовать такие критерии, как «доступность в ночное время» и «есть охлаждение» . Каждый из них может быть отдельным настраиваемым атрибутом, использующим логические значения. Данному транспортному средству могут быть назначены все три этих пользовательских атрибута вместе с пользовательским атрибутом зоны , которому присвоено соответствующее строковое значение.

Обновить атрибуты автомобиля

Каждый ключ attributes может иметь только одно значение для каждого транспортного средства . Вы объявляете пользовательские атрибуты транспортного средства, используя attributes в маске поля, а затем предоставляете значения на основе метода, описанного ниже.

Этот API UpdateDeliveryVehicle не позволяет обновлять только один атрибут. При использовании этого метода любое использование поля attributes в маске поля приводит к переобъявлению всего набора атрибутов транспортного средства для транспортного средства. Это приводит к перезаписи любого ранее существовавшего атрибута, не включенного явно в маску поля. Если вы используете этот метод для объявления нового настраиваемого атрибута, вам также необходимо повторно объявить каждый настраиваемый атрибут, который вы хотите сохранить в автомобиле. Если вы исключите attributes из маски поля, этот метод оставит существующие пользовательские атрибуты такими, как они были определены ранее для автомобиля. Если вы используете attributes в маске поля, но не задавая значения, это эквивалентно удалению всех пользовательских атрибутов с автомобиля.

Пример обновления полей транспортного средства

В этом разделе показано, как обновить поля транспортного средства с помощью UpdateDeliveryVehicleRequest , который включает в себя update_mask указывающий, какие поля нужно обновить. Подробности см. в документации по протокольным буферам о масках полей .

Для обновления полей, отличных от last_location требуются права администратора Fleet Engine Delivery .

Пример: установить пользовательский атрибут

В этом примере указывается новый атрибут: zone . Как отмечалось ранее в разделе «Обновление атрибутов транспортного средства» , обновление поля attributes с использованием этого подхода требует указания всех настраиваемых атрибутов, которые вы хотите сохранить. Поэтому в примере показано значение available-at-night , записанное для предотвращения его перезаписи во время операции обновления, которая задает поле attributes .

См. справку по поставщикам.deliveryVehicles.patch .

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 myDeliveryVehicle = DeliveryVehicle.newBuilder()
      .addAllAttributes(ImmutableList.of(
          DeliveryVehicleAttribute.newBuilder().setKey("zone").setValue("1B").build(),
          DeliveryVehicleAttribute.newBuilder().setKey("available-at-night").setValue("true").build()))
      .build();

  // DeliveryVehicle request
  UpdateDeliveryVehicleRequest updateDeliveryVehicleRequest =
    UpdateDeliveryVehicleRequest.newBuilder()  // No need for the header
        .setName(vehicleName)
        .setDeliveryVehicle(myDeliveryVehicle)
        .setUpdateMask(FieldMask.newBuilder()
            .addPaths("attributes"))
        .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;
  }

ОТДЫХ 

  # 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=attributes" \
    -H "Content-type: application/json" \
    -H "Authorization: Bearer ${JWT}" \
    --data-binary @- << EOM
  {
      "attributes": [
        {"key": "zone", "value": "1B"},
        {"key": "available-at-night", "value": "true"}
      ]
  }
  EOM

Что дальше