Package maps.fleetengine.v1

Index

TripService

Service de gestion des trajets.

CreateTrip

rpc CreateTrip(CreateTripRequest) returns (Trip)

Crée un trajet dans Fleet Engine et renvoie le nouveau trajet.
GetTrip

rpc GetTrip(GetTripRequest) returns (Trip)

Obtenir des informations sur un seul trajet
ReportBillableTrip

rpc ReportBillableTrip(ReportBillableTripRequest) returns (Empty)

Signaler l'utilisation du trajet facturable.
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 des véhicules

CreateVehicle

rpc CreateVehicle(CreateVehicleRequest) returns (Vehicle)

Instancie un nouveau véhicule associé à un fournisseur de services de covoiturage ou de livraisons à la demande. Chaque Vehicle doit avoir un identifiant 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'un 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 utilisés s'ils sont renseignés.
GetVehicle

rpc GetVehicle(GetVehicleRequest) returns (Vehicle)

Renvoie un véhicule à partir de Fleet Engine.
ListVehicles

rpc ListVehicles(ListVehiclesRequest) returns (ListVehiclesResponse)

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

rpc SearchVehicles(SearchVehiclesRequest) returns (SearchVehiclesResponse)

Renvoie une liste de 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 name du véhicule.

Si le champ attributes est modifié, 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, consultez la méthode UpdateVehicleAttributes. De même, le champ waypoints peut être mis à jour, mais il doit contenir tous les points de cheminement qui se trouvent actuellement dans le véhicule.
UpdateVehicleAttributes

rpc UpdateVehicleAttributes(UpdateVehicleAttributesRequest) returns (UpdateVehicleAttributesResponse)

Met à jour partiellement les attributs d'un véhicule. Seuls les attributs mentionnés dans la demande seront mis à jour. Les autres attributs ne seront PAS modifiés. Remarque: la différence est différente dans UpdateVehicle, où l'intégralité du champ attributes sera remplacé par celui de UpdateVehicleRequest. Les attributs qui ne figurent pas dans la requête seront supprimés.

BatteryInfo

Informations sur la batterie de l'appareil.

Champs
battery_status

BatteryStatus

État de la batterie : pleine, 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 : pleine, charge, etc.

Enums
UNKNOWN_BATTERY_STATUS État de la batterie inconnu.
BATTERY_STATUS_CHARGING La batterie est en cours de charge.
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 charge pas.
BATTERY_STATUS_POWER_LOW La batterie est faible.

BillingPlatformIdentifier

Ensemble de valeurs indiquant la plate-forme sur laquelle la requête a été émise.

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 répertoriées dans cette énumération.

ConsumableTrafficPolyline

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

Champs
speed_reading_interval[]

SpeedReadingInterval

Vitesse de circulation sur le trajet entre le point de cheminement précédent et le point de cheminement actuel.
encoded_path_to_waypoint

string

Trajet emprunté par le conducteur entre le point de cheminement précédent et le point de cheminement actuel. Ce trajet contient des points de repère permettant aux clients d'afficher des repères de signalisation le long du trajet (voir speed_reading_interval). Le décodage n'est pas encore pris en charge.

CreateTripRequest

CreateTrip request message (Créer un message de demande de trajet)

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 être l'ID du projet Google Cloud (par exemple, sample-cloud-project) auquel appartient le compte de service qui effectue cet appel.
trip_id

string

Obligatoire. ID de trajet unique. Cette offre est soumise aux restrictions suivantes:

  • Veuillez saisir une chaîne Unicode valide.
  • Ne doit pas dépasser 64 caractères.
  • Normalisée selon le formulaire C de normalisation Unicode.
  • Ne doit pas contenir les caractères ASCII suivants : "/", ":", "?", "," ou "#".
trip

Trip

Obligatoire. Entité de voyage à créer.

Lorsque vous créez un voyage, vous devez remplir les champs suivants:

  • trip_type
  • pickup_point

Si vous les renseignez, les champs suivants sont utilisés:

  • 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 un trip_status de NEW, même si vous transmettez un trip_status de CANCELED dans la requête de création.

Seuls les trajets EXCLUSIVE prennent en charge intermediate_destinations.

