Package maps.fleetengine.v1

Index

TripService

Service de gestion des trajets.

CreateTrip

rpc CreateTrip(CreateTripRequest) returns (Trip)

Crée un trajet dans le moteur de parc 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 des trajets facturables

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)

Instancier un nouveau véhicule associé à un fournisseur de services de covoiturage ou de livraison à la demande Chaque Vehicle doit avoir un identifiant de véhicule unique.

Les champs Vehicle suivants sont obligatoires lors de la création d'un 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 sont utilisés s'ils sont fournis.

GetVehicle

rpc GetVehicle(GetVehicleRequest) returns (Vehicle)

Renvoie un véhicule à partir de 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 la requête.

SearchVehicles

rpc SearchVehicles(SearchVehiclesRequest) returns (SearchVehiclesResponse)

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

UpdateVehicle

rpc UpdateVehicle(UpdateVehicleRequest) returns (Vehicle)

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

Lorsque vous mettez à jour 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

Le name du véhicule ne peut pas non plus être modifié.

Si le champ attributes est mis à jour, tous les attributs du véhicule sont remplacés par les attributs 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 doit contenir tous les points de cheminement actuellement sur le 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: Cela est différent dans UpdateVehicle, où l'ensemble du champ attributes est remplacé par celui de UpdateVehicleRequest. Les attributs qui ne figurent pas dans la requête sont supprimés.

BatteryInfo

Informations sur la batterie de l'appareil.

Champs
battery_status

BatteryStatus

