タスクの確定

このドキュメントでは、タスクの作成方法と使用方法を理解していることを前提としています。配送タスクを完了する方法の具体的な例を次に示します。

  • タスクをクローズする: 配送タスクをクローズすると、ステータスが CLOSED に変わり、そのタスクがアクティブではなくなったことを示します。

  • タスクの結果を設定する: タスクをクローズしたら、結果を SUCCEEDED または FAILED に設定してタスクを完了します。これは、ジャーニーの共有で配達結果を表示し、Fleet Engine サービスの正しい請求を保証するために、タスクを完了するうえで重要な部分です。

タスクを閉じる

タスクは次の方法で閉じることができます。

  • 車両の停止ステータスを更新します。車両から経由地を削除すると、その経由地に関連付けられているすべてのタスクが閉じられます。詳しくは、アップデートの停止ステータスをご覧ください。
  • 車両の停車地のリストからタスクを削除します。これには、停止のタスクリストを更新することが含まれますが、完了したタスクはリストに含まれません。タスクを更新するのタスクの順序を更新するをご覧ください。
  • タスクの状態を CLOSED に設定します。この操作は、車両に割り当てられていないタスクに対してのみ実行できます。このセクションでは、このアプローチについて説明します。

タスクを閉じると、再度開くことはできません。

タスクを閉じても、タスクの成功または失敗は示されません。タスクが進行中と見なされなくなったことを示します。タスクの実際の結果を示し、フリート トラッキングとルート共有の目的で表示するには、タスクの実際の結果を示す必要があります。後述の タスクの結果を設定するをご覧ください。

タスクをクローズするためのタスク フィールド

このセクションでは、タスクを終了するときに設定する必要があるフィールドについて説明します。Fleet Engine は、更新対象のエンティティの他のすべてのフィールドを無視します。

必須項目 値
state State.CLOSED

タスクを直接閉じる

次の例は、gRPC または UpdateTask への HTTP REST リクエスト呼び出しを使用して、未割り当てのタスクをクローズ状態に設定する方法を示しています。

gRPC

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

 DeliveryServiceBlockingStub deliveryService =
   DeliveryServiceGrpc.newBlockingStub(channel);

 // Task settings
 String taskName = "providers/" + PROJECT_ID + "/tasks/" + TASK_ID;
 Task task = Task.newBuilder()
   .setName(taskName)
   .setState(Task.State.CLOSED) // You can only directly CLOSE a
   .build();                    // task that is NOT assigned to a vehicle.

 // Task request
 UpdateTaskRequest updateTaskRequest =
   UpdateTaskRequest.newBuilder()  // No need for the header
       .setTask(task)
       .setUpdateMask(FieldMask.newBuilder().addPaths("state"))
       .build();

 try {
   Task updatedTask = deliveryService.updateTask(updateTaskRequest);
 } catch (StatusRuntimeException e) {
   Status s = e.getStatus();
   switch (s.getCode()) {
      case NOT_FOUND:
        break;
      case PERMISSION_DENIED:
        break;
   }
   return;
 }

REST

PATCH https://fleetengine.googleapis.com/v1/providers/<project_id>/tasks/<id>?updateMask=state

  • <id> は、タスクの一意の ID です。
  • リクエスト ヘッダーには、値が Bearer <token> の Authorization フィールドが含まれている必要があります。ここで、<token> は、サービス アカウントのロールと JSON ウェブトークンに記載されているガイドラインに従ってサーバーによって発行されます。
  • リクエスト本文に Task エンティティを含める必要があります

curl コマンドの例:

 # Set JWT, PROJECT_ID, and TASK_ID in the local environment
 curl -X PATCH "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/tasks/${TASK_ID}?updateMask=state,taskOutcome,taskOutcomeTime" \
   -H "Content-type: application/json" \
   -H "Authorization: Bearer ${JWT}" \
   --data-binary @- << EOM
 {
   "state": "CLOSED",
   "taskOutcome": "SUCCEEDED",
   "taskOutcomeTime": "$(date -u +"%Y-%m-%dT%H:%M:%SZ")"
 }
 EOM

タスクの結果を設定する

タスクの実際の結果を示すには、クローズされたタスクの結果を SUCCEEDED または FAILED に設定します。タスクの結果を設定する前に、タスクをクローズする必要があります。Fleet Engine では、状態が SUCCEEDED の配達タスクに対してのみ課金されます。