Lorsque vehicle_id est défini pour un trajet partagé, vous devez fournir la liste Trip.vehicle_waypoints afin de spécifier 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 aucun point de cheminement supplémentaire. Vous devez classer ces points de cheminement de sorte que, pour un trajet donné, le point de prise en charge 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 entrelacer les 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 être l'ID du projet Google Cloud (par exemple, sample-cloud-project) auquel appartient le compte de service qui effectue cet appel.
vehicle_id

string

Obligatoire. ID unique du véhicule. Cette offre est soumise aux restrictions suivantes:

  • Veuillez saisir une chaîne Unicode valide.
  • Ne doit pas dépasser 64 caractères.
  • Normalisée selon le formulaire C de normalisation Unicode.
  • Ne doit pas contenir les caractères ASCII suivants : "/", ":", "?", "," ou "#".
vehicle

Vehicle

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

  • vehicleState
  • supportedTripTypes
  • maximumCapacity
  • vehicleType

Lors de la création d'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 utilisés s'ils sont renseignés.

DeviceSettings

Informations sur les différents paramètres de l'appareil mobile.

Champs
location_power_save_mode

LocationPowerSaveMode

Fonctionnement des fonctionnalités de localisation 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 mode interactif.
battery_info

BatteryInfo

Informations sur l'état de la batterie.

GetTripRequest

Message de demande GetTrip.

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 être l'ID du projet Google Cloud (par exemple, sample-cloud-project) auquel appartient le compte de service qui effectue cet appel.
view

TripView

Sous-ensemble des champs "Trip" qui doivent être renvoyés, ainsi que leur interprétation.
current_route_segment_version

Timestamp

Indique le code temporel 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 d'itinéraire n'est pas défini dans la réponse. Si une valeur minimale n'est pas spécifiée, les données de route sont toujours récupérées.
remaining_waypoints_version

Timestamp

Indique le code temporel minimal (exclu) pour lequel les valeurs Trip.remaining_waypoints sont récupérées. S'ils ne sont pas modifiés 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 le code temporel minimal (exclu) pour lequel la valeur Trip.current_route_segment_traffic est récupérée. 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 une valeur minimale n'est pas spécifiée, 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 être l'ID du projet Google Cloud (par exemple, sample-cloud-project) auquel appartient le compte de service qui effectue cet appel.
current_route_segment_version

Timestamp

Indique le code temporel minimal (exclu) pour lequel la valeur Vehicle.current_route_segment est récupérée. Si l'itinéraire n'est pas modifié depuis cet horodatage, le champ current_route_segment n'est pas défini dans la réponse. Si une valeur minimale n'est pas 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 relatives à 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 stockées en tant qu'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

Dernier chiffre de la plaque d'immatriculation ou "-1" pour indiquer qu'aucune valeur numérique n'est présente sur la plaque d'immatriculation.

  • "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 être l'ID du projet Google Cloud (par exemple, sample-cloud-project) auquel appartient le compte de service qui effectue cet appel.
page_size

int32

Nombre maximal de véhicules à retourner. La valeur par défaut est 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 filtrage de la demande ne sont pas identiques à ceux de l'appel précédent à ListVehicles.
minimum_capacity

Int32Value

Spécifie la capacité minimale requise du véhicule. La valeur maximum_capacity de tous les véhicules renvoyés est supérieure ou égale à cette valeur. S'il est défini, il doit être supérieur ou égal à 0.
trip_types[]

TripType

Limite la réponse aux véhicules compatibles avec au moins 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 au cours de la durée spécifiée. Les véhicules fixes qui transmettent encore leur position ne sont pas considérés comme obsolètes. S'il est présent, il doit s'agir d'une durée positive valide.
vehicle_type_categories[]

Category

Obligatoire. Limite la réponse aux véhicules appartenant à l'une des catégories de types 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. Ensemble, 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/opération AND. Un maximum de 50 attributs obligatoires est autorisé. Ce nombre correspond au nombre maximal d'attributs autorisé pour un véhicule. Chaque chaîne répétée doit être au format "key:value".
required_one_of_attributes[]

string

Limite la réponse aux véhicules avec au moins un des attributs spécifiés dans chaque VehicleAttributeList. Dans chaque liste, un véhicule doit correspondre à au moins un des attributs. Ce champ est une opération de disjonction/OU inclusive dans chaque VehicleAttributeList et une opération de conjonction/ET sur la collection 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 fournit des fonctionnalités supplémentaires.

