本文將說明建立及管理車輛時,可以更新的重要車輛欄位。
|
如需車輛欄位的完整清單,請參閱:
|
車輛狀態欄位
系統可以將車輛狀態設為 OFFLINE
或 ONLINE
。舉例來說,您可以將車輛狀態設為每天上午 9 點為 ONLINE
,每天下午 5 點為 OFFLINE
。
離線模式 | ONLINE 模式 |
---|---|
使用 OFFLINE 表示車輛不接受新的行程。請注意,車輛仍可在這個狀態下完成指派的行程。 |
|
車輛屬性欄位
使用車輛 attributes
欄位建立自訂條件,讓消費者或車隊營運商能夠根據多種搜尋條件,在你的車隊中找到車輛。這樣一來,應用程式就能提供更強大的功能,比起只使用其他車輛欄位的搜尋條件,提供更精準的車輛比對結果。每輛車輛最多可有 100 個屬性,且每個屬性都必須有專屬索引鍵。值可以是字串、布林值或數字。
舉例來說,您可以宣告名為 class 的自訂屬性,以便根據車輛等級區分共乘車輛。您可以使用下列字串值代表車輛級別:ECONOMY
、STANDARD
和 LUXURY
。
不過,自訂屬性值不必互斥。你可以使用「寵物友善」、「禁菸」和「可搭乘長途車程」等條件。每個屬性都可以是使用布林值的個別自訂屬性。指定車輛可指派這三個自訂屬性,並將class 自訂屬性設為適當的字串值。
透過這種方式使用屬性,您就能取得各種實用功能,方便您為特定需求的旅程找到合適的車輛。如要瞭解如何將自訂屬性用於查詢篩選器,請參閱「搜尋車輛」一文。
更新車輛屬性
您可以使用 UpdateVehicle
或 UpdateVehicleAttributes
更新車輛屬性。每個 attributes
鍵每輛車只能有一個值。您可以使用欄位遮罩中的 attributes
宣告自訂車輛屬性,然後根據下列方法提供值。
UpdateVehicle |
UpdateVehicleAttributes |
|
---|---|---|
這個 API 不允許只更新單一屬性。使用此方法時,如果在欄位遮罩中使用 attributes 欄位,系統會為車輛重新宣告整個車輛屬性組合。這會導致覆寫任何未明確納入欄位遮罩的現有屬性。如果您使用這個方法宣告新的自訂屬性,也必須重新宣告您希望車輛保留的每個自訂屬性。如果您在欄位遮罩中排除 attributes ,則此方法會保留先前為車輛定義的自訂屬性。如果您在欄位遮罩中使用 attributes ,但未設定值,則等同於從車輛中移除所有自訂屬性。 |
這個方法會接受要更新的特定屬性清單。這項要求只會更新或新增欄位遮罩中指定的屬性。未指定的現有屬性則維持不變。 |
更新車輛欄位範例
本節說明如何使用 UpdateVehicleRequest
更新車輛欄位,其中包含 update_mask
,可指出要更新哪些欄位。詳情請參閱通訊協定緩衝區說明文件中的「欄位遮罩」一節。
如要更新 last_location
以外的欄位,您必須具備 Fleet Engine On-demand 管理員 權限。
範例:啟用新的行程類型和自訂屬性
這個範例會為車輛啟用 back_to_back
行程,並指定新的屬性:class
。如前述「更新車輛屬性」一節所述,使用這種方法更新 attributes
欄位時,您必須指明要保留的所有自訂屬性。因此,範例會顯示寫入的 cash_only
值,以免在指定 attributes
欄位的更新作業期間遭到覆寫。
如要只更新一個鍵/值屬性組合的值,請改用 UpdateVehicleAttributes
方法,並在 UpdateVehicle
要求的欄位遮罩中排除 attribute
欄位。
請參閱 providers.vehicles.update
參考資料,瞭解 gRPC 和 REST。
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