更新车辆字段

本文档介绍了在创建和管理车辆时可以更新的重要车辆字段。

  • vehicle_state：确定车辆是否可用于新行程。
  • vehicle_type：创建车辆时必需的字段。 该字段还可以作为车辆匹配的过滤条件。 如需详细了解如何设置此字段，请参阅创建车辆。
  • attributes[]：一个可选的 VehicleAttribute 类型数组。使用它们可定义自定义条件，以增强搜索或列出车辆时的过滤行为。
  

如需查看完整的车辆字段列表，请参阅：

车辆状态字段

您的系统可以将车辆状态设置为 OFFLINE 或 ONLINE。例如，您可以将车辆状态设置为每天上午 9 点为 ONLINE，每天下午 5 点为 OFFLINE。

离线模式 在线模式
使用 OFFLINE 表示车辆不接受新行程。请注意，车辆在此状态下仍可完成已分配的行程。
  • 以 ONLINE 状态创建的 Vehicle 可能会立即在对 SearchVehicles 查询的响应中返回。 如需了解详情，请参阅搜索车辆。
  • 在 ONLINE 状态下创建的车辆应使用 CreateVehicle 调用中的 last_location 字段。

车辆属性字段

您可以使用车辆 attributes 字段创建自定义条件，以便您的消费者或车队运营商能够根据更多不同的搜索条件在您的车队中查找车辆。这样一来，您的应用就能提供比仅基于其他车辆字段的搜索条件更好的车辆匹配结果。每辆车最多可以有 100 个属性，每个属性都必须具有唯一的键。值可以是字符串、布尔值或数字。

例如，您可以声明一个名为 class 的自定义属性，以区分不同等级的网约车。您可以使用以下字符串值来表示车辆等级：ECONOMY、STANDARD 和 LUXURY。

不过，自定义属性值不必互斥。您可以使用适合携带宠物、禁烟和能够进行长途旅行等条件。这些都可以是使用布尔值的单独自定义属性。给定车辆可以分配所有这三个自定义属性，以及设置为相应字符串值的 class 自定义属性。

通过这种方式使用属性，您可以获得各种功能，以便找到满足特定需求的车辆。如需了解如何使用自定义属性作为查询过滤条件，请参阅搜索车辆。

更新车辆属性

您可以使用 UpdateVehicle 或 UpdateVehicleAttributes 更新车辆属性。每个 attributes 键针对每辆车只能有一个值。您可以使用字段掩码中的 attributes 声明自定义车辆属性，然后根据以下方法提供值。

UpdateVehicle UpdateVehicleAttributes
此 API 不支持仅更新单个属性。使用此方法时，如果字段掩码中使用了 attributes 字段，则会导致为车辆重新声明整套车辆属性。这会导致任何未明确包含在字段掩码中的预先存在的属性被覆盖。如果您使用此方法声明新的自定义属性，还必须重新声明您希望车辆保留的每个自定义属性。如果您在字段掩码中排除 attributes，则此方法会保留之前为车辆定义的现有自定义属性。如果您在字段掩码中使用 attributes，但未设置值，则相当于从车辆中移除所有自定义属性。 此方法接受要更新的属性的特定列表。相应请求仅更新或添加字段掩码中指定的属性。未指定的现有属性保持不变。

更新车辆字段示例

本部分展示了如何使用 UpdateVehicleRequest 更新车辆字段，其中包括用于指示要更新的字段的 update_mask。如需了解详情，请参阅有关字段掩码的 Protocol Buffers 文档。

更新 last_location 以外的字段需要 Fleet Engine On-demand Admin 权限。

示例：启用新的行程类型和自定义属性

此示例为车辆启用了 back_to_back 行程，并指定了一个新属性：class。如前文更新车辆属性中所述，使用此方法更新 attributes 字段时，您需要指明要保留的所有自定义属性。因此，该示例显示了写入的 cash_only 值，以防止在指定 attributes 字段的更新操作期间被覆盖。

如需仅更新一个键值对属性的值，请改用 UpdateVehicleAttributes 方法，并且不要在 UpdateVehicle 请求的字段掩码中包含 attribute 字段。

请参阅 gRPC 和 REST 的 providers.vehicles.update 参考文档。

gRPC

static final String PROJECT_ID = "project-id";
static final String VEHICLE_ID = "vid-8241890";

VehicleServiceBlockingStub vehicleService = VehicleService.newBlockingStub(channel);

String vehicleName = "providers/" + PROJECT_ID + "/vehicles/" + VEHICLE_ID;
Vehicle updatedVehicle = Vehicle.newBuilder()
    .setVehicleState(VehicleState.ONLINE)
    .addAllAttributes(ImmutableList.of(
        VehicleAttribute.newBuilder().setKey("class").setValue("ECONOMY").build(),
        VehicleAttribute.newBuilder().setKey("cash_only").setValue("false").build()))
    .setBackToBackEnabled(true)
    .build();

UpdateVehicleRequest updateVehicleRequest = UpdateVehicleRequest.newBuilder()
    .setName(vehicleName)
    .setVehicle(updatedVehicle)
    .setUpdateMask(FieldMask.newBuilder()
        .addPaths("vehicle_state")
        .addPaths("attributes")
        .addPaths("back_to_back_enabled"))
    .build();

try {
  Vehicle updatedVehicle =
      vehicleService.updateVehicle(updateVehicleRequest);
} catch (StatusRuntimeException e) {
  Status s = e.getStatus();
  switch (s.getCode()) {
    case NOT_FOUND:
      // Most implementations will call CreateVehicle in this case
      break;
    case PERMISSION_DENIED:
      break;
  }
  return;
}
// If no Exception, Vehicle updated successfully.

REST

curl -X PUT \
  "https://fleetengine.googleapis.com/v1/providers/project-id/vehicles/vid-8241890?updateMask=vehicle_state,attributes,back_to_back_enabled" \
  -H "Authorization: Bearer $JWT" \
  -H "Content-Type: application/json" \
  --data-binary @- << EOM
{
    "vehicleState": "ONLINE",
    "attributes": [
      {"key": "class", "value": "LUXURY"},
      {"key": "cash_only", "value": "false"}
    ],
    "backToBackEnabled": true
}
EOM

后续步骤