REST Resource: providers.tasks

{
  "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)
    }
  ]
}

string

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

enum (Type)

必須。変更不可。タスクのタイプを定義します。たとえば、休憩や配送などです。

enum (State)

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

enum (TaskOutcome)

タスクの結果。

string (Timestamp format)

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

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

object (LocationInfo)

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

enum (TaskOutcomeLocationSource)

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

string

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

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

string

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

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

object (LocationInfo)

変更不可。タスクが完了する場所。UNAVAILABLE タスクでは省略可能ですが、他のすべてのタスクでは必須です。

string (Duration format)

必須。変更不可。このロケーションでタスクを実行するために必要な時間。

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

object (TimeWindow)

タスクを完了する必要がある時間枠。

object (JourneySharingInfo)

出力専用。ジャーニー共有専用のフィールド。ステータスが CLOSED の場合、入力されません。

object (TaskTrackingViewConfig)

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

object (TaskAttribute)

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

{
  "remainingVehicleJourneySegments": [
    {
      object (VehicleJourneySegment)
    }
  ],
  "lastLocation": {
    object (DeliveryVehicleLocation)
  },
  "lastLocationSnappable": boolean
}

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 間のルート情報を提供します。

object (DeliveryVehicleLocation)

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

boolean

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

{
  "routePolylinePointsVisibility": {
    object (VisibilityOption)
  },
  "estimatedArrivalTimeVisibility": {
    object (VisibilityOption)
  },
  "estimatedTaskCompletionTimeVisibility": {
    object (VisibilityOption)
  },
  "remainingDrivingDistanceVisibility": {
    object (VisibilityOption)
  },
  "remainingStopCountVisibility": {
    object (VisibilityOption)
  },
  "vehicleLocationVisibility": {
    object (VisibilityOption)
  }
}

object (VisibilityOption)

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

object (VisibilityOption)

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

object (VisibilityOption)

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

object (VisibilityOption)

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

object (VisibilityOption)

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

object (VisibilityOption)

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

{

  // 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.
}

integer

このデータ要素は、残りの停留所数が remainingStopCountThreshold 以下の場合、エンドユーザーに表示されます。

string (Duration format)

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

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

integer

このデータ要素は、残りの走行距離（メートル）が remainingDrivingDistanceMetersThreshold 以下の場合、エンドユーザーに表示されます。

boolean

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

boolean

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