Package maps.fleetengine.v1

Index

TripService

Service de gestion des trajets.

CreateTrip

rpc CreateTrip(CreateTripRequest) returns (Trip)

Crée un trajet dans le moteur du parc et renvoie le nouveau trajet.
GetTrip

rpc GetTrip(GetTripRequest) returns (Trip)

Obtenez des informations sur un seul trajet.
ReportBillableTrip

rpc ReportBillableTrip(ReportBillableTripRequest) returns (Empty)

Signaler l'utilisation facturable du trajet.
SearchTrips

rpc SearchTrips(SearchTripsRequest) returns (SearchTripsResponse)

Obtenez tous les trajets d'un véhicule spécifique.
UpdateTrip

rpc UpdateTrip(UpdateTripRequest) returns (Trip)

Met à jour les données du trajet.

VehicleService

Service de gestion de véhicules

CreateVehicle

rpc CreateVehicle(CreateVehicleRequest) returns (Vehicle)

Instancie un nouveau véhicule associé à un fournisseur de services de partage de course à la demande ou de livraison. Chaque Vehicle doit avoir un ID de véhicule unique.

Les champs Vehicle suivants sont obligatoires lors de la création d'une Vehicle:

  • vehicleState
  • supportedTripTypes
  • maximumCapacity
  • vehicleType

Les champs Vehicle suivants sont ignorés lors de la création d'une Vehicle:

  • name
  • currentTrips
  • availableCapacity
  • current_route_segment
  • current_route_segment_end_point
  • current_route_segment_version
  • current_route_segment_traffic
  • route
  • waypoints
  • waypoints_version
  • remaining_distance_meters
  • remaining_time_seconds
  • eta_to_next_waypoint
  • navigation_status

Tous les autres champs sont facultatifs et sont utilisés s'ils sont renseignés.
GetVehicle

rpc GetVehicle(GetVehicleRequest) returns (Vehicle)

Renvoie un véhicule du parc Fleet Engine.
ListVehicles

rpc ListVehicles(ListVehiclesRequest) returns (ListVehiclesResponse)

Affiche une liste paginée des véhicules associés à un fournisseur qui correspondent aux options de requête.
SearchFuzzedVehicles

rpc SearchFuzzedVehicles(SearchVehiclesRequest) returns (SearchVehiclesResponse)

Obsolète: utilisez plutôt SearchVehicles.
SearchVehicles

rpc SearchVehicles(SearchVehiclesRequest) returns (SearchVehiclesResponse)

Renvoie la liste des véhicules correspondant aux options de la requête.
UpdateVehicle

rpc UpdateVehicle(UpdateVehicleRequest) returns (Vehicle)

Écrit les données mises à jour du véhicule dans Fleet Engine.

Lors de la mise à jour d'un Vehicle, les champs suivants ne peuvent pas être mis à jour, car ils sont gérés par le serveur:

  • currentTrips
  • availableCapacity
  • current_route_segment_version
  • waypoints_version

Impossible de mettre à jour le véhicule name non plus.

Si le champ attributes est mis à jour, tous les attributs du véhicule sont remplacés par ceux fournis dans la requête. Si vous ne souhaitez mettre à jour que certains attributs, reportez-vous à la méthode UpdateVehicleAttributes. De même, le champ waypoints peut être mis à jour, mais il doit contenir tous les points de cheminement actuels du véhicule, et aucun autre.
UpdateVehicleAttributes

rpc UpdateVehicleAttributes(UpdateVehicleAttributesRequest) returns (UpdateVehicleAttributesResponse)

Met à jour partiellement les attributs d'un véhicule. Seuls les attributs mentionnés dans la requête seront mis à jour. Les autres attributs ne seront PAS modifiés. Remarque: ce n'est pas le cas dans UpdateVehicle, où l'intégralité du champ attributes est remplacée par celle de UpdateVehicleRequest et les attributs qui ne figurent pas dans la requête sont supprimés.
UpdateVehicleLocation

rpc UpdateVehicleLocation(UpdateVehicleLocationRequest) returns (VehicleLocation)

Obsolète: utilisez plutôt la méthode UpdateVehicle. La fonction UpdateVehicleLocation met à jour la position du véhicule.

BatteryInfo

Informations sur la batterie de l'appareil.

Champs
battery_status

BatteryStatus

État de la batterie, qu'elle soit pleine, en charge, etc.
power_source

PowerSource

État de la source d'alimentation de la batterie.
battery_percentage

float

Pourcentage actuel de la batterie [0-100].

BatteryStatus

État de la batterie, qu'elle soit pleine, en charge, etc.

Enums
UNKNOWN_BATTERY_STATUS État de la batterie inconnu.
BATTERY_STATUS_CHARGING La batterie est en cours de chargement.
BATTERY_STATUS_DISCHARGING La batterie est en cours de décharge.
BATTERY_STATUS_FULL La batterie est pleine.
BATTERY_STATUS_NOT_CHARGING La batterie ne se recharge pas.
BATTERY_STATUS_POWER_LOW La batterie est faible.

BillingPlatformIdentifier

Ensemble de valeurs qui indiquent la plate-forme sur laquelle la requête a été envoyée.

Enums
BILLING_PLATFORM_IDENTIFIER_UNSPECIFIED Par défaut. Utilisé pour les plates-formes non spécifiées.
SERVER La plate-forme est un serveur client.
WEB La plate-forme est un navigateur Web.
ANDROID La plate-forme est un appareil mobile Android.
IOS La plate-forme est un appareil mobile iOS.
OTHERS Autres plates-formes non listées dans cette énumération.

ConsumableTrafficPolyline

Densité du trafic le long du parcours d'un véhicule.

Champs
speed_reading_interval[]

SpeedReadingInterval

Vitesse du trafic le long du chemin entre le point de cheminement précédent et le point de cheminement actuel
encoded_path_to_waypoint

string

Chemin que le conducteur emprunte entre le point de cheminement précédent et le point de cheminement actuel. Ce tracé contient des points de repère afin que les clients puissent y afficher des repères de circulation (voir la section speed_reading_interval). Le décodage n'est pas encore disponible.

CreateTripRequest

CreateTrip request message

Champs
header

RequestHeader

En-tête de requête Fleet Engine standard.
parent

string

Obligatoire. Doit se présenter sous la forme providers/{provider}. Le fournisseur doit correspondre à l'ID du projet Google Cloud (par exemple, sample-cloud-project) auquel appartient le compte de service effectuant cet appel.
trip_id

string

Obligatoire. Identifiant de trajet unique. Offre soumise aux restrictions suivantes:

  • Vous devez saisir une chaîne Unicode valide.
  • La longueur ne doit pas dépasser 64 caractères.
  • Normalisée conformément au formulaire de normalisation Unicode C.
  • Ne doit contenir aucun des caractères ASCII suivants: "/", ":", "?", ""," ou "#".
trip

Trip

Obligatoire. Entité de voyage à créer.

Lorsque vous créez un trajet, les champs suivants sont obligatoires:

  • trip_type
  • pickup_point

Les champs suivants sont utilisés si vous les renseignez:

  • number_of_passengers
  • vehicle_id
  • dropoff_point
  • intermediate_destinations
  • vehicle_waypoints

Tous les autres champs "Trip" sont ignorés. Par exemple, tous les trajets commencent par NEW (trip_status), même si vous transmettez un trip_status de CANCELED dans la requête de création.

Seuls EXCLUSIVE trajets prennent en charge intermediate_destinations.

Lorsque vehicle_id est défini pour un trajet partagé, vous devez fournir la liste Trip.vehicle_waypoints afin d'indiquer l'ordre des points de cheminement restants pour le véhicule. Sinon, l'ordre des points de cheminement sera indéterminé.

Lorsque vous spécifiez Trip.vehicle_waypoints, la liste doit contenir tous les points de cheminement restants des trajets du véhicule, sans points de cheminement supplémentaires. Vous devez ordonner ces points de cheminement de sorte que, pour un trajet donné, le point de départ se trouve avant les destinations intermédiaires, et toutes les destinations intermédiaires avant le point de dépose. Les points de cheminement d'un trajet EXCLUSIVE ne doivent pas s'entrelacer avec d'autres trajets.

Les champs trip_id, waypoint_type et location sont utilisés, et tous les autres champs TripWaypoint de vehicle_waypoints sont ignorés.

CreateVehicleRequest

Message de requête CreateVehicle.

Champs
header

RequestHeader

En-tête de requête Fleet Engine standard.
parent

string

Obligatoire. Doit se présenter sous la forme providers/{provider}. Le fournisseur doit correspondre à l'ID du projet Google Cloud (par exemple, sample-cloud-project) auquel appartient le compte de service effectuant cet appel.
vehicle_id

string

Obligatoire. ID unique du véhicule. Offre soumise aux restrictions suivantes:

  • Vous devez saisir une chaîne Unicode valide.
  • La longueur ne doit pas dépasser 64 caractères.
  • Normalisée conformément au formulaire de normalisation Unicode C.
  • Ne doit contenir aucun des caractères ASCII suivants: "/", ":", "?", ""," ou "#".
vehicle

Vehicle

Obligatoire. Entité Véhicule à créer. Lorsque vous créez un véhicule, les champs suivants sont obligatoires:

  • vehicleState
  • supportedTripTypes
  • maximumCapacity
  • vehicleType

