他のタスクタイプを作成する

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

予定されたタスク用の 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	カスタム タスク属性のリスト。各属性には一意のキーが必要です。

対応不可タスクを作成する

利用不可を示すタスクを作成できます（例: ドライバーの休憩）。対応不可タスクを作成するには、次のガイドラインを使用します。

• タスクタイプを UNAVAILABLE に設定します。
• トラッキング ID は含めないでください。
• 利用不可タスクの場所を指定する必要はありませんが、指定すると、1 日を通して到着予定時刻の計算がより正確になります。

ジャーニー シェアの UNAVAILABLE タスクにある場合、車両の位置情報には特別な公開ルールが適用されます。

• Shipment Tracking ライブラリと統合されたユーザーアプリ: 車両が利用不可タスクを実行している場合、ユーザーアプリのユーザーは車両の位置情報を確認できませんが、配送状況の情報は確認できます。
• Fleet Tracking ライブラリと統合されたフリート追跡アプリ: 車両が利用不可タスクを実行している場合、フリート追跡アプリを使用するフリート管理者は、利用不可タスクの車両の位置情報を確認できます。

次の例は、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.UNAVAILABLE)
    .setState(Task.State.OPEN)
    .setTaskDuration(
      Duration.newBuilder().setSeconds(60 * 60))  // 1hr break
    .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> は、サービス アカウントのロールと JSON Web Token で説明されているガイドラインに従ってサーバーによって発行されます。

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

curl コマンドの例:

 # Set $JWT, $PROJECT_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": "UNAVAILABLE",
   "state": "OPEN",
   "plannedLocation": {
      "point": {
         "latitude": -6.195139,
         "longitude": 106.820826
      }
   },
   "taskDuration": "300s"
 }
 EOM

試験運用版: 試験運用版の機能として、LocationInfo（gRPC または REST）フィールドで、と併用または の代わりに place（gRPC または REST）を使用できるようになりました。

LatLng

スケジュール設定された停止タスクを作成する

予定された停車（顧客の場所での運転以外のタスク、給油のための停車、ドライバーがフィーダー車両から荷物を受け取る場合など）のタスクを作成できます。スケジュールされた停止タスクを作成する場合は、次のガイドラインを使用します。

• タスクタイプを
• トラッキング ID は含めないでください。
• 必要に応じて、場所を指定できます。

次の例は、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.SCHEDULED_STOP)
    .setState(Task.State.OPEN)
    .setPlannedLocation(               // Grand Indonesia East Mall
      LocationInfo.newBuilder().setPoint(
        LatLng.newBuilder().setLatitude(-6.195139).setLongitude(106.820826)))
    .setTaskDuration(
      Duration.newBuilder().setSeconds(2 * 60))
    .build();

  // Task request
  CreateTaskRequest createTaskRequest =
    CreateTaskRequest.newBuilder()  // No need for the header
        .setParent(parent)
        .setTaskId("task-8241890")  // Task ID assigned by the Provider
        .setTrip(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> は、サービス アカウントのロールと JSON Web Token で説明されているガイドラインに従ってサーバーによって発行されます。

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

curl コマンドの例:

# Set $JWT, $PROJECT_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": "SCHEDULED_STOP",
   "state": "OPEN",
   "plannedLocation": {
      "point": {
         "latitude": -6.195139,
         "longitude": 106.820826
      }
   },
   "taskDuration": "600s"
 }
 EOM

試験運用版: 試験運用版の機能として、LocationInfo（gRPC または REST）フィールドで、と併用または の代わりに place（gRPC または REST）を使用できるようになりました。

LatLng

次のステップ

• タスクを一括で作成する
• タスクを構成する
• タスクを更新する