Comme pour required_one_of_attributes, required_one_of_attribute_sets utilise un message qui autorise une liste de listes, ce qui permet d'utiliser des 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'une VehicleAttributeList. Dans chaque liste, un véhicule doit correspondre à tous les attributs. Ce champ est une opération de conjonction/ET dans chaque VehicleAttributeList et une opération de disjonction inclusive/OU dans la collection 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 dans cet état.
on_trip_only

bool

Ne renvoyez que les véhicules avec le ou les trajets actuels.
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 du véhicule (par exemple, attributes.<key> = <value> ou attributes.<key1> = <value1> AND attributes.<key2> = <value2>). Le nombre maximal de restrictions autorisé 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 acceptées par rapport aux attributs sont les 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 comme des chaînes (par exemple, attributes.<key> = "10" ou attributes.<key> = "true").
viewport

Viewport

Facultatif. 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 correspond aux critères de la demande.
total_size

int64

Obligatoire. Nombre total de véhicules correspondant aux critères de la demande sur toutes les pages.

LocationPowerSaveMode

Comment les fonctionnalités de localisation sont configurées pour se comporter sur l'appareil mobile lorsque l'économiseur de batterie est activé sur celui-ci est activée. (https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())

Enums
UNKNOWN_LOCATION_POWER_SAVE_MODE LocationPowerSaveMode non définie
LOCATION_MODE_NO_CHANGE L'économiseur de batterie n'a normalement pas d'incidence sur les fournisseurs de services de localisation, ou l'économiseur de batterie est désactivé.
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF Le fournisseur de géolocalisation 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 services 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 services de localisation resteront disponibles, mais les correctifs de localisation ne doivent être fournis qu'aux applications de premier plan.
LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF La localisation ne sera pas désactivée, mais LocationManager limitera toutes les requêtes envoyées aux fournisseurs lorsque l'appareil est non interactif.

LocationSensor

Capteur ou méthodologie permettant de 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é, identifiant d'antenne-relais ou point d'accès Wi-Fi.
PASSIVE ID de l'antenne-relais ou point d'accès Wi-Fi.
ROAD_SNAPPED_LOCATION_PROVIDER Position déterminée par l'appareil mobile comme étant la position la plus probable sur la route.
CUSTOMER_SUPPLIED_LOCATION Emplacement fourni par le client à partir d'une source indépendante. En règle générale, cette valeur est utilisée pour un emplacement fourni à partir de sources autres que l'appareil mobile exécutant le SDK Driver. Si la source d'origine est décrite par l'une des autres valeurs d'énumération, utilisez cette valeur. Les emplacements marqués CUSTOMER_SUPPLIED_LOCATION sont généralement indiqués dans le last_location.supplemental_location_sensor d'un véhicule.
FLEET_ENGINE_LOCATION Emplacement calculé par Fleet Engine en fonction des signaux à sa disposition. 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 services de localisation sur les systèmes d'exploitation Apple.

État de 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 de navigation de 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 à moins de 50 m de la destination.

PolylineFormatType

Type de format de la 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 est 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 demande ReportBillableTrip.

Champs
name

string

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

string

Obligatoire. Code pays à deux lettres correspondant au pays du voyage. Le prix est défini en fonction du code pays.
platform

BillingPlatformIdentifier

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

string

Identifiants directement liés au trajet signalé. Il s'agit généralement des identifiants (par exemple, des identifiants de session) des opérations de pré-réservation effectuées avant que l'identifiant de trajet 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 de différents types de solutions pour un trajet signalé.

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

RequestHeader

Un 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 nom n'est spécifié, la réponse peut être rédigée dans n'importe quelle langue, la langue de préférence étant l'anglais, le cas échéant. 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. La version est au format "major.minor.patch". Exemple: 1.1.2.
os_version

string

Version du système d'exploitation sur lequel le SDK à l'origine de l'appel s'exécute. Exemples de valeurs de champ: 4.4.1, 12.1.
device_model

string

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

SdkType

Type de SDK envoyant la requête.
maps_sdk_version

string

