配送タスクを作成する

このドキュメントでは、 スケジュール設定されたタスクの概要と、Fleet Engine の概要セクションの このセクションのスケジュール設定されたタスクとは？を読んでいることを前提としています。

スケジュール設定されたタスクの Fleet Engine には、さまざまなカテゴリのタスクがあります。

  • 配送タスク: 配送物の集荷や配達など、運転タスクに使用します。
  • 利用不可タスク: 休憩など、運転手が利用できない時間に使用します。
  • スケジュール設定された停止タスク: 宅配ボックスや顧客の 場所での運転以外のタスクに使用します。たとえば、建物に入る時間や配達場所を探す時間などです。

このドキュメントでは、サーバーで配送タスクを作成する方法について説明します。 他の タスクタイプについては、他のタスクタイプを作成するをご覧ください。

配送タスクのフィールド

このセクションでは、集荷タスクと配達タスクの両方に必要なタスク フィールドについて説明します。

必須のタスク フィールド

Fleet Engine で作成するすべてのタスクには、必須フィールドを指定する必要があります。また、オプション フィールドを指定することもできます。他のフィールドはすべて無視されます。タスク作成リクエストで割り当てられた deliveryVehicleId が指定されている場合は、例外がスローされます。タスクを車両に割り当てるには、UpdateDeliveryVehicleRequest を使用します。詳細については、 タスクを更新するをご覧ください。

フィールド値
type

タスクタイプに一致するタイプに設定します。次のいずれかになります。

  • PICKUP
  • DELIVERY
  • SCHEDULED_STOP
  • UNAVAILABLE
state State.OPEN
task_id 一意のタスク ID。これは配送物の荷物追跡番号ではありません。システムにタスク ID がない場合は、ユニバーサルに一意な 識別子（UUID）を生成できます。詳細については、 タスク ID をご覧ください。
tracking_id PICKUP または DELIVERY タスクのみ: 配送物の追跡に使用する番号または識別子。配送以外のタスクにはこのフィールドを指定しないでください。
planned_location PICKUP, DELIVERY, または SCHEDULED_STOP タスクのみ: タスクが完了する場所。 タスクには必須ではありません。UNAVAILABLE
task_duration タスクを完了するために追加する予定時間。たとえば、駐車場を探す場合や、受け渡し場所まで歩く場合などです。

配送タスクのオプション フィールド

フィールド値
target_time_window タスクを完了する時間枠。このフィールド はルーティング動作には影響しません。
task_tracking_view_config PICKUP または DELIVERY タスクのみ: どのような状況でどのデータ要素がエンドユーザーに表示されるかを指定するタスク追跡の構成。
attributes カスタムタスク属性のリスト。各属性には一意のキーが必要です。

配送物の集荷タスクを作成する

Fleet Engine を使用して、配送物の集荷を行う運転手の行動を追跡するには、配送物の集荷タスクを作成します。これには、タスクタイプ属性を PICKUP に設定します。次の例は、グランド インドネシア イースト モールからの配送物の集荷を示しています。

次の例は、 Java gRPC ライブラリを使用して配送物の集荷タスクを作成する方法、または CreateTaskに HTTP REST リクエストを行う方法を示しています。

gRPC

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

  DeliveryServiceBlockingStub deliveryService =
    DeliveryServiceGrpc.newBlockingStub(channel);

  // Task settings
  String parent = "providers/" + PROJECT_ID;
  Task task = Task.newBuilder()
    .setType(Task.Type.PICKUP)
    .setState(Task.State.OPEN)
    .setTrackingId("my-tracking-id")
    .setPlannedLocation(               // Grand Indonesia East Mall
      LocationInfo.newBuilder().setPoint(
        LatLng.newBuilder().setLatitude(-6.195139).setLongitude(106.820826)))
    .setTaskDuration(
      Duration.newBuilder().setSeconds(2 * 60))
    .setTargetTimeWindow(
      TimeWindow.newBuilder()
        .setStartTime(Timestamp.newBuilder().setSeconds(1680123600))
        .setEndTime(Timestamp.newBuilder().setSeconds(1680130800)))
    .addAttributes(TaskAttribute.newBuilder().setKey("foo").setStringValue("value"))
    .addAttributes(TaskAttribute.newBuilder().setKey("bar").setNumberValue(10))
    .addAttributes(TaskAttribute.newBuilder().setKey("baz").setBoolValue(false))
    .build();

  // Task request
  CreateTaskRequest createTaskRequest =
    CreateTaskRequest.newBuilder()  // No need for the header
        .setParent(parent)          // Avoid using auto-incrementing IDs for the taskId
        .setTaskId("task-8241890")  // Task ID assigned by the Provider
        .setTask(task)              // Initial state
        .build();

  // Error handling
  // If Fleet Engine does not have a task with that ID and the credentials of the
  // requestor pass, the service creates the task successfully.

  try {
    Task createdTask = deliveryService.createTask(createTaskRequest);
  } catch (StatusRuntimeException e) {
    Status s = e.getStatus();
    switch (s.getCode()) {
       case ALREADY_EXISTS:
         break;
       case PERMISSION_DENIED:
         break;
    }
    return;
  }

