Aufgaben suchen

In diesem Dokument wird beschrieben, wie Sie Aufgabeninformationen von einem Server oder Browser abrufen können. Fleet Engine unterstützt zwei Möglichkeiten, Aufgaben zu finden:

• Aufgaben suchen: Sie können Aufgaben anhand der folgenden IDs suchen:

  • Aufgaben-ID: Wird von Nutzern wie Flottenmanagern verwendet, die Zugriff auf die vollständige Ansicht der Aufgabendaten haben.
  • Tracking-ID: Wird von Ihrer Clientsoftware verwendet, um einem Endnutzer begrenzte Informationen zur Verfügung zu stellen, z. B. wann ein Paket bei ihm zugestellt wird.

  Achten Sie darauf, den Unterschied zwischen der Aufgaben-ID und der Aufgaben-Tracking-ID zu verstehen. Sie sind jedoch nicht identisch. Weitere Informationen finden Sie im Leitfaden zu geplanten Aufgaben unter Grundlegende Aufgabenfelder.

• Aufgabenliste: umfassender Zugriff auf Aufgaben, nur für vertrauenswürdige Nutzer bestimmt

Aufgaben suchen

In diesem Abschnitt wird beschrieben, wie Sie Aufgaben anhand der Aufgaben-ID oder der Tracking-ID suchen. Es gelten folgende Anforderungen:

• Suchanfragen nach der Tracking-ID müssen den Sichtbarkeitsregeln entsprechen, die unter Sichtbarkeitsregeln für getrackte Objekte beschrieben sind.

• Verwenden Sie das möglichst eng gefasste Token, um Sicherheitsrisiken zu begrenzen. Wenn Sie beispielsweise ein Delivery Consumer Token verwenden, werden bei allen Aufrufen nur Informationen zurückgegeben, die für diesen Endnutzer relevant sind, z. B. der Absender oder Empfänger einer Sendung. Alle anderen Informationen in den Antworten werden von Fleet Engine entfernt. Weitere Informationen zu Tokens finden Sie unter JSON Web Tokens.

Aufgabe anhand der Aufgaben-ID suchen

Sie können eine Aufgabe anhand ihrer Aufgaben-ID in einer Serverumgebung mit gRPC oder REST abrufen. In den folgenden Beispielen wird gezeigt, wie Sie die Java gRPC-Bibliothek oder eine REST-Anfrage verwenden, um GetTask aufzurufen.

 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}"

Aufgaben nach Tracking-ID suchen

In den folgenden Beispielen wird gezeigt, wie Sie Aufgaben anhand ihrer Sendungs-ID mit gRPC oder einem HTTP-REST-Aufruf an GetTaskTrackingInfo suchen.

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}"

Aufgaben auflisten

Für das Auflisten von Aufgaben ist ein umfassender Zugriff auf Aufgaben erforderlich. Aufgaben zum Hinzufügen von Einträgen sind nur für vertrauenswürdige Nutzer vorgesehen. Verwenden Sie Authentifizierungstokens für Leser oder Administratoren von Fleet Engine Delivery, wenn Sie Anfragen für Listenaufgaben stellen. Weitere Informationen finden Sie unter Dienstkontenrollen.

Listen paginaieren

Aufgabenlisten sind paginated. In Anfragen zum Auflisten von Aufgaben kann eine Seitengröße angegeben werden. Wenn eine Seitengröße angegeben ist, darf die Anzahl der zurückgegebenen Aufgaben nicht größer als die angegebene Seitengröße sein. Wenn keine Seitengröße angegeben ist, wird eine angemessene Standardgröße verwendet. Wenn die angeforderte Seitengröße einen internen Maximalwert überschreitet, wird der interne Maximalwert verwendet.

Eine Aufgabenliste kann ein Token zum Lesen der nächsten Ergebnisseite enthalten. Wenn Sie diese nächste Seite abrufen möchten, senden Sie dieselbe Anfrage noch einmal zusammen mit dem Seitentoken. Wenn das zurückgegebene Seiten-Token leer ist, sind keine weiteren Aufgaben zum Abrufen verfügbar.

Felder beim Auflisten von Aufgaben

Fleet Engine entfernt beim Auflisten von Aufgaben die folgenden Felder:

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

Verwenden Sie die folgenden Feldformate, die auf Vorschlägen zur Verbesserung der Google API basieren:

Aufgeführte Aufgaben filtern

Sie können die aufgelisteten Aufgaben nach den meisten Aufgabeneigenschaften filtern. Informationen zur Syntax von Filterabfragen finden Sie unter AIP-160. Wenn keine Filterabfrage angegeben ist, werden alle Aufgaben aufgeführt.

In der folgenden Tabelle sind gültige Aufgabeneigenschaften aufgeführt, die Sie zum Filtern verwenden können:

Eine vollständige Liste der Filterabfrageoperatoren finden Sie unter AIP-160.

Beispiele für Aufgaben auflisten

Im folgenden Beispiel wird gezeigt, wie Sie Aufgaben für ein deliveryVehicleId- und ein Aufgabenattribut auflisten, sowohl mit der Java gRPC-Bibliothek als auch mit einem HTTP-REST-Aufruf an ListTasks.

Eine erfolgreiche Antwort kann trotzdem leer sein. Eine leere Antwort gibt an, dass mit dem angegebenen deliveryVehicleId keine Aufgaben verknüpft sind.

 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}"

Nächste Schritte

• Sendungen verwalten