Version du MapSDK dont dépend le SDK appelant, le cas échéant. La version est au format "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 issu 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 qui peut ê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 demande 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 à l'origine de l'appel 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 être l'ID du projet Google Cloud (par exemple, sample-cloud-project) auquel appartient le compte de service qui effectue cet appel.
vehicle_id

string

Véhicule associé aux trajets dans la requête. Si aucune valeur n'est spécifiée, les trajets renvoyés ne contiennent pas les éléments suivants:

  • current_route_segment
  • remaining_waypoints
  • remaining_distance_meters
  • eta_to_first_waypoint
active_trips_only

bool

Si elle est définie sur "true", la réponse inclut les trajets qui ont une incidence sur 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 cette valeur sur une valeur précédemment renvoyée dans SearchTripsResponse pour continuer à partir des résultats précédents.
minimum_staleness

Duration

Si cette valeur est spécifiée, elle 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. Lorsqu'il ne reste aucun résultat, 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 être l'ID du projet Google Cloud (par exemple, sample-cloud-project) auquel appartient le compte de service qui effectue cet appel.
pickup_point

TerminalLocation

Obligatoire. Point de départ à proximité duquel la recherche doit être effectuée.
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 d'un véhicule autour du point de prise en charge. Seuls les véhicules compris dans le rayon de recherche sont renvoyés. 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. Spécifie le nombre de passagers envisagés 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 véhicules compatibles avec ce type de trajet.
maximum_staleness

Duration

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

VehicleType

Obligatoire. Limite la recherche aux véhicules de l'un des types spécifiés. Vous devez indiquer au moins un type de véhicule. Les VehicleTypes d'une catégorie de 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. Ensemble, 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 véhicules présentant les attributs spécifiés. Ce champ est une opération de conjonction/opération AND. Un maximum de 50 attributs obligatoires est autorisé. Ce nombre correspond au nombre maximal d'attributs autorisé pour un véhicule.
required_one_of_attributes[]

VehicleAttributeList

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

VehicleAttributeList

required_one_of_attribute_sets fournit des fonctionnalités supplémentaires.

Comme pour required_one_of_attributes, required_one_of_attribute_sets utilise un message qui autorise une liste de listes, ce qui permet d'utiliser des 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 véhicules avec tous les attributs dans un élément VehicleAttributeList. Dans chaque liste, un véhicule doit correspondre à tous les attributs. Ce champ est une opération de conjonction/ET dans chaque VehicleAttributeList et une opération de disjonction inclusive/OU dans la collection de VehicleAttributeList.
order_by

VehicleMatchOrder

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

bool

Indique si les véhicules avec 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 auxquels des trajets sont attribués 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 les 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. Elle doit être définie sur une valeur autre que CURRENT_TRIPS_PRESENT_UNSPECIFIED si trip_type inclut SHARED.
filter

string

Facultatif. Requête de filtre à appliquer lors de la recherche de 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 du véhicule (par exemple, attributes.<key> = <value> ou attributes.<key1> = <value1> AND attributes.<key2> = <value2>). Le nombre maximal de restrictions autorisé 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 acceptées par rapport aux attributs sont les 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 comme des chaînes (par exemple, attributes.<key> = "10" ou attributes.<key> = "true").

CurrentTripsPresent

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

Enums
CURRENT_TRIPS_PRESENT_UNSPECIFIED La disponibilité des véhicules avec des trajets est régie par le champ include_back_to_back.
NONE Les véhicules sans trajets peuvent apparaître 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 au maximum cinq trajets en cours et 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 des correspondances du véhicule dans la réponse.

Enums
UNKNOWN_VEHICLE_MATCH_ORDER Par défaut, utilisé pour les véhicules non spécifiés ou non reconnus dans l'ordre.
PICKUP_POINT_ETA Ordre croissant selon le temps de trajet du véhicule jusqu'au lieu 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 selon le 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 demande.
PICKUP_POINT_STRAIGHT_DISTANCE Ordre croissant selon la distance en ligne droite entre le dernier emplacement signalé du véhicule et le lieu de prise en charge.
COST Ordre croissant selon le 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 à l'aide de valeurs par défaut et peuvent être modifiées pour chaque 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 qui correspondent aux critères SearchVehiclesRequest, classés selon le champ SearchVehiclesRequest.order_by.

