- リソース: Task
- 型
- TaskOutcomeLocationSource
- JourneySharingInfo
- TaskTrackingViewConfig
- VisibilityOption
- メソッド
リソース: Task
Delivery API のタスクは、追跡する単一のアクションを表します。一般に、配送関連のタスクと分割タスクは区別されます。配送には複数のタスクを関連付けることができます。たとえば、集荷に関する Task と、降車または乗り換えに関する Task を 1 つずつ設定することができます。また、特定の配送の異なるタスクは、異なる車両で処理できます。たとえば、ある車両で集荷を処理してハブまで荷物を運び、別の車両で同じハブから降車場所まで荷物を運ぶことができます。
注: gRPC API と REST API では、異なるフィールド命名規則を使用します。たとえば、gRPC API の Task.journey_sharing_info
フィールドと REST API の Task.journeySharingInfo
フィールドは、同じフィールドを指します。
JSON 表現 |
---|
{ "name": string, "type": enum ( |
フィールド | |
---|---|
name |
|
type |
必須。変更不可。Task のタイプを定義します。(破損、発送など)。 |
state |
必須。タスクの現在の実行状態。 |
taskOutcome |
タスクの結果。 |
taskOutcomeTime |
RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
taskOutcomeLocation |
|
taskOutcomeLocationSource |
|
trackingId |
変更不可。このフィールドを使用すると ID を簡単に保存できるため、複雑なマッピングを使用する必要がなくなります。
|
deliveryVehicleId |
出力専用。このタスクを実行する車両の ID。配送車両 ID には次の制限があります。
|
plannedLocation |
変更不可。タスクを完了する場所。 |
taskDuration |
必須。変更不可。この場所でタスクを実行するのに必要な時間。 「 |
targetTimeWindow |
タスクが完了するまでの時間枠。 |
journeySharingInfo |
出力専用。移動経路の共有固有のフィールド。状態が |
taskTrackingViewConfig |
どのような状況でエンドユーザーに表示されるデータ要素を指定するタスク追跡の構成。 |
attributes[] |
カスタムタスク属性のリスト。各属性には一意のキーが必要です。 |
タイプ
タスクのタイプ。
列挙型 | |
---|---|
TYPE_UNSPECIFIED |
デフォルトでは、タスクの種類は不明です。 |
PICKUP |
集荷タスクとは、お客様から荷物を受け取るために行われるアクションです。車庫またはフィーダーの車両ピックアップには、SCHEDULED_STOP タイプを使用する必要があります。 |
DELIVERY |
配達タスクとは、最終顧客に荷物を配達するために行われるアクションです。車両販売店またはフィーダー車両の持ち込みには、SCHEDULED_STOP タイプを使用する必要があります。 |
SCHEDULED_STOP |
スケジュールされた停止タスクは、計画の目的で使用されます。たとえば、フィーダー車両や倉庫での荷物の集荷または持ち込みなどが考えられます。エンドユーザーに集荷または持ち込む配送には使用しないでください。 |
UNAVAILABLE |
車両が運行されていないことを意味するタスク。たとえば、ドライバーが休憩をとったときや、車両に給油しているときに発生することがあります。 |
TaskOutcomeLocationSource
taskOutcomeLocation
にデータを入力したソースの ID。
列挙型 | |
---|---|
TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED |
設定前のタスクの結果。 |
PROVIDER |
プロバイダが taskOutcomeLocation を指定しています。 |
LAST_VEHICLE_LOCATION |
プロバイダが taskOutcomeLocation を指定しなかったため、Fleet Engine は直近の車両位置情報を使用しました。 |
JourneySharingInfo
特定のフィールドを共有するジャーニー。
JSON 表現 |
---|
{ "remainingVehicleJourneySegments": [ { object ( |
フィールド | |
---|---|
remainingVehicleJourneySegments[] |
割り当てられた車両がこのタスクを完了する前に行った停車地の追跡情報。このリストには、他のタスクの停車地を含めることができます。 最初のセグメントである |
lastLocation |
割り当てられた車両について車両が最後に報告された場所を示します。 |
lastLocationSnappable |
車両の lastLocation を |
TaskTrackingViewConfig
タスクのデータ要素をエンドユーザーにいつ表示すべきかを定義する構成メッセージ。
JSON 表現 |
---|
{ "routePolylinePointsVisibility": { object ( |
フィールド | |
---|---|
routePolylinePointsVisibility |
ルートのポリライン ポイントを表示するタイミングを指定するフィールド。このフィールドが指定されていない場合、このデータに対するプロジェクト レベルのデフォルトの公開設定が使用されます。 |
estimatedArrivalTimeVisibility |
到着予定時刻を表示できるタイミングを指定するフィールド。このフィールドが指定されていない場合、このデータに対するプロジェクト レベルのデフォルトの公開設定が使用されます。 |
estimatedTaskCompletionTimeVisibility |
タスクの推定完了時間を表示するタイミングを指定するフィールド。このフィールドが指定されていない場合、このデータに対するプロジェクト レベルのデフォルトの公開設定が使用されます。 |
remainingDrivingDistanceVisibility |
残りの運転距離を表示できるタイミングを指定するフィールド。このフィールドが指定されていない場合、このデータに対するプロジェクト レベルのデフォルトの公開設定が使用されます。 |
remainingStopCountVisibility |
残りの経由地数を表示するタイミングを指定するフィールド。このフィールドが指定されていない場合、このデータに対するプロジェクト レベルのデフォルトの公開設定が使用されます。 |
vehicleLocationVisibility |
車両の位置情報を表示できるタイミングを指定するフィールド。このフィールドが指定されていない場合、このデータに対するプロジェクト レベルのデフォルトの公開設定が使用されます。 |
VisibilityOption
データ要素をいつエンドユーザーに表示するかを定義するオプション メッセージ。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド visibility_option 。選択した特定の公開設定オプション。visibility_option は次のいずれかになります。 |
|
remainingStopCountThreshold |
このデータ要素は、残りの経由地数 <= leaseStopCountThreshold 以下の場合、エンドユーザーに表示されます。 |
durationUntilEstimatedArrivalTimeThreshold |
このデータ要素は、駅 / 停留所の到着予定時刻が durationDURATIONArrivalTimeThreshold 以下の場合、エンドユーザーに表示されます。 「 |
remainingDrivingDistanceMetersThreshold |
このデータ要素は、残りの運転距離がメートル単位 <= restDrivingDistanceMetersThreshold 以下の場合、エンドユーザーに表示されます。 |
always |
true に設定すると、このデータ要素は常にしきい値なしでエンドユーザーに表示されます。このフィールドを false に設定することはできません。 |
never |
true に設定すると、しきい値のないエンドユーザーに対して、このデータ要素が常に非表示になります。このフィールドを false に設定することはできません。 |
メソッド |
|
---|---|
|
新しい Task オブジェクトのバッチを作成して返します。 |
|
新しい Task オブジェクトを作成して返します。 |
|
Task に関する情報を取得します。 |
|
指定したフィルタ条件を満たすすべての Task を取得します。 |
|
Task のデータを更新します。 |