配送タスクを作成する

このドキュメントは、Fleet Engine の概要セクションの [予定されたタスク][1] の入門ガイドと、このセクションの [予定されたタスクとは][2] を読んでいることを前提としています。

予定されたタスク用の Fleet Engine には、さまざまなタスクのカテゴリが用意されています。

  • 配送タスク: 配送の集荷や配達などの運転タスクに使用します。
  • 利用不可タスク: 必要な休憩など、ドライバーが利用できない時間に使用します。
  • 予定された停止タスク: ドロップボックスや顧客の場所での運転以外のタスク（建物に入る時間や配達場所の特定など）に使用します。

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

配送タスクのフィールド

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

必須のタスク フィールド

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

フィールド値
type

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

  • PICKUP
  • DELIVERY
  • SCHEDULED_STOP
  • UNAVAILABLE
state State.OPEN
task_id 一意のタスク ID。これは、配送の荷物追跡番号ではありません。システムにタスク ID がない場合は、Universally Unique Identifier（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 に設定します。次の例は、Grand Indonesia East Mall からの荷物の集荷を示しています。

次の例は、[Java gRPC ライブラリ][4] を使用して集荷タスクを作成する方法、または [CreateTask][5] に 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> は、タスクの固有識別子です。

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

リクエストの本文には、[配送タスクのフィールド][8] で説明されている適切なフィールドを含む 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 ライブラリ][4] を使用して集荷タスクを作成する方法、または [CreateTask][5] に 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> は、タスクの固有識別子です。

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

リクエスト本文には 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
 ```

placeidtrips1: /maps/documentation/mobility/fleet-engine/reference/tasks/rpc/maps.fleetengine.delivery.v1.html#locationinfo placeidtrips2: /maps/documentation/mobility/fleet-engine/reference/tasks/rest/v1/LocationInfo.html placeidtrips3: /maps/documentation/mobility/fleet-engine/reference/tasks/rpc/maps.fleetengine.delivery.v1.html#maps.fleetengine.delivery.v1.LocationInfo.FIELDS.string.maps.fleetengine.delivery.v1.LocationInfo.place placeidtrips4: /maps/documentation/mobility/fleet-engine/reference/tasks/rest/v1/LocationInfo.html#FIELDS.place

次のステップ

  • [その他のタスクタイプを作成する][13]
  • [タスクを更新する][3]

[1]: /maps/documentation/mobility/fleet-engine/essentials/tasks-intro [2]: /maps/documentation/mobility/fleet-engine/journeys/tasks [3]: update-tasks [4]: /maps/documentation/mobility/fleet-engine/essentials/client-libraries-tasks#java [5]: /maps/documentation/mobility/fleet-engine/reference/tasks/rest/v1/providers.tasks/create [6]: /maps/documentation/mobility/fleet-engine/essentials/set-up-fleet/service-accounts [7]: /maps/documentation/mobility/fleet-engine/essentials/set-up-fleet/jwt [8]: /maps/documentation/mobility/fleet-engine/journeys/tasks/create-shipment-tasks#shipment_task_fields [13]: /maps/documentation/mobility/fleet-engine/journeys/tasks/create-other-tasks