SpeedReadingInterval

Indicateur de densité du trafic sur une section contiguë d'un chemin. Avec un chemin comportant les points P_0, P_1, ... , P_N (indice 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. Au format JSON, lorsque l'index est égal à 0, le champ semble vide.
end_polyline_point_index

int32

Index de fin de cet intervalle dans le chemin. Au format JSON, lorsque l'index est égal à 0, le champ semble vide.
speed

Speed

Vitesse du trafic pour cet intervalle.

Vitesse

Classification de la vitesse d'une 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 n'est détecté.
SLOW Ralentissement détecté, mais aucun embouteillage ne s'est formé.
TRAFFIC_JAM Embouteillage détecté.

StopLocation

L'emplacement réel de l'arrêt (prise en charge/dépose).

Champs
point

LatLng

Obligatoire. Indique le lieu 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 pour le trajet.
terminal_point_id
(deprecated)

TerminalPointId

Obsolète: spécifiez plutôt le champ point.
access_point_id
(deprecated)

string

Obsolète: spécifiez plutôt le champ point.
trip_id
(deprecated)

string

Obsolète.
terminal_location_type
(deprecated)

WaypointType

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

TerminalPointId

Obsolète: les TerminalPoints ne sont plus compatibles avec Fleet Engine. Utilisez TerminalLocation.point à la place.

Champs
value
(deprecated)

string

Obsolète.
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 pour le véhicule.

Champs
traffic_rendering

VisualTrafficReportPolylineRendering

Rendu polyligne de la vitesse du trafic dans toutes les régions le long d'une portion de route d'un client.

Trajet

Métadonnées du trajet.

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 retiré.
actual_pickup_point

StopLocation

Uniquement en entrée. L'emplacement réel où et quand le client a été retiré. Ce champ permet au fournisseur de fournir des commentaires sur les informations de retrait réelles.
actual_pickup_arrival_point

StopLocation

Uniquement en entrée. L'heure et le lieu réels d'arrivée du chauffeur au lieu de prise en charge. Ce champ permet au fournisseur de fournir des informations sur l'arrivée réelle au point de prise en charge.
pickup_time

Timestamp

Uniquement en sortie. Il peut s'agir de l'heure de départ estimée du ou des passagers, ou de l'heure réelle à laquelle ils ont été pris en charge.
intermediate_destinations[]

TerminalLocation

Arrêts intermédiaires dans l'ordre de la demande de trajet (en plus des prises en charge et des déposes). Dans un premier temps, cette option 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, un nombre compris entre [0..N-1] indiquant la destination intermédiaire que le véhicule traverse ensuite. Lorsque TripStatus est défini sur ARRIVED_AT_INTERMEDIATE_DESTINATION, un nombre compris entre [0..N-1] indiquant la destination intermédiaire à laquelle se trouve le véhicule. Le fournisseur définit cette valeur. Si aucun intermediate_destinations n'est défini, 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 aux 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, ainsi que le lieu de prise en charge Ce champ permet au fournisseur de fournir des commentaires sur les informations de prise en charge 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 du moment et du lieu où le client a été déposé Ce champ permet au fournisseur de fournir des commentaires sur les informations de dépôt réelles.
dropoff_time

Timestamp

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

TripWaypoint

Uniquement en sortie. Chemin complet (inclus) entre la position actuelle et le point de dépôt. Ce tracé peut inclure des points de cheminement d'autres trajets.
vehicle_waypoints[]

TripWaypoint

Ce champ permet de trier manuellement les points de cheminement pour le trajet. Il contient tous les points de cheminement restants pour le véhicule attribué, ainsi que les points de cheminement de prise en charge et de dépose de 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 lors des appels GetTrip.
route[]

LatLng

Uniquement en sortie. Itinéraire prévu pour ce trajet vers la première entrée dans "restants_waypoints". Notez que le premier point de cheminement peut appartenir à un trajet différent.
current_route_segment

string

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

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

Timestamp

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

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

ConsumableTrafficPolyline

Uniquement en sortie. Indique les conditions de circulation le long du current_route_segment, le cas échéant.

Remarque: Ce champ est destiné uniquement à être utilisé par le SDK Driver et le SDK Consumer.
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é uniquement à être utilisé par le SDK Driver et le SDK Consumer.
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 s'il est terminé ou annulé.
eta_to_first_waypoint

