Package maps.fleetengine.delivery.v1

Índice

DeliveryService

O serviço Last Mile Delivery.

BatchCreateTasks

rpc BatchCreateTasks(BatchCreateTasksRequest) returns (BatchCreateTasksResponse)

Cria e retorna um lote de novos objetos Task.
CreateDeliveryVehicle

rpc CreateDeliveryVehicle(CreateDeliveryVehicleRequest) returns (DeliveryVehicle)

Cria e retorna um novo DeliveryVehicle.
CreateTask

rpc CreateTask(CreateTaskRequest) returns (Task)

Cria e retorna um novo objeto Task.
GetDeliveryVehicle

rpc GetDeliveryVehicle(GetDeliveryVehicleRequest) returns (DeliveryVehicle)

Retorna a instância de DeliveryVehicle especificada.
GetTask

rpc GetTask(GetTaskRequest) returns (Task)

Recebe informações sobre um Task.
GetTaskTrackingInfo

rpc GetTaskTrackingInfo(GetTaskTrackingInfoRequest) returns (TaskTrackingInfo)

Retorna a instância de TaskTrackingInfo especificada.
ListDeliveryVehicles

rpc ListDeliveryVehicles(ListDeliveryVehiclesRequest) returns (ListDeliveryVehiclesResponse)

Recebe todos os DeliveryVehicles que atendem aos critérios de filtragem especificados.
ListTasks

rpc ListTasks(ListTasksRequest) returns (ListTasksResponse)

Recebe todos os Tasks que atendem aos critérios de filtragem especificados.
SearchTasks

rpc SearchTasks(SearchTasksRequest) returns (SearchTasksResponse)

Obsoleto: use GetTaskTrackingInfo.
UpdateDeliveryVehicle

rpc UpdateDeliveryVehicle(UpdateDeliveryVehicleRequest) returns (DeliveryVehicle)

Grava dados atualizados do DeliveryVehicle no Fleet Engine e atribui Tasks ao DeliveryVehicle. Não é possível atualizar o nome do DeliveryVehicle. No entanto, é possível atualizar remaining_vehicle_journey_segments, mas ele precisa conter todos os VehicleJourneySegments atualmente no DeliveryVehicle. Os task_ids são recuperados do remaining_vehicle_journey_segments, e os Tasks correspondentes são atribuídos ao DeliveryVehicle, se eles ainda não tiverem sido atribuídos.
UpdateTask

rpc UpdateTask(UpdateTaskRequest) returns (Task)

Atualiza os dados de Task.

BatchCreateTasksRequest

A mensagem de solicitação BatchCreateTask.

Campos
header

DeliveryRequestHeader

Opcional. O cabeçalho da solicitação da API Standard Delivery. Observação: se você definir esse campo, o campo de cabeçalho nas mensagens CreateTaskRequest precisará estar vazio ou corresponder a este campo.
parent

string

Obrigatório. O recurso pai compartilhado por todas as tarefas. Esse valor precisa estar no formato providers/{provider}. O provider precisa ser o ID do projeto do Google Cloud. Por exemplo, sample-cloud-project. O campo pai nas mensagens CreateTaskRequest precisa estar vazio ou corresponder a esse campo.
requests[]

CreateTaskRequest

Obrigatório. A mensagem de solicitação que especifica os recursos a serem criados. Observação: é possível criar no máximo 500 tarefas em um lote.

BatchCreateTasksResponse

A mensagem de resposta BatchCreateTask.

Campos
tasks[]

Task

As tarefas criadas.

CreateDeliveryVehicleRequest

A mensagem de solicitação CreateDeliveryVehicle.

Campos
header

DeliveryRequestHeader

Opcional. O cabeçalho da solicitação da API Standard Delivery.
parent

string

Obrigatório. Precisa estar no formato providers/{provider}. O provedor precisa ser o ID do projeto do Google Cloud. Por exemplo, sample-cloud-project.
delivery_vehicle_id

string

Obrigatório. Esse ID precisa ser exclusivo e está sujeito à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 '#'.
delivery_vehicle

DeliveryVehicle

Obrigatório. A entidade DeliveryVehicle que será criada. Ao criar um novo veículo de entrega, você pode definir os seguintes campos opcionais:

  • last_location
  • atributos

Observação: o campo name do Veículo de entrega é ignorado. Todos os outros campos DeliveryVehicle não devem ser definidos. Caso contrário, um erro é retornado.

CreateTaskRequest

A mensagem de solicitação CreateTask.

Campos
header

DeliveryRequestHeader

Opcional. O cabeçalho da solicitação da API Standard Delivery.
parent

string

Obrigatório. Precisa estar no formato providers/{provider}. O provider precisa ser o ID do projeto do Google Cloud. Por exemplo, sample-cloud-project.
task_id

string

Obrigatório. O ID da tarefa precisa ser exclusivo, mas não pode ser um ID de rastreamento de remessa. Para armazenar um ID de rastreamento de frete, use o campo tracking_id. Várias tarefas podem ter o mesmo tracking_id. Os IDs de tarefas 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 '#'.
task

Task

