Method: providers.vehicles.search

Renvoie une liste de véhicules correspondant aux options de requête.

Requête HTTP

POST https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles:search

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
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 effectuant cet appel.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "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
}
Champs
header

object (RequestHeader)

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

object (TerminalLocation)

Obligatoire. Point de retrait à proximité.
dropoffPoint

object (TerminalLocation)

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

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

integer

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

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 capacité.
tripTypes[]

enum (TripType)

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

string (Duration format)

Limite la recherche aux seuls véhicules ayant envoyé des mises à jour de position à Fleet Engine pendant la durée spécifiée. Les véhicules à l'arrêt qui transmettent 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.

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

object (VehicleType)

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

object (VehicleAttribute)

Les appelants peuvent former des opérations logiques complexes en utilisant n'importe quelle combinaison des champs requiredAttributes, requiredOneOfAttributes et requiredOneOfAttributeSets.

requiredAttributes est une liste. requiredOneOfAttributes utilise un message qui autorise une liste de listes. Combinés, les deux champs permettent de composer l'expression suivante:

(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 seuls véhicules disposant des attributs spécifiés. Ce champ est une opération de conjonction/ET. Un maximum de 50 obligatoireAttributes est autorisé. Ce nombre correspond au nombre maximal d'attributs autorisés sur un véhicule.
requiredOneOfAttributes[]

object (VehicleAttributeList)

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

object (VehicleAttributeList)

requiredOneOfAttributeSets fournit des fonctionnalités supplémentaires.

À l'instar de requiredOneOfAttributes, requiredOneOfAttributeSets utilise un message qui autorise une liste de listes, ce qui permet d'utiliser des expressions comme 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
  ...)
)

Restreint la recherche aux véhicules dont tous les attributs sont inclus dans un VehicleAttributeList. Dans chaque liste, un véhicule doit correspondre à tous les attributs. Ce champ est une opération de conjonction/AND dans chaque VehicleAttributeList et une opération de disjonction/OU inclusive dans la collection de VehicleAttributeList.
orderBy

enum (VehicleMatchOrder)

Obligatoire. Spécifie le critère d'ordre souhaité pour les résultats.
includeBackToBack

boolean

Indique si les véhicules avec un seul trajet actif sont éligibles pour 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 associés à des trajets sont exclus des résultats de recherche. Si currentTripsPresent n'est pas spécifié et que ce champ est défini sur true, les résultats de recherche peuvent inclure des véhicules avec un trajet actif dont l'état est ENROUTE_TO_DROPOFF. Lorsque currentTripsPresent est spécifié, ce champ ne peut pas être défini sur "true".

La valeur par défaut est false.
tripId

string

Indique le trajet associé à ce SearchVehicleRequest.
currentTripsPresent

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

string

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

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 ET avec d'autres contraintes, telles que minimumCapacity ou vehicleTypes.

Notez que les seules requêtes acceptées concernent les attributs de véhicule (par exemple, attributes.<key> = <value> ou attributes.<key1> = <value1> AND attributes.<key2> = <value2>). Le nombre maximal de restrictions autorisé 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 par rapport aux attributs acceptées sont des comparaisons de chaînes. Pour être comparées aux valeurs numériques ou booléennes, les valeurs doivent être entre guillemets explicites pour être traitées comme des chaînes (par exemple, attributes.<key> = "10" ou attributes.<key> = "true").

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de SearchVehiclesResponse.