Timestamp

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

Duration

Uniquement en sortie. Durée entre le retour des données de trajet et l'heure dans Trip.eta_to_first_waypoint. La valeur n'est pas spécifiée si le trajet n'est pas attribué à un 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 les éléments 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 chauffeur n'est pas inclus). Un véhicule doit avoir de la capacité disponible pour être renvoyé 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 current_route_segment. "False" si last_location ou current_route_segment n'existe pas. Il est calculé par Fleet Engine. Toute mise à jour effectuée par les clients sera ignorée.
view

TripView

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

TripStatus

État d'un trajet indiquant sa progression.

Enums
UNKNOWN_TRIP_STATUS Valeur par défaut, utilisée pour l'état du trajet non spécifié ou non reconnu.
NEW Nouveau voyage.
ENROUTE_TO_PICKUP Le chauffeur est en route vers le lieu de prise en charge.
ARRIVED_AT_PICKUP Le chauffeur est arrivé au point de prise en charge.
ARRIVED_AT_INTERMEDIATE_DESTINATION Le conducteur est arrivé à une destination intermédiaire et attend le passager.
ENROUTE_TO_INTERMEDIATE_DESTINATION Le conducteur se dirige vers une destination intermédiaire (et non au lieu de dépose).
ENROUTE_TO_DROPOFF Le conducteur a pris en charge 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 partage de course.

TripType

Type de trajet.

Enums
UNKNOWN_TRIP_TYPE Valeur par défaut, utilisée pour les types de trajets non spécifiés ou non reconnus.
SHARED Le trajet peut partager un véhicule avec d'autres trajets.
EXCLUSIVE Le trajet est réservé à un véhicule.

TripView

Sélecteur pour différents ensembles de champs de trajet dans une réponse GetTrip. Pour plus de contexte, reportez-vous à l'AIP-157. 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 du SDK. Pour des raisons de stabilité et d'assistance, nous recommandons aux clients de sélectionner un TripView autre que SDK.
SDK Inclut des champs qui ne peuvent pas être interprétés ni gérés à l'aide de bibliothèques accessibles au public.
JOURNEY_SHARING_V1S Les champs "Trip" sont renseignés pour le cas d'utilisation "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 un point d'arrivée sur le 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 ce trajet, par exemple, prise en charge ou dépose.
path_to_waypoint[]

LatLng

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

string

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

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

ConsumableTrafficPolyline

Conditions de circulation du trajet menant à ce point de cheminement. Notez que le trafic n'est disponible que pour les clients de la solution Rides and Deliveries de Google Maps Platform.
distance_meters

Int32Value

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

Timestamp

Heure d'arrivée estimée à ce point de cheminement. Non défini pour le premier point de cheminement d'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 d'une liste.

UpdateTripRequest

Mettre à jour le message de demande 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 être l'ID du projet Google Cloud (par exemple, sample-consumer-project) auquel appartient le compte de service qui effectue cet appel.
trip

Trip

Obligatoire. Le 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 des Trip.vehicle_waypoints pour spécifier l'ordre des points de cheminement restants. Sinon, cet ordre 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 aucun point de cheminement supplémentaire. Vous devez classer ces points de cheminement de sorte que, pour un trajet donné, le point de prise en charge 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 entrelacer les 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 les trajets comportant plusieurs destinations, vous devez fournir Trip.intermediate_destinations_version lorsque vous mettez à jour l'état du trajet sur ENROUTE_TO_INTERMEDIATE_DESTINATION. La valeur Trip.intermediate_destinations_version transmise doit correspondre à 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. L'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 être l'ID du projet Google Cloud (par exemple, sample-cloud-project) auquel appartient le compte de service qui effectue 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 mise à jour des attributs du véhicule, y compris les attributs nouveaux, modifiés et non modifiés.

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 être 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 modifié, 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, consultez la méthode UpdateVehicleAttributes.

De même, le champ waypoints peut être mis à jour, mais il doit contenir tous les points de cheminement qui se trouvent actuellement dans le véhicule.
update_mask

FieldMask