Obrigatório. A entidade Task a ser criada. Ao criar uma tarefa, os seguintes campos são obrigatórios:

  • type
  • state (precisa ser definido como OPEN)
  • tracking_id (não pode ser definido para tarefas UNAVAILABLE ou SCHEDULED_STOP, mas é obrigatório para todos os outros tipos de tarefa)
  • planned_location (opcional para UNAVAILABLE tarefas)
  • task_duration

Observação: o campo name da tarefa é ignorado. Todos os outros campos "Task" não podem ser definidos. Caso contrário, um erro é retornado.

DeliveryRequestHeader

Um RequestHeader contém campos comuns a todas as solicitações de RPC Delivery.

Campos
language_code

string

O código de idioma BCP-47, como en-US ou sr-Latn. Para mais informações, consulte http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Se nenhum for especificado, a resposta poderá estar em qualquer idioma, com preferência por inglês se existir tal nome. Exemplo de valor do campo: en-US.
region_code

string

Obrigatório. Código regional CLDR da região de origem da solicitação. Exemplo de valor do campo: US.
sdk_version

string

Versão do SDK de chamada, se aplicável. O formato da versão é "major.minor.patch", por exemplo: 1.1.2.
os_version

string

Versão do sistema operacional em que o SDK de chamada está sendo executado. Exemplos de valor de campo: 4.4.1, 12.1.
device_model

string

Modelo do dispositivo em que o SDK de chamada está sendo executado. Exemplos de valor de campo: iPhone12,1, SM-G920F.
sdk_type

SdkType

O tipo de SDK que envia a solicitação.
maps_sdk_version

string

Versão do MapSDK de que o SDK de chamada depende, se aplicável. O formato da versão é "major.minor.patch", por exemplo: 5.2.1.
nav_sdk_version

string

Versão do NavSDK de que o SDK de chamada depende, se aplicável. O formato da versão é "major.minor.patch", por exemplo: 2.1.0.
platform

Platform

Plataforma do SDK de chamada.
manufacturer

string

Fabricante do dispositivo Android do SDK de chamada, aplicável somente aos SDKs do Android. Exemplo de valor do campo: Samsung.
android_api_level

int32

Nível da API do Android do SDK de chamada, aplicável apenas aos SDKs do Android. Exemplo de valor do campo: 23.
trace_id

string

ID opcional que pode ser fornecido para fins de registro e identificação da solicitação.

Plataforma

A plataforma do SDK de chamada.

Enums
PLATFORM_UNSPECIFIED O valor padrão. Esse valor será usado se a plataforma for omitida.
ANDROID A solicitação vem do Android.
IOS A solicitação vem do iOS.
WEB A solicitação vem da Web.

SdkType

Tipos possíveis de SDK.

Enums
SDK_TYPE_UNSPECIFIED O valor padrão. Esse valor será usado se o sdk_type for omitido.
CONSUMER O SDK de chamada é Consumer.
DRIVER O SDK de chamada é o Driver.
JAVASCRIPT O SDK de chamada é o JavaScript.

DeliveryVehicle

A mensagem DeliveryVehicle. Um veículo de entrega transporta encomendas de um depósito para um local de entrega e de um local de coleta para o depósito. Em alguns casos, os veículos de entrega também transportam encomendas diretamente do local de retirada para o local de entrega.

Observação: as APIs REST e gRPC usam convenções de nomenclatura de campo diferentes. Por exemplo, o campo DeliveryVehicle.current_route_segment na API gRPC e o campo DeliveryVehicle.currentRouteSegment na API REST se referem ao mesmo campo.

Campos
name

string

O nome exclusivo deste veículo de entrega. O formato é providers/{provider}/deliveryVehicles/{vehicle}.
last_location

DeliveryVehicleLocation

O último local informado do veículo de entrega.
navigation_status

DeliveryVehicleNavigationStatus

Status de navegação do Veículo de entrega.
current_route_segment

bytes

A polilinha codificada que especifica o trajeto que a navegação recomenda até o próximo waypoint. O app do motorista atualiza essa informação quando uma parada é alcançada ou ultrapassada e quando a navegação redefine o trajeto. Esses LatLngs são retornados em Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) ou Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) para todas as tarefas ativas atribuídas ao veículo.

Há alguns casos em que esse campo não pode ser usado para preencher Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) ou Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST):

  • O endpoint de current_route_segment não corresponde a DeliveryVehicle.remaining_vehicle_journey_segments[0].stop (gRPC) ou DeliveryVehicle.remainingVehicleJourneySegments[0].stop (REST).

  • Como o app do motorista não atualizou a localização recentemente, o último valor atualizado desse campo pode estar desatualizado.

  • O app do motorista atualizou recentemente o local, mas o current_route_segment está desatualizado e aponta para uma parada anterior do veículo.

Nesses casos, o Fleet Engine preenche esse campo com um trajeto do VehicleStop passado mais recentemente até o próximo VehicleStop para garantir que o consumidor desse campo tenha as melhores informações disponíveis sobre o caminho atual do Veículo de entrega.
current_route_segment_end_point

LatLng

O local em que a current_route_segment termina. No momento, ele não é preenchido pelo app do driver, mas pode ser fornecido em chamadas UpdateDeliveryVehicle. É o LatLng da próxima parada do veículo ou o último LatLng do current_route_segment. O Fleet Engine vai fazer o possível para interpolar para um VehicleStop real.

Esse campo será ignorado em chamadas UpdateDeliveryVehicle se o campo current_route_segment estiver vazio.
remaining_distance_meters

Int32Value

A distância de carro restante do current_route_segment. O app Driver normalmente oferece esse campo, mas há algumas circunstâncias em que o Fleet Engine substitui o valor enviado pelo app. Para mais informações, consulte DeliveryVehicle.current_route_segment. Esse campo é retornado em Task.remaining_vehicle_journey_segments[0].driving_distance_meters (gRPC) ou Task.remainingVehicleJourneySegments[0].drivingDistanceMeters (REST) para todos os Tasks ativos atribuídos ao veículo de entrega.

O Fleet Engine vai ignorar esse campo no UpdateDeliveryVehicleRequest se o current_route_segment estiver vazio.
remaining_duration

Duration

O tempo restante de condução do current_route_segment. O app Driver normalmente oferece esse campo, mas há algumas circunstâncias em que o Fleet Engine substitui o valor enviado pelo app. Para mais informações, consulte DeliveryVehicle.current_route_segment. Esse campo é retornado em Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) ou Task.remainingVehicleJourneySegments[0].drivingDuration (REST) para todas as tarefas ativas atribuídas ao veículo de entrega.

O Fleet Engine vai ignorar esse campo no UpdateDeliveryVehicleRequest se o current_route_segment estiver vazio.
remaining_vehicle_journey_segments[]

VehicleJourneySegment

Os trechos da viagem atribuídos a este veículo de entrega, começando no local informado mais recentemente. Este campo não será preenchido na resposta de ListDeliveryVehicles.
attributes[]

DeliveryVehicleAttribute

Uma lista de atributos personalizados do veículo de entrega. Um Veículo de entrega pode ter no máximo 100 atributos, e cada um deles precisa ter uma chave exclusiva.
type

DeliveryVehicleType

O tipo deste veículo de entrega. Se não for definido, o padrão será AUTO.

DeliveryVehicleType

O tipo de veículo de entrega.

Enums
DELIVERY_VEHICLE_TYPE_UNSPECIFIED O valor não é utilizado.
AUTO Um automóvel.
TWO_WHEELER Uma motocicleta, ciclomoto ou outro veículo de duas rodas
BICYCLE Transporte com energia humana.
PEDESTRIAN Um transportador humano, normalmente caminhando ou correndo, viajando ao longo de vias de pedestres.

DeliveryVehicleAttribute

Descreve um atributo de veículo como um par de chave-valor. O tamanho da string "key:value" não pode exceder 256 caracteres.

Campos
key

string

A chave do atributo.
value

string

O valor do atributo.
Campo de união delivery_vehicle_attribute_value. O valor do atributo pode ser do tipo string, booleano ou duplo. delivery_vehicle_attribute_value pode ser apenas de um dos tipos a seguir:
string_value

string

Valor do atributo com tipo string.

Observação: ele é idêntico ao campo value, que será descontinuado. Para métodos de criação ou atualização, qualquer um dos campos pode ser usado, mas é altamente recomendável usar string_value. Se string_value e value estiverem definidos, eles precisarão ser idênticos, ou um erro será gerado. Ambos os campos são preenchidos nas respostas.
bool_value

bool

Valor do atributo tipo booleano.
number_value

double

Valor de atributo de dois tipos.

DeliveryVehicleLocation

O local, a velocidade e a direção de um veículo em um determinado momento.

Campos
location

LatLng

O local do veículo. Quando é enviado ao Fleet Engine, a localização do veículo é uma localização de GPS. Quando você o receber em uma resposta, a localização do veículo pode ser uma localização de GPS, uma localização suplementar ou outra localização estimada. A origem é especificada em location_sensor.
horizontal_accuracy
(deprecated)

DoubleValue

Obsoleto: use latlng_accuracy.
latlng_accuracy

DoubleValue

Precisão de location em metros como um raio.
heading

Int32Value

Direção em que o veículo está se movendo, em graus. 0 representa Norte. O intervalo válido é [0,360).
bearing_accuracy
(deprecated)

DoubleValue

Obsoleto: use heading_accuracy.
heading_accuracy

DoubleValue

Precisão de heading em graus.
altitude

DoubleValue

Altitude em metros acima de WGS84.
vertical_accuracy
(deprecated)

DoubleValue

Obsoleto: use altitude_accuracy.
altitude_accuracy

DoubleValue

Precisão de altitude em metros.
speed_kmph
(deprecated)

Int32Value

Velocidade do veículo em quilômetros por hora. Obsoleto: use speed.
speed

DoubleValue

Velocidade do veículo em metros/segundo
speed_accuracy

DoubleValue

Precisão de speed em metros/segundo.
update_time

Timestamp

O horário em que location foi informado pelo sensor de acordo com o relógio.
server_time

Timestamp

Apenas saída. A hora em que o servidor recebeu as informações de localização.
location_sensor

DeliveryVehicleLocationSensor

Provedor de dados de local (por exemplo, GPS).
is_road_snapped

BoolValue

Define se location está alinhado a uma via.
is_gps_sensor_enabled

BoolValue

Apenas entrada. Indica se o sensor de GPS está ativado no dispositivo móvel.
time_since_update

Int32Value

Apenas entrada. Tempo (em segundos) desde o primeiro envio do local ao servidor. Esse número será zero na primeira atualização. Se a hora for desconhecida (por exemplo, quando o app for reiniciado), esse valor será redefinido como zero.
num_stale_updates
(deprecated)

Int32Value

Apenas entrada. Obsoleto: outros indicadores agora são usados para determinar se um local está desatualizado.
raw_location

LatLng

Local bruto do veículo (não processado pelo carrapato).
raw_location_time

Timestamp

Carimbo de data/hora associado ao local bruto.
raw_location_sensor

DeliveryVehicleLocationSensor

Origem da localização bruta. O valor padrão é GPS.
raw_location_accuracy

DoubleValue

Precisão de raw_location como raio, em metros.
supplemental_location

LatLng

Local complementar fornecido pelo app de integração.
supplemental_location_time

Timestamp

Carimbo de data/hora associado ao local complementar.
supplemental_location_sensor

DeliveryVehicleLocationSensor

Origem do local complementar. O valor padrão é CUSTOMER_SUPPLIED_LOCATION.
supplemental_location_accuracy

DoubleValue

Precisão de supplemental_location como raio, em metros.
road_snapped
(deprecated)

bool

Obsoleto: use is_road_snapped.

DeliveryVehicleLocationSensor

O sensor ou a metodologia usada para determinar o local.

Enums
UNKNOWN_SENSOR O sensor não foi especificado ou é desconhecido.
GPS GPS ou GPS assistido.
NETWORK GPS assistido, ID de torre de celular ou ponto de acesso Wi-Fi.
PASSIVE ID da torre de celular ou ponto de acesso Wi-Fi.
ROAD_SNAPPED_LOCATION_PROVIDER Um local determinado pelo dispositivo móvel como a posição mais provável para a estrada.
CUSTOMER_SUPPLIED_LOCATION Um local fornecido pelo cliente de uma fonte independente. Normalmente, esse valor é usado para um local fornecido de origens diferentes do dispositivo móvel que executa o SDK do Driver. Se a fonte original for descrita por um dos outros valores de tipo enumerado, use esse valor. Os locais marcados como CUSTOMER_AdapterPLIED_LOCATION normalmente são fornecidos por um last_location.supplemental_location_sensor do Veículo de entrega.
FLEET_ENGINE_LOCATION Uma localização calculada pelo Fleet Engine com base nos sinais disponíveis. Apenas saída. Esse valor será rejeitado se for recebido em uma solicitação.
FUSED_LOCATION_PROVIDER Provedor de localização combinada do Android.
CORE_LOCATION O provedor de localização nos sistemas operacionais Apple.

DeliveryVehicleNavigationStatus

Status de navegação do veículo.

Enums
UNKNOWN_NAVIGATION_STATUS Status de navegação não especificado.
NO_GUIDANCE A navegação do app do motorista está no modo FREE_NAV.
ENROUTE_TO_DESTINATION A navegação guiada está disponível, e a navegação no app do motorista entrou no modo GUIDED_NAV.
OFF_ROUTE O veículo saiu do trajeto sugerido.
ARRIVED_AT_DESTINATION O veículo está a aproximadamente 50 m do destino.

GetDeliveryVehicleRequest

A mensagem de solicitação GetDeliveryVehicle.

Campos
header

DeliveryRequestHeader

Opcional. O cabeçalho da solicitação da API Standard Delivery.
name

string

Obrigatório. Precisa estar no formato providers/{provider}/deliveryVehicles/{delivery_vehicle}. O provider precisa ser o ID do projeto do Google Cloud. Por exemplo, sample-cloud-project.

GetTaskRequest

A mensagem de solicitação GetTask.

Campos
header

DeliveryRequestHeader

Opcional. O cabeçalho da solicitação da API Standard Delivery.
name

string

Obrigatório. Precisa estar no formato providers/{provider}/tasks/{task}. O provider precisa ser o ID do projeto do Google Cloud. Por exemplo, sample-cloud-project.

GetTaskTrackingInfoRequest

A mensagem de solicitação GetTaskTrackingInfoRequest.

Campos
header

DeliveryRequestHeader

Opcional. O cabeçalho da solicitação da API Standard Delivery.
name

string

Obrigatório. Precisa estar no formato providers/{provider}/taskTrackingInfo/{tracking_id}. O provider precisa ser o ID do projeto do Google Cloud e o tracking_id precisa ser o ID de rastreamento associado à tarefa. Um exemplo de nome pode ser providers/sample-cloud-project/taskTrackingInfo/sample-tracking-id.

ListDeliveryVehiclesRequest

A mensagem de solicitação ListDeliveryVehicles.

Campos
header

DeliveryRequestHeader

Opcional. O cabeçalho da solicitação da API Standard Delivery.
parent

string

Obrigatório. Precisa estar no formato providers/{provider}. O provider precisa ser o ID do projeto do Google Cloud. Por exemplo, sample-cloud-project.
page_size

int32

Opcional. O número máximo de veículos a serem retornados. O serviço pode retornar menos que esse número. Se você não especificar esse número, o servidor determinará a quantidade de resultados a serem retornados.
page_token

string

Opcional. Um token de página recebido de uma chamada ListDeliveryVehicles anterior. Você precisa fornecê-lo para recuperar a página seguinte.

Ao paginar, todos os outros parâmetros fornecidos para ListDeliveryVehicles precisam corresponder à chamada que forneceu o token da página.
filter

string

Opcional. Uma consulta de filtro a ser aplicada ao listar veículos de entrega. Consulte exemplos da sintaxe de filtro em http://aip.dev/160 (em inglês). Se você não especificar um valor ou especificar uma string vazia para o filtro, todos os veículos de entrega serão retornados.

As únicas consultas aceitas para ListDeliveryVehicles são em atributos do veículo (por exemplo, attributes.<key> = <value> ou attributes.<key1> = <value1> AND attributes.<key2> = <value2>). Além disso, todos os atributos são armazenados como strings. Portanto, as únicas comparações aceitas em atributos são as de strings. Para comparar com valores numéricos ou booleanos, os valores precisam ser explicitamente citados para serem tratados como strings (por exemplo, attributes.<key> = "10" ou attributes.<key> = "true").

O número máximo de restrições permitido em uma consulta de filtro é 50. Uma restrição faz parte da consulta no formato attribute.<KEY> <COMPARATOR> <VALUE>. Por exemplo, attributes.foo = bar é uma restrição.
viewport

Viewport

Opcional. Um filtro que limita os veículos retornados àqueles cujo último local conhecido estava na área retangular definida pela janela de visualização.

ListDeliveryVehiclesResponse

A mensagem de resposta ListDeliveryVehicles.

Campos
delivery_vehicles[]

DeliveryVehicle

O conjunto de veículos de entrega que atendem aos critérios de filtragem solicitados. Quando nenhum filtro é especificado, a solicitação retorna todos os veículos de entrega. Uma resposta bem-sucedida também pode estar vazia. Uma resposta vazia indica que nenhum veículo de entrega foi encontrado atendendo aos critérios do filtro solicitado.
next_page_token

string

É possível transmitir esse token no ListDeliveryVehiclesRequest para continuar a listar os resultados. Quando todos os resultados forem retornados, o campo não estará na resposta ou será uma string vazia.
total_size

int64

O número total de veículos de entrega que correspondem aos critérios da solicitação em todas as páginas.

ListTasksRequest

A mensagem de solicitação ListTasks.

Campos
header

DeliveryRequestHeader

Opcional. O cabeçalho da solicitação da API Standard Delivery.
parent

string

Obrigatório. Precisa estar no formato providers/{provider}. O provider precisa ser o ID do projeto do Google Cloud. Por exemplo, sample-cloud-project.
page_size

int32

Opcional. O número máximo de tarefas a serem retornadas. O serviço pode retornar menos que esse valor. Se você não especificar esse valor, o servidor determinará o número de resultados a serem retornados.
page_token

string

Opcional. Um token de página recebido de uma chamada ListTasks anterior. Você pode fornecer isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListTasks precisam corresponder à chamada que forneceu o token da página.
filter

string

Opcional. Uma consulta de filtro para aplicar ao listar tarefas. Consulte exemplos de sintaxe de filtro em http://aip.dev/160 (em inglês). Se você não especificar um valor ou se filtrar uma string vazia, todas as tarefas serão retornadas. Para mais informações sobre as propriedades "Task" que podem ser filtradas, consulte Listar tarefas.

ListTasksResponse

A resposta ListTasks que contém o conjunto de tarefas que atendem aos critérios do filtro em ListTasksRequest.

Campos
tasks[]

Task

O conjunto de tarefas que atende aos critérios de filtragem solicitados. Quando nenhum filtro é especificado, a solicitação retorna todas as tarefas. Uma resposta bem-sucedida também pode estar vazia. Uma resposta vazia indica que não foram encontradas tarefas que atendam aos critérios do filtro solicitado.
next_page_token

string

Transmita esse token no ListTasksRequest para continuar a listar os resultados. Se todos os resultados tiverem sido retornados, esse campo será uma string vazia ou não aparecerá na resposta.
total_size

int64

O número total de tarefas que correspondem aos critérios de solicitação em todas as páginas.

LocationInfo

Um local com identificadores adicionais.

Campos
point

LatLng

Coordenadas do local.

SearchTasksRequest

Obsoleto: em vez de enviar GetTaskTrackingInfoRequests para GetTaskTrackingInfo,

Campos
header

DeliveryRequestHeader

Opcional. O cabeçalho da solicitação da API Standard Delivery.
parent

string

Obrigatório. Precisa estar no formato providers/{provider}. O provedor precisa ser o ID do projeto do Google Cloud. Por exemplo, sample-cloud-project.
tracking_id

string

Obrigatório. O identificador do conjunto de tarefas relacionadas que estão sendo solicitadas. Os IDs de acompanhamento 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 '#'.
page_size

int32

Opcional. O número máximo de tarefas a serem retornadas. O serviço pode retornar menos que esse valor. Se você não especificar esse valor, o servidor determinará o número de resultados a serem retornados.
page_token

string

Opcional. Um token de página recebido de uma chamada SearchTasks anterior. É necessário fornecer esse valor para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para SearchTasks precisam corresponder à chamada que forneceu o token da página.

SearchTasksResponse

A resposta SearchTasks. Ele contém o conjunto de tarefas que atendem aos critérios de pesquisa no SearchTasksRequest.

Campos
tasks[]

Task

O conjunto de tarefas para o tracking_id solicitado. Uma resposta bem-sucedida também pode estar vazia. Uma resposta vazia indica que nenhuma tarefa está associada ao tracking_id fornecido.
next_page_token

string

Transmita esse token no SearchTasksRequest para continuar a listar os resultados. Se todos os resultados tiverem sido retornados, esse campo será uma string vazia ou não aparecerá na resposta.

Tarefa

Uma tarefa na API Delivery representa uma única ação a ser monitorada. Em geral, há uma distinção entre tarefas relacionadas a remessa e tarefas de interrupção. Uma remessa pode ter várias tarefas associadas a ela. Por exemplo, pode haver uma Tarefa para a retirada e outra para a desembarque ou a baldeação. Além disso, diferentes Tarefas para uma determinada remessa podem ser processadas por veículos diferentes. Por exemplo, um veículo pode lidar com a retirada, conduzindo-a ao hub, enquanto outro conduz a mesma remessa do centro para o local de desembarque.

Observação: as APIs REST e gRPC usam convenções de nomenclatura de campo diferentes. Por exemplo, o campo Task.journey_sharing_info na API gRPC e o campo Task.journeySharingInfo na API REST se referem ao mesmo campo.

Campos
name

string

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

Type

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

State

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

TaskOutcome

O resultado da tarefa.
task_outcome_time

Timestamp

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

LocationInfo

O local em que o resultado do Task foi definido. Esse valor é atualizado como parte de UpdateTask. 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 raw).
task_outcome_location_source

TaskOutcomeLocationSource

Indica de onde veio o valor de task_outcome_location.
tracking_id

string

Imutável. Esse campo facilita o armazenamento de um ID para que você possa evitar o uso de um mapeamento complicado. Não é possível definir tracking_id para Tarefas dos tipos UNAVAILABLE e SCHEDULED_STOP. Esses IDs 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 '#'.
delivery_vehicle_id

string

Apenas saída. O ID do veículo que está executando esta Tarefa. Os IDs de 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 '#'.
planned_location

LocationInfo

Imutável. O local em que a Tarefa será concluída. Opcional para tarefas UNAVAILABLE, mas necessário para todas as outras tarefas.
task_duration

Duration

Obrigatório. Imutável. O tempo necessário para executar uma Task no local.
target_time_window

TimeWindow

A janela de tempo em que a tarefa deve ser concluída.
journey_sharing_info

JourneySharingInfo

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

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.
attributes[]

TaskAttribute

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

JourneySharingInfo

Jornada de compartilhamento de campos específicos.

Campos
remaining_vehicle_journey_segments[]

VehicleJourneySegment

Informações de rastreamento das paradas que o veículo atribuído vai fazer antes de concluir esta 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 rota do último local conhecido do driver até o próximo VehicleStop. As informações de trajeto atuais geralmente vêm do app do motorista, exceto em alguns casos indicados na documentação do 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 trajeto entre os VehicleStops restantes.
last_location

DeliveryVehicleLocation

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

bool

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

Estado

O estado de uma tarefa. Isso indica o progresso das tarefas.

Enums
STATE_UNSPECIFIED Padrão. Usado para um estado de tarefa não especificado ou não reconhecido.
OPEN A Tarefa ainda não foi atribuída a um veículo de entrega ou o veículo de entrega ainda não passou pela parada de veículo atribuída ao Task.
CLOSED Quando o veículo passa pela parada desta Tarefa.

TaskOutcome

O resultado da tentativa de executar uma tarefa. Quando TaskState está fechado, TaskOutcome indica se ela foi concluída.

Enums
TASK_OUTCOME_UNSPECIFIED O resultado da tarefa antes que seu valor seja definido.
SUCCEEDED A tarefa foi concluída.
FAILED Não foi possível concluir a tarefa ou ela foi cancelada.

TaskOutcomeLocationSource

A identidade da origem que preencheu o task_outcome_location.

Enums
TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED O resultado da tarefa antes que seja definido.
PROVIDER A task_outcome_location especificada pelo provedor.
LAST_VEHICLE_LOCATION Como o provedor não especificou o task_outcome_location, o Fleet Engine usou a última localização conhecida do veículo.

Tipo

O tipo de Task.

Enums
TYPE_UNSPECIFIED Padrão, o tipo de tarefa é desconhecido.
PICKUP Uma tarefa de retirada é a ação realizada para retirar uma remessa de um cliente. As retiradas de veículos em depósito ou alimentador devem usar o tipo SCHEDULED_STOP.
DELIVERY Uma tarefa de entrega é a ação realizada para entregar uma remessa a um cliente final. As entregas de veículos em depósitos ou alimentadores devem usar o tipo SCHEDULED_STOP.
SCHEDULED_STOP Uma Tarefa de parada programada é usada para fins de planejamento. Por exemplo, pode representar a retirada ou entrega de remessas de veículos ou depósitos alimentadores. Ele não deve ser usado para remessas que são retiradas ou entregues de um cliente final.
UNAVAILABLE Uma tarefa que significa que o Veículo não está disponível para manutenção. Por exemplo, isso pode acontecer quando o motorista faz uma pausa ou o veículo está sendo reabastecido.

TaskAttribute

Descreve um atributo de tarefa como um par de chave-valor. O tamanho da string "key:value" não pode exceder 256 caracteres.

Campos
key

string

A chave do atributo. As chaves não podem conter dois-pontos (:).
Campo de união task_attribute_value. O valor do atributo pode ser do tipo string, booleano ou duplo. Se nenhum for definido, o TaskAttribute string_value será armazenado como a string vazia "". task_attribute_value só pode ser uma das seguintes opções:
string_value

string

Valor do atributo com tipo string.
bool_value

bool

Valor do atributo tipo booleano.
number_value

double

Valor de atributo de dois tipos.

TaskTrackingInfo

A mensagem TaskTrackingInfo. A mensagem contém informações de rastreamento de tarefas que serão usadas para exibição. Se um ID de rastreamento estiver associado a várias tarefas, o Fleet Engine usará uma heurística para decidir qual TaskTrackingInfo selecionar.

Campos
name

string

Precisa estar no formato providers/{provider}/taskTrackingInfo/{tracking}, em que tracking representa o ID de acompanhamento.
tracking_id

string

Imutável. O ID de acompanhamento de uma tarefa. * 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 '#'.
vehicle_location

DeliveryVehicleLocation

Última localização do veículo.
route_polyline_points[]

LatLng

Uma lista de pontos que, quando conectados, formam uma polilinha do trajeto esperado do veículo até o local desta tarefa.
remaining_stop_count

Int32Value

Indica o número de paradas que o veículo resta até que a parada da tarefa seja alcançada, incluindo a parada da tarefa. Por exemplo, se a próxima parada do veículo for a parada de tarefa, o valor será 1.
remaining_driving_distance_meters

Int32Value

A distância total restante em metros até o VehicleStop de interesse.
estimated_arrival_time

Timestamp

O carimbo de data/hora que indica a hora estimada de chegada ao local da parada.
estimated_task_completion_time

Timestamp

O carimbo de data/hora que indica o tempo estimado de conclusão de uma tarefa.
state

State

O estado de execução atual da tarefa.
task_outcome

TaskOutcome

O resultado da tentativa de executar uma tarefa.
task_outcome_time

Timestamp

O carimbo de data/hora que indica quando o resultado da tarefa foi definido pelo provedor.
planned_location

LocationInfo

Imutável. O local em que a Tarefa será concluída.
target_time_window

TimeWindow

A janela de tempo em que a tarefa deve ser concluída.
attributes[]

TaskAttribute

Os atributos personalizados definidos na tarefa.

TaskTrackingViewConfig

A mensagem de configuração que define quando um elemento de dados de uma tarefa deve ficar visível para os usuários finais.

Campos
route_polyline_points_visibility

VisibilityOption

O campo que especifica quando os pontos de polilinha do trajeto podem ser visíveis. Se este campo não for especificado, será usada a configuração de visibilidade padrão para envolvidos no projeto para esses dados.
estimated_arrival_time_visibility

VisibilityOption

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

VisibilityOption

O campo que especifica quando o tempo estimado de 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 envolvidos no projeto para esses dados.
remaining_driving_distance_visibility

VisibilityOption

O campo que especifica quando a distância de carro restante pode ser visível. Se este campo não for especificado, será usada a configuração de visibilidade padrão para envolvidos no projeto para esses dados.
remaining_stop_count_visibility

VisibilityOption

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

VisibilityOption

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

VisibilityOption

A mensagem de opção que define quando um elemento de dados deve ficar visível para os usuários finais.

Campos
Campo de união visibility_option. A opção de visibilidade específica escolhida. visibility_option pode ser apenas de um dos tipos a seguir:
remaining_stop_count_threshold

int32

Esse elemento de dados será visível para os usuários finais se a contagem de paradas restante <= missing_stop_count_threshold.
duration_until_estimated_arrival_time_threshold

Duration

Esse elemento de dados ficará visível para os usuários finais se a HEC para a parada <= Duration_until_estimated_arrival_time_threshold.
remaining_driving_distance_meters_threshold

int32

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

bool

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

bool

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

TimeWindow

Um período.

Campos
start_time

Timestamp

Obrigatório. O horário de início da janela de tempo (inclusive).
end_time

Timestamp

Obrigatório. O horário de término da janela de tempo (inclusive).

UpdateDeliveryVehicleRequest

A mensagem de solicitação UpdateDeliveryVehicle.

Campos
header

DeliveryRequestHeader

Opcional. O cabeçalho da solicitação da API Standard Delivery.
delivery_vehicle

DeliveryVehicle

Obrigatório. Atualização da entidade DeliveryVehicle a ser aplicada. Observação: não é possível atualizar o nome do DeliveryVehicle.
update_mask

FieldMask

Obrigatório. Uma máscara de campo que indica quais campos DeliveryVehicle serão atualizados. Observe que update_mask precisa conter pelo menos um campo.

É uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: "remaining_vehicle_journey_segments".

UpdateTaskRequest

A mensagem de solicitação UpdateTask.

Campos
header

DeliveryRequestHeader

Opcional. O cabeçalho da solicitação da API Standard Delivery.
task

Task

Obrigatório. A tarefa associada à atualização. Os campos a seguir são mantidos pelo Fleet Engine. Não os atualize usando Task.update.

  • last_location.
  • last_location_snappable.
  • name.
  • remaining_vehicle_journey_segments.
  • task_outcome_location_source.

Observação: não é possível alterar o valor de task_outcome depois de defini-lo.

Se a Tarefa foi atribuída a um veículo de entrega, não defina o estado dela como FECHADO usando Task.update. Em vez disso, remova a VehicleStop que contém a tarefa do veículo de entrega, que define automaticamente o estado da tarefa como FECHADA.
update_mask

FieldMask

Obrigatório. A máscara de campo que indica quais campos do Task devem ser atualizados. Observação: o update_mask precisa conter pelo menos um campo.

É uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: "task_outcome,task_outcome_time,task_outcome_location".

VehicleJourneySegment

Representa o trecho de viagem de um Veículo, da parada anterior até a atual. Se for a primeira parada ativa, ela será feita do local atual do veículo até essa parada.

Campos
stop

VehicleStop

Especifica o local da parada, junto com os Tasks associados a ela. Alguns campos do VehicleStop podem não estar presentes se esse trecho da viagem fizer parte de JourneySharingInfo.
driving_distance_meters

Int32Value

Apenas saída. A distância de viagem da parada anterior até esta parada. Se a parada atual for a primeira parada na lista de trechos da viagem, o ponto de partida será o local do veículo registrado no momento em que essa parada foi adicionada à lista. Talvez este campo não esteja presente se o trecho da jornada fizer parte de JourneySharingInfo.
driving_duration

Duration

Apenas saída. O tempo de viagem da parada anterior até esta parada. Se a parada atual for a primeira parada na lista de trechos da viagem, o ponto de partida será o local do veículo registrado no momento em que essa parada foi adicionada à lista.

Se esse campo estiver definido no caminho Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) ou Task.remainingVehicleJourneySegments[0].drivingDuration (REST), ele poderá ser preenchido com o valor de DeliveryVehicle.remaining_duration (gRPC) ou DeliveryVehicle.remainingDuration (REST). Isso fornece a duração restante do percurso com base no local mais recente conhecido do app do motorista em vez do tempo de percurso da parada anterior.
path[]

LatLng

Apenas saída. Caminho da parada anterior até esta parada. Se a parada atual for a primeira parada na lista de trechos da viagem, esse será o caminho da localização atual do veículo até essa parada no momento em que ela foi adicionada à lista. Talvez este campo não esteja presente se o trecho da jornada fizer parte de JourneySharingInfo.

Se esse campo estiver definido no caminho Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) ou Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST), ele poderá ser preenchido com os LatLngs decodificados de DeliveryVehicle.current_route_segment (gRPC) ou DeliveryVehicle.currentRouteSegment (REST). Ela fornece o caminho de carro do local mais recente conhecido do app do motorista, em vez do caminho da parada anterior.

VehicleStop

Descreve um ponto em que um Veículo para para realizar uma ou mais Tasks.

Campos
planned_location

LocationInfo

Obrigatório. O local da parada. Os locais nos Tasks podem não corresponder exatamente a esse local, mas estarão a uma curta distância dele. Este campo não será preenchido na resposta de uma chamada GetTask ou SearchTasks.
tasks[]

TaskInfo

A lista de Tasks a serem realizadas nessa parada. Este campo não será preenchido na resposta de uma chamada GetTask ou SearchTasks.
state

State

O estado da VehicleStop. Este campo não será preenchido na resposta de uma chamada GetTask ou SearchTasks.

Estado

O estado atual de uma VehicleStop.

Enums
STATE_UNSPECIFIED Desconhecido.
NEW Criada, mas sem roteamento ativo.
ENROUTE Atribuído e fazendo roteamento ativo.
ARRIVED Chegou à parada. Pressupõe que, quando o Veículo está desviando para a próxima parada, que todas as paradas anteriores foram concluídas.

TaskInfo

Outras informações sobre a Tarefa realizada nessa parada.

Campos
task_id

string

O ID da tarefa. Este campo não será preenchido na resposta de uma chamada GetTask ou SearchTasks. Os IDs de tarefas 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 '#'.
task_duration

Duration

Apenas saída. O tempo necessário para executar a Tarefa.
target_time_window

TimeWindow

Apenas saída. A janela de tempo em que a tarefa deve ser concluída. Isso é definido apenas na resposta a GetDeliveryVehicle.