Lorsque vous créez un véhicule, les champs suivants sont ignorés:

  • name
  • currentTrips
  • availableCapacity
  • current_route_segment
  • current_route_segment_end_point
  • current_route_segment_version
  • current_route_segment_traffic
  • route
  • waypoints
  • waypoints_version
  • remaining_distance_meters
  • remaining_time_seconds
  • eta_to_next_waypoint
  • navigation_status

Tous les autres champs sont facultatifs et sont utilisés s'ils sont renseignés.

DeviceSettings

Informations relatives aux différents paramètres de l'appareil mobile.

Champs
location_power_save_mode

LocationPowerSaveMode

Comment les fonctionnalités de localisation sont configurées pour se comporter sur l'appareil lorsque l'économiseur de batterie est activé.
is_power_save_mode

bool

Indique si l'appareil est actuellement en mode Économie d'énergie.
is_interactive

bool

Indique si l'appareil est en état interactif.
battery_info

BatteryInfo

Informations sur l'état de la batterie.

GetTripRequest

GetTrip request message.

Champs
header

RequestHeader

En-tête de requête Fleet Engine standard.
name

string

Obligatoire. Doit se présenter sous la forme providers/{provider}/trips/{trip}. Le fournisseur doit correspondre à l'ID du projet Google Cloud (par exemple, sample-cloud-project) auquel appartient le compte de service effectuant cet appel.
view

TripView

Sous-ensemble de champs "Trip" devant être renvoyés et leur interprétation.
current_route_segment_version

Timestamp

Indique l'horodatage minimal (exclusif) pour lequel les données Trip.route ou Trip.current_route_segment sont récupérées. Si les données de l'itinéraire ne sont pas modifiées depuis cet horodatage, le champ "route" n'est pas défini dans la réponse. Si aucune valeur minimale n'est spécifiée, les données de l'itinéraire sont toujours récupérées.
remaining_waypoints_version

Timestamp

Indique l'horodatage minimal (exclusif) pour lequel des Trip.remaining_waypoints sont récupérées. Si elles ne sont pas modifiées depuis cet horodatage, les remaining_waypoints ne sont pas définis dans la réponse. Si ce champ n'est pas spécifié, remaining_waypoints est toujours récupéré.
route_format_type

PolylineFormatType

Format d'itinéraire actuel renvoyé, LAT_LNG_LIST_TYPE (dans Trip.route) ou ENCODED_POLYLINE_TYPE (dans Trip.current_route_segment). La valeur par défaut est LAT_LNG_LIST_TYPE.
current_route_segment_traffic_version

Timestamp

Indique l'horodatage minimal (exclusif) pour lequel Trip.current_route_segment_traffic est récupéré. Si les données de trafic ne sont pas modifiées depuis cet horodatage, le champ current_route_segment_traffic n'est pas défini dans la réponse. Si aucun minimum n'est spécifié, les données de trafic sont toujours récupérées. Notez que le trafic n'est disponible que pour les clients de la solution On-demand Rides and Deliveries.
remaining_waypoints_route_version

Timestamp

Indique l'horodatage minimal (exclusif) pour lequel les données Trip.remaining_waypoints.traffic_to_waypoint et Trip.remaining_waypoints.path_to_waypoint sont récupérées. Si les données ne sont pas modifiées depuis cet horodatage, les champs ci-dessus ne sont pas définis dans la réponse. Si remaining_waypoints_route_version n'est pas spécifié, le trafic et le chemin d'accès sont toujours récupérés.

GetVehicleRequest

Message de requête GetVehicle.

Champs
header

RequestHeader

En-tête de requête Fleet Engine standard.
name

string

Obligatoire. Doit se présenter sous la forme providers/{provider}/vehicles/{vehicle}. Le fournisseur doit correspondre à l'ID du projet Google Cloud (par exemple, sample-cloud-project) auquel appartient le compte de service effectuant cet appel.
current_route_segment_version

Timestamp

Indique l'horodatage minimal (exclusif) pour lequel Vehicle.current_route_segment est récupéré. Si la route n'est pas modifiée depuis ce code temporel, le champ current_route_segment n'est pas défini dans la réponse. Si aucune valeur minimale n'est spécifiée, la valeur current_route_segment est toujours récupérée.
waypoints_version

Timestamp

Indique l'horodatage minimal (exclusif) pour lequel les données Vehicle.waypoints sont récupérées. Si les points de cheminement ne sont pas modifiés depuis cet horodatage, les données vehicle.waypoints ne sont pas définies dans la réponse. Si ce champ n'est pas spécifié, vehicle.waypoints est toujours récupéré.

LicensePlate

Informations sur la plaque d'immatriculation du véhicule. Pour éviter de stocker des informations permettant d'identifier personnellement l'utilisateur, seules les informations minimales concernant la plaque d'immatriculation sont incluses dans l'entité.

Champs
country_code

string

Obligatoire. Code pays/région CLDR. Par exemple, US pour les États-Unis ou IN pour l'Inde.
last_character

string

La plaque d'immatriculation contient le dernier chiffre de la plaque d'immatriculation ou "-1" pour indiquer qu'aucune valeur numérique n'est indiquée.

  • "ABC 1234" -> "4"
  • "AB 123 CD" -> "3"
  • "ABCDEF" -> "-1"

ListVehiclesRequest

Message de requête ListVehicles.

Champs
header

RequestHeader

En-tête de requête Fleet Engine standard.
parent

string

Obligatoire. Doit se présenter sous la forme providers/{provider}. Le fournisseur doit correspondre à l'ID du projet Google Cloud (par exemple, sample-cloud-project) auquel appartient le compte de service effectuant cet appel.
page_size

int32

Nombre maximal de véhicules à retourner. Valeur par défaut: 100.
page_token

string

Valeur de next_page_token fournie par un appel précédent à ListVehicles afin que vous puissiez paginer des groupes de véhicules. La valeur n'est pas définie si les critères de filtre de la requête ne sont pas identiques à ceux de l'appel précédent de ListVehicles.
minimum_capacity

Int32Value

Spécifie la capacité minimale requise pour le véhicule. Tous les véhicules renvoyés auront une valeur maximum_capacity supérieure ou égale à cette valeur. Si ce champ est défini, il doit être supérieur ou égal à 0.
trip_types[]

TripType

Limite la réponse aux véhicules qui acceptent au moins l'un des types de trajets spécifiés.
maximum_staleness

Duration

Limite la réponse aux véhicules qui ont envoyé des mises à jour de position à Fleet Engine pendant la durée spécifiée. Les véhicules fixes qui transmettent toujours leur position ne sont pas considérés comme obsolètes. Si ce champ est présent, doit être une durée positive valide.
vehicle_type_categories[]

Category

Obligatoire. Limite la réponse aux véhicules appartenant à l'une des catégories de type spécifiées. UNKNOWN : non autorisé.
required_attributes[]

string

Les appelants peuvent former des opérations logiques complexes en utilisant n'importe quelle combinaison des champs required_attributes, required_one_of_attributes et required_one_of_attribute_sets.

required_attributes est une liste. required_one_of_attributes utilise un message qui autorise une liste de listes. Combinés, les deux champs permettent de composer cette expression:

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(required_one_of_attributes[0][0] OR required_one_of_attributes[0][1] OR
...)
AND
(required_one_of_attributes[1][0] OR required_one_of_attributes[1][1] OR
...)

Limite la réponse aux véhicules avec les attributs spécifiés. Ce champ est une opération de conjonction/AND. Un maximum de 50 Required_attributes est autorisé. Ce nombre correspond au nombre maximal d'attributs autorisé sur un véhicule. Chaque chaîne répétée doit être au format "clé:valeur".
required_one_of_attributes[]

string

Limite la réponse aux véhicules ayant au moins l'un des attributs spécifiés dans chaque VehicleAttributeList. Dans chaque liste, un véhicule doit correspondre à au moins l'un des attributs. Ce champ est une opération de disjonction/OU inclusive dans chaque VehicleAttributeList et une opération de conjonction/ET dans l'ensemble de l'ensemble de VehicleAttributeList. Chaque chaîne répétée doit être au format "clé1:valeur1|clé2:valeur2|clé3:valeur3".
required_one_of_attribute_sets[]

string

required_one_of_attribute_sets offre des fonctionnalités supplémentaires.

À l'instar de required_one_of_attributes, required_one_of_attribute_sets utilise un message qui autorise une liste de listes, en autorisant les expressions comme celle-ci:

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(
  (required_one_of_attribute_sets[0][0] AND
  required_one_of_attribute_sets[0][1] AND
  ...)
  OR
  (required_one_of_attribute_sets[1][0] AND
  required_one_of_attribute_sets[1][1] AND
  ...)
)

Limite la réponse aux véhicules qui correspondent à tous les attributs d'un VehicleAttributeList. Dans chaque liste, un véhicule doit correspondre à tous les attributs. Ce champ est une opération de conjonction/AND dans chaque VehicleAttributeList et une opération de disjonction/OU inclusive dans l'ensemble de VehicleAttributeList. Chaque chaîne répétée doit être au format "clé1:valeur1|clé2:valeur2|clé3:valeur3".
vehicle_state

VehicleState