Obligatoire. Masque de champ indiquant les champs du 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 acceptés par 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 d'usagers pouvant être transportés par ce véhicule. Le pilote n'est pas pris en compte dans cette valeur. Cette valeur doit être supérieure ou égale à 1.
attributes[]

VehicleAttribute

Liste des attributs du véhicule. Un véhicule peut avoir 100 attributs au maximum, et chaque attribut doit avoir une clé unique.
vehicle_type

VehicleType

Obligatoire. Type de ce véhicule. Peut être utilisé pour filtrer les véhicules dans les résultats SearchVehicles. Cette fonctionnalité a également une incidence sur le calcul de l'heure d'arrivée prévue et de l'itinéraire.
license_plate

LicensePlate

Informations relatives à 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 atteindre le point de cheminement suivant. 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é uniquement à être utilisé 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 parcours. Remarque: Ce champ est destiné uniquement à être utilisé 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 les routes renvoyées qui n'ont pas changé.
current_route_segment_end_point

TripWaypoint

Point de cheminement où se termine current_route_segment. Ces informations peuvent être fournies par les conducteurs lors d'appels UpdateVehicle, soit en tant que point de cheminement complet pour le trajet, en tant que point de cheminement LatLng, soit en tant que dernier LatLng du current_route_segment. Fleet Engine fera alors de son mieux pour interpoler un point de cheminement réel si celui-ci n'est pas entièrement 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 à la première entrée du champ waypoints. La valeur n'est pas spécifiée si le champ waypoints ou Vehicle.current_route_segment est vide.

Lors de la mise à jour d'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 ou 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.

Lors de la mise à jour d'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 en cache cette valeur 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 des trajets intervenus. Si la valeur est true, SearchVehicles peut inclure le véhicule même s'il est actuellement associé à un trajet. La valeur par défaut est false.
navigation_status

NavigationStatus

État de navigation du véhicule.
device_settings

DeviceSettings

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

VehicleType

Type de véhicule.

Champs
category

Category

Catégorie de type de véhicule

Catégorie

Catégories de types de véhicules

Enums
UNKNOWN Par défaut, utilisé pour les catégories de véhicules non spécifiées ou non reconnues.
AUTO Une voiture.
TAXI Véhicule agissant en tant que taxi (généralement agréé ou réglementé).
TRUCK Généralement, un véhicule avec une grande capacité de stockage.
TWO_WHEELER Une moto, une cyclomoteur ou un autre véhicule à deux roues
BICYCLE Transport à énergie humaine
PEDESTRIAN Transporteur humain, généralement marchant ou courant, empruntant des voies piétonnes.

VehicleAttribute

Décrit un attribut de véhicule en tant que paire clé-valeur. La valeur "key:value" La chaîne ne doit 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. Valeur de l'attribut. Elle peut être de type "string", "bool" ou "double". vehicle_attribute_value ne peut être qu'un des éléments suivants :
string_value

string

Valeur d'attribut de type 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 deux définis, ils doivent être identiques, sinon une erreur sera 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 saisie en double.

VehicleAttributeList

Type de données "liste de listes" pour les attributs d'un véhicule.

Champs
attributes[]

VehicleAttribute

Liste des attributs de cette collection.

VehicleLocation

L'emplacement, la vitesse et la direction d'un véhicule à un moment précis.

Champs
location

LatLng

Emplacement du véhicule. Lorsqu'il est envoyé à Fleet Engine, la position du véhicule correspond à une position GPS. Lorsque vous le recevez en réponse, la position du véhicule peut être une position GPS, une position supplémentaire ou toute 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 la forme d'un rayon.
heading

Int32Value

Direction 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 selon l'horloge du capteur.
server_time

Timestamp

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

LocationSensor

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

BoolValue

Indique si location est aligné sur 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 écoulé (en secondes) depuis l'envoi de la première position au serveur. Ce sera zéro pour 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

Localisation brute du véhicule (non traitée par la capture de route).
raw_location_time

Timestamp

