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

このドキュメントでは、追加可能な重要な車両フィールドについて説明します。 車両の作成と管理に役立ちます。

  • type: この配送車両のタイプ。これは、この車両用に生成されるルートに影響します。
  • attributes[]: DeliveryVehicleAttribute 型のオプション配列。これらの条件を使用して、サービス内の車両のカスタム条件を定義し、車両の検索や掲載時にフィルタ処理を強化します。
 

車両フィールドの完全なリストについては、以下をご覧ください。

車両属性フィールド

車両の attributes フィールドを使用して、カスタマイズした条件を作成し、 車両を幅広く探せるようにしました。 さまざまな検索条件を指定できます。これにより、他の車両フィールドのみに基づく検索条件を使用する場合よりも、より適切な車両の一致を提供するアプリの機能を強化できます。1 台につき最大 100 台まで それぞれに一意のキーが必要です。値は文字列、ブール値、数値のいずれかです。

たとえば、zone というカスタム属性を宣言して、配送車両が運行する都市のゾーンを区別できます。ゾーンを表すには、1B2C3A などの文字列値を使用します。その後、フリート トラッキングでフィルタを使用して、 特定のゾーンで走行中の車両を そのゾーンを担当するオペレーターに提供します

ただし、カスタム属性値は互いに重複しなくてもかまいません。available-at-nighthas-refrigeration などの条件を使用できます。これらの ブール値を使用する個別のカスタム属性を指定できます。特定の車両には、これらの 3 つのカスタム属性と、適切な文字列値に設定されたゾーン カスタム属性をすべて割り当てることができます。

車両属性を更新する

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

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

車両フィールドの更新例

このセクションでは、以下を使用して車両フィールドを更新する方法について説明します。 UpdateDeliveryVehicleRequestupdate_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

次のステップ