Limite la réponse aux véhicules associés à cet état.
on_trip_only

bool

Ne renvoyez que les véhicules associés au ou aux trajets en cours.
filter

string

Facultatif. Requête de filtre à appliquer lorsque vous listez des véhicules. Consultez la page http://aip.dev/160 pour obtenir des exemples de syntaxe de filtre.

Ce champ est conçu pour remplacer les champs required_attributes, required_one_of_attributes et required_one_of_attributes_sets. Si une valeur non vide est spécifiée ici, les champs suivants doivent être vides: required_attributes, required_one_of_attributes et required_one_of_attributes_sets.

Ce filtre fonctionne comme une clause ET avec d'autres contraintes, telles que vehicle_state ou on_trip_only.

Notez que les seules requêtes acceptées concernent les attributs de véhicule (par exemple, attributes.<key> = <value> ou attributes.<key1> = <value1> AND attributes.<key2> = <value2>). Le nombre maximal de restrictions autorisées dans une requête de filtre est de 50.

De plus, tous les attributs sont stockés sous forme de chaînes. Par conséquent, les seules comparaisons possibles avec les attributs sont des comparaisons de chaînes. Pour effectuer une comparaison avec des valeurs numériques ou booléennes, les valeurs doivent être explicitement placées entre guillemets pour être traitées en tant que chaînes (par exemple, attributes.<key> = "10" ou attributes.<key> = "true").
viewport

Viewport

Facultatif. Un filtre qui limite les véhicules renvoyés à ceux dont la dernière position connue se trouvait dans la zone rectangulaire définie par la fenêtre d'affichage.

ListVehiclesResponse

Message de réponse ListVehicles.

Champs
vehicles[]

Vehicle

Véhicules correspondant aux critères de la demande. Le nombre maximal de véhicules renvoyés est déterminé par le champ page_size de la requête.
next_page_token

string

Jeton permettant de récupérer la page de véhicules suivante ou vide si plus aucun véhicule ne répond aux critères de la requête.
total_size

int64

Obligatoire. Nombre total de véhicules correspondant aux critères de la demande sur l'ensemble des pages.

LocationPowerSaveMode

La manière dont les fonctionnalités de localisation sont configurées pour se comporter sur l'appareil mobile lorsque la fonctionnalité "Économiseur de batterie" est activée. (https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())

Enums
UNKNOWN_LOCATION_POWER_SAVE_MODE LocationPowerSaveMode non défini
LOCATION_MODE_NO_CHANGE L'économiseur de batterie n'a aucune incidence sur les fournisseurs de localisation, ou l'économiseur de batterie est désactivé.
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF Le fournisseur de localisation basé sur le GPS doit être désactivé lorsque l'économiseur de batterie est activé et que l'appareil n'est pas interactif.
LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF Tous les fournisseurs de localisation doivent être désactivés lorsque l'économiseur de batterie est activé et que l'appareil n'est pas interactif.
LOCATION_MODE_FOREGROUND_ONLY Tous les fournisseurs de localisation resteront disponibles, mais les corrections de position ne doivent être fournies qu'aux applications au premier plan.
LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF La localisation n'est pas désactivée, mais LocationManager limite toutes les demandes adressées aux fournisseurs lorsque l'appareil n'est pas interactif.

LocationSensor

Capteur ou méthodologie utilisé pour déterminer la position

Enums
UNKNOWN_SENSOR Le capteur n'est pas spécifié ou est inconnu.
GPS GPS ou GPS assisté.
NETWORK GPS assisté, identification d’antenne-relais ou point d’accès Wi-Fi.
PASSIVE ID d'antenne-relais ou point d'accès Wi-Fi.
ROAD_SNAPPED_LOCATION_PROVIDER Emplacement déterminé par l'appareil mobile comme étant la position la plus probable sur la route.
CUSTOMER_SUPPLIED_LOCATION Site fourni par le client par une source indépendante. Généralement, cette valeur est utilisée pour un emplacement fourni à partir de sources autres que l'appareil mobile exécutant Driver SDK. Si la source originale est décrite par l'une des autres valeurs d'énumération, utilisez-la. Les lieux marqués CUSTOMER_SUPPLIED_LOCATION sont généralement indiqués via le champ last_location.supplemental_location_sensor du véhicule.
FLEET_ENGINE_LOCATION Emplacement calculé par Fleet Engine en fonction des signaux disponibles. Uniquement en sortie. Cette valeur sera refusée si elle est reçue dans une requête.
FUSED_LOCATION_PROVIDER Fused Location Provider d'Android
CORE_LOCATION Fournisseur de localisation sur les systèmes d'exploitation Apple.

État de la navigation du véhicule.

Enums
UNKNOWN_NAVIGATION_STATUS État de navigation non spécifié.
NO_GUIDANCE La navigation de l'application Conducteur est en mode FREE_NAV.
ENROUTE_TO_DESTINATION La navigation détaillée est disponible, et l'application Conducteur est passée en mode GUIDED_NAV.
OFF_ROUTE Le véhicule a quitté l'itinéraire suggéré.
ARRIVED_AT_DESTINATION Le véhicule se trouve dans un rayon d'environ 50 mètres autour de la destination.

PolylineFormatType

Type de format de polyligne.

Enums
UNKNOWN_FORMAT_TYPE Le format n'est pas spécifié ou est inconnu.
LAT_LNG_LIST_TYPE Liste de google.type.LatLng.
ENCODED_POLYLINE_TYPE Polyligne encodée avec un algorithme de compression de polylignes. Le décodage n'est pas encore pris en charge.

PowerSource

Type de chargeur utilisé pour charger la batterie.

Enums
UNKNOWN_POWER_SOURCE Source d'alimentation inconnue.
POWER_SOURCE_AC La source d'alimentation doit être un chargeur secteur.
POWER_SOURCE_USB La source d'alimentation est un port USB.
POWER_SOURCE_WIRELESS La source d'alimentation est sans fil.
POWER_SOURCE_UNPLUGGED La batterie est débranchée.

ReportBillableTripRequest

Message de requête ReportFactTrip.

Champs
name

string

Obligatoire. Doit se présenter sous la forme providers/{provider}/billableTrips/{billable_trip}. Le fournisseur doit correspondre à l'ID du projet Google Cloud (par exemple, sample-cloud-project) auquel appartient le compte de service effectuant cet appel.
country_code

string

Obligatoire. Code à deux lettres du pays où a lieu le trajet. Le prix est défini en fonction du code pays.
platform

BillingPlatformIdentifier

Plate-forme sur laquelle la demande a été envoyée.
related_ids[]

string

Identifiants directement liés au trajet signalé. Il s'agit généralement des identifiants (par exemple, des identifiants de session) d'opérations de pré-réservation effectuées avant que l'identifiant de voyage ne soit disponible. Le nombre d'related_ids est limité à 50.
solution_type

SolutionType

Type de solution produit GMP (par exemple, ON_DEMAND_RIDESHARING_AND_DELIVERIES) utilisé pour le trajet signalé.

SolutionType

Sélecteur pour différents types de solutions pour un trajet signalé.

Enums
SOLUTION_TYPE_UNSPECIFIED Valeur par défaut. Pour assurer la rétrocompatibilité, l'API utilisera par défaut ON_DEMAND_RIDESHARING_AND_DELIVERIES, qui est le premier type de solution compatible.
ON_DEMAND_RIDESHARING_AND_DELIVERIES La solution consiste à proposer un service de partage de course et de livraison à la demande.

RequestHeader

"RequestHeader" contient des champs communs à toutes les requêtes RPC Fleet Engine.

Champs
language_code

string

Code de langue BCP-47, tel que en-US ou sr-Latn. Pour en savoir plus, consultez la page http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Si aucun des deux n'est spécifié, la réponse peut être rédigée dans n'importe quelle langue, avec une préférence pour l'anglais si un tel nom existe. Exemple de valeur de champ: en-US.
region_code

string

Obligatoire. Code CLDR de la région d'origine de la requête. Exemple de valeur de champ: US.
sdk_version

string

Version du SDK appelant, le cas échéant. Le format de la version est "major.minor.patch". Exemple: 1.1.2.
os_version

string

Version du système d'exploitation sur lequel le SDK appelant est exécuté. Exemples de valeurs de champs: 4.4.1, 12.1.
device_model

string

Modèle de l'appareil sur lequel le SDK appelant est exécuté. Exemples de valeurs de champs: iPhone12,1, SM-G920F.
sdk_type

SdkType

Type de SDK qui envoie la requête.
maps_sdk_version

string

Version du MapSDK dont dépend le SDK appelant, le cas échéant. Le format de la version est "major.minor.patch". Exemple: 5.2.1.
nav_sdk_version

string

Version du NavSDK dont dépend le SDK appelant, le cas échéant. Le format de la version est "major.minor.patch". Exemple: 2.1.0.
platform

Platform

Plate-forme du SDK appelant.
manufacturer

string

Fabricant de l'appareil Android à partir du SDK appelant (applicable uniquement aux SDK Android). Exemple de valeur de champ: Samsung.
android_api_level

int32

Niveau d'API Android du SDK appelant, applicable uniquement aux SDK Android. Exemple de valeur de champ: 23.
trace_id

string

ID facultatif pouvant être fourni à des fins de journalisation afin d'identifier la requête.