Horodatage 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 en tant que 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 en tant que 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 à un véhicule qui correspond aux points des 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 de 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 est en cours de trajet, 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 lieu de prise en charge spécifié dans la requête, y compris les lieux intermédiaires de prise en charge ou de dépose des trajets existants. Cette distance comprend la distance calculée en voiture (itinéraire), ainsi que la distance en ligne droite entre le point d'arrivée pour la navigation et le lieu de prise en charge demandé. (La distance entre le point d'arrivée pour la navigation et le lieu de prise en charge 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 lieu 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 demande. L'heure d'arrivée prévue inclut l'arrêt à n'importe quel point de cheminement avant l'heure dropoff_point spécifiée dans la requête. La valeur ne sera renseignée que si un point de dépôt est spécifié dans la requête. Une valeur vide indique une erreur de calcul de l'heure d'arrivée prévue.
vehicle_pickup_to_dropoff_distance_meters

Int32Value

Distance parcourue (en mètres) du véhicule entre le lieu de prise en charge et le lieu de dépôt spécifié dans la demande. La distance est uniquement entre les deux points et n'inclut pas l'emplacement du véhicule ni tout autre point devant être visité avant que le véhicule ne se rende au lieu de prise en charge ou de dépôt. La valeur ne sera renseignée que si dropoff_point est spécifié dans la requête. Une valeur vide indique un échec de calcul de la distance entre la prise en charge et le lieu de dépose spécifié dans la requête.
trip_type

TripType

Obligatoire. Type de trajet de la requête utilisée pour calculer l'heure d'arrivée prévue jusqu'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. Cette liste comprend l'emplacement du véhicule, les points de prise en charge des trajets actifs pour le véhicule, ainsi que les points de prise en charge indiqués dans la requête. Une liste vide indique un échec de calcul de l'heure d'arrivée prévue pour le véhicule.
vehicle_match_type

VehicleMatchType

Le type de véhicule correspond.
requested_ordered_by

VehicleMatchOrder

Ordre demandé pour le tri des correspondances de véhicules.
ordered_by

VehicleMatchOrder

Commande réelle utilisée pour ce véhicule. Normalement, cela correspond à la valeur "order_by" de la requête. Toutefois, dans certains cas, par exemple en cas d'erreur interne du serveur, une autre méthode peut être utilisée (par exemple, PICKUP_POINT_STRAIGHT_DISTANCE).

VehicleMatchType

Type de véhicule correspondant.

Enums
UNKNOWN Type de correspondance du véhicule inconnu
EXCLUSIVE Aucun trajet n'est actuellement attribué au véhicule et peut se rendre au lieu de prise en charge.
BACK_TO_BACK Le véhicule est actuellement attribué à un trajet, mais peut se rendre au lieu de prise en charge une fois le trajet en cours terminé. Le calcul de l'heure d'arrivée prévue et de la distance tient compte du trajet existant.
CARPOOL Le véhicule a une capacité suffisante pour une course partagée.
CARPOOL_BACK_TO_BACK Le véhicule termine son trajet en cours et actif avant d'atteindre le lieu de prise en charge. Le calcul de l'heure d'arrivée prévue et de la distance tient compte du trajet existant.

VehicleState

État d'un Vehicle.

Enums
UNKNOWN_VEHICLE_STATE Par défaut, utilisé pour les états du véhicule non spécifiés ou non reconnus.
OFFLINE Le véhicule n'accepte pas de nouveaux trajets. Remarque: Le véhicule peut continuer à fonctionner dans cet état pendant la réalisation d'un trajet qui lui est attribué.
ONLINE Le véhicule accepte de nouveaux trajets.

VisualTrafficReportPolylineRendering

Décrit la manière dont 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. Les tronçons ne se chevauchent pas nécessairement et ne couvrent pas nécessairement l'intégralité de l'itinéraire.

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

RoadStretch

Un tronçon de route à tracer.

Champs
style

Style

Obligatoire. Style à appliquer.
offset_meters

int32

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

int32

Obligatoire. Longueur du tracé où appliquer le style.

Style

Style de trafic indiquant la vitesse du trafic.

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 le long d'un itinéraire pour un VehicleMatch dans un SearchVehiclesResponse. Ce concept est représenté sous la forme d'un TripWaypoint dans 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 Des points de cheminement pour récupérer des passagers ou des objets
DROP_OFF_WAYPOINT_TYPE Des points de cheminement pour déposer des passagers ou des objets
INTERMEDIATE_DESTINATION_WAYPOINT_TYPE Points de cheminement pour des destinations intermédiaires au cours d'un trajet multidestination.