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

Debe tener el formato providers/{provider}/tasks/{task}.

enum (Type)

Obligatorio. Inmutable. Define el tipo de Task. Por ejemplo, una pausa o un envío.

enum (State)

Obligatorio. El estado actual de la ejecución de la Task.

enum (TaskOutcome)

El resultado de la Task.

string (Timestamp format)

Es la marca de tiempo que indica cuándo el proveedor configuró el resultado de Task.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

object (LocationInfo)

La ubicación en la que se estableció el resultado de Task. Este valor se actualiza como parte de tasks.patch. Si el proveedor no actualiza de forma explícita este valor, Fleet Engine lo propaga de forma predeterminada con la ubicación más reciente del vehículo (la ubicación sin).

enum (TaskOutcomeLocationSource)

Indica de dónde provino el valor de taskOutcomeLocation.

string

Inmutable. Este campo facilita el almacenamiento de un ID para que no tengas que usar una asignación complicada. No puedes configurar trackingId para tareas de tipo UNAVAILABLE y SCHEDULED_STOP. Estos IDs están sujetos a las siguientes restricciones:

• Debe ser una string Unicode válida.
• Tiene una longitud máxima de 64 caracteres.
• Se normalizó según el Formulario de normalización C de Unicode.
• No puede contener ninguno de los siguientes caracteres ASCII: “/”, “:”, “?”, “,” o '#'.

string

Solo salida. El ID del vehículo que ejecuta esta tarea. Los IDs de vehículos de entrega están sujetos a las siguientes restricciones:

• Debe ser una string Unicode válida.
• Tiene una longitud máxima de 64 caracteres.
• Se normalizó según el Formulario de normalización C de Unicode.
• No puede contener ninguno de los siguientes caracteres ASCII: “/”, “:”, “?”, “,” o '#'.

object (LocationInfo)

Inmutable. Es la ubicación en la que se completará la tarea. Opcional para las tareas de UNAVAILABLE, pero es obligatorio para todas las demás tareas.

string (Duration format)

Obligatorio. Inmutable. El tiempo necesario para ejecutar una Task en esta ubicación.

Una duración en segundos con hasta nueve dígitos decimales que terminen en "s". Ejemplo: "3.5s".

object (TimeWindow)

Es el período durante el cual se debe completar la tarea.

object (JourneySharingInfo)

Solo salida. Campos específicos del recorrido compartido. No se propaga cuando el estado es CLOSED.

object (TaskTrackingViewConfig)

Es la configuración del seguimiento de tareas que especifica qué elementos de datos son visibles para los usuarios finales y en qué circunstancias.

object (TaskAttribute)

Una lista de atributos personalizados de Tasks. Cada atributo debe tener una clave única.

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

object (VehicleJourneySegment)

Información de seguimiento para las paradas que realizará el vehículo asignado antes de completar esta Tarea. Ten en cuenta que esta lista puede contener paradas de otras tareas.

El primer segmento, Task.journey_sharing_info.remaining_vehicle_journey_segments[0] (gRPC) o Task.journeySharingInfo.remainingVehicleJourneySegments[0] (REST), contiene información de ruta desde la última ubicación conocida del conductor hasta el próximo VehicleStop. Por lo general, la información de ruta actual proviene de la app del conductor, excepto en algunos casos que se indican en la documentación de DeliveryVehicle.current_route_segment. Fleet Engine propaga los otros segmentos en Task.journey_sharing_info.remaining_vehicle_journey_segments (gRPC) o Task.journeySharingInfo.remainingVehicleJourneySegments (REST). Proporcionan información de ruta entre los VehicleStops restantes.

object (DeliveryVehicleLocation)

Indica la ubicación más reciente que se informó del vehículo asignado.

boolean

Indica si la última ubicación del vehículo se puede ajustar a currentRouteSegment. Este valor es Falso si lastLocation o currentRouteSegment no existen. Fleet Engine calcula este valor. Se ignoran las actualizaciones de los clientes.

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

object (VisibilityOption)

Es el campo que especifica cuándo se pueden ver los puntos de polilínea de la ruta. Si no se especifica este campo, se usará la configuración de visibilidad predeterminada a nivel de proyecto para estos datos.

object (VisibilityOption)

El campo que especifica cuándo puede mostrarse la hora de llegada estimada. Si no se especifica este campo, se usará la configuración de visibilidad predeterminada a nivel de proyecto para estos datos.

object (VisibilityOption)

Campo que especifica cuándo se puede visualizar el tiempo estimado de finalización de la tarea. Si no se especifica este campo, se usará la configuración de visibilidad predeterminada a nivel de proyecto para estos datos.

object (VisibilityOption)

Puede verse el campo que especifica el momento en que se puede recorrer el área restante en automóvil. Si no se especifica este campo, se usará la configuración de visibilidad predeterminada a nivel de proyecto para estos datos.

object (VisibilityOption)

El campo que especifica cuándo puede estar visible el recuento de paradas restante. Si no se especifica este campo, se usará la configuración de visibilidad predeterminada a nivel de proyecto para estos datos.

object (VisibilityOption)

Es el campo que especifica cuándo puede ser visible la ubicación del vehículo. Si no se especifica este campo, se usará la configuración de visibilidad predeterminada a nivel de proyecto para estos datos.

{

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

Este elemento de datos es visible para los usuarios finales si el recuento de paradas restante es igual a <= distribucionesStopCountThreshold.

string (Duration format)

Este elemento de datos es visible para los usuarios finales si la hora de llegada estimada a la parada es <= durationUntilEstimatedArrivalTimeThreshold.

Una duración en segundos con hasta nueve dígitos decimales que terminen en "s". Ejemplo: "3.5s".

integer

Este elemento de datos es visible para los usuarios finales si la distancia de conducción restante en metros es inferior o igual a la cantidad de metros que recibimos.

boolean

Si se configura como true, este elemento de datos siempre es visible para los usuarios finales sin umbrales. Este campo no se puede establecer como falso.

boolean

Si se configura como true, este elemento de datos siempre está oculto para los usuarios finales sin umbrales. Este campo no se puede establecer como falso.