Plate-forme

Plate-forme du SDK appelant.

Enums
PLATFORM_UNSPECIFIED Valeur par défaut. Cette valeur est utilisée si la plate-forme est omise.
ANDROID La requête provient d'Android.
IOS La requête provient d'iOS.
WEB La requête provient du Web.

SdkType

Types de SDK possibles.

Enums
SDK_TYPE_UNSPECIFIED Valeur par défaut. Cette valeur est utilisée si sdk_type est omis.
CONSUMER Le SDK appelant est Consumer.
DRIVER Le SDK appelant est Driver.
JAVASCRIPT Le SDK appelant est JavaScript.

SearchTripsRequest

Message de demande SearchTrips.

Champs
header

RequestHeader

En-tête de requête Fleet Engine standard.
parent

string

Obligatoire. Doit se présenter sous la forme providers/{provider}. Le fournisseur doit correspondre à l'ID du projet Google Cloud (par exemple, sample-cloud-project) auquel appartient le compte de service effectuant cet appel.
vehicle_id

string

Véhicule associé aux trajets de la requête. S'ils ne sont pas spécifiés, les trajets renvoyés ne contiennent pas:

  • current_route_segment
  • remaining_waypoints
  • remaining_distance_meters
  • eta_to_first_waypoint
active_trips_only

bool

Si la valeur est "true", la réponse inclut les trajets qui influencent l'itinéraire d'un conducteur.
page_size

int32

Si cette règle n'est pas configurée, le serveur décide du nombre de résultats à renvoyer.
page_token

string

Définissez ce paramètre sur une valeur précédemment renvoyée dans SearchTripsResponse pour reprendre à partir des résultats précédents.
minimum_staleness

Duration

Si cette valeur est spécifiée, renvoie les trajets qui n'ont pas été mis à jour après l'heure (current - minimum_staleness).

SearchTripsResponse

Message de réponse SearchTrips.

Champs
trips[]

Trip

Liste des trajets pour le véhicule demandé.
next_page_token

string

Transmettez ce jeton dans SearchTripsRequest pour parcourir les résultats de la liste. L'API renvoie une liste de trajets à chaque appel, et lorsqu'il ne reste plus de résultats, la liste de trajets est vide.

SearchVehiclesRequest

Message de requête SearchVehicles.

Champs
header

RequestHeader

En-tête de requête Fleet Engine standard.
parent

string

Obligatoire. Doit se présenter sous la forme providers/{provider}. Le fournisseur doit correspondre à l'ID du projet Google Cloud (par exemple, sample-cloud-project) auquel appartient le compte de service effectuant cet appel.
pickup_point

TerminalLocation

Obligatoire. Point de retrait à proximité.
dropoff_point

TerminalLocation

Le lieu de dépôt prévu par le client. Ce champ est obligatoire si trip_types contient TripType.SHARED.
pickup_radius_meters

int32

Obligatoire. Définit le rayon de recherche du véhicule autour du point de prise en charge. Seuls les véhicules situés dans le rayon de recherche s'affichent. La valeur doit être comprise entre 400 et 10 000 mètres (inclus).
count

int32

Obligatoire. Spécifie le nombre maximal de véhicules à renvoyer. La valeur doit être comprise entre 1 et 50 (inclus).
minimum_capacity

int32

Obligatoire. Indique le nombre de passagers pris en compte pour un trajet. La valeur doit être supérieure ou égale à un. Le pilote n'est pas pris en compte dans la valeur de capacité.
trip_types[]

TripType

Obligatoire. Représente le type de trajet proposé. Doit inclure exactement un type. UNKNOWN_TRIP_TYPE : non autorisé. Limite la recherche aux seuls véhicules pouvant prendre en charge ce type de trajet.
maximum_staleness

Duration

Limite la recherche aux seuls véhicules ayant envoyé des mises à jour de position à Fleet Engine pendant la durée spécifiée. Les véhicules fixes qui transmettent toujours leur position ne sont pas considérés comme obsolètes. Si ce champ n'est pas défini, le serveur utilise cinq minutes comme valeur par défaut.
vehicle_types[]

VehicleType

Obligatoire. Limite la recherche aux véhicules correspondant à l'un des types spécifiés. Vous devez spécifier au moins un type de véhicule. Les VehicleTypes de catégorie UNKNOWN ne sont pas autorisés.
required_attributes[]

VehicleAttribute

Les appelants peuvent former des opérations logiques complexes en utilisant n'importe quelle combinaison des champs required_attributes, required_one_of_attributes et required_one_of_attribute_sets.

required_attributes est une liste. required_one_of_attributes utilise un message qui autorise une liste de listes. Combinés, les deux champs permettent de composer cette expression:

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(required_one_of_attributes[0][0] OR required_one_of_attributes[0][1] OR
...)
AND
(required_one_of_attributes[1][0] OR required_one_of_attributes[1][1] OR
...)

Limite la recherche aux seuls véhicules disposant des attributs spécifiés. Ce champ est une opération de conjonction/AND. Un maximum de 50 Required_attributes est autorisé. Ce nombre correspond au nombre maximal d'attributs autorisé sur un véhicule.
required_one_of_attributes[]

VehicleAttributeList

Limite la recherche aux seuls véhicules ayant au moins l'un des attributs spécifiés dans chaque VehicleAttributeList. Dans chaque liste, un véhicule doit correspondre à au moins l'un des attributs. Ce champ est une opération de disjonction/OU inclusive dans chaque VehicleAttributeList et une opération de conjonction/ET dans l'ensemble de l'ensemble de VehicleAttributeList.
required_one_of_attribute_sets[]

VehicleAttributeList

required_one_of_attribute_sets offre des fonctionnalités supplémentaires.

À l'instar de required_one_of_attributes, required_one_of_attribute_sets utilise un message qui autorise une liste de listes, en autorisant les expressions comme celle-ci:

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(
  (required_one_of_attribute_sets[0][0] AND
  required_one_of_attribute_sets[0][1] AND
  ...)
  OR
  (required_one_of_attribute_sets[1][0] AND
  required_one_of_attribute_sets[1][1] AND
  ...)
)

Limite la recherche aux seuls véhicules ayant tous les attributs d'un VehicleAttributeList. Dans chaque liste, un véhicule doit correspondre à tous les attributs. Ce champ est une opération de conjonction/AND dans chaque VehicleAttributeList et une opération de disjonction/OU inclusive dans l'ensemble de VehicleAttributeList.
order_by

VehicleMatchOrder

Obligatoire. Spécifie le critère de classement souhaité pour les résultats.
include_back_to_back

bool

Indique si les véhicules effectuant un seul trajet actif sont éligibles pour cette recherche. Ce champ n'est utilisé que lorsque current_trips_present n'est pas spécifié. Lorsque current_trips_present n'est pas spécifié et que ce champ est défini sur false, les véhicules associés à des trajets sont exclus des résultats de recherche. Lorsque current_trips_present n'est pas spécifié et que ce champ est défini sur true, les résultats de recherche peuvent inclure des véhicules avec un trajet actif dont l'état est ENROUTE_TO_DROPOFF. Lorsque current_trips_present est spécifié, ce champ ne peut pas être défini sur "true".

La valeur par défaut est false.
trip_id

string

Indique le trajet associé à ce SearchVehicleRequest.
current_trips_present

CurrentTripsPresent

Indique si les véhicules avec des trajets actifs sont éligibles pour cette recherche. Il doit être défini sur une valeur autre que CURRENT_TRIPS_PRESENT_UNSPECIFIED si trip_type inclut SHARED.
filter

string

Facultatif. Requête de filtre à appliquer lorsque vous recherchez des véhicules. Consultez la page http://aip.dev/160 pour obtenir des exemples de syntaxe de filtre.

Ce champ est conçu pour remplacer les champs required_attributes, required_one_of_attributes et required_one_of_attributes_sets. Si une valeur non vide est spécifiée ici, les champs suivants doivent être vides: required_attributes, required_one_of_attributes et required_one_of_attributes_sets.

Ce filtre fonctionne comme une clause ET avec d'autres contraintes, telles que minimum_capacity ou vehicle_types.

Notez que les seules requêtes acceptées concernent les attributs de véhicule (par exemple, attributes.<key> = <value> ou attributes.<key1> = <value1> AND attributes.<key2> = <value2>). Le nombre maximal de restrictions autorisées dans une requête de filtre est de 50.

De plus, tous les attributs sont stockés sous forme de chaînes. Par conséquent, les seules comparaisons possibles avec les attributs sont des comparaisons de chaînes. Pour effectuer une comparaison avec des valeurs numériques ou booléennes, les valeurs doivent être explicitement placées entre guillemets pour être traitées en tant que chaînes (par exemple, attributes.<key> = "10" ou attributes.<key> = "true").

CurrentTripsPresent

Spécifie les types de restrictions appliquées aux trajets actuels d'un véhicule.

Enums
CURRENT_TRIPS_PRESENT_UNSPECIFIED La disponibilité des véhicules comportant des trajets est régie par le champ include_back_to_back.
NONE Les véhicules sans trajets peuvent figurer dans les résultats de recherche. Lorsque cette valeur est utilisée, include_back_to_back ne peut pas être true.
ANY Les véhicules avec un maximum de cinq trajets actuels et de 10 points de cheminement sont inclus dans les résultats de recherche. Lorsque cette valeur est utilisée, include_back_to_back ne peut pas être true.

