Encontrar tarefas

Este documento descreve as maneiras de encontrar informações de tarefas em um servidor ou navegador. O Fleet Engine oferece duas maneiras de encontrar tarefas:

• Pesquisar tarefas: é possível pesquisar tarefas pelos seguintes IDs:

  • ID da tarefa: usado por usuários como operadores de frota que têm acesso à visualização completa dos dados da tarefa.
  • ID de rastreamento: usado pelo software do cliente para fornecer informações limitadas a um usuário final, como quando um pacote é esperado na casa dele.

  Entenda a diferença entre o ID da tarefa e o ID de rastreamento da tarefa. Eles não são a mesma coisa. Consulte Campos básicos de tarefas no guia de tarefas programadas.

• Listar tarefas: acesso amplo a tarefas, destinado apenas a usuários confiáveis.

Pesquisar tarefas

Nesta seção, descrevemos como pesquisar tarefas por ID da tarefa ou ID de rastreamento. Ele tem os seguintes requisitos:

• As pesquisas por ID de rastreamento precisam obedecer às regras de visibilidade declaradas em Regras de visibilidade para objetos rastreados.

• Use o token mais restrito possível para limitar os riscos de segurança. Por exemplo, se você usar um token de consumidor de entrega, todas as chamadas vão retornar apenas informações relevantes para esse usuário final, como o remetente ou o destinatário de uma remessa. O Fleet Engine encobre todas as outras informações nas respostas. Para mais informações sobre tokens, consulte Tokens JSON da Web.

Pesquisar tarefa por ID

É possível pesquisar uma tarefa pelo ID dela em um ambiente de servidor usando gRPC ou REST. Os exemplos a seguir mostram como usar a biblioteca gRPC Java ou uma solicitação REST para GetTask.

 static final String PROJECT_ID = "my-delivery-co-gcp-project";
 static final String TASK_ID = "task-8597549";

 DeliveryServiceBlockingStub deliveryService =
   DeliveryServiceGrpc.newBlockingStub(channel);

 // Task request
 String taskName = "providers/" + PROJECT_ID + "/tasks/" + TASK_ID;
 GetTaskRequest getTaskRequest = GetTaskRequest.newBuilder()  // No need for the header
     .setName(taskName)
     .build();

 try {
   Task task = deliveryService.getTask(getTaskRequest);
 } catch (StatusRuntimeException e) {
   Status s = e.getStatus();
   switch (s.getCode()) {
      case NOT_FOUND:
        break;

      case PERMISSION_DENIED:
        break;
   }
   return;
 }

    # Set JWT, PROJECT_ID, and TASK_ID in the local environment
    curl -H "Authorization: Bearer ${JWT}" \
      "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/tasks/${TASK_ID}"

Pesquisar tarefas por ID de rastreamento

Os exemplos a seguir mostram como pesquisar tarefas pelo ID de rastreamento do envio usando gRPC ou uma chamada HTTP REST para GetTaskTrackingInfo.

static final String PROJECT_ID = "my-delivery-co-gcp-project";
static final String TRACKING_ID = "TID-7449w087464x5";

DeliveryServiceBlockingStub deliveryService =
  DeliveryServiceGrpc.newBlockingStub(channel);

// Tasks request
String parent = "providers/" + PROJECT_ID;
GetTaskTrackingInfoRequest getTaskTrackingInfoRequest = GetTaskTrackingInfoRequest.newBuilder()  // No need for the header
    .setParent(parent)
    .setTrackingId(TRACKING_ID)
    .build();

try {
  TaskTrackingInfo taskTrackingInfo = deliveryService.getTaskTrackingInfo(getTaskTrackingInfoRequest);
} catch (StatusRuntimeException e) {
  Status s = e.getStatus();
  switch (s.getCode()) {
     case NOT_FOUND:
       break;

     case PERMISSION_DENIED:
       break;
  }
  return;
}

# Set JWT, PROJECT_ID, and TRACKING_ID in the local environment
curl -H "Authorization: Bearer ${JWT}" \
  "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/taskTrackingInfo/${TRACKING_ID}"

Listar tarefas

A listagem de tarefas pede acesso amplo a elas. A listagem de tarefas é destinada apenas a usuários confiáveis. Use tokens de autenticação de leitura de frota de entrega ou administrador de entrega ao fazer solicitações de tarefas de lista. Consulte Papéis da conta de serviço para mais informações.

Paginar listas

As listas de tarefas são paginadas. Um tamanho de página pode ser especificado em solicitações de listagem de tarefas. Se um tamanho de página for especificado, o número de tarefas retornadas não será maior que o tamanho especificado. Se nenhum tamanho de página estiver presente, um padrão razoável será usado. Se o tamanho da página solicitado exceder um valor máximo interno, esse valor será usado.

Uma lista de tarefas pode incluir um token para ler a próxima página de resultados. Para recuperar a próxima página, reenvie a mesma solicitação com o token de página. Quando o token de página retornado está vazio, não há mais tarefas disponíveis para recuperação.

Campos ao listar tarefas

O Fleet Engine encobre os seguintes campos ao listar tarefas:

• VehicleStop.planned_location
• VehicleStop.state
• VehicleStop.TaskInfo.taskId

Use os seguintes formatos de campo com base nas propostas de melhoria da API do Google:

Filtrar tarefas listadas

É possível filtrar as tarefas listadas pela maioria das propriedades. Para a sintaxe de consulta de filtro, consulte AIP-160. Se nenhuma consulta de filtro for especificada, todas as tarefas serão listadas.

A tabela a seguir mostra as propriedades de tarefa válidas que podem ser usadas para filtragem:

Consulte AIP-160 para ver uma lista completa de operadores de consulta de filtro.

Listar exemplos de tarefas

O exemplo a seguir mostra como listar tarefas para um deliveryVehicleId e um atributo de tarefa, ambos com a biblioteca Java gRPC e com uma chamada HTTP REST para ListTasks.

Uma resposta bem-sucedida ainda pode estar vazia. Uma resposta vazia indica que não há tarefas associadas ao deliveryVehicleId fornecido.

 static final String PROJECT_ID = "my-delivery-co-gcp-project";
 static final String TRACKING_ID = "TID-7449w087464x5";

 DeliveryServiceBlockingStub deliveryService =
   DeliveryServiceGrpc.newBlockingStub(channel);

 // Tasks request
 String parent = "providers/" + PROJECT_ID;
 ListTasksRequest listTasksRequest = ListTasksRequest.newBuilder()  // No need for the header
     .setParent(parent)
     .setFilter("delivery_vehicle_id = 123 AND attributes.foo = true")
     .build();

 try {
   ListTasksResponse listTasksResponse = deliveryService.listTasks(listTasksRequest);
 } catch (StatusRuntimeException e) {
   Status s = e.getStatus();
   switch (s.getCode()) {
      case NOT_FOUND:
        break;

      case PERMISSION_DENIED:
        break;
   }
   return;
 }

    // JSON representation
    {
      "tasks": [
        {
          object (Task)
        }
      ],
      "nextPageToken": string,
      "totalSize": integer
    }

 # Set JWT, PROJECT_ID, and VEHICLE_ID in the local environment
 curl -H "Authorization: Bearer ${JWT}" \
   "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/tasks?filter=state%20%3D%20OPEN%20AND%20delivery_vehicle_id%20%3D%20${VEHICLE_ID}"

A seguir

• Gerenciar envios