このドキュメントは、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 |
カスタムタスク属性のリスト。各属性には一意のキーが必要です。 |
配送集荷タスクを作成する
Fleet Engine を使用して荷物を受け取るドライバーのアクティビティを追跡するには、荷物の回収タスクを作成します。これには、タスクタイプ属性を PICKUP
に設定する必要があります。次の例は、Grand Indonesia East Mall からの配送集荷を示しています。
次の例は、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> は、タスクの一意の識別子です。
リクエスト ヘッダーには、値が Bearer <token> の Authorization フィールドを含める必要があります。ここで <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> はタスクの一意の ID です。
リクエスト ヘッダーには、値が Bearer <token> の Authorization フィールドを含める必要があります。ここで、<token> は、サービス アカウントのロールと JSON Web トークンで説明されているガイドラインに従ってサーバーが発行します。
リクエストの本文には 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
```