État de la batterie (pleine ou 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 (pleine ou en 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 se 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 indiquant sur quelle plate-forme 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 listées dans cette énumération.

ConsumableTrafficPolyline

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

Champs
speed_reading_interval[]

SpeedReadingInterval

Vitesse du trafic 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 repère précédent et le point de repère actuel. Ce parcours contient des repères afin que les clients puissent afficher des repères de trafic le long du parcours (voir speed_reading_interval). Le décodage n'est pas encore pris en charge.

CreateTripRequest

Message de requête CreateTrip.

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 de projet (par exemple, sample-cloud-project) du projet Google Cloud dont le compte de service à l'origine de cet appel est membre.

trip_id

string

Obligatoire. ID de trajet unique. Sous réserve des restrictions suivantes:

  • Doit être une chaîne de caractères Unicode valide.
  • Limité à 64 caractères maximum.
  • Normalisé selon la forme de normalisation Unicode C.
  • Ne doit pas contenir l'un 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 fournissez:

  • number_of_passengers
  • vehicle_id
  • dropoff_point
  • intermediate_destinations
  • vehicle_waypoints

Tous les autres champs de type "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 sont compatibles avec intermediate_destinations.

Lorsque vehicle_id est défini pour un trajet partagé, vous devez fournir la liste des Trip.vehicle_waypoints pour 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 points de cheminement supplémentaires. Vous devez organiser ces points de repère de sorte que, pour un trajet donné, le point de prise en charge soit placé avant les destinations intermédiaires, et que toutes les destinations intermédiaires soient placées avant le point de dépose. Les points de cheminement d'un trajet EXCLUSIVE ne doivent pas se chevaucher 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 être l'ID de projet (par exemple, sample-cloud-project) du projet Google Cloud dont le compte de service à l'origine de cet appel est membre.

vehicle_id

string

Obligatoire. ID de véhicule unique. Sous réserve des restrictions suivantes:

  • Doit être une chaîne de caractères Unicode valide.
  • Limité à 64 caractères maximum.
  • Normalisé selon la forme de normalisation Unicode C.
  • Ne doit pas contenir l'un des caractères ASCII suivants: '/', ':', '?', ',' ou '#'.
vehicle

Vehicle

Obligatoire. Entité de 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 fournis.

DeviceSettings

Informations sur divers paramètres de l'appareil mobile.

Champs
location_power_save_mode

LocationPowerSaveMode

Comportement 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 dans un état interactif.

battery_info

BatteryInfo

Informations sur l'état de la batterie.

GetTripRequest

Message de requête 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 de projet (par exemple, sample-cloud-project) du projet Google Cloud dont le compte de service à l'origine de cet appel est membre.

view

TripView

Sous-ensemble des champs "Trip" (Voyage) à renvoyer et 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 parcours n'ont pas changé depuis ce code temporel, le champ "route" n'est pas défini dans la réponse. Si aucun nombre minimal n'est spécifié, les données de parcours sont toujours récupérées.

remaining_waypoints_version

Timestamp

Indique le code temporel minimal (exclusif) pour lequel les Trip.remaining_waypoints sont récupérés. Si elles n'ont pas changé depuis ce code temporel, les remaining_waypoints ne sont pas définies dans la réponse. Si ce champ n'est pas spécifié, remaining_waypoints est toujours récupéré.

route_format_type

PolylineFormatType

Format de l'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 (exclusif) pour lequel Trip.current_route_segment_traffic est récupéré. Si les données de trafic n'ont pas changé depuis ce code temporel, le champ current_route_segment_traffic n'est pas défini dans la réponse. Si aucun nombre minimal n'est spécifié, les données sur le trafic sont toujours récupérées. Notez que le trafic n'est disponible que pour les clients de la solution Courses et livraisons à la demande.

remaining_waypoints_route_version

Timestamp

Indique le code temporel 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 n'ont pas changé depuis ce code temporel, 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 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 de projet (par exemple, sample-cloud-project) du projet Google Cloud dont le compte de service à l'origine de cet appel est membre.

current_route_segment_version

Timestamp

Indique le code temporel minimal (exclusif) pour lequel Vehicle.current_route_segment est récupéré. Si l'itinéraire n'a pas changé depuis ce code temporel, le champ current_route_segment n'est pas défini dans la réponse. Si aucun nombre minimal n'est spécifié, current_route_segment est toujours récupéré.

waypoints_version

Timestamp

Indique le code temporel minimal (exclusif) pour lequel les données Vehicle.waypoints sont récupérées. Si les points de cheminement n'ont pas changé depuis ce code temporel, 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 sur la plaque d'immatriculation sont stockées 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

Le dernier chiffre de la plaque d'immatriculation ou "-1" pour indiquer qu'aucune valeur numérique n'est présente dans 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 de projet (par exemple, sample-cloud-project) du projet Google Cloud dont le compte de service à l'origine de cet appel est membre.

page_size

int32

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

page_token

string

Valeur de l'next_page_token fournie par un appel précédent à ListVehicles afin de pouvoir paginer des groupes de véhicules. La valeur est indéfinie si les critères de filtrage de la requête ne sont pas identiques aux critères de filtrage de l'appel précédent de ListVehicles.

minimum_capacity

Int32Value

Indique la capacité minimale requise du véhicule. Tous les véhicules renvoyés auront un maximum_capacity supérieur ou égal à cette valeur. Si défini, doit être supérieur ou égal à 0.

trip_types[]

TripType

Limite la réponse aux véhicules compatibles avec 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 au cours de la durée spécifiée. Les véhicules à l'arrêt qui continuent de transmettre leur position ne sont pas considérés comme obsolètes. Si 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 à l'aide de 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 permet 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 présentant les attributs spécifiés. Ce champ correspond à une opération de conjonction/AND. Vous ne pouvez pas inclure plus de 50 attributs obligatoires. Il correspond au nombre maximal d'attributs autorisés pour 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 présentant au moins l'un des attributs spécifiés dans chaque VehicleAttributeList. Dans chaque liste, un véhicule doit correspondre à au moins un des attributs. Ce champ correspond à une opération de disjonction/OR inclusive dans chaque VehicleAttributeList et à une opération de conjonction/AND pour l'ensemble des 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.

Tout comme required_one_of_attributes, required_one_of_attribute_sets utilise un message qui permet une liste de listes, ce qui permet des expressions telles que 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/OR inclusive sur l'ensemble des 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 dont l'état est défini.

on_trip_only

bool

Ne renvoyez que les véhicules avec le ou les trajets en cours.

filter

string

Facultatif. Requête de filtre à appliquer lors de la liste des véhicules. Pour obtenir des exemples de syntaxe de filtre, consultez http://aip.dev/160.

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 AND 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 avec les 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 requête. 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 suivante des véhicules, ou vide si aucun véhicule ne répond plus aux critères de la requête.

total_size

int64

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

LocationPowerSaveMode

Comment 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 Undefined LocationPowerSaveMode
LOCATION_MODE_NO_CHANGE Soit les fournisseurs de position ne doivent pas être affectés par l'économiseur de batterie, soit l'économiseur de batterie est désactivé.
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF Le fournisseur de position 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 position 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 position restent disponibles, mais les corrections de position ne doivent être fournies 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 n'est pas interactif.

LocationSensor

Capteur ou méthodologie utilisés 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é, identifiant d'une antenne-relais ou point d'accès Wi-Fi
PASSIVE Identifiant de l'antenne-relais ou du point d'accès Wi-Fi
ROAD_SNAPPED_LOCATION_PROVIDER Emplacement déterminé par l'appareil mobile comme étant l'emplacement routier le plus probable.
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 comme CUSTOMER_SUPPLIED_LOCATION sont généralement fournis via le last_location.supplemental_location_sensor d'un véhicule.
FLEET_ENGINE_LOCATION Emplacement calculé par Fleet Engine en fonction des signaux dont il dispose. Uniquement en sortie. Cette valeur sera rejetée si elle est reçue dans une requête.
FUSED_LOCATION_PROVIDER Fused Location Provider d'Android.
CORE_LOCATION Fournisseur de position 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 Driver est en mode FREE_NAV.
ENROUTE_TO_DESTINATION La navigation détaillée est disponible et la navigation dans l'application Driver 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 à environ 50 m 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 à l'aide d'un algorithme de compression de polyligne. Le décodage n'est pas encore disponible.

PowerSource

Type de chargeur utilisé pour recharger 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 requête ReportBillableTrip.

Champs
name

string

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

country_code

string

Obligatoire. Code pays à deux lettres du pays où se déroule le voyage. Le prix est défini en fonction du code pays.

platform

BillingPlatformIdentifier

Plate-forme sur laquelle la requête a été émise.

related_ids[]

string

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

solution_type

SolutionType

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

SolutionType

Sélecteur pour les différents types de solutions d'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 de covoiturage et de livraison à la demande.

RequestHeader

Un RequestHeader contient des champs communs à toutes les requêtes RPC de 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 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'où provient 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" (par exemple, 1.1.2).

os_version

string

Version du système d'exploitation sur lequel le SDK appelant 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 qui envoie la requête.

maps_sdk_version

string

Version du MapSDK sur laquelle le SDK appelant dépend, le cas échéant. Le format de la version est "major.minor.patch" (par exemple, 5.2.1).

nav_sdk_version

string

Version du NavSDK sur laquelle le SDK appelant dépend, le cas échéant. Le format de la version est "major.minor.patch" (par exemple, 2.1.0).

platform

Platform

Plate-forme du SDK appelant.

manufacturer

string

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

android_api_level

int32

Niveau d'API Android du SDK appelant, uniquement applicable 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 requête 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 de projet (par exemple, sample-cloud-project) du projet Google Cloud dont le compte de service à l'origine de cet appel est membre.

vehicle_id

string

Véhicule associé aux trajets de la requête. Si ce paramètre n'est pas spécifié, 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 ce champ est défini sur "true", la réponse inclut les trajets qui influencent l'itinéraire d'un conducteur.

page_size

int32

Si ce paramètre n'est pas défini, 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 une 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 de 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 n'y a plus de résultats, la liste 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 de projet (par exemple, sample-cloud-project) du projet Google Cloud dont le compte de service à l'origine de cet appel est membre.

pickup_point

TerminalLocation

Obligatoire. Point de retrait à proximité duquel effectuer la recherche.

dropoff_point

TerminalLocation

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 de véhicules autour du point de prise en charge. Seuls les véhicules situés dans le rayon de recherche seront affiché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. 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 la capacité.

trip_types[]

TripType

Obligatoire. Indique le type de trajet proposé. Doit inclure un seul 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 informations de localisation à Fleet Engine au cours de la durée spécifiée. Les véhicules à l'arrêt qui continuent de transmettre 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 appartenant à l'un des types spécifiés. Vous devez spécifier au moins un type de véhicule. Les types de véhicules dont la catégorie est UNKNOWN ne sont pas autorisés.

required_attributes[]

VehicleAttribute

Les appelants peuvent former des opérations logiques complexes à l'aide de 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 permet 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 correspond à une opération de conjonction/AND. Vous ne pouvez pas inclure plus de 50 attributs obligatoires. Il correspond au nombre maximal d'attributs autorisés pour un véhicule.

required_one_of_attributes[]

VehicleAttributeList

Limite la recherche aux véhicules présentant au moins l'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/OR inclusive dans chaque VehicleAttributeList et une opération de conjonction/AND pour l'ensemble des VehicleAttributeList.

required_one_of_attribute_sets[]

VehicleAttributeList

required_one_of_attribute_sets fournit des fonctionnalités supplémentaires.

Tout comme required_one_of_attributes, required_one_of_attribute_sets utilise un message qui permet une liste de listes, ce qui permet des expressions telles que 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 qui présentent 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/OR inclusive dans l'ensemble des 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 à 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 false, les véhicules avec des trajets attribués sont exclus des résultats de recherche. Lorsque current_trips_present n'est pas spécifié et que ce champ est 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é à cet objet SearchVehicleRequest.

current_trips_present

CurrentTripsPresent

Indique si les véhicules avec des trajets actifs sont éligibles à cette recherche. Cette valeur doit être différente de CURRENT_TRIPS_PRESENT_UNSPECIFIED si trip_type inclut SHARED.

filter

string

Facultatif. Requête de filtre à appliquer lors de la recherche de véhicules. Pour obtenir des exemples de syntaxe de filtre, consultez http://aip.dev/160.

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 AND 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 avec les 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 ayant 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 de véhicules dans la réponse.

Enums
UNKNOWN_VEHICLE_MATCH_ORDER Par défaut, utilisé pour les correspondances de véhicules non spécifiées ou non reconnues.
PICKUP_POINT_ETA Tri croissant par temps de trajet en voiture jusqu'au point de prise en charge.
PICKUP_POINT_DISTANCE Par ordre croissant de distance en voiture du véhicule jusqu'au point de prise en charge.
DROPOFF_POINT_ETA Tri croissant en fonction du temps de trajet en voiture 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 Par ordre croissant de distance en ligne droite entre le dernier emplacement signalé du véhicule et le point de prise en charge.
COST par ordre croissant du coût de la correspondance configuré. Le coût de mise en correspondance est défini comme un calcul pondéré entre la distance en ligne droite et l'heure d'arrivée estimée. Les pondérations sont définies avec des valeurs par défaut et peuvent être modifiées par client. Veuillez contacter l'assistance Google si vous devez modifier ces pondérations pour votre projet.

SearchVehiclesResponse

Message de réponse SearchVehicles.

Champs
matches[]

VehicleMatch

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

SpeedReadingInterval

Indicateur de densité du trafic sur un segment contigu d'un parcours. Étant donné un chemin avec les points P_0, P_1, ... , P_N (indice à partir de 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ébut de cet intervalle dans le chemin d'accès. Dans le format JSON, lorsque l'index est égal à 0, le champ semble ne pas être renseigné.

end_polyline_point_index

int32

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

speed

Speed

Vitesse du trafic pendant cet intervalle.

Vitesse

Classification de la vitesse de la polyligne en fonction des données sur le 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 n'est formé.
TRAFFIC_JAM Embouteillage détecté.

StopLocation

Emplacement exact où un arrêt (prise en charge/dépose) s'est produit.

Champs
point

LatLng

Obligatoire. Indique l'emplacement réel.

timestamp

Timestamp

Indique quand 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 de 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 points de terminaison ne sont plus acceptés dans 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 du véhicule.

Champs
traffic_rendering

VisualTrafficReportPolylineRendering

Affichage d'une polyligne représentant la vitesse du trafic pour toutes les régions sur un tronçon du trajet 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 viendra récupérer son colis.

actual_pickup_point

StopLocation

Uniquement en entrée. Emplacement exact et heure de prise en charge du client Ce champ permet au fournisseur de fournir des commentaires sur les informations de prise en charge réelles.

actual_pickup_arrival_point

StopLocation

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

pickup_time

Timestamp

Uniquement en sortie. Heure estimée à laquelle le ou les passagers seront pris en charge ou heure réelle à laquelle ils ont été pris en charge.

intermediate_destinations[]

TerminalLocation

Arrêts intermédiaires dans l'ordre indiqué dans la demande de trajet (en plus des points de départ et d'arrivée). Cette fonctionnalité ne sera pas disponible pour les trajets partagés dans un premier temps.

intermediate_destinations_version

Timestamp

Indique la dernière fois que l'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 ENROUTE_TO_INTERMEDIATE_DESTINATION, nombre compris entre [0..N-1] indiquant la destination intermédiaire que le véhicule traversera ensuite. Lorsque TripStatus est ARRIVED_AT_INTERMEDIATE_DESTINATION, nombre compris entre [0..N-1] indiquant la destination intermédiaire du véhicule. Cette valeur est définie par le fournisseur. 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 d'arrivée du chauffeur à 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. Heure et lieu exacts où le client a été pris en charge à une destination intermédiaire. 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 souhaite être déposé.

actual_dropoff_point

StopLocation

Uniquement en entrée. Heure et lieu exacts de la dépose du client. Ce champ permet au fournisseur de fournir des commentaires sur les informations de dépose réelles.

dropoff_time

Timestamp

Uniquement en sortie. Heure estimée à laquelle le ou les passagers seront déposés à la destination finale, ou heure réelle à laquelle ils ont été déposés.

remaining_waypoints[]

TripWaypoint

Uniquement en sortie. Chemin complet entre l'emplacement actuel et le point de dépôt, y compris. Ce chemin peut inclure des points de cheminement d'autres trajets.

vehicle_waypoints[]

TripWaypoint

Ce champ permet de définir manuellement l'ordre des points de cheminement pour le trajet. Il contient tous les points de repère restants pour le véhicule attribué, ainsi que les points de ramassage et de dépôt 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é que par le serveur pour les appels UpdateTrip et CreateTrip, et NON pour les appels GetTrip.

route[]

LatLng

Uniquement en sortie. Itinéraire prévu pour ce trajet jusqu'à la première entrée de remaining_waypoints. Notez que le premier point de cheminement peut appartenir à un autre trajet.

current_route_segment

string

Uniquement en sortie. Chemin d'accès au prochain point de repère encodé.

Remarque: Ce champ n'est destiné qu'à être utilisé par le SDK Driver et le SDK Consumer. Le décodage n'est pas encore disponible.

current_route_segment_version

Timestamp

Uniquement en sortie. Indique la dernière fois que l'itinéraire a été modifié.

Remarque: Ce champ n'est destiné qu'à ê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 de l'current_route_segment lorsqu'elles sont disponibles.

Remarque: Ce champ n'est destiné qu'à ê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 l'current_route_segment_traffic a été modifié.

Remarque: Ce champ n'est destiné qu'à être utilisé par le SDK Driver et le SDK Consumer.

current_route_segment_end_point

TripWaypoint

Uniquement en sortie. Point d'intérêt où current_route_segment se termine.

remaining_distance_meters

Int32Value

Uniquement en sortie. Distance restante à parcourir 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 estimée au prochain point de cheminement (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 moment où les données de trajet sont renvoyées et l'heure indiquée 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 d'intérêt a été ajouté, supprimé ou modifié).

remaining_waypoints_route_version

Timestamp

Uniquement en sortie. Indique la dernière fois que les 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 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 de ce trajet, sans inclure le conducteur. Un véhicule doit disposer d'une capacité disponible pour être renvoyé dans une réponse SearchVehicles.

last_location

VehicleLocation

Uniquement en sortie. Indique le dernier emplacement signalé du véhicule le long du trajet.

last_location_snappable

bool

Uniquement en sortie. Indique si l'last_location du véhicule peut être épinglé au current_route_segment. "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 des champs de trajet renseignés et mode d'interprétation

TripStatus

État d'un trajet indiquant sa progression.

Enums
UNKNOWN_TRIP_STATUS Par défaut, utilisé pour l'état de trajet non spécifié ou non reconnu.
NEW Trajet nouvellement créé.
ENROUTE_TO_PICKUP Le chauffeur est en route vers le point de prise en charge.
ARRIVED_AT_PICKUP Le chauffeur est arrivé au point de rendez-vous.
ARRIVED_AT_INTERMEDIATE_DESTINATION Le chauffeur 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 vers 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 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 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 "Trip" dans une réponse GetTrip. Pour en savoir plus, consultez AIP-157. D'autres vues seront probablement 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 assurer la stabilité et l'assistance, nous recommandons aux clients de sélectionner un TripView autre que SDK.
SDK Inclut les champs qui ne peuvent pas être interprétés ou pris en charge à l'aide de bibliothèques publiques.
JOURNEY_SHARING_V1S Les champs de 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 un point d'arrivée sur son trajet.

Champs
location

TerminalLocation

Emplacement de ce point de repère.

trip_id

string

Trajet associé à ce point de repère.

waypoint_type

WaypointType

Rôle de ce point de repère dans ce trajet, par exemple "Ramassage" ou "Dépose".

path_to_waypoint[]

LatLng

Chemin d'accès du point de cheminement précédent au point de cheminement actuel. Indé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 n'est destiné qu'à être utilisé par le SDK Driver et le SDK Consumer. Le décodage n'est pas encore disponible.

traffic_to_waypoint

ConsumableTrafficPolyline

Conditions de circulation sur le trajet vers ce point de repère. Notez que le trafic n'est disponible que pour les clients de la solution Google Maps Platform Rides and Deliveries.

distance_meters

Int32Value

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

eta

Timestamp

Heure d'arrivée estimée à ce point de repère. Indéfini pour le premier point de cheminement d'une liste.

duration

Duration

Temps de trajet entre le point de repère précédent et ce point. Indéfini pour le premier point de cheminement d'une liste.

UpdateTripRequest

Message de requête UpdateTrip.

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 de projet (par exemple, sample-consumer-project) du projet Google Cloud dont le compte de service à l'origine de cet appel est membre.

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 la Trip.vehicle_id d'un trajet partagé, vous devez fournir la liste des Trip.vehicle_waypoints pour spécifier l'ordre des points de cheminement restants. Sinon, l'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 points de cheminement supplémentaires. Vous devez organiser ces points de cheminement de sorte que, pour un trajet donné, le point de prise en charge soit placé avant les destinations intermédiaires, et que toutes les destinations intermédiaires soient placées avant le point de dépose. Les points de cheminement d'un trajet EXCLUSIVE ne doivent pas se chevaucher 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 les trajets avec plusieurs destinations, vous devez fournir Trip.intermediate_destinations_version lorsque vous définissez l'état du trajet sur ENROUTE_TO_INTERMEDIATE_DESTINATION. L'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 de l'itinéraire à 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 être l'ID de projet (par exemple, sample-cloud-project) du projet Google Cloud dont le compte de service à l'origine de cet appel est membre.

attributes[]

VehicleAttribute

Obligatoire. Attributs du véhicule à mettre à jour. Les attributs non mentionnés ne sont pas 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 inchangé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 correspondre à l'ID de projet (par exemple, sample-cloud-project) du projet Google Cloud dont le compte de service à l'origine de cet appel est membre.

vehicle

Vehicle

Obligatoire. Valeurs de l'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 les attributs 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 doit contenir tous les points de cheminement actuellement sur le véhicule et aucun autre.

update_mask

FieldMask

Obligatoire. Masque de champ indiquant les champs de l'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 de ce 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 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 à 1.

attributes[]

VehicleAttribute

Liste des attributs du véhicule. Un véhicule peut comporter au maximum 100 attributs, 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. Elle a également une incidence sur l'heure d'arrivée prévue et les calculs d'itinéraire.

license_plate

LicensePlate

Informations sur la plaque d'immatriculation du véhicule.

route[]
(deprecated)

TerminalLocation

Obsolète: utilisez Vehicle.waypoints à la place.

current_route_segment

string

Polyligne spécifiant le trajet que l'application du conducteur prévoit d'emprunter jusqu'au prochain point de repère. Cette liste est également renvoyée dans Trip.current_route_segment pour tous les trajets actifs attribués au véhicule.

Remarque: Ce champ n'est destiné qu'à être utilisé par le SDK du pilote. Le décodage n'est pas encore disponible.

current_route_segment_traffic

TrafficPolylineData

Uniquement en entrée. Fleet Engine utilise ces informations pour améliorer le partage de trajets. Remarque: Ce champ n'est destiné qu'à être utilisé par le SDK du pilote.

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 itinéraires qui n'ont pas changé.

current_route_segment_end_point

TripWaypoint

Point de repère où current_route_segment se termine. Les conducteurs peuvent fournir cette information dans les appels UpdateVehicle sous la forme d'un point de cheminement complet du trajet, d'un point de cheminement LatLng ou du dernier LatLng de la current_route_segment. Fleet Engine fera ensuite de son mieux pour interpoler un point de cheminement réel s'il 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 restante à parcourir en voiture pour l'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 estimée à 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.

Lors de la mise à jour d'un véhicule, remaining_time_seconds a la priorité sur eta_to_first_waypoint dans la même requête.

remaining_time_seconds

Int32Value

Uniquement en entrée. Temps de trajet restant pour l'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.

Lors de la mise à jour d'un véhicule, remaining_time_seconds a la priorité sur eta_to_first_waypoint dans la même requête.

waypoints[]

TripWaypoint

Les points de cheminement restants attribués à ce véhicule.

waypoints_version

Timestamp

Uniquement en sortie. Date 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 les trajets consécutifs. Si 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 de type de véhicule

Catégorie

Catégories de types de véhicules

Enums
UNKNOWN Valeur par défaut, utilisée pour les catégories de véhicules non spécifiées ou non reconnues.
AUTO Une automobile.
TAXI Tout véhicule qui fait office de taxi (généralement sous licence ou réglementé).
TRUCK En général, un véhicule offrant une grande capacité de stockage.
TWO_WHEELER Moto, mobylette ou autre véhicule à deux roues
BICYCLE Transport à propulsion humaine
PEDESTRIAN Transport en commun humain, généralement à pied ou en courant, empruntant des voies piétonnes.

VehicleAttribute

Décrit un attribut de véhicule sous la forme d'une paire clé-valeur. La longueur de la chaîne "clé:valeur" 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. La valeur de l'attribut peut être de type chaîne, booléen 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 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 à double type.

VehicleAttributeList

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

Champs
attributes[]

VehicleAttribute

Liste des attributs de cette collection.

VehicleLocation

Position, vitesse et cap d'un véhicule à un moment donné.

Champs
location

LatLng

Emplacement du véhicule. Lorsqu'il est envoyé à Fleet Engine, l'emplacement du véhicule est un emplacement GPS. Lorsque vous la recevez dans une réponse, la position du véhicule peut être une position GPS, une position supplémentaire ou une autre position estimée. La source est spécifiée dans location_sensor.

horizontal_accuracy
(deprecated)

DoubleValue

Obsolète: utilisez latlng_accuracy à la place.

latlng_accuracy

DoubleValue

Précision de location en mètres en tant que 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 heading_accuracy à la place.

heading_accuracy

DoubleValue

Précision de heading en degrés.

altitude

DoubleValue

Altitude en mètres au-dessus du WGS84.

vertical_accuracy
(deprecated)

DoubleValue

Obsolète: utilisez altitude_accuracy à la place.

altitude_accuracy

DoubleValue

Précision de altitude mètres

speed_kmph
(deprecated)

Int32Value

Vitesse du véhicule en kilomètres par heure. Obsolète: utilisez speed à la place.

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 de 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. Durée (en secondes) depuis l'envoi de cet emplacement au serveur pour la première fois. Il sera nul pour la première mise à jour. Si l'heure est inconnue (par exemple, lorsque l'application redémarre), cette valeur est réinitialisée sur zéro.

num_stale_updates
(deprecated)

Int32Value

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

raw_location

LatLng

Position brute du véhicule (non traitée par Road Snapper).

raw_location_time

Timestamp

Code temporel associé à la position brute.

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

Position supplémentaire fournie 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 is_road_snapped à la place.

VehicleMatch

Inclut le véhicule et les estimations associées pour un véhicule correspondant aux points des trajets actifs pour le véhicule SearchVehiclesRequest.

Champs
vehicle

Vehicle

Obligatoire. Véhicule correspondant à la requête.

vehicle_pickup_eta

Timestamp

Heure d'arrivée estimée du véhicule au point de ramassage spécifié dans la requête. Une valeur vide indique un échec lors du calcul de l'heure d'arrivée estimée du véhicule. Si SearchVehiclesRequest.include_back_to_back était true et que ce véhicule a un trajet actif, vehicle_pickup_eta inclut le temps nécessaire pour terminer le trajet actif en cours.

vehicle_pickup_distance_meters

Int32Value

Distance entre l'emplacement actuel du véhicule et le point de prise en charge spécifié dans la demande, 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), ainsi que la distance en ligne droite entre le point d'arrivée de la navigation et le point de prise en charge demandé. (La distance entre le point d'arrivée de la navigation et le point de prise en charge demandé est généralement faible.) Une valeur vide indique une erreur lors du 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 demande.

vehicle_dropoff_eta

Timestamp

Heure d'arrivée estimée du véhicule complet au point de dépose spécifié dans la demande. L'heure d'arrivée prévue inclut les arrêts aux points de cheminement avant l'dropoff_point spécifié dans la requête. La valeur n'est renseignée que lorsqu'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 estimée.

vehicle_pickup_to_dropoff_distance_meters

Int32Value

Distance (en mètres) du véhicule entre le point de prise en charge et le point de dépose spécifié dans la demande. La distance ne concerne que les deux points et n'inclut pas l'emplacement du véhicule ni les autres points que le véhicule doit atteindre avant de se rendre au point de prise en charge ou 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 qu'il n'a pas été possible de calculer 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 utilisée pour calculer l'heure d'arrivée estimée au point de prise en charge.

vehicle_trips_waypoints[]

Waypoint

Liste triée des points de cheminement utilisés pour calculer l'heure d'arrivée prévue. La liste comprend la localisation du véhicule, les points de retrait des trajets actifs pour le véhicule et les points de retrait indiqués dans la demande. Une liste vide indique un échec lors du calcul de l'heure d'arrivée estimée du véhicule.

vehicle_match_type

VehicleMatchType

Type de correspondance du véhicule.

requested_ordered_by

VehicleMatchOrder

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

ordered_by

VehicleMatchOrder

Ordre demandé pour trier les correspondances de véhicules. Équivaut à requested_ordered_by.

VehicleMatchType

Type de correspondance de véhicule.

Enums
UNKNOWN Type de correspondance de véhicule inconnu
EXCLUSIVE Aucun trajet n'est actuellement attribué au véhicule, qui peut se rendre au point de prise en charge.
BACK_TO_BACK Le véhicule est actuellement attribué à un trajet, mais peut se rendre au point de prise en charge une fois le trajet en cours terminé. Les calculs de l'heure d'arrivée estimée et de la distance tiennent compte du trajet existant.
CARPOOL Le véhicule est suffisamment spacieux pour une course partagée.
CARPOOL_BACK_TO_BACK Le véhicule terminera son trajet en cours avant de se rendre au point de ramassage. Les calculs de l'heure d'arrivée estimée et de la distance tiennent compte du trajet existant.

VehicleState

État d'un Vehicle.

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

VisualTrafficReportPolylineRendering

Décrit comment les clients doivent colorer une partie de la polyligne le long du parcours.

Champs
road_stretch[]

RoadStretch

Facultatif. Segments de route à afficher le long de la polyligne. Les tronçons ne se chevauchent pas et ne couvrent pas nécessairement l'ensemble du trajet.

En l'absence de tronçon de route à styliser, le client doit appliquer le style par défaut pour 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 [offset_meters, offset_meters + length_meters).

length_meters

int32

Obligatoire. Longueur du chemin d'accès 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 d'un itinéraire pour un VehicleMatch dans un SearchVehiclesResponse. Ce concept est représenté par un TripWaypoint dans tous les autres points de terminaison.

Champs
lat_lng

LatLng

Emplacement de ce point de repère.

eta

Timestamp

Heure estimée à laquelle le véhicule arrivera à ce point de repère.

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 repère pour prendre des passagers ou des articles.
DROP_OFF_WAYPOINT_TYPE Points de repère pour déposer des passagers ou des articles.
INTERMEDIATE_DESTINATION_WAYPOINT_TYPE Points de cheminement pour les destinations intermédiaires d'un trajet multi-destination