|
このドキュメントでは、車両の作成と管理時に更新できる重要な車両フィールドについて説明します。
|
車両フィールドの一覧については、以下をご覧ください。
|
車両の状態フィールド
システムは車両の状態を OFFLINE または ONLINE に設定できます。たとえば、毎日午前 9 時に車両の状態を ONLINE に設定し、毎日午後 5 時に OFFLINE に設定できます。
| オフライン モード | ONLINE モード |
|---|---|
OFFLINE は、車両が新しいルートを受け入れていないことを示します。この状態の車両は、割り当てられたルートを完了できます。 |
|
車両属性フィールド
車両の attributes フィールドを使用してカスタマイズされた条件を作成すると、ユーザーやフリート事業者は、さまざまな検索条件でフリート内の車両を見つけることができます。これにより、他の車両フィールドのみに基づく検索条件を使用する場合よりも、より適切な車両の一致を提供するアプリの機能を強化できます。各車両に設定できる属性は最大 100 個で、それぞれに一意のキーが必要です。値は文字列、ブール値、数値のいずれかです。
たとえば、class というカスタム属性を宣言して、クラスレベルでライドシェアリング ビークルを区別できます。車両クラスレベルを表すには、ECONOMY、STANDARD、LUXURY の文字列値を使用します。
ただし、カスタム属性値は互いに重複しなくてもかまいません。たとえば、ペット可、禁煙、長距離移動可能などの条件を使用できます。これらはそれぞれ、ブール値を使用する個別のカスタム属性にできます。特定の車両には、これらの 3 つのカスタム属性と、適切な文字列値に設定されたクラス カスタム属性をすべて割り当てることができます。
このように属性を使用すると、特定のニーズのある旅行に適した車両を見つけるのに役立つさまざまな機能を利用できます。カスタム属性をクエリフィルタとして使用する方法については、車両を検索するをご覧ください。
車両属性を更新する
車両属性は、UpdateVehicle または UpdateVehicleAttributes を使用して更新できます。各 attributes キーには、車両ごとに 1 つの値のみを設定できます。カスタム車両属性を宣言するには、フィールドマスクで attributes を使用し、以下の方法に基づいて値を指定します。
UpdateVehicle |
UpdateVehicleAttributes |
|
|---|---|---|
この API では、1 つの属性のみを更新することはできません。この方法を使用すると、フィールド マスクで attributes フィールドを使用すると、車両属性のセット全体が車両に対して再宣言されます。これにより、フィールドマスクに明示的に含まれていない既存の属性が上書きされます。この方法で新しいカスタム属性を宣言する場合は、車両に保持するすべてのカスタム属性を再宣言する必要があります。フィールド マスクで attributes を除外すると、このメソッドは、車両に以前に定義された既存のカスタム属性をそのまま残します。フィールド マスクで attributes を使用しても値を設定しない場合は、車両からすべてのカスタム属性が削除された場合と同じです。 |
このメソッドは、更新する属性の特定のリストを受け入れます。このリクエストでは、フィールド マスクで指定された属性のみが更新または追加されます。指定されていない既存の属性は変更されません。 |
車両フィールドの更新例
このセクションでは、UpdateVehicleRequest を使用して車両フィールドを更新する方法について説明します。UpdateVehicleRequest には、更新するフィールドを示す update_mask が含まれています。詳細については、フィールド マスクに関するプロトコル バッファのドキュメントをご覧ください。
last_location 以外のフィールドを更新するには、Fleet Engine オンデマンド管理者の権限が必要です。
例: 新しいルートタイプとカスタム属性を有効にする
この例では、車両の back_to_back ルートを有効にし、新しい属性 class を指定します。前述の車両属性を更新するで説明したように、この方法で attributes フィールドを更新するには、保持するカスタム属性をすべて指定する必要があります。そのため、この例では、attributes フィールドを指定する更新オペレーション中に上書きされないように、cash_only 値が書き込まれています。
1 つの Key/Value 属性ペアの値のみを更新するには、代わりに 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