タスクの結果の詳細

タスクには、タスクの結果に関する追加の詳細も表示されます。これらの設定は直接行うことができ、Fleet Engine は設定を尊重します。

  • タスクの結果の場所: Fleet Engine は、タスクの結果の場所を車両の直近の既知の位置情報で自動的に入力します。必要に応じて、こちらを提供することもできます。
  • タスクの結果時間: Fleet Engine はこのフィールドに入力しませんが、設定できます。

task_outcome_location と task_outcome_time の設定には、次のいずれかの方法を使用できます。

  • タスクの結果を設定する同じリクエストで更新します。
  • タスクの結果を設定した後で、後で更新します。
  • 設定後に再度変更します。

Fleet Engine は、タスクの結果に関連する次の更新を防止します。

  • タスクの結果が SUCCEEDED または FAILED に設定されると、変更できなくなります。
  • 結果が設定されていないタスクには、タスクの結果の場所や結果の時間を設定できません。

結果を設定するためのタスク フィールド

このセクションでは、タスクの結果を設定する際に設定する必須フィールドと省略可能なフィールドについて説明します。Fleet Engine は、更新用のエンティティ内の他のフィールドを無視します。

必須項目 値
taskOutcome Outcome.SUCCEEDED または Outcome.FAILED

省略可能項目値
taskOutcomeLocation タスクが完了した場所。設定されていない場合、Fleet Engine はデフォルトで最後の車両の位置に設定します。
taskOutcomeTime タスクが完了したときのタイムスタンプ。

タスクの結果の例

次の例は、Java gRPC ライブラリと UpdateTask への HTTP REST 呼び出しを使用して、タスクの結果を SUCCEEDED に設定し、タスクが完了した場所を設定する方法を示しています。

gRPC

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

 DeliveryServiceBlockingStub deliveryService =
   DeliveryServiceGrpc.newBlockingStub(channel);

 // Task settings
 String taskName = "providers/" + PROJECT_ID + "/tasks/" + TASK_ID;
 Task task = Task.newBuilder()
   .setName(taskName)
   .setTaskOutcome(TaskOutcome.SUCCEEDED)
   .setTaskOutcomeTime(now())
   .setTaskOutcomeLocation(               // Grand Indonesia East Mall
     LocationInfo.newBuilder().setPoint(
       LatLng.newBuilder().setLatitude(-6.195139).setLongitude(106.820826)))
   .build();

 // Task request
 UpdateTaskRequest updateTaskRequest =
   UpdateTaskRequest.newBuilder()  // No need for the header
       .setTask(task)
       .setUpdateMask(FieldMask.newBuilder().addPaths("task_outcome", "task_outcome_time", "task_outcome_location"))
       .build();

 try {
   Task updatedTask = deliveryService.updateTask(updateTaskRequest);
 } catch (StatusRuntimeException e) {
   Status s = e.getStatus();
   switch (s.getCode()) {
      case NOT_FOUND:
        break;
      case PERMISSION_DENIED:
        break;
   }
   return;
 }

REST

PATCH https://fleetengine.googleapis.com/v1/providers/<project_id>/tasks/<id>?updateMask=taskOutcome,taskOutcomeTime,taskOutcomeLocation

  • <id> は、タスクの一意の ID です。
  • リクエスト ヘッダーには、値が Bearer <token> の Authorization フィールドが含まれている必要があります。ここで、<token> は、サービス アカウントのロールと JSON ウェブトークンに記載されているガイドラインに従ってサーバーによって発行されます。
  • リクエストの本文には Task エンティティを含める必要があります。
 # Set JWT, PROJECT_ID, and TASK_ID in the local environment
 curl -X PATCH "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/tasks/${TASK_ID}?updateMask=taskOutcome,taskOutcomeTime,taskOutcomeLocation" \
   -H "Content-type: application/json" \
   -H "Authorization: Bearer ${JWT}" \
   --data-binary @- << EOM
 {
   "taskOutcome": "SUCCEEDED",
   "taskOutcomeTime": "$(date -u +"%Y-%m-%dT%H:%M:%SZ")",
   "taskOutcomeLocation": {
     "point": {
       "latitude": -6.195139,
       "longitude": 106.820826
     }
   }
 }
 EOM

次のステップ