このドキュメントは、次の入門ガイドをお読みになったことを前提としています。 「Fleet Engine の概要」セクションのスケジュールされたタスク このセクションの「スケジュールされたタスクとは」をご覧ください。
スケジュール設定されたタスク用の Fleet Engine には、さまざまな種類のタスクが用意されています。
- 配送タスク: 配送の集荷や配達などの運転タスクに使用します。
- Unavailability Tasks: ドライバが利用できない場合に使用されます。 必要があります。
- スケジュール設定された停止タスク: ドロップ ボックスまたは顧客での運転以外のタスクに使用します。 特定の場所(建物に入るまでの時間、配達場所の検索時間など)を記録します。
このドキュメントでは、サーバー上で配送以外のタスクを作成する方法について説明します。対象 発送タスクの種類については、発送タスクを作成するをご覧ください。
非駆動タスクのタスク フィールド
このセクションでは、両方の非可用性の場合に必要なタスク フィールドについて説明します。 スケジュール設定された停止タスクなどです。
タスクの必須項目
Fleet Engine でタスクを作成するたびに、必要な権限が付与されている必要があります。
任意のフィールドを指定できます。フリート エンジン
それ以外のフィールドはすべて無視し、タスクの作成時に例外をスローします。
リクエストによって deliveryVehicleId
が割り当てられています。車両にタスクを割り当てるには、UpdateDeliveryVehicleRequest
を使用します。詳細については、タスクを更新するをご覧ください。
フィールド | 値 |
---|---|
type |
次のいずれかのタスクの種類に一致する種類に設定します。
|
state |
State.OPEN |
task_id |
一意のタスク ID。荷物の荷物追跡番号は使用しないでください。もし タスク ID がない場合、ユニバーサルな一意の ID を あります。詳細については、以下をご覧ください。 タスク ID。 |
tracking_id |
PICKUP タスクまたは DELIVERY タスクのみ:
配送の追跡に使用する番号または ID。禁止事項
この項目は配送以外のタスクに指定します。 |
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
サーバー環境から使用できないタスクを作成するには、HTTP REST を作成する
CreateTask
への呼び出し:
POST https://fleetengine.googleapis.com/v1/providers/<project_id>/tasks?taskId=<id>
<id> は、タスクの一意の識別子です。
リクエスト ヘッダーには、次の値を含む Authorization フィールドが含まれている必要があります。 Bearer <token>。<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
スケジュール設定された停止タスクを作成する
スケジュール設定された停車地のタスクを作成できます。たとえば、運転中のタスクや 燃料補給場所、またはドライバーが フィーダーカーから 100 万スケジュール設定された停止タスクを作成する場合は、次のガイドラインに従ってください。
- タスクタイプを次のように設定します。
- トラッキング ID は含めないでください。
- 必要に応じて場所を指定できます。
次の例は、次のコマンドを使用して、利用不可のスケジュール タスクを作成する方法を示しています。
Java gRPC ライブラリを使用する方法、または HTTP REST リクエストを作成する方法を
CreateTask
。
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
サーバー環境からスケジュール設定された停止タスクを作成するには、HTTP REST を作成する
CreateTask
への呼び出し:
POST https://fleetengine.googleapis.com/v1/providers/<project_id>/tasks?taskId=<id>
<id> は、タスクの一意の識別子です。
リクエスト ヘッダーには、次の値を含む Authorization フィールドが含まれている必要があります。 Bearer <token>。<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