REST Resource: providers.tasks

リソース: Task

Delivery API のタスクは、追跡する 1 つのアクションを表します。一般的に、配送関連のタスクと中断タスクは区別されます。1 つの配送に複数のタスクを関連付けることができます。たとえば、タスクに対して「乗車」と「持ち込み」または「乗り換え」を 1 つずつ設定できます。また、配送ごとに異なるタスクを処理できる車両もあります。たとえば、ある車両が集荷を処理してハブへの荷物を運ぶ一方で、別の車両は同じ荷物をハブから持ち込み場所まで運ぶことができます。

注: gRPC API と REST API では、フィールド命名規則が異なります。たとえば、gRPC API の Task.journey_sharing_info フィールドと REST API の Task.journeySharingInfo フィールドは同じフィールドを参照します。

JSON 表現 
{
  "name": string,
  "type": enum (Type),
  "state": enum (State),
  "taskOutcome": enum (TaskOutcome),
  "taskOutcomeTime": string,
  "taskOutcomeLocation": {
    object (LocationInfo)
  },
  "taskOutcomeLocationSource": enum (TaskOutcomeLocationSource),
  "trackingId": string,
  "deliveryVehicleId": string,
  "plannedLocation": {
    object (LocationInfo)
  },
  "taskDuration": string,
  "targetTimeWindow": {
    object (TimeWindow)
  },
  "journeySharingInfo": {
    object (JourneySharingInfo)
  },
  "taskTrackingViewConfig": {
    object (TaskTrackingViewConfig)
  },
  "attributes": [
    {
      object (TaskAttribute)
    }
  ]
}
フィールド
name

string

providers/{provider}/tasks/{task} の形式で指定してください。
type

enum (Type)

必須。変更不可。タスクのタイプを定義します。（例: 中断、発送）。
state

enum (State)

必須。タスクの現在の実行状態。
taskOutcome

enum (TaskOutcome)

タスクの結果。
taskOutcomeTime

string (Timestamp format)

Task の結果がプロバイダによって設定された時点を示すタイムスタンプ。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
taskOutcomeLocation

object (LocationInfo)

Task の結果が設定されたロケーション。この値は tasks.patch の一部として更新されます。この値がプロバイダによって明示的に更新されない場合、Fleet Engine はデフォルトで最後に確認された車両の位置情報（未加工の位置情報）をデフォルトで入力します。
taskOutcomeLocationSource

enum (TaskOutcomeLocationSource)

taskOutcomeLocation の値の取得元を示します。
trackingId

string

変更不可。このフィールドを使用すると ID を簡単に保存できるため、複雑なマッピングを使用する手間が省けます。UNAVAILABLE タイプと SCHEDULED_STOP タイプのタスクには trackingId を設定できません。これらの ID には次の制限があります。

  • 有効な Unicode 文字列を指定する必要があります。
  • 最大文字数は 64 文字です。
  • Unicode 正規化フォーム C に従って正規化されます。
  • ASCII 文字「/」、「:」、「?」、「」、「#」を含めることはできません。
deliveryVehicleId

string

出力専用。このタスクを実行している車両の ID。配達車両 ID には次の制限があります。

  • 有効な Unicode 文字列を指定する必要があります。
  • 最大文字数は 64 文字です。
  • Unicode 正規化フォーム C に従って正規化されます。
  • ASCII 文字「/」、「:」、「?」、「」、「#」を含めることはできません。
plannedLocation

object (LocationInfo)

変更不可。タスクを完了する場所。UNAVAILABLE 個のタスクでは任意ですが、他のすべてのタスクでは必須です。
taskDuration

string (Duration format)

必須。変更不可。この場所でタスクを実行するために必要な時間。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。
targetTimeWindow

object (TimeWindow)

タスクを完了する時間枠。
journeySharingInfo

object (JourneySharingInfo)

出力専用。ジャーニーの共有固有のフィールド。状態が CLOSED の場合は入力されません。
taskTrackingViewConfig

object (TaskTrackingViewConfig)

どのような状況でどのデータ要素がエンドユーザーに表示されるかを指定する、タスク トラッキングの構成。
attributes[]

object (TaskAttribute)

カスタムタスク属性のリスト。各属性には一意のキーが必要です。

タイプ

タスクのタイプ。

列挙型
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 (VehicleJourneySegment)
    }
  ],
  "lastLocation": {
    object (DeliveryVehicleLocation)
  },
  "lastLocationSnappable": boolean
}
フィールド
remainingVehicleJourneySegments[]

object (VehicleJourneySegment)

このタスクを完了する前に、割り当てられた車両が実施する停車地のトラッキング情報。このリストには、他のタスクの経由地を含めることもできます。