VehicleMatchOrder

Spécifie l'ordre dans lequel les véhicules correspondent dans la réponse.

Enums
UNKNOWN_VEHICLE_MATCH_ORDER Valeur par défaut, utilisée pour l'ordre de correspondance des véhicules non spécifié ou non reconnu.
PICKUP_POINT_ETA Ordre croissant selon le temps de trajet du véhicule jusqu'au point de prise en charge.
PICKUP_POINT_DISTANCE Ordre croissant selon la distance parcourue par le véhicule jusqu'au point de prise en charge.
DROPOFF_POINT_ETA Ordre croissant (en fonction du temps de trajet du véhicule) jusqu'au point de dépôt Cette commande ne peut être utilisée que si le point de dépôt est spécifié dans la requête.
PICKUP_POINT_STRAIGHT_DISTANCE Ordre croissant selon une distance en ligne droite entre la dernière position signalée du véhicule et le point de prise en charge
COST Ordre croissant en fonction du coût de correspondance configuré. Le coût de correspondance est défini comme un calcul pondéré entre la distance en ligne droite et l'heure d'arrivée prévue. Les pondérations sont définies avec des valeurs par défaut et peuvent être modifiées en fonction du client. Veuillez contacter l'assistance Google si ces pondérations doivent être modifiées pour votre projet.

SearchVehiclesResponse

Message de réponse SearchVehicles.

Champs
matches[]

VehicleMatch

Liste des véhicules correspondant aux critères SearchVehiclesRequest, classés en fonction du champ SearchVehiclesRequest.order_by.

SpeedReadingInterval

Indicateur de densité du trafic sur un segment contigu d'un chemin. Pour un tracé comportant des points P_0, P_1, ... et P_N (index basé sur zéro), SpeedReadingInterval définit un intervalle et décrit son trafic à l'aide des catégories suivantes.

Champs
start_polyline_point_index

int32

Index de départ de cet intervalle dans le chemin. En JSON, lorsque l'index est 0, le champ semble non renseigné.
end_polyline_point_index

int32

Index de fin de cet intervalle dans le chemin. En JSON, lorsque l'index est 0, le champ semble non renseigné.
speed

Speed

Vitesse du trafic dans cet intervalle.

Rapidité

Classification de la vitesse de la polyligne en fonction des données de trafic.

Enums
SPEED_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
NORMAL Vitesse normale, aucun ralentissement détecté
SLOW Ralentissement détecté, mais aucun embouteillage détecté.
TRAFFIC_JAM Embouteillage détecté.

StopLocation

Lieu réel où un arrêt (prise en charge/dépôt) s'est produit.

Champs
point

LatLng

Obligatoire. Indique l'emplacement réel.
timestamp

Timestamp

Indique à quel moment l'arrêt s'est produit.
stop_time
(deprecated)

Timestamp

Uniquement en entrée. Obsolète. Utilisez le champ d'horodatage.

TerminalLocation

Décrit l'emplacement d'un point de cheminement.

Champs
point

LatLng

Obligatoire. Indique l'emplacement d'un point de cheminement du trajet.
terminal_point_id

TerminalPointId

ID du point de terminaison.
access_point_id
(deprecated)

string

Obsolète.
trip_id
(deprecated)

string

Obsolète.
terminal_location_type
(deprecated)

WaypointType

Obsolète: Vehicle.waypoint contiendra ces données.

TerminalPointId

Identifie un point d'accès final.

Champs
value

string

Identifiant unique du point de terminaison.
Champ d'union Id. Obsolète. Id ne peut être qu'un des éléments suivants :
place_id
(deprecated)

string

Obsolète.
generated_id
(deprecated)

string

Obsolète.

TrafficPolylineData

Conditions de circulation sur l'itinéraire prévu du véhicule.

Champs
traffic_rendering

VisualTrafficReportPolylineRendering

Rendu sous forme de polylignes de la vitesse du trafic dans toutes les régions sur une portion du trajet d'un client.

Trajet

Métadonnées des trajets.

Champs
name

string

Uniquement en sortie. Au format "providers/{provider}/trips/{trip}"
vehicle_id

string

Identifiant du véhicule effectuant ce trajet.
trip_status

TripStatus

État actuel du trajet.
trip_type

TripType

Type de trajet.
pickup_point

TerminalLocation

Lieu où le client indique qu'il sera récupéré.
actual_pickup_point

StopLocation

Uniquement en entrée. Position réelle du moment où le client a été récupéré. Ce champ permet au fournisseur de fournir des commentaires sur les informations réelles de retrait.
actual_pickup_arrival_point

StopLocation

Uniquement en entrée. Heure et lieu réels de l'arrivée du chauffeur au point de prise en charge. Ce champ permet au fournisseur de fournir des commentaires sur les informations d'arrivée réelles au point retrait.
pickup_time

Timestamp

Uniquement en sortie. soit l'heure future estimée de prise en charge du ou des passagers, soit l'heure réelle à laquelle ils seront pris en charge.
intermediate_destinations[]

TerminalLocation

Arrêts intermédiaires pour que le trajet soit demandé (en plus des lieux de prise en charge et de dépose). Dans un premier temps, cette fonctionnalité ne sera pas disponible pour les trajets partagés.
intermediate_destinations_version

Timestamp

Indique la dernière fois que le intermediate_destinations a été modifié. Votre serveur doit mettre en cache cette valeur et la transmettre dans UpdateTripRequest lors de la mise à jour de intermediate_destination_index pour s'assurer que intermediate_destinations n'est pas modifié.
intermediate_destination_index

int32

Lorsque TripStatus est défini sur ENROUTE_TO_INTERMEDIATE_DESTINATION, il s'agit d'un nombre compris entre [0..N-1] et indiquant la destination intermédiaire que le véhicule passera ensuite. Lorsque TripStatus est défini sur ARRIVED_AT_INTERMEDIATE_DESTINATION, il s'agit d'un nombre compris entre [0..N-1] et indiquant à quelle destination intermédiaire se trouve le véhicule. Le fournisseur définit cette valeur. En l'absence de intermediate_destinations, ce champ est ignoré.
actual_intermediate_destination_arrival_points[]

StopLocation

Uniquement en entrée. Heure et lieu réels de l'arrivée du conducteur à une destination intermédiaire. Ce champ permet au fournisseur de fournir des commentaires sur les informations d'arrivée réelles à des destinations intermédiaires.
actual_intermediate_destinations[]

StopLocation

Uniquement en entrée. L'heure et le lieu réels de prise en charge du client à une destination intermédiaire. Ce champ permet au fournisseur de fournir des commentaires sur les informations de retrait réelles aux destinations intermédiaires.
dropoff_point

TerminalLocation

Lieu où le client indique qu'il sera déposé.
actual_dropoff_point

StopLocation

Uniquement en entrée. L'heure et le lieu réels de dépôt et d'arrivée du client. Ce champ permet au fournisseur de fournir des commentaires sur les informations réelles de dépôt.
dropoff_time

Timestamp

Uniquement en sortie. Il peut s'agir de l'heure à laquelle le ou les passagers déposeront le ou les passagers à leur destination finale, ou de l'heure réelle à laquelle ils seront déposés.
remaining_waypoints[]

TripWaypoint

Uniquement en sortie. Chemin complet de l'emplacement actuel au point de dépôt (inclus). Ce chemin peut inclure des points de cheminement d'autres trajets.
vehicle_waypoints[]

TripWaypoint

Ce champ permet d'organiser manuellement les points de cheminement du trajet. Il contient tous les points de cheminement restants du véhicule attribué, ainsi que les points de cheminement de prise en charge et de dépose pour ce trajet. Si le trajet n'a pas été attribué à un véhicule, Fleet Engine ignore ce champ. Pour des raisons de confidentialité, ce champ n'est renseigné par le serveur que lors des appels UpdateTrip et CreateTrip, et NON des appels GetTrip.
route[]

LatLng

Uniquement en sortie. Itinéraire anticipé de ce trajet jusqu'à la première entrée dans left_waypoints (points de cheminement restants). Notez que le premier point de cheminement peut appartenir à un autre trajet.
current_route_segment

string

Uniquement en sortie. Trajet encodé vers le point de cheminement suivant.

Remarque: Ce champ est destiné à être utilisé uniquement par le SDK Driver et le SDK grand public. Le décodage n'est pas encore pris en charge.
current_route_segment_version

Timestamp

Uniquement en sortie. Indique la date et l'heure de la dernière modification de l'itinéraire.

Remarque: Ce champ est destiné à être utilisé uniquement par le SDK Driver et le SDK grand public.
current_route_segment_traffic

ConsumableTrafficPolyline

Uniquement en sortie. Indique les conditions de circulation le long du current_route_segment lorsqu'elles sont disponibles.

Remarque: Ce champ est destiné à être utilisé uniquement par le SDK Driver et le SDK grand public.
current_route_segment_traffic_version

Timestamp

Uniquement en sortie. Indique la dernière fois que le current_route_segment_traffic a été modifié.

Remarque: Ce champ est destiné à être utilisé uniquement par le SDK Driver et le SDK grand public.
current_route_segment_end_point

TripWaypoint

