Method: providers.tasks.search

Obsolète: utilisez plutôt taskTrackingInfo.get.

Requête HTTP

GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/tasks: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. Exemple : sample-cloud-project.

Paramètres de requête

Paramètres
header

object (DeliveryRequestHeader)

Facultatif. En-tête de requête de l'API Delivery standard.
trackingId

string

Obligatoire. Identifiant de l'ensemble des tâches associées demandées. Les ID de suivi sont soumis aux restrictions suivantes:

  • Vous devez saisir une chaîne Unicode valide.
  • 64 caractères maximum.
  • Normalisée conformément au formulaire de normalisation Unicode C.
  • Ne doit pas contenir les caractères ASCII suivants: "/", ":", "?", "#".
pageSize

integer

Facultatif. Nombre maximal de tâches à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur. Si vous ne spécifiez pas cette valeur, le serveur détermine le nombre de résultats à renvoyer.
pageToken

string

Facultatif. Jeton de page reçu d'un appel tasks.search précédent. Vous devez indiquer cette valeur pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à tasks.search doivent correspondre à l'appel ayant fourni le jeton de page.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Réponse tasks.search. Il contient l'ensemble des tâches qui correspondent aux critères de recherche du SearchTasksRequest.

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

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

object (Task)

Ensemble de tâches pour le trackingId demandé. Une réponse positive peut également être vide. Une réponse vide indique qu'aucune tâche n'est associée au trackingId fourni.
nextPageToken

string

Transmettez ce jeton dans SearchTasksRequest pour continuer à répertorier les résultats. Si tous les résultats ont été renvoyés, ce champ est soit une chaîne vide, soit n'apparaît pas dans la réponse.