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

Precisa estar no formato providers/{provider}/tasks/{task}.

enum (Type)

Obrigatório. Imutável. Define o tipo da tarefa. Por exemplo, uma pausa ou um envio.

enum (State)

Obrigatório. O estado de execução atual da tarefa.

enum (TaskOutcome)

O resultado da Tarefa.

string (Timestamp format)

O carimbo de data/hora que indica quando o resultado do Task foi definido pelo provedor.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

object (LocationInfo)

O local em que o resultado de Task foi definido. Esse valor é atualizado como parte de tasks.patch. Se esse valor não for atualizado explicitamente pelo provedor, o Fleet Engine vai preenchê-lo por padrão com o último local conhecido do veículo (o local bruto).

enum (TaskOutcomeLocationSource)

Indica de onde veio o valor do taskOutcomeLocation.

string

Imutável. Esse campo facilita o armazenamento de um ID para que você evite usar um mapeamento complicado. Não é possível definir trackingId para tarefas do tipo UNAVAILABLE e SCHEDULED_STOP. Esses IDs estão sujeitos às seguintes restrições:

• Precisa ser uma string Unicode válida.
• Limitado a um tamanho máximo de 64 caracteres.
• Normalizado de acordo com o Formulário C de normalização Unicode.
• Não pode conter nenhum dos seguintes caracteres ASCII: '/', ':', '?', ',' ou '#'.

string

Apenas saída. O ID do veículo que está executando essa tarefa. Os IDs dos veículos de entrega estão sujeitos às seguintes restrições:

• Precisa ser uma string Unicode válida.
• Limitado a um comprimento máximo de 64 caracteres.
• Normalizado de acordo com o Formulário C de normalização Unicode.
• Não pode conter nenhum dos seguintes caracteres ASCII: '/', ':', '?', ',' ou '#'.

object (LocationInfo)

Imutável. O local onde a Tarefa será concluída. Opcional para tarefas UNAVAILABLE, mas obrigatório para todas as outras tarefas.

string (Duration format)

Obrigatório. Imutável. O tempo necessário para executar uma tarefa nesse local.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".

object (TimeWindow)

Janela de tempo em que a tarefa precisa ser concluída.

object (JourneySharingInfo)

Apenas saída. Campos específicos do compartilhamento da jornada. Não é preenchido quando o estado é CLOSED.

object (TaskTrackingViewConfig)

A configuração do rastreamento de tarefas que especifica quais elementos de dados ficam visíveis para os usuários finais em quais circunstâncias.

object (TaskAttribute)

Uma lista de atributos de tarefas personalizados. Cada atributo precisa ter uma chave exclusiva.

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

object (VehicleJourneySegment)

Informações de rastreamento das paradas que o veículo atribuído vai fazer antes de concluir a tarefa. Essa lista pode conter paradas de outras tarefas.

O primeiro segmento, Task.journey_sharing_info.remaining_vehicle_journey_segments[0] (gRPC) ou Task.journeySharingInfo.remainingVehicleJourneySegments[0] (REST), contém informações de trajeto do último local conhecido do motorista até o próximo VehicleStop. As informações da rota atual geralmente vêm do app do motorista, exceto em alguns casos indicados na documentação de DeliveryVehicle.current_route_segment. Os outros segmentos em Task.journey_sharing_info.remaining_vehicle_journey_segments (gRPC) ou Task.journeySharingInfo.remainingVehicleJourneySegments (REST) são preenchidos pelo Fleet Engine. Eles fornecem informações de rota entre os VehicleStops restantes.

object (DeliveryVehicleLocation)

Indica o último local informado do veículo atribuído pelo veículo.

boolean

Indica se o lastLocation do veículo pode ser vinculado ao currentRouteSegment. Esse valor é falso se lastLocation ou currentRouteSegment não existirem. Esse valor é calculado pelo Fleet Engine. As atualizações dos clientes são ignoradas.

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

object (VisibilityOption)

Campo que especifica quando os pontos da polilinha do trajeto podem ficar visíveis. Se esse campo não for especificado, a configuração de visibilidade padrão no nível do projeto para esses dados será usada.

object (VisibilityOption)

Campo que especifica quando o horário de chegada estimado pode ser mostrado. Se este campo não for especificado, será usada a configuração de visibilidade padrão para esses dados no nível do projeto.

object (VisibilityOption)

Campo que especifica quando o tempo estimado para a conclusão da tarefa pode ficar visível. Se este campo não for especificado, será usada a configuração de visibilidade padrão para esses dados no nível do projeto.

object (VisibilityOption)

Campo que especifica quando a distância restante da viagem pode ser mostrada. Se esse campo não for especificado, a configuração de visibilidade padrão no nível do projeto para esses dados será usada.

object (VisibilityOption)

O campo que especifica quando o número de paradas restantes pode ficar visível. Se este campo não for especificado, será usada a configuração de visibilidade padrão para esses dados no nível do projeto.

object (VisibilityOption)

Campo que especifica quando a localização do veículo pode ficar visível. Se esse campo não for especificado, a configuração de visibilidade padrão no nível do projeto para esses dados será usada.

{

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

Esse elemento de dados fica visível para os usuários finais se o restante da contagem de paradas for <= remainingStopCountThreshold.

string (Duration format)

Esse elemento de dados fica visível para os usuários finais se o ETA até a parada for <= durationUntilEstimatedArrivalTimeThreshold.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".

integer

Esse elemento de dados será visível para os usuários finais se a distância de carro restante em metros <= refundDistanceMetersThreshold.

boolean

Se definido como verdadeiro, esse elemento de dados fica sempre visível para os usuários finais sem limites. Este campo não pode ser definido como falso.

boolean

Se definido como "true", esse elemento de dados fica sempre oculto dos usuários finais sem limites. Este campo não pode ser definido como falso.