Uniquement en sortie. Point de cheminement où se termine current_route_segment.
remaining_distance_meters

Int32Value

Uniquement en sortie. Distance en voiture restante dans le champ current_route_segment. La valeur n'est pas spécifiée si le trajet n'est pas attribué à un véhicule, ou si le trajet est terminé ou annulé.
eta_to_first_waypoint

Timestamp

Uniquement en sortie. L'heure d'arrivée prévue au point de cheminement suivant (la première entrée dans le champ remaining_waypoints) La valeur n'est pas spécifiée si le trajet n'est attribué à aucun véhicule ou s'il est inactif (terminé ou annulé).
remaining_time_to_first_waypoint

Duration

Uniquement en sortie. Durée entre le renvoi des données du trajet et l'heure indiquée dans Trip.eta_to_first_waypoint. La valeur n'est pas spécifiée si le trajet n'est attribué à aucun véhicule ou s'il est inactif (terminé ou annulé).
remaining_waypoints_version

Timestamp

Uniquement en sortie. Indique la dernière fois que remaining_waypoints a été modifié (un point de cheminement a été ajouté, supprimé ou modifié).
remaining_waypoints_route_version

Timestamp

Uniquement en sortie. Indique la dernière fois que remaining_waypoints.path_to_waypoint et remaining_waypoints.traffic_to_waypoint ont été modifiés. Votre application cliente doit mettre en cache cette valeur et la transmettre dans GetTripRequest pour s'assurer que les chemins d'accès et le trafic de remaining_waypoints ne sont renvoyés que s'ils sont mis à jour.
number_of_passengers

int32

