Method: providers.trips.search

Obtenez tous les trajets pour un véhicule spécifique.

Requête HTTP

POST https://fleetengine.googleapis.com/v1/{parent=providers/*}/trips: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)
  },
  "vehicleId": string,
  "activeTripsOnly": boolean,
  "pageSize": integer,
  "pageToken": string,
  "minimumStaleness": string
}
Champs
header

object (RequestHeader)

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

string

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

  • currentRouteSegment
  • remainingWaypoints
  • remainingDistanceMeters
  • etaToFirstWaypoint
activeTripsOnly

boolean

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

integer

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

string

Définissez-la sur une valeur précédemment renvoyée dans SearchTripsResponse pour reprendre à partir des résultats précédents.
minimumStaleness

string (Duration format)

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

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

Corps de la réponse

dans le message de réponse trips.search.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "trips": [
    {
      object (Trip)
    }
  ],
  "nextPageToken": string
}
Champs
trips[]

object (Trip)

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

string

Transmettez ce jeton dans la SearchTripsRequest à la page des résultats de la liste. L'API renvoie une liste de trajets à chaque appel. Lorsqu'il ne reste plus de résultats, la liste de trajets est vide.