最初のセグメントの Task.journey_sharing_info.remaining_vehicle_journey_segments[0]（gRPC）または Task.journeySharingInfo.remainingVehicleJourneySegments[0]（REST）には、ドライバーが最後に認識した場所から次の VehicleStop へのルート情報が含まれています。現在のルート情報は通常、ドライバーのアプリから取得されます（DeliveryVehicle.current_route_segment のドキュメントに記載されている一部のケースを除きます）。Task.journey_sharing_info.remaining_vehicle_journey_segments（gRPC）または Task.journeySharingInfo.remainingVehicleJourneySegments（REST）の他のセグメントは、Fleet Engine によって入力されます。これらは、残りの VehicleStops 間のルート情報を提供します。
lastLocation

object (DeliveryVehicleLocation)

車両が最後に報告された割り当てられている車両の位置を示します。
lastLocationSnappable

boolean

車両の lastLocation を currentRouteSegment にスナップできるかどうかを示します。lastLocation または currentRouteSegment のいずれかが存在しない場合、この値は False です。この値は Fleet Engine によって計算されます。クライアントからの更新は無視されます。

TaskTrackingViewConfig

タスクのデータ要素をエンドユーザーに表示するタイミングを定義する構成メッセージ。

JSON 表現 
{
  "routePolylinePointsVisibility": {
    object (VisibilityOption)
  },
  "estimatedArrivalTimeVisibility": {
    object (VisibilityOption)
  },
  "estimatedTaskCompletionTimeVisibility": {
    object (VisibilityOption)
  },
  "remainingDrivingDistanceVisibility": {
    object (VisibilityOption)
  },
  "remainingStopCountVisibility": {
    object (VisibilityOption)
  },
  "vehicleLocationVisibility": {
    object (VisibilityOption)
  }
}
フィールド
routePolylinePointsVisibility

object (VisibilityOption)

ルートのポリライン ポイントを表示するタイミングを指定するフィールド。このフィールドが指定されていない場合、このデータにプロジェクト レベルのデフォルトの公開設定が使用されます。
estimatedArrivalTimeVisibility

object (VisibilityOption)

到着予定時刻を表示するタイミングを指定するフィールド。このフィールドが指定されていない場合、このデータにプロジェクト レベルのデフォルトの公開設定が使用されます。
estimatedTaskCompletionTimeVisibility

object (VisibilityOption)

タスク完了予定時間を表示するタイミングを指定するフィールド。このフィールドが指定されていない場合、このデータにプロジェクト レベルのデフォルトの公開設定が使用されます。
remainingDrivingDistanceVisibility

object (VisibilityOption)

残りの走行距離を表示するタイミングを指定するフィールド。このフィールドが指定されていない場合、このデータにプロジェクト レベルのデフォルトの公開設定が使用されます。
remainingStopCountVisibility

object (VisibilityOption)

残りの停車回数を表示するタイミングを指定するフィールド。このフィールドが指定されていない場合、このデータにプロジェクト レベルのデフォルトの公開設定が使用されます。
vehicleLocationVisibility

object (VisibilityOption)

車両の位置情報を表示できるタイミングを指定するフィールド。このフィールドが指定されていない場合、このデータにプロジェクト レベルのデフォルトの公開設定が使用されます。

VisibilityOption

データ要素をいつエンドユーザーに表示するかを定義するオプション メッセージ。

JSON 表現 
{

  // Union field visibility_option can be only one of the following:
  "remainingStopCountThreshold": integer,
  "durationUntilEstimatedArrivalTimeThreshold": string,
  "remainingDrivingDistanceMetersThreshold": integer,
  "always": boolean,
  "never": boolean
  // End of list of possible types for union field visibility_option.
}
フィールド
共用体フィールド visibility_option。選択した特定の公開設定オプション。visibility_option は次のいずれかになります。
remainingStopCountThreshold

integer

このデータ要素は、残りの停止回数が残り停止カウントしきい値以下の場合、エンドユーザーに表示されます。
durationUntilEstimatedArrivalTimeThreshold

string (Duration format)

このデータ要素は、停車地までの到着予定時刻が durationUntilEstimateArrivalTimeThreshold 以下の場合、エンドユーザーに表示されます。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。
remainingDrivingDistanceMetersThreshold

integer

このデータ要素は、残りの走行距離（メートル単位）が残り運転距離メーターのしきい値である場合、エンドユーザーに表示されます。
always

boolean

true に設定すると、このデータ要素が、しきい値なしで常にエンドユーザーに表示されます。このフィールドを false に設定することはできません。
never

boolean

true に設定すると、このデータ要素はしきい値なしで常にエンドユーザーに対して非表示になります。このフィールドを false に設定することはできません。

メソッド

batchCreate

 新しい Task オブジェクトのバッチを作成して返します。

create

 新しい Task オブジェクトを作成して返します。

get

 Task に関する情報を取得します。

list

 指定されたフィルタ条件を満たすすべての Task を取得します。

patch

 Task のデータを更新します。