Ce document décrit les champs importants que vous pouvez modifier lorsque vous créez et gérez des véhicules.
|
Pour obtenir la liste complète des champs pour les véhicules, consultez les articles suivants:
|
Champ "État du véhicule"
Votre système peut définir l'état du véhicule sur OFFLINE
ou ONLINE
. Par exemple :
pourrait définir l'état du véhicule sur ONLINE
tous les jours à 9h et OFFLINE
tous les jours
à 17h.
Mode HORS CONNEXION | Mode EN LIGNE |
---|---|
Utilisez OFFLINE pour indiquer qu'un véhicule n'accepte pas de nouveaux trajets. Notez que le véhicule peut toujours effectuer les trajets qui lui sont attribués dans cet état. |
|
Champ "Attributs du véhicule"
Utilisez le champ attributes
du véhicule pour créer des critères personnalisés afin d'activer votre
aux consommateurs ou aux opérateurs de flottes de véhicules de transports en commun pour trouver des véhicules dans votre flotte
une variété de critères de recherche. Ainsi, vos applications peuvent mieux
fournir de meilleurs véhicules par rapport à ce que vous auriez obtenu en utilisant des critères de recherche ;
uniquement à partir d'autres champs du véhicule. Chaque véhicule peut en avoir 100 au maximum
et chacun doit posséder une clé unique. Les valeurs peuvent être des chaînes, des valeurs booléennes ou des nombres.
Par exemple, vous pouvez déclarer un attribut personnalisé appelé classe pour
différencier vos véhicules de VTC selon les niveaux de classe. Vous devez utiliser les valeurs de chaîne suivantes pour représenter les niveaux de classe de véhicule : ECONOMY
, STANDARD
et LUXURY
.
Toutefois, les valeurs des attributs personnalisés ne doivent pas nécessairement être mutuellement exclusives. Vous pourriez Utilisez des critères comme accepte les animaux, non-fumeurs et peut prendre plus de temps trajets. Chacune de ces valeurs peut être un attribut personnalisé distinct qui utilise des valeurs booléennes. Ces trois attributs personnalisés peuvent être attribués à un véhicule donné. avec l'attribut personnalisé class défini sur la valeur de chaîne appropriée.
En utilisant les attributs de cette façon, vous pouvez bénéficier d'une grande variété de fonctionnalités utiles trouver des véhicules pour des trajets ayant des besoins spécifiques. Pour savoir comment pour utiliser des attributs personnalisés comme filtres de requête, consultez Rechercher des véhicules.
Mettre à jour les attributs du véhicule
Vous pouvez modifier les attributs du véhicule à l'aide de UpdateVehicle
ou de UpdateVehicleAttributes
. Chaque clé attributes
ne peut avoir qu'une seule valeur par clé
véhicule. Vous déclarez des attributs de véhicule personnalisés à l'aide de attributes
dans le masque de champ, puis en fournissant des valeurs en fonction de la méthode ci-dessous.
UpdateVehicle |
UpdateVehicleAttributes |
|
---|---|---|
Cette API ne permet pas de mettre à jour un seul attribut. Lorsque vous utilisez
cette méthode, toute utilisation de attributes
du masque de champ donne l'ensemble complet de
attributs du véhicule sont à nouveau déclarés pour le véhicule. Tout attribut préexistant qui n'est pas explicitement inclus dans le masque de champ est écrasé. Si vous utilisez cette méthode pour déclarer un nouvel attribut personnalisé, vous devez également déclarer à nouveau tous les attributs personnalisés que vous souhaitez conserver pour le véhicule. Si vous excluez attributes dans le masque de champ, cette méthode laisse les attributs personnalisés existants tels que définis précédemment pour le véhicule. Si vous utilisez attributes dans le masque de champ, mais sans définir de valeurs, cela équivaut à supprimer tous les attributs personnalisés du véhicule.
|
Cette méthode accepte une liste spécifique d'attributs pour mise à jour. La requête ne met à jour ni n'ajoute que les attributs spécifiés dans le masque de champ. Les attributs préexistants qui ne sont pas spécifiés restent inchangés. |
Exemple de mise à jour des champs du véhicule
Cette section explique comment modifier les champs du véhicule avec UpdateVehicleRequest
.
qui inclut un update_mask
pour indiquer les champs à mettre à jour. Pour en savoir plus, consultez la documentation Protocol Buffers sur les masques de champ.
Les modifications apportées à des champs autres que last_location
nécessitent des droits d'administrateur Fleet Engine On-Demand.
Exemple: Activer le nouveau type de trajet et l'attribut personnalisé
Cet exemple active les trajets back_to_back
pour le véhicule et spécifie également un
nouvel attribut: class
. Comme indiqué dans la section Mettre à jour les attributs des véhicules précédemment, pour mettre à jour le champ attributes
à l'aide de cette approche, vous devez indiquer tous les attributs personnalisés que vous souhaitez conserver. Par conséquent, l'exemple montre une valeur cash_only
écrite pour éviter qu'elle ne soit écrasée lors d'une opération de mise à jour qui spécifie le champ attributes
.
Pour ne mettre à jour que la valeur d'une paire d'attributs clé-valeur, utilisez la méthode
UpdateVehicleAttributes
et n'incluez pas le champ attribute
.
dans le masque de champ pour la requête UpdateVehicle
.
Consultez la documentation de référence sur providers.vehicles.update
pour gRPC et 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