|
このドキュメントでは、車両の作成と管理時に更新できる重要な車両フィールドについて説明します。
|
車両フィールドの完全なリストについては、以下をご覧ください。 |
車両属性フィールド
車両の attributes フィールドを使用してカスタム条件を作成すると、ユーザーやフリート オペレーターは、さまざまな検索条件でフリート内の車両を見つけることができます。これにより、他の車両フィールドのみに基づく検索条件を使用する場合よりも、アプリの車両マッチング機能が向上します。各車両には最大 100 個の属性を設定でき、それぞれに一意のキーが必要です。値は文字列、ブール値、数値にできます。
たとえば、カスタム属性 zone を宣言して、配送車両が運行する都市のゾーンを区別できます。異なるゾーンを表すには、1B、2C、3A などの文字列値を使用します。その後、フリート トラッキングでフィルタを使用して、特定のゾーンで作業している車両のみをそのゾーンの担当者に表示できます。
ただし、カスタム属性値は相互に排他的である必要はありません。たとえば、 available-at-night や has-refrigeration などの条件を使用できます。これらはそれぞれ、ブール値を使用する個別のカスタム属性にできます。特定の車両には、これらの 3 つのカスタム属性すべてと、適切な文字列値に設定された zone カスタム属性を割り当てることができます。
車両属性を更新する
各 attributes キーに設定できる値は、車両ごとに 1 つ のみです。フィールド マスクの attributes を使用してカスタム車両属性を宣言し、以下の方法に基づいて値を指定します。
この UpdateDeliveryVehicle API では、単一の属性のみを更新することはできません。このメソッドを使用すると、フィールド マスクで attributes フィールドを使用すると、車両の車両属性の完全なセット が再宣言されます。これにより、フィールド マスクに明示的に含まれていない既存の属性が上書きされます。このメソッドを使用して新しいカスタム属性を宣言する場合は、車両に保持するすべてのカスタム属性も再宣言する必要があります。フィールド マスクで attributes を除外すると、このメソッドでは、車両に定義されている既存のカスタム属性がそのまま残ります。
フィールド マスクで attributes を使用しても値を設定しない場合は、車両からすべてのカスタム属性を削除するのと同じです。
車両フィールドの更新例
このセクションでは、UpdateDeliveryVehicleRequest を使用して車両フィールドを更新する方法について説明します。これには、更新するフィールドを示す update_mask が含まれます。詳細については、
フィールド マスクに関するプロトコル バッファのドキュメントをご覧ください。
last_location 以外のフィールドを更新するには、フリート エンジン配送管理者権限が必要です。
例: カスタム属性を設定する
この例では、新しい属性 zone を指定します。前述の
車両属性の更新で説明したように、attributes フィールドをこの方法で更新するには、保持するすべてのカスタム属性を指定する必要があります。
したがって、この例では、attributes フィールドを指定する更新オペレーション中に上書きされないように、available-at-night 値が書き込まれています。
providers.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;
}
REST
# 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