このドキュメントは、Fleet Engine の概要セクションのスケジュール設定されたタスクの入門ガイドと、このセクションのスケジュール設定されたタスクとはをすでにお読みになっていることを前提としています。
スケジュール設定されたタスク用の Fleet Engine には、さまざまな種類のタスクが用意されています。
- 配送タスク: 荷物の集荷や配送などの運転タスクに使用します。
- 不在タスク: 休憩が必要な場合など、ドライバーが不在のときに使用します。
- スケジュール設定された停車タスク: 私書箱やお客様の場所での運転以外のタスク(建物への入館時間や配達ポイントの検索など)に使用します。
このドキュメントでは、サーバー上で配送以外のタスクを作成する方法について説明します。配送タスクの種類については、配送タスクを作成するをご覧ください。
非駆動タスクのタスク フィールド
このセクションでは、利用不能タスクとスケジュール設定された停止タスクの両方に必要なタスク フィールドについて説明します。
必須のタスク フィールド
Fleet Engine でタスクを作成するたびに、必須フィールドを指定する必要があります。省略可能なフィールドも指定できます。Fleet Engine は他のすべてのフィールドを無視し、タスク作成リクエストで割り当てられた deliveryVehicleId
が指定されている場合は例外をスローします。車両にタスクを割り当てるには、UpdateDeliveryVehicleRequest
を使用します。詳細については、タスクを更新するをご覧ください。
フィールド | 値 |
---|---|
type |
タスクタイプと一致するタイプに設定します。次のいずれかです。
|
state |
State.OPEN |
task_id |
一意のタスク ID。荷物追跡番号は使用できません。システムにタスク ID がない場合は、一意の識別子(UUID)を生成できます。詳細については、タスク ID をご覧ください。 |
tracking_id |
PICKUP タスクまたは DELIVERY タスクのみ: 配送の追跡に使用している番号または識別子。配送以外のタスクにはこのフィールドを使用しないでください。 |
plannedLocation |
PICKUP 、DELIVERY 、または SCHEDULED_STOP タスクのみ: タスクを完了する場所。UNAVAILABLE タスクには必要ありません。 |
taskDuration |
タスクを完了するために追加で必要となる推定時間。たとえば、駐車場を探したり、受け渡し場所まで歩いたりするなどです。 |
配送タスクのオプション フィールド
フィールド | 値 |
---|---|
targetTimeWindow |
タスクを完了する時間枠。このフィールドはルーティングの動作には影響しません。 |
task_tracking_view_config |
PICKUP タスクまたは DELIVERY タスクのみ: どのデータ要素がどのような状況でエンドユーザーに表示されるかを指定する、タスク トラッキングの構成。 |
attributes |
カスタムタスク属性のリスト。各属性には一意のキーが必要です。 |
不在タスクを作成する
ドライバーの休憩など、利用できないことを示すタスクを作成できます。利用不能なタスクを作成するには、次のガイドラインを使用します。
- タスクタイプを
UNAVAILABLE
に設定します。 - トラッキング ID は含めないでください。
- 不在タスクの場所を指定する必要はありませんが、指定すると、1 日を通してより正確な到着予定時刻の計算が可能になります。
車両の位置情報には、ルート共有の UNAVAILABLE
タスク中は特別な公開設定ルールが適用されます。
- 配送追跡ライブラリと統合されたコンシューマ向けアプリ: 車両が不在タスク中の場合、コンシューマ向けアプリのユーザーは車両の位置情報を確認できませんが、配送のステータス情報は確認できます。
- フリート トラッキング ライブラリと統合されたフリート トラッキング アプリ: 車両が不在タスク中の場合、フリート トラッキング アプリを使用するフリート マネージャーは、不在タスクの車両の位置を確認できます。
次の例は、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
スケジュール設定された停止タスクを作成する
予定停車地点のタスクを作成できます。たとえば、お客様の場所での運転以外のタスク、給油停車地点、ドライバーがフィーダー車両から荷物を受け取る場所などです。スケジュール設定された停止タスクを作成する場合は、次のガイドラインに従ってください。
- タスクタイプを次のように設定します。
- トラッキング 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