このページは Cloud Translation API によって翻訳されました。

配送車両フィールドを更新

このドキュメントでは、車両の作成と管理時に更新できる重要な車両フィールドについて説明します。

type: この配達車両のタイプ。これは、この車両用に生成されたルートに影響します。
attributes[]: DeliveryVehicleAttribute 型のオプション配列。これらを使用して、サービスの車両のカスタム条件を定義し、車両の検索時やリスト表示時のフィルタリング動作を強化します。

車両フィールドの一覧については、以下をご覧ください。

車両属性フィールド

車両の attributes フィールドを使用して、カスタマイズされた条件を作成し、消費者がさまざまな検索条件でフリート内の車両を見つけられるようにします。これにより、他の車両フィールドのみに基づく検索条件を使用する場合よりも、アプリの車両マッチング機能が向上します。各車両には最大 100 個の属性を設定でき、それぞれに一意のキーが必要です。値は文字列、ブール値、数値のいずれかです。

たとえば、配達車両がどのゾーンで運行しているかを区別するために、zone というカスタム属性を宣言できます。異なるゾーンを表すには、1B、2C、3A などの文字列値を使用します。その後、フリートトラッキングのフィルタを使用して、特定のゾーンで作業している車両のみをそのゾーンの担当者に表示できます。

ただし、カスタム属性の値は相互に排他的である必要はありません。available-at-night や has-refrigeration などの条件を使用できます。それぞれがブール値を使用する個別のカスタム属性になる可能性があります。特定の車両には、これらの 3 つのカスタム属性すべてと、適切な文字列値に設定されたゾーンのカスタム属性を割り当てることができます。

車両属性を更新する

各 attributes キーには、車両ごとに 1 つの値のみを設定できます。カスタム車両属性は、フィールドマスクの attributes を使用して宣言し、次の方法に基づいて値を指定します。

この UpdateDeliveryVehicle API では、単一の属性のみを更新することはできません。このメソッドを使用すると、フィールドマスクで attributes フィールドを使用するたびに、車両の属性の完全なセットが車両に対して再宣言されます。これにより、フィールドマスクに明示的に含まれていない既存の属性が上書きされます。このメソッドを使用して新しいカスタム属性を宣言する場合は、車両に保持させたいすべてのカスタム属性を再宣言する必要があります。フィールドマスクで attributes を除外すると、このメソッドは既存のカスタム属性を車両に対して以前に定義されたままにします。フィールドマスクで attributes を使用しても値を設定しない場合、車両からすべてのカスタム属性を削除するのと同じことになります。

車両フィールドの更新の例

このセクションでは、UpdateDeliveryVehicleRequest を使用して車両フィールドを更新する方法について説明します。これには、更新するフィールドを示す update_mask が含まれます。詳細については、フィールドマスクに関するプロトコルバッファのドキュメントをご覧ください。

last_location 以外のフィールドを更新するには、Fleet Engine Delivery 管理者権限が必要です。

例: カスタム属性を設定する

この例では、新しい属性 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

次のステップ

配送車両の位置情報を更新する