このドキュメントは、タスクの作成と使用方法を理解していることを前提としています。次の方法で配送タスクを構成する方法の具体的な例を示します。
配送タスクのターゲット時間枠を設定する: タスクが完了するまでの時間枠を設定します。
タスクの公開設定をカスタマイズする: お客様やフリート オペレーターに表示するタスク アクティビティの公開設定をカスタマイズします。
配送タスクのフィールドの詳細については、配送タスクを作成するをご覧ください。既存のタスクに関する追加情報を更新する場合は、タスクの更新対象のフィールドに加えて、タスクに関連する ID も含める必要があります。
対象の時間帯を設定する
ターゲット時間枠は、タスクが完了する必要があるTimeWindow です。たとえば、配送先の受取人に配送時間帯を伝える場合は、タスクのターゲット時間帯を使用してこの時間帯をキャプチャし、アラートを生成できます。また、過去のルートのパフォーマンスを分析するために使用することもできます。
ターゲット時間枠は開始時間と終了時間で構成され、任意のタスクタイプに設定できます。ターゲット時間枠はルーティング動作に影響しません。
次の例は、Java gRPC ライブラリを使用して時間枠を設定する方法、または UpdateTask
に HTTP REST リクエストを送信する方法を示しています。このフィールドは、タスクの作成時に設定することもできます。
gRPC
static final String PROJECT_ID = "my-delivery-co-gcp-project";
static final String TASK_ID = "task-8241890";
DeliveryServiceBlockingStub deliveryService =
DeliveryServiceGrpc.newBlockingStub(channel);
// Task settings
String taskName = "providers/" + PROJECT_ID + "/tasks/" + TASK_ID;
Task task = Task.newBuilder()
.setName(taskName)
.setTargetTimeWindow(
TimeWindow.newBuilder()
.setStartTime(Timestamp.newBuilder().setSeconds(1680123600))
.setEndTime(Timestamp.newBuilder().setSeconds(1680130800)))
.build();
// Task request
UpdateTaskRequest updateTaskRequest =
UpdateTaskRequest.newBuilder() // No need for the header
.setTask(task)
.setUpdateMask(FieldMask.newBuilder().addPaths("targetTimeWindow"))
.build();
try {
Task updatedTask = deliveryService.updateTask(updateTaskRequest);
} catch (StatusRuntimeException e) {
Status s = e.getStatus();
switch (s.getCode()) {
case NOT_FOUND:
break;
case PERMISSION_DENIED:
break;
}
return;
}
REST
HTTP を使用してタスク時間ウィンドウを設定するには、PATCH
を呼び出し、updateMask
を使用して targetTimeWindow
パラメータを更新します。
PATCH https://fleetengine.googleapis.com/v1/providers/<project_id>/tasks/<id>?updateMask=targetTimeWindow
ここで、<id> はタスクの一意の識別子です。リクエスト ヘッダーには、値が Bearer <token> の Authorization フィールドを含める必要があります。ここで、<token> は、サービス アカウントのロールと JSON Web Token で説明されているガイドラインに従ってサーバーが発行します。
# Set JWT, PROJECT_ID, and TASK_ID in the local environment
curl -X PATCH "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/tasks/${TASK_ID}?updateMask=targetTimeWindow" \
-H "Content-type: application/json" \
-H "Authorization: Bearer ${JWT}" \
--data-binary @- << EOM
{
"targetTimeWindow": {
"startTime": "2023-03-29T21:00:00Z",
"endTime": "2023-03-29T23:00:00Z"
}
}
EOM
タスクの公開設定をカスタマイズする
デフォルトでは、Fleet Engine はタスク アクティビティを可視化します。このアクティビティは、荷物を受け取るお客様と荷物を追跡するフリート オペレーターの両方に表示できます。これには、荷物の配達ステータスに関する通知をお客様に送信する前に、配達の停留所数を示す情報などが含まれます。この情報は、ビジネスモデルに合わせてタスクごとにカスタマイズできます。
このセクションでは、地図上で追跡対象のオブジェクトの表示ルールについて説明します。これらのルールは、次の 2 つのカテゴリのオブジェクトに適用されます。
- 位置マーカーの公開設定
- アクティブな車両タスクのタスクデータの可視性(ポリラインや到着予定時刻など)
位置情報マーカーの公開設定ルール
Fleet Engine では、配送のステータスに関係なく、配送先の位置マーカーが地図上に表示されます。
タスクデータの公開設定ルール
このセクションでは、タスクデータに適用されるデフォルトの公開設定ルールについて説明します。カスタマイズできるのはアクティブな車両タスクのみです。つまり、カスタマイズした公開設定ルールを適用できるのは、集荷と配達のタスクのみです。
次のタスクはカスタマイズできません。
- スケジュール設定された停止
- 不在タスク
- 無効な車両タスク
利用不可タスクの公開設定ルール
デフォルトでは、追跡中のタスクに 1 つ以上の不在タスクが割り当てられている場合、車両は地図に表示されません。たとえば、ドライバーが休憩を取っている場合や、追跡対象の荷物に向かう途中で車両が給油している場合などです。到着予定時刻とタスクの完了予定時刻は引き続き利用できます。繰り返しになりますが、このルールはカスタマイズできません。
アクティブな車両タスクの公開設定
TaskTrackingInfo
オブジェクトには、配送追跡ライブラリを使用して表示できるデータ要素がいくつか用意されています。デフォルトでは、タスクが車両に割り当てられ、車両がタスクから 5 停留所以内にある場合に、これらのフィールドが表示されます。タスクが完了またはキャンセルされると、公開は終了します。
可視性の構成は、Fleet Engine 内でタスクを作成または更新するときにタスクに TaskTrackingViewConfig
を設定して、タスクごとにカスタマイズできます。これにより、個々のデータ要素が使用可能になるルールが作成されます。
次の表に、公開設定ルールを適用できるフィールドを示します。
公開設定ルールの車両タスク フィールド |
---|
|
次の表に、上記のフィールドで使用できる公開設定オプションを示します。
公開設定オプション |
---|
|
ルート ポリラインと車両位置の公開設定ルール
トラッキングされたルートの場合、ルート ポリラインの可視性は車両の可視性に依存します。車両が表示されていないアクティブなルートでルート ポリラインが表示されている場合でも、表示されているポリラインの終点から車両の位置を推測できます。そのため、ルート ポリラインの公開設定は、車両の公開設定と同等か、それより制限が厳しいものにする必要があります。
有効なルート ポリラインと車両位置の公開設定の組み合わせを指定するには、次のルールに従ってください。
ルートのポリラインと車両の位置情報に同じ公開設定を指定している
このシナリオでは、ポリラインと車両の位置情報の両方で同じオプションが設定されます。これらのオプションには次のようなものがあります。
- 残りの停留所数
- 到着予定日までの所要時間
- 残りの走行可能距離
ルールに準拠するには、ルート ポリラインの公開設定の値が、車両の公開設定の値以下にする必要があります。この例では、ポリラインの残りの停留所のしきい値が 3 に設定されています。これは、車両に指定されている 5 の値よりも小さい値です。つまり、追跡中のルートのタスクの場所から 5 停留所離れた地点に到達すると車両が表示されますが、その車両のルートは、ルートの 3 停留所手前まで表示されません。
```js
"taskTrackingViewConfig": {
"routePolylinePointsVisibility": {
"remainingStopCountThreshold": 3
},
"vehicleLocationVisibility": {
"remainingStopCountThreshold": 5
},
}
```
ルートのポリラインと車両の位置に異なる公開設定オプションを指定している
ルート ポリラインと車両の位置情報の公開設定が異なる場合、車両の位置情報は、公開設定の両方が満たされている場合にのみ表示されます。ポリラインの公開設定は、車両の公開設定ルールが適用されます。
- 常に表示: 車両の位置情報でも同じ常に表示の公開設定オプションが提供されている場合、経路ポリラインは常に表示の公開設定オプションを使用する必要があります。
- 表示しない: 車両の位置情報で [表示しない] の公開設定オプションが使用されている場合、ルート ポリラインでは [表示しない] の公開設定オプションを使用する必要があります。
以下に例を示します。
"taskTrackingViewConfig": {
"routePolylinePointsVisibility": {
"remainingStopCountThreshold": 3
},
"vehicleLocationVisibility": {
"remainingDrivingDistanceMetersThreshold": 3000
},
}
この例では、残りの停留所数が 3 以上で、残りの走行距離が 3, 000 メートル以上の場合のみ、車両の位置情報が表示されます。
タスクの公開設定のカスタマイズの例
次の例は、次の公開設定ルールを使用してタスクを設定する方法を示しています。
- 車両が 3 つ目の停留所内にある場合は、ルートのポリラインを表示します。
- 残りの走行距離が 5,000 メートル未満の場合は、到着予定時刻を表示します。
- 残りの停留所数は表示しないでください。
- 他のフィールドは、車両がタスクから 5 停留所以内にある場合に表示されるデフォルトの公開設定を保持します。
gRPC または REST の場合は TaskTrackingViewConfig
をご覧ください。
gRPC
static final String PROJECT_ID = "my-delivery-co-gcp-project";
static final String TASK_ID = "task-8241890";
DeliveryServiceBlockingStub deliveryService =
DeliveryServiceGrpc.newBlockingStub(channel);
// Task settings
String taskName = "providers/" + PROJECT_ID + "/tasks/" + TASK_ID;
Task task = Task.newBuilder()
.setName(taskName)
.setTaskTrackingViewConfig(
TaskTrackingViewConfig.newBuilder()
.setRoutePolylinePointsVisibility(
VisibilityOption.newBuilder().setRemainingStopCountThreshold(3))
.setEstimatedArrivalTimeVisibility(
VisibilityOption.newBuilder().remainingDrivingDistanceMetersThreshold(5000))
.setRemainingStopCountVisibility(
VisibilityOption.newBuilder().setNever(true)))
.build();
// Task request
UpdateTaskRequest updateTaskRequest =
UpdateTaskRequest.newBuilder() // No need for the header
.setTask(task)
.setUpdateMask(FieldMask.newBuilder().addPaths("taskTrackingViewConfig"))
.build();
try {
Task updatedTask = deliveryService.updateTask(updateTaskRequest);
} catch (StatusRuntimeException e) {
Status s = e.getStatus();
switch (s.getCode()) {
case NOT_FOUND:
break;
case PERMISSION_DENIED:
break;
}
return;
}
REST
HTTP を使用してタスク トラッキング ビューの設定ウィンドウを設定するには、PATCH
を呼び出し、updateMask
を使用して taskTrackingViewConfig
パラメータを更新します。
PATCH https://fleetengine.googleapis.com/v1/providers/<project_id>/tasks/<id>?updateMask=taskTrackingViewConfig
次に例を示します。
# Set JWT, PROJECT_ID, and TASK_ID in the local environment
curl -X PATCH "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/tasks/${TASK_ID}?updateMask=taskTrackingViewConfig" \
-H "Content-type: application/json" \
-H "Authorization: Bearer ${JWT}" \
--data-binary @- << EOM
{
"taskTrackingViewConfig": {
"routePolylinePointsVisibility": {
"remainingStopCountThreshold": 3
},
"estimatedArrivalTimeVisibility": {
"remainingDrivingDistanceMetersThreshold": 5000
},
"remainingStopCountVisibility": {
"never": true
}
}
}
EOM