Immuable. Indique le nombre de passagers pour ce trajet (le conducteur n'est pas inclus). Un véhicule doit avoir de la capacité disponible pour être retourné dans une réponse SearchVehicles.
last_location

VehicleLocation

Uniquement en sortie. Indique la dernière position signalée du véhicule sur l'itinéraire.
last_location_snappable

bool

Uniquement en sortie. Indique si le last_location du véhicule peut être ancré au segment_route_actu. "false" si last_location ou current_route_segment n'existe pas. Il est calculé par Fleet Engine. Toute mise à jour des clients sera ignorée.
view

TripView

Sous-ensemble de champs "Trip" renseignés et comment ils doivent être interprétés.

TripStatus

État d'un trajet indiquant sa progression.

Enums
UNKNOWN_TRIP_STATUS Par défaut, utilisé pour l'état du trajet non spécifié ou non reconnu.
NEW Voyage nouvellement créé.
ENROUTE_TO_PICKUP Le chauffeur se dirige vers le point de prise en charge.
ARRIVED_AT_PICKUP Le chauffeur est arrivé au point de prise en charge.
ARRIVED_AT_INTERMEDIATE_DESTINATION Le chauffeur est arrivé à une destination intermédiaire et attend le passager.
ENROUTE_TO_INTERMEDIATE_DESTINATION Le chauffeur se dirige vers une destination intermédiaire (et non le point de dépose).
ENROUTE_TO_DROPOFF Le chauffeur a pris le passager et se dirige vers la prochaine destination.
COMPLETE Le passager a été déposé et le trajet est terminé.
CANCELED Le trajet a été annulé avant la prise en charge par le conducteur, le passager ou le fournisseur de services de covoiturage.

TripType

Type de trajet.

Enums
UNKNOWN_TRIP_TYPE Par défaut, utilisé pour les types de trajets non spécifiés ou non reconnus.
SHARED Un véhicule peut être partagé lors d'autres trajets.
EXCLUSIVE Le trajet est réservé à un véhicule.

TripView

Sélecteur pour différents ensembles de champs "Trip" dans une réponse GetTrip. Consultez la page AIP-157 pour plus de contexte. D'autres vues sont susceptibles d'être ajoutées.

Enums
TRIP_VIEW_UNSPECIFIED Valeur par défaut. Pour assurer la rétrocompatibilité, l'API utilise par défaut une vue SDK. Pour des raisons de stabilité et de compatibilité, nous recommandons aux clients de sélectionner une TripView autre que SDK.
SDK Inclut les champs qui peuvent ne pas être interprétables ou pris en charge à l'aide de bibliothèques accessibles au public.
JOURNEY_SHARING_V1S Les champs "Trip" (Trajet) sont renseignés pour le cas d'utilisation du partage de trajet. Cette vue est destinée aux communications de serveur à serveur.

TripWaypoint

Décrit un point d'arrêt sur l'itinéraire d'un véhicule ou le point d'arrivée d'un trajet d'un véhicule.

Champs
location

TerminalLocation

Emplacement de ce point de cheminement.
trip_id

string

Trajet associé à ce point de cheminement.
waypoint_type

WaypointType

Rôle de ce point de cheminement dans le trajet (prise en charge ou dépose, par exemple).
path_to_waypoint[]

LatLng

Chemin du point de cheminement précédent jusqu'au point de cheminement actuel. Non défini pour le premier point de cheminement dans une liste. Ce champ n'est renseigné que sur demande.
encoded_path_to_waypoint

string

Chemin encodé entre le point de cheminement précédent et le point de cheminement actuel.

Remarque: Ce champ est destiné à être utilisé uniquement par le SDK Driver et le SDK grand public. Le décodage n'est pas encore pris en charge.
traffic_to_waypoint

ConsumableTrafficPolyline

Conditions de circulation le long du chemin menant à ce point de cheminement. Notez que le trafic n'est disponible que pour les clients de la solution Trajets et livraisons de Google Maps Platform.
distance_meters

Int32Value

Distance du chemin entre le point de cheminement précédent et le point de cheminement actuel. Non défini pour le premier point de cheminement dans une liste.
eta

Timestamp

Heure d'arrivée estimée à ce point de cheminement. Non défini pour le premier point de cheminement dans une liste.
duration

Duration

Temps de trajet entre le point de cheminement précédent et ce point. Non défini pour le premier point de cheminement dans une liste.

UpdateTripRequest

Message de demande de mise à jour de trajet.

Champs
header

RequestHeader

En-tête de requête Fleet Engine standard.
name

string

Obligatoire. Doit se présenter sous la forme providers/{provider}/trips/{trip}. Le fournisseur doit correspondre à l'ID du projet Google Cloud (par exemple, sample-consumer-project) auquel appartient le compte de service effectuant cet appel.
trip

Trip

Obligatoire. Trajet associé à la mise à jour.

Les champs suivants sont gérés par Fleet Engine. Ne les mettez pas à jour à l'aide de Trip.update.

  • current_route_segment
  • current_route_segment_end_point
  • current_route_segment_traffic
  • current_route_segment_traffic_version
  • current_route_segment_version
  • dropoff_time
  • eta_to_next_waypoint
  • intermediate_destinations_version
  • last_location
  • name
  • number_of_passengers
  • pickup_time
  • remaining_distance_meters
  • remaining_time_to_first_waypoint
  • remaining_waypoints
  • remaining_waypoints_version
  • route

Lorsque vous mettez à jour le Trip.vehicle_id pour un trajet partagé, vous devez fournir la liste Trip.vehicle_waypoints pour indiquer l'ordre des points de cheminement restants. Sinon, l'ordre est indéterminé.

Lorsque vous spécifiez Trip.vehicle_waypoints, la liste doit contenir tous les points de cheminement restants des trajets du véhicule, sans points de cheminement supplémentaires. Vous devez ordonner ces points de cheminement de sorte que, pour un trajet donné, le point de départ se trouve avant les destinations intermédiaires, et toutes les destinations intermédiaires avant le point de dépose. Les points de cheminement d'un trajet EXCLUSIVE ne doivent pas s'entrelacer avec d'autres trajets. Les champs trip_id, waypoint_type et location sont utilisés, et tous les autres champs TripWaypoint de vehicle_waypoints sont ignorés.

Pour éviter une condition de concurrence pour des trajets comportant plusieurs destinations, vous devez fournir Trip.intermediate_destinations_version lorsque l'état du trajet est modifié sur ENROUTE_TO_INTERMEDIATE_DESTINATION. Le Trip.intermediate_destinations_version transmis doit être cohérent avec la version de Fleet Engine. Si ce n'est pas le cas, la requête échoue.
update_mask

FieldMask

Obligatoire. Masque de champ indiquant les champs du trajet à mettre à jour. update_mask doit contenir au moins un champ.

UpdateVehicleAttributesRequest

Message de requête UpdateVehicleAttributes.

Champs
header

RequestHeader

En-tête de requête Fleet Engine standard.
name

string

Obligatoire. Doit se présenter sous la forme providers/{provider}/vehicles/{vehicle}. Le fournisseur doit correspondre à l'ID du projet Google Cloud (par exemple, sample-cloud-project) auquel appartient le compte de service effectuant cet appel.
attributes[]

VehicleAttribute

Obligatoire. Attributs du véhicule à mettre à jour. Les attributs non mentionnés ne sont ni modifiés, ni supprimés.

UpdateVehicleAttributesResponse

Message de réponse UpdateVehicleAttributes.

Champs
attributes[]

VehicleAttribute

Obligatoire. Liste complète des attributs du véhicule mise à jour, y compris les attributs neufs, modifiés et non modifiés.

UpdateVehicleLocationRequest

Message de requête UpdateVehicleLocation.

Champs
header

RequestHeader

En-tête de requête Fleet Engine standard.
name

string

Obligatoire. Doit se présenter sous la forme providers/{provider}/vehicles/{vehicle}. {provider} doit correspondre à l'ID du projet Google Cloud (par exemple, sample-cloud-project) auquel appartient le compte de service qui effectue cet appel.
current_location

VehicleLocation

Obligatoire. Dernière position du véhicule Les sous-champs location et update_time sont obligatoires.
current_state

VehicleState

Définissez l'état du véhicule sur ONLINE ou OFFLINE. S'il est défini sur UNKNOWN_VEHICLE_STATE, l'état du véhicule ne sera pas modifié.

UpdateVehicleRequest

"Message de requête UpdateVehicle.

Champs
header

RequestHeader

En-tête de requête Fleet Engine standard.
name

string

Obligatoire. Doit se présenter sous la forme providers/{provider}/vehicles/{vehicle}. {provider} doit correspondre à l'ID du projet Google Cloud (par exemple, sample-cloud-project) auquel appartient le compte de service qui effectue cet appel.
vehicle

Vehicle

Obligatoire. Valeurs d'entité Vehicle à appliquer. Lors de la mise à jour d'un Vehicle, il est possible que les champs suivants ne soient pas mis à jour, car ils sont gérés par le serveur.

  • available_capacity
  • current_route_segment_version
  • current_trips
  • name
  • waypoints_version

Si le champ attributes est mis à jour, tous les attributs du véhicule sont remplacés par ceux fournis dans la requête. Si vous ne souhaitez mettre à jour que certains attributs, reportez-vous à la méthode UpdateVehicleAttributes.

De même, le champ waypoints peut être mis à jour, mais il doit contenir tous les points de cheminement actuels du véhicule, et aucun autre.
update_mask

FieldMask

Obligatoire. Masque de champ indiquant les champs de Vehicle à mettre à jour. Vous devez indiquer au moins un nom de champ.

Véhicule

Métadonnées du véhicule.

Champs
name

string

Uniquement en sortie. Nom unique du véhicule. Il a le format suivant : providers/{provider}/vehicles/{vehicle}.
vehicle_state

VehicleState

État du véhicule.
supported_trip_types[]

TripType

Types de trajets compatibles avec ce véhicule.
current_trips[]

string

Uniquement en sortie. Liste des trip_id pour les trajets actuellement attribués à ce véhicule.
last_location

VehicleLocation

Dernière position signalée du véhicule.
maximum_capacity

int32

Nombre total de passagers que ce véhicule peut transporter Le conducteur n'est pas pris en compte dans cette valeur. Cette valeur doit être supérieure ou égale à un.
attributes[]

VehicleAttribute

Liste des attributs du véhicule. Un véhicule peut comporter 100 attributs au maximum, chacun d'entre eux devant être associé à une clé unique.
vehicle_type

VehicleType

Obligatoire. Type de ce véhicule. Permet de filtrer les véhicules dans les résultats SearchVehicles. Elle influence également le calcul de l'heure d'arrivée prévue et de l'itinéraire.
license_plate

LicensePlate

Informations sur la plaque d'immatriculation du véhicule.
route[]
(deprecated)

TerminalLocation

Obsolète: utilisez plutôt Vehicle.waypoints.
current_route_segment

string

Polyligne spécifiant l'itinéraire que l'application du conducteur prévoit d'emprunter pour accéder au prochain point de cheminement. Cette liste est également renvoyée dans Trip.current_route_segment pour tous les trajets actifs attribués au véhicule.

Remarque: Ce champ est destiné à être utilisé uniquement par le SDK Driver. Le décodage n'est pas encore pris en charge.
current_route_segment_traffic

TrafficPolylineData

Uniquement en entrée. Fleet Engine utilise ces informations pour améliorer le partage de trajets. Remarque: Ce champ est destiné à être utilisé uniquement par le SDK Driver.
current_route_segment_version

Timestamp

Uniquement en sortie. Heure à laquelle current_route_segment a été défini. Il peut être stocké par le client et transmis dans les futures requêtes GetVehicle pour éviter de renvoyer des routes qui n'ont pas changé.
current_route_segment_end_point

TripWaypoint

Point de cheminement où se termine current_route_segment. Il peut être fourni par les conducteurs lors des appels UpdateVehicle en tant que point de cheminement pour un trajet complet, en tant que point de cheminement LatLng ou en tant que dernier LatLng du current_route_segment. Fleet Engine s'efforcera alors d'interpoler au mieux un point de cheminement réel s'il n'est pas complètement spécifié. Ce champ est ignoré dans les appels UpdateVehicle, sauf si current_route_segment est également spécifié.
remaining_distance_meters

Int32Value

Distance en voiture restante pour le current_route_segment. Cette valeur est également renvoyée dans Trip.remaining_distance_meters pour tous les trajets actifs attribués au véhicule. La valeur n'est pas spécifiée si le champ current_route_segment est vide.
eta_to_first_waypoint

Timestamp

Heure d'arrivée prévue de la première entrée du champ waypoints. La valeur n'est pas spécifiée si le champ waypoints est vide ou si le champ Vehicle.current_route_segment est vide.

Lorsque vous mettez à jour un véhicule, remaining_time_seconds est prioritaire sur eta_to_first_waypoint dans la même requête.
remaining_time_seconds

Int32Value

Uniquement en entrée. Temps de trajet restant pour le current_route_segment. La valeur n'est pas spécifiée si le champ waypoints est vide ou si le champ Vehicle.current_route_segment est vide. Cette valeur doit correspondre à eta_to_first_waypoint - current_time si toutes les parties utilisent la même horloge.

Lorsque vous mettez à jour un véhicule, remaining_time_seconds est prioritaire sur eta_to_first_waypoint dans la même requête.
waypoints[]

TripWaypoint

Points de cheminement restants attribués à ce véhicule.
waypoints_version

Timestamp

Uniquement en sortie. Heure de la dernière mise à jour du champ waypoints. Les clients doivent mettre cette valeur en cache et la transmettre dans GetVehicleRequest pour s'assurer que le champ waypoints n'est renvoyé que s'il est mis à jour.
back_to_back_enabled

bool

Indique si le conducteur accepte les allers-retours. Si la valeur est true, SearchVehicles peut inclure le véhicule même s'il est actuellement attribué à un trajet. La valeur par défaut est false.
navigation_status

NavigationStatus

État de la navigation du véhicule.
device_settings

DeviceSettings

Uniquement en entrée. Informations sur les paramètres de l'appareil mobile utilisé par le conducteur.

VehicleType

Type de véhicule.

Champs
category

Category

Catégorie du type de véhicule

Catégorie

Catégories de type de véhicule

Enums
UNKNOWN Valeur par défaut, utilisée pour les catégories de véhicules non spécifiées ou non reconnues.
AUTO Une voiture.
TAXI Tout véhicule agissant en tant que taxi (généralement agréé ou réglementé).
TRUCK Il s'agit généralement d'un véhicule disposant d'une grande capacité de stockage.
TWO_WHEELER Moto, cyclomoteur ou autre véhicule à deux roues
BICYCLE Transport manuel.
PEDESTRIAN Transporteur humain, généralement en train de marcher ou de courir sur des chemins piétonniers.

VehicleAttribute

Décrit un attribut de véhicule en tant que paire clé-valeur. La chaîne "key:value" ne peut pas dépasser 256 caractères.

Champs
key

string

Clé de l'attribut. Les clés ne doivent pas contenir le caractère deux-points (:).
value

string

Valeur de l'attribut.
Champ d'union vehicle_attribute_value. La valeur de l'attribut peut être de type chaîne, valeur booléenne ou double. vehicle_attribute_value ne peut être qu'un des éléments suivants :
string_value

string

Valeur d'attribut de chaîne.

Remarque: Ce champ est identique au champ value, qui sera à terme abandonné. Pour les méthodes de création ou de mise à jour, vous pouvez utiliser l'un ou l'autre des champs, mais nous vous recommandons vivement d'utiliser string_value. Si string_value et value sont tous les deux définis, ils doivent être identiques, sans quoi une erreur est générée. Les deux champs sont renseignés dans les réponses.
bool_value

bool

Valeur d'attribut de type booléen.
number_value

double

Valeur d'attribut de type double.

VehicleAttributeList

Type de données de type liste de listes pour les attributs du véhicule.

Champs
attributes[]

VehicleAttribute

Liste des attributs de cette collection.

VehicleLocation

Localisation, vitesse et direction d'un véhicule à un moment donné.

Champs
location

LatLng

L'emplacement du véhicule Lorsqu'il est envoyé à Fleet Engine, la position du véhicule est une position GPS. Lorsque vous le recevez dans une réponse, la position du véhicule peut être soit une position GPS, un lieu supplémentaire, soit une autre position estimée. La source est spécifiée dans location_sensor.
horizontal_accuracy
(deprecated)

DoubleValue

Obsolète: utilisez plutôt latlng_accuracy.
latlng_accuracy

DoubleValue

Précision de location en mètres sous forme de rayon
heading

Int32Value

Sens de circulation du véhicule en degrés. 0 représente le nord. La plage valide est [0 360).
bearing_accuracy
(deprecated)

DoubleValue

Obsolète: utilisez plutôt heading_accuracy.
heading_accuracy

DoubleValue

Précision de heading en degrés.
altitude

DoubleValue

Altitude en mètres au-dessus de WGS84.
vertical_accuracy
(deprecated)

DoubleValue

Obsolète: utilisez plutôt altitude_accuracy.
altitude_accuracy

DoubleValue

Précision de altitude en mètres.
speed_kmph
(deprecated)

Int32Value

Vitesse du véhicule en kilomètres par heure. Obsolète: utilisez plutôt speed.
speed

DoubleValue

Vitesse du véhicule en mètres/seconde
speed_accuracy

DoubleValue

Précision de speed en mètres/seconde.
update_time

Timestamp

Heure à laquelle location a été signalé par le capteur, sur la base de son horloge.
server_time

Timestamp

Uniquement en sortie. Heure à laquelle le serveur a reçu les informations de localisation.
location_sensor

LocationSensor

Fournisseur de données de localisation (par exemple, GPS)
is_road_snapped

BoolValue

Indique si location est ancré à une route.
is_gps_sensor_enabled

BoolValue

Uniquement en entrée. Indique si le capteur GPS est activé sur l'appareil mobile.
time_since_update

Int32Value

Uniquement en entrée. Temps (en secondes) écoulé depuis la première envoi de la position au serveur. Cette valeur est égale à zéro lors de la première mise à jour. Si l'heure n'est pas connue (lorsque l'application redémarre, par exemple), cette valeur est réinitialisée.
num_stale_updates
(deprecated)

Int32Value

Uniquement en entrée. Obsolète: d'autres signaux sont désormais utilisés pour déterminer si un établissement est obsolète.
raw_location

LatLng

Emplacement brut du véhicule (non traité par l'outil de détection de la route).
raw_location_time

Timestamp

Code temporel associé à l'emplacement brut.
raw_location_sensor

LocationSensor

Source de l'emplacement brut. La valeur par défaut est GPS.
raw_location_accuracy

DoubleValue

Précision de raw_location comme rayon, en mètres.
supplemental_location

LatLng

Emplacement supplémentaire fourni par l'application d'intégration.
supplemental_location_time

Timestamp

Code temporel associé à l'emplacement supplémentaire.
supplemental_location_sensor

LocationSensor

Source de l'emplacement supplémentaire. La valeur par défaut est CUSTOMER_SUPPLIED_LOCATION.
supplemental_location_accuracy

DoubleValue

Précision de supplemental_location comme rayon, en mètres.
road_snapped
(deprecated)

bool

Obsolète: utilisez plutôt is_road_snapped.

VehicleMatch

Contient le véhicule et les estimations associées pour un véhicule qui correspondent aux points de trajets actifs du véhicule SearchVehiclesRequest.

Champs
vehicle

Vehicle

Obligatoire. Un véhicule correspondant à la requête.
vehicle_pickup_eta

Timestamp

L'heure d'arrivée prévue du véhicule jusqu'au point de prise en charge spécifié dans la requête. Une valeur vide indique un échec du calcul de l'heure d'arrivée prévue pour le véhicule. Si SearchVehiclesRequest.include_back_to_back était true et que ce véhicule effectue un trajet actif, vehicle_pickup_eta inclut le temps nécessaire pour effectuer le trajet en cours.
vehicle_pickup_distance_meters

Int32Value

Distance entre la position actuelle du véhicule et le point de prise en charge spécifié dans la requête, y compris les points de prise en charge ou de dépose intermédiaires pour les trajets existants. Cette distance comprend la distance calculée en voiture (itinéraire), plus la distance en ligne droite entre le point d'arrivée final de la navigation et le point de départ demandé. La distance entre le point d'arrivée final de la navigation et le point de départ demandé est généralement faible. Une valeur vide indique une erreur de calcul de la distance.
vehicle_pickup_straight_line_distance_meters

Int32Value

Obligatoire. Distance en ligne droite entre le véhicule et le point de prise en charge spécifié dans la requête.
vehicle_dropoff_eta

Timestamp

L'heure d'arrivée prévue complète du véhicule jusqu'au point de dépôt spécifié dans la requête. L'heure d'arrivée prévue inclut l'arrêt à tous les points de cheminement avant le dropoff_point spécifié dans la requête. Cette valeur n'est renseignée que si un point de dépôt est spécifié dans la requête. Une valeur vide indique une erreur lors du calcul de l'heure d'arrivée prévue.
vehicle_pickup_to_dropoff_distance_meters

Int32Value

Distance en voiture du véhicule (en mètres) entre le point de prise en charge et le point de dépôt spécifié dans la requête. La distance ne correspond qu'à l'espace entre les deux points. Elle n'inclut pas l'emplacement du véhicule ni aucun autre point à visiter avant que le véhicule ne se rende au point de prise en charge ou au point de dépôt. La valeur n'est renseignée que lorsqu'un dropoff_point est spécifié dans la requête. Une valeur vide indique un échec du calcul de la distance entre le point de prise en charge et le point de dépôt spécifié dans la requête.
trip_type

TripType

Obligatoire. Type de trajet de la requête qui a été utilisé pour calculer l'heure d'arrivée prévue au point de prise en charge.
vehicle_trips_waypoints[]

Waypoint

Liste numérotée des points de cheminement utilisés pour calculer l'heure d'arrivée prévue. La liste comprend l'emplacement du véhicule, les points de retrait des trajets en cours pour celui-ci et les points de prise en charge fournis dans la requête. Une liste vide indique que le calcul de l'heure d'arrivée prévue du véhicule n'a pas pu être effectué.
vehicle_match_type

VehicleMatchType

Type de véhicule correspondant.
requested_ordered_by

VehicleMatchOrder

Ordre demandé pour trier les correspondances de véhicules.
ordered_by

VehicleMatchOrder

Commande réellement utilisée pour ce véhicule. Normalement, il correspondra au champ "order_by" de la requête. Toutefois, dans certaines circonstances, telles qu'une erreur de serveur interne, une autre méthode peut être utilisée (par exemple, PICKUP_POINT_STRAIGHT_DISTANCE).

VehicleMatchType

Type de correspondance de véhicule.

Enums
UNKNOWN Type de correspondance du véhicule inconnu
EXCLUSIVE Le véhicule n'est actuellement associé à aucun trajet et peut poursuivre jusqu'au point de prise en charge.
BACK_TO_BACK Le véhicule est actuellement affecté à un trajet, mais il peut passer au point de prise en charge une fois le trajet en cours terminé. L'heure d'arrivée prévue et le calcul des distances tiennent compte du trajet existant.
CARPOOL Le véhicule dispose d'une capacité suffisante pour un trajet partagé.
CARPOOL_BACK_TO_BACK Le véhicule termine son trajet actif en cours avant de passer au point de prise en charge. L'heure d'arrivée prévue et le calcul des distances tiennent compte du trajet existant.

VehicleState

État d'une Vehicle.

Enums
UNKNOWN_VEHICLE_STATE Valeur par défaut, utilisée pour les états non spécifiés ou non reconnus du véhicule.
OFFLINE Le véhicule n'accepte pas de nouveaux trajets. Remarque: Le véhicule peut continuer à fonctionner dans cet état pendant qu'il effectue un trajet qui lui a été attribué.
ONLINE Le véhicule accepte de nouveaux trajets.

VisualTrafficReportPolylineRendering

Décrit comment les clients doivent colorer une partie de la polyligne le long de l'itinéraire.

Champs
road_stretch[]

RoadStretch

Facultatif. Sections de route devant être affichées le long de la polyligne. Il est garanti que les tronçons ne se chevauchent pas et ne couvrent pas nécessairement l'intégralité de l'itinéraire.

En l'absence de tronçon de route pour le style, le client doit appliquer la valeur par défaut de l'itinéraire.

RoadStretch

Un tronçon de route à afficher.

Champs
style

Style

Obligatoire. Style à appliquer.
offset_meters

int32

Obligatoire. Le style doit être appliqué entre les [offset_meters, offset_meters + length_meters).
length_meters

int32

Obligatoire. Longueur du tracé auquel appliquer le style.

Style

Style de circulation, indiquant la vitesse de circulation.

Enums
STYLE_UNSPECIFIED Aucun style sélectionné.
SLOWER_TRAFFIC Le trafic ralentit.
TRAFFIC_JAM Il y a un embouteillage.

Repère

Décrit les points intermédiaires d'un itinéraire pour un VehicleMatch dans un SearchVehiclesResponse. Ce concept est représenté par un TripWaypoint sur tous les autres points de terminaison.

Champs
lat_lng

LatLng

Emplacement de ce point de cheminement.
eta

Timestamp

Estimation de l'heure d'arrivée du véhicule à ce point de cheminement.

WaypointType

Type de point de cheminement.

Enums
UNKNOWN_WAYPOINT_TYPE Type de point de cheminement inconnu ou non spécifié.
PICKUP_WAYPOINT_TYPE Points de cheminement pour la prise en charge des passagers ou des objets
DROP_OFF_WAYPOINT_TYPE Les points de cheminement pour déposer les usagers ou les éléments
INTERMEDIATE_DESTINATION_WAYPOINT_TYPE Points de cheminement pour des destinations intermédiaires dans un trajet multidestination