REST

サーバー環境から配送物の集荷タスクを作成するには、CreateTask に HTTP REST 呼び出しを行います。

POST https://fleetengine.googleapis.com/v1/providers/<project_id>/tasks?taskId=<id>

<id> はタスクの一意の識別子です。

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

リクエスト本文には、配送タスクのフィールドで説明されている適切なフィールドを持つ Task エンティティを含める必要があります。

curl コマンドの例:

 # Set $JWT, $PROJECT_ID, $TRACKING_ID, and $TASK_ID in the local
 # environment
 curl -X POST "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/tasks?taskId=${TASK_ID}" \
   -H "Content-type: application/json" \
   -H "Authorization: Bearer ${JWT}" \
   --data-binary @- << EOM
 {
   "type": "PICKUP",
   "state": "OPEN",
   "trackingId": "${TRACKING_ID}",
   "plannedLocation": {
      "point": {
         "latitude": -6.195139,
         "longitude": 106.820826
      }
   },
   "taskDuration": "90s",
   "targetTimeWindow": {
     "startTime": "2023-03-29T21:00:00Z",
     "endTime": "2023-03-29T23:00:00Z"
   }
 }
 EOM

配送物の配達タスクを作成する

Fleet Engine を使用して、配送物の配達を行う運転手の行動を追跡するには、配送物の配達タスクを作成します。これには、タスクタイプ属性を DELIVERY に設定します。次の例は、グランド インドネシア イースト モールへの配送物の配達を示しています。

次の例は、 Java gRPC ライブラリを使用して配送物の集荷タスクを作成する方法、または CreateTaskに HTTP REST リクエストを行う方法を示しています。

gRPC

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

  DeliveryServiceBlockingStub deliveryService =
    DeliveryServiceGrpc.newBlockingStub(channel);

  // Task settings
  String parent = "providers/" + PROJECT_ID;
  Task task = Task.newBuilder()
    .setType(Task.Type.DELIVERY)
    .setState(Task.State.OPEN)
    .setTrackingId("my-tracking-id")
    .setPlannedLocation(               // Grand Indonesia East Mall
      LocationInfo.newBuilder().setPoint(
        LatLng.newBuilder().setLatitude(-6.195139).setLongitude(106.820826)))
    .setTaskDuration(
      Duration.newBuilder().setSeconds(2 * 60))
    .setTargetTimeWindow(
      TimeWindow.newBuilder()
        .setStartTime(Timestamp.newBuilder().setSeconds(1680123600))
        .setEndTime(Timestamp.newBuilder().setSeconds(1680130800)))
    .addAttributes(TaskAttribute.newBuilder().setKey("foo").setStringValue("value"))
    .addAttributes(TaskAttribute.newBuilder().setKey("bar").setNumberValue(10))
    .addAttributes(TaskAttribute.newBuilder().setKey("baz").setBoolValue(false))
    .build();

  // Task request
  CreateTaskRequest createTaskRequest =
    CreateTaskRequest.newBuilder()  // No need for the header
        .setParent(parent)          // Avoid using auto-incrementing IDs for the taskId
        .setTaskId("task-8241890")  // Task ID assigned by the Provider
        .setTask(task)              // Initial state
        .build();

  // Error handling
  // If Fleet Engine does not have task with that ID and the credentials of the
  // requestor pass, the service creates the task successfully.

  try {
    Task createdTask = deliveryService.createTask(createTaskRequest);
  } catch (StatusRuntimeException e) {
    Status s = e.getStatus();
    switch (s.getCode()) {
       case ALREADY_EXISTS:
         break;
       case PERMISSION_DENIED:
         break;
    }
    return;
  }

REST

サーバー環境から配送物の集荷タスクを作成するには、CreateTask に HTTP REST 呼び出しを行います。

POST https://fleetengine.googleapis.com/v1/providers/<project_id>/tasks?taskId=<id>

<id> はタスクの一意の識別子です。

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

リクエスト本文には、Task エンティティを含める必要があります。

curl コマンドの例:

 # Set $JWT, $PROJECT_ID, $TRACKING_ID, and $TASK_ID in the local
 # environment
 curl -X POST "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/tasks?taskId=${TASK_ID}" \
   -H "Content-type: application/json" \
   -H "Authorization: Bearer ${JWT}" \
   --data-binary @- << EOM
 {
   "type": "DELIVERY",
   "state": "OPEN",
   "trackingId": "${TRACKING_ID}",
   "plannedLocation": {
      "point": {
         "latitude": -6.195139,
         "longitude": 106.820826
      }
   },
   "taskDuration": "90s",
   "targetTimeWindow": {
     "startTime": "2023-03-29T21:00:00Z",
     "endTime": "2023-03-29T23:00:00Z"
   }
 }
 EOM
 ```

次のステップ