Method: providers.vehicles.search

{
  "header": {
    object (RequestHeader)
  },
  "pickupPoint": {
    object (TerminalLocation)
  },
  "dropoffPoint": {
    object (TerminalLocation)
  },
  "pickupRadiusMeters": integer,
  "count": integer,
  "minimumCapacity": integer,
  "tripTypes": [
    enum (TripType)
  ],
  "maximumStaleness": string,
  "vehicleTypes": [
    {
      object (VehicleType)
    }
  ],
  "requiredAttributes": [
    {
      object (VehicleAttribute)
    }
  ],
  "requiredOneOfAttributes": [
    {
      object (VehicleAttributeList)
    }
  ],
  "requiredOneOfAttributeSets": [
    {
      object (VehicleAttributeList)
    }
  ],
  "orderBy": enum (VehicleMatchOrder),
  "includeBackToBack": boolean,
  "tripId": string,
  "currentTripsPresent": enum (CurrentTripsPresent),
  "filter": string
}

object (RequestHeader)

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

object (TerminalLocation)

Obligatoire. Lieu de prise en charge à proximité duquel la recherche doit être effectuée.

object (TerminalLocation)

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

integer

Obligatoire. Définit le rayon de recherche du 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).

integer

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

integer

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

enum (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.

string (Duration format)

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 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.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"

object (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 types de véhicules dont la catégorie est UNKNOWN ne sont pas autorisés.

object (VehicleAttribute)

Les appelants peuvent former des opérations logiques complexes à l'aide de n'importe quelle combinaison des champs requiredAttributes, requiredOneOfAttributes et requiredOneOfAttributeSets.

requiredAttributes est une liste. requiredOneOfAttributes utilise un message qui permet une liste de listes. Ensemble, les deux champs permettent de composer cette expression :

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(requiredOneOfAttributes[0][0] OR requiredOneOfAttributes[0][1] OR
...)
AND
(requiredOneOfAttributes[1][0] OR requiredOneOfAttributes[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. Un maximum de 50 attributs requiredAttributes est autorisé. Ce nombre correspond au nombre maximal d'attributs autorisé pour un véhicule.

object (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/OU inclusive dans chaque VehicleAttributeList et une opération de conjonction/ET sur la collection de VehicleAttributeList.

object (VehicleAttributeList)

requiredOneOfAttributeSets fournit des fonctionnalités supplémentaires.

Tout comme requiredOneOfAttributes, requiredOneOfAttributeSets utilise un message qui permet une liste de listes, ce qui permet des expressions telles que celle-ci :

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(
  (requiredOneOfAttributeSets[0][0] AND
  requiredOneOfAttributeSets[0][1] AND
  ...)
  OR
  (requiredOneOfAttributeSets[1][0] AND
  requiredOneOfAttributeSets[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/ET dans chaque VehicleAttributeList et une opération de disjonction inclusive/OU dans la collection de VehicleAttributeList.

enum (VehicleMatchOrder)

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

boolean

Indique si les véhicules avec un seul trajet actif sont éligibles à cette recherche. Ce champ n'est utilisé que lorsque currentTripsPresent n'est pas spécifié. Lorsque currentTripsPresent 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 currentTripsPresent 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 currentTripsPresent est spécifié, ce champ ne peut pas être défini sur "true".

La valeur par défaut est false.

string

Indique le trajet associé à ce SearchVehicleRequest.

enum (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 tripType inclut SHARED.

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 requiredAttributes, requiredOneOfAttributes et required_one_of_attributes_sets. Si une valeur non vide est spécifiée ici, les champs suivants doivent être vides: requiredAttributes, requiredOneOfAttributes et required_one_of_attributes_sets.

Ce filtre fonctionne comme une clause AND avec d'autres contraintes, telles que minimumCapacity ou vehicleTypes.

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").