REST Resource: providers.tasks

リソース: 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 (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)

必須。変更不可。Task のタイプを定義します。（破損、発送など）。
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 タイプの ToDo リストには 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

このデータ要素は、残りの経由地数 <= leaseStopCountThreshold 以下の場合、エンドユーザーに表示されます。
durationUntilEstimatedArrivalTimeThreshold

string (Duration format)

このデータ要素は、駅 / 停留所の到着予定時刻が durationDURATIONArrivalTimeThreshold 以下の場合、エンドユーザーに表示されます。

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

integer

このデータ要素は、残りの運転距離がメートル単位 <= restDrivingDistanceMetersThreshold 以下の場合、エンドユーザーに表示されます。
always

boolean

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

boolean

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

Methods

batchCreate

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

create

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

get

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

list

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

patch

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

search
(deprecated)

 非推奨: 代わりに GetTaskTrackingInfo を使用してください。