Rechercher des tâches

Ce document décrit comment trouver des informations sur les tâches à partir d'un serveur ou d'un navigateur. Fleet Engine propose deux méthodes pour rechercher des tâches:

• Rechercher des tâches : vous pouvez rechercher des tâches par ID :

  • ID de tâche : utilisé par les utilisateurs tels que les opérateurs de flotte qui ont accès à la vue complète des données de la tâche.
  • ID de suivi: utilisé par votre logiciel client pour fournir des informations limitées à un utilisateur final, par exemple la date à laquelle un colis est attendu chez lui.

  Assurez-vous de bien comprendre la différence entre l'ID de tâche et l'ID de suivi de tâche. Sachez qu'il s'agit de deux choses différentes. Consultez la section Champs de tâches de base du guide des tâches planifiées.

• Liste de tâches: accès étendu aux tâches, réservé aux utilisateurs de confiance.

Rechercher des tâches

Cette section explique comment rechercher des tâches par ID de tâche ou ID de suivi. Les exigences sont les suivantes:

• Les recherches par ID de suivi doivent respecter les règles de visibilité indiquées dans la section Règles de visibilité pour les objets suivis.

• Utilisez le jeton le plus étroit possible pour limiter les risques de sécurité. Par exemple, si vous utilisez un jeton de client livré, tous les appels ne renvoient que des informations pertinentes pour cet utilisateur final, comme le transporteur ou le destinataire d'un colis. Fleet Engine masque toutes les autres informations dans les réponses. Pour en savoir plus sur les jetons, consultez la page Jetons Web JSON.

Rechercher une tâche par ID de tâche

Vous pouvez rechercher une tâche d'après son ID dans un environnement de serveur à l'aide de gRPC ou de REST. Les exemples suivants montrent comment utiliser la bibliothèque gRPC Java ou une requête REST envoyée à GetTask.

 static final String PROJECT_ID = "my-delivery-co-gcp-project";
 static final String TASK_ID = "task-8597549";

 DeliveryServiceBlockingStub deliveryService =
   DeliveryServiceGrpc.newBlockingStub(channel);

 // Task request
 String taskName = "providers/" + PROJECT_ID + "/tasks/" + TASK_ID;
 GetTaskRequest getTaskRequest = GetTaskRequest.newBuilder()  // No need for the header
     .setName(taskName)
     .build();

 try {
   Task task = deliveryService.getTask(getTaskRequest);
 } catch (StatusRuntimeException e) {
   Status s = e.getStatus();
   switch (s.getCode()) {
      case NOT_FOUND:
        break;

      case PERMISSION_DENIED:
        break;
   }
   return;
 }

    # Set JWT, PROJECT_ID, and TASK_ID in the local environment
    curl -H "Authorization: Bearer ${JWT}" \
      "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/tasks/${TASK_ID}"

Rechercher des tâches par ID de suivi

Les exemples suivants montrent comment rechercher des tâches par leur ID de suivi d'expédition à l'aide de gRPC ou d'un appel REST HTTP à GetTaskTrackingInfo.

static final String PROJECT_ID = "my-delivery-co-gcp-project";
static final String TRACKING_ID = "TID-7449w087464x5";

DeliveryServiceBlockingStub deliveryService =
  DeliveryServiceGrpc.newBlockingStub(channel);

// Tasks request
String parent = "providers/" + PROJECT_ID;
GetTaskTrackingInfoRequest getTaskTrackingInfoRequest = GetTaskTrackingInfoRequest.newBuilder()  // No need for the header
    .setParent(parent)
    .setTrackingId(TRACKING_ID)
    .build();

try {
  TaskTrackingInfo taskTrackingInfo = deliveryService.getTaskTrackingInfo(getTaskTrackingInfoRequest);
} catch (StatusRuntimeException e) {
  Status s = e.getStatus();
  switch (s.getCode()) {
     case NOT_FOUND:
       break;

     case PERMISSION_DENIED:
       break;
  }
  return;
}

# Set JWT, PROJECT_ID, and TRACKING_ID in the local environment
curl -H "Authorization: Bearer ${JWT}" \
  "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/taskTrackingInfo/${TRACKING_ID}"

Répertorier les tâches

La liste des tâches demande un accès étendu aux tâches. La création de tâches de liste n'est destinée qu'aux utilisateurs de confiance. Utilisez des jetons d'authentification Lecteur Fleet Engine Delivery ou Administrateur de diffusion lorsque vous envoyez des requêtes de tâches de liste. Pour en savoir plus, consultez la section Rôles associés aux comptes de service.

Paginer les listes

Les listes de tâches sont paginées. Vous pouvez spécifier une taille de page dans les requêtes de listage de tâches. Si une taille de page est spécifiée, le nombre de tâches renvoyées n'est pas supérieur à la taille de page spécifiée. Si aucune taille de page n'est spécifiée, une valeur par défaut raisonnable est utilisée. Si la taille de page demandée dépasse une valeur maximale interne, la valeur maximale interne est utilisée.

Une liste de tâches peut inclure un jeton permettant de lire la page de résultats suivante. Pour récupérer la page suivante, renvoyez la même requête avec le jeton de page. Lorsque le jeton de page renvoyé est vide, aucune tâche n'est disponible à récupérer.

Champs à utiliser pour lister des tâches

Fleet Engine masque les champs suivants lors de la création d'une liste des tâches:

• VehicleStop.planned_location
• VehicleStop.state
• VehicleStop.TaskInfo.taskId

Utilisez les formats de champ suivants, basés sur les propositions d'amélioration de l'API Google :

Filtrer les tâches listées

Vous pouvez filtrer les tâches répertoriées selon la plupart de leurs propriétés. Pour en savoir plus sur la syntaxe des requêtes de filtre, consultez la page AIP-160. Si aucune requête de filtre n'est spécifiée, toutes les tâches sont listées.

Le tableau suivant présente les propriétés de tâche valides que vous pouvez utiliser pour le filtrage:

Pour obtenir la liste complète des opérateurs de requête de filtrage, consultez AIP-160.

Répertorier des exemples de tâches

L'exemple suivant montre comment lister les tâches pour un deliveryVehicleId et un attribut de tâche, à la fois avec la bibliothèque Java gRPC et avec un appel REST HTTP à ListTasks.

Une réponse positive peut toujours être vide. Une réponse vide indique qu'aucune tâche n'est associée au deliveryVehicleId fourni.

 static final String PROJECT_ID = "my-delivery-co-gcp-project";
 static final String TRACKING_ID = "TID-7449w087464x5";

 DeliveryServiceBlockingStub deliveryService =
   DeliveryServiceGrpc.newBlockingStub(channel);

 // Tasks request
 String parent = "providers/" + PROJECT_ID;
 ListTasksRequest listTasksRequest = ListTasksRequest.newBuilder()  // No need for the header
     .setParent(parent)
     .setFilter("delivery_vehicle_id = 123 AND attributes.foo = true")
     .build();

 try {
   ListTasksResponse listTasksResponse = deliveryService.listTasks(listTasksRequest);
 } catch (StatusRuntimeException e) {
   Status s = e.getStatus();
   switch (s.getCode()) {
      case NOT_FOUND:
        break;

      case PERMISSION_DENIED:
        break;
   }
   return;
 }

    // JSON representation
    {
      "tasks": [
        {
          object (Task)
        }
      ],
      "nextPageToken": string,
      "totalSize": integer
    }

 # Set JWT, PROJECT_ID, and VEHICLE_ID in the local environment
 curl -H "Authorization: Bearer ${JWT}" \
   "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/tasks?filter=state%20%3D%20OPEN%20AND%20delivery_vehicle_id%20%3D%20${VEHICLE_ID}"

Étape suivante

• Gérer les envois