Package maps.fleetengine.delivery.v1

Índice

DeliveryService

O serviço de entrega de última milha.

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.
DeleteDeliveryVehicle

rpc DeleteDeliveryVehicle(DeleteDeliveryVehicleRequest) returns (Empty)

Exclui um veículo de entrega do Fleet Engine.

Retorna FAILED_PRECONDITION se o veículo de entrega tiver tarefas abertas atribuídas.
DeleteTask

rpc DeleteTask(DeleteTaskRequest) returns (Empty)

Exclui uma única tarefa.

Retorna FAILED_PRECONDITION se a tarefa estiver ABERTA e atribuída a um DeliveryVehicle.
GetDeliveryVehicle

rpc GetDeliveryVehicle(GetDeliveryVehicleRequest) returns (DeliveryVehicle)

Retorna a instância DeliveryVehicle especificada.
GetTask

rpc GetTask(GetTaskRequest) returns (Task)

Recebe informações sobre um Task.
GetTaskTrackingInfo

rpc GetTaskTrackingInfo(GetTaskTrackingInfoRequest) returns (TaskTrackingInfo)

Retorna a instância 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.
UpdateDeliveryVehicle

rpc UpdateDeliveryVehicle(UpdateDeliveryVehicleRequest) returns (DeliveryVehicle)

Grava dados atualizados de DeliveryVehicle no Fleet Engine e atribui Tasks ao DeliveryVehicle. Não é possível atualizar o nome do DeliveryVehicle. Você pode atualizar remaining_vehicle_journey_segments, mas ele precisa conter todos os VehicleJourneySegments para serem mantidos no DeliveryVehicle. Os task_ids são recuperados de remaining_vehicle_journey_segments, e os Tasks correspondentes são atribuídos ao DeliveryVehicle, se 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 de solicitação padrão da API Delivery. Observação: se você definir esse campo, o campo de cabeçalho nas mensagens CreateTaskRequest precisará estar vazio ou corresponder a esse 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 este 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 de solicitação padrão da API 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. O ID do veículo de entrega precisa ser exclusivo e estar 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 de normalização C do Unicode.
  • Não pode conter nenhum dos seguintes caracteres ASCII: '/', ':', '?', ',' ou '#'.
delivery_vehicle

DeliveryVehicle

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

  • tipo
  • last_location
  • Atributos

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

CreateTaskRequest

A mensagem de solicitação CreateTask.

Campos
header

DeliveryRequestHeader

Opcional. O cabeçalho de solicitação padrão da API 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 remessa, 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 de normalização C do 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 tarefas UNAVAILABLE)
  • task_duration

Os campos a seguir podem ser definidos opcionalmente:

  • target_time_window
  • task_tracking_view_config
  • attributes

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

DeleteDeliveryVehicleRequest

Mensagem de solicitação DeleteDeliveryVehicle.

Campos
header

DeliveryRequestHeader

Opcional. O cabeçalho de solicitação padrão da API 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.

DeleteTaskRequest

Mensagem de solicitação de DeleteTask.

Campos
header

DeliveryRequestHeader

Opcional. O cabeçalho de solicitação padrão da API 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.

DeliveryRequestHeader

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

Campos
language_code

string

O código de idioma BCP-47, como "pt-BR" ou "sr-Latn". Para mais informações, consulte http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Se nenhum for especificado, a resposta poderá ser em qualquer idioma, com preferência pelo inglês, se esse nome existir. Exemplo de valor de 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 da qual 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 da qual 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 que faz a chamada.
manufacturer

string

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

int32

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

string

ID opcional que pode ser fornecido para fins de registro, a fim de identificar a solicitação.

Plataforma

A plataforma do SDK que faz a chamada.

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

SdkType

Possíveis tipos de SDK.

Enums
SDK_TYPE_UNSPECIFIED O valor padrão. Esse valor é usado se sdk_type for omitido.
CONSUMER O SDK que faz a chamada é o Consumer.
DRIVER O SDK que faz a chamada é o driver.
JAVASCRIPT O SDK de chamada é JavaScript.

DeliveryVehicle

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

Observação: as APIs gRPC e REST 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 desse veículo de entrega. O formato é providers/{provider}/deliveryVehicles/{vehicle}.
last_location

DeliveryVehicleLocation

O último local informado do veículo de entrega.
past_locations[]

DeliveryVehicleLocation

Somente entrada. Locais em que o veículo de entrega esteve no passado e que ainda não foram informados ao Fleet Engine. Ele é usado em UpdateDeliveryVehicleRequest para registrar locais que antes não podiam ser enviados ao servidor. Isso geralmente acontece quando o veículo de entrega não tem conectividade de Internet.
navigation_status

DeliveryVehicleNavigationStatus

O status de navegação do veículo de entrega.
current_route_segment

bytes

A poligonal codificada que especifica a rota que a navegação recomenda para o próximo ponto de passagem. O app do motorista atualiza essa informação quando uma parada é alcançada ou ultrapassada e quando a navegação é redirecionada. 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 pode não ser usado para preencher Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) ou Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST):

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

  • O app do motorista não atualizou a localização recentemente. Por isso, o valor da última atualização desse campo pode estar desatualizado.

  • O app do motorista atualizou o local recentemente, 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 uma rota do ponto de parada do veículo mais recente até o próximo ponto de parada do veículo 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 o current_route_segment termina. No momento, esse campo não é preenchido pelo app do motorista, mas você pode fornecê-lo em chamadas UpdateDeliveryVehicle. É a LatLng da próxima parada do veículo ou a última LatLng do current_route_segment. O Fleet Engine vai fazer o possível para interpolar para um VehicleStop real.

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

Int32Value

A distância restante para o current_route_segment. O app Driver geralmente fornece 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 em UpdateDeliveryVehicleRequest se o campo current_route_segment estiver vazio.
remaining_duration

Duration

O tempo restante de percurso para o current_route_segment. O app Driver geralmente fornece 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 em UpdateDeliveryVehicleRequest se o campo current_route_segment estiver vazio.
remaining_vehicle_journey_segments[]

VehicleJourneySegment

Os segmentos de percurso atribuídos a este veículo de entrega, começando pelo local mais recente informado. Esse 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 atributo precisa ter uma chave exclusiva.
type

DeliveryVehicleType

O tipo do 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 é usado.
AUTO Um automóvel.
TWO_WHEELER Motocicleta, ciclomotor ou outro veículo de duas rodas
BICYCLE Transporte humano.
PEDESTRIAN Um transportador humano, geralmente caminhando ou correndo, viajando por caminhos de pedestres.

DeliveryVehicleAttribute

Descreve um atributo do veículo como um par de chave-valor. O comprimento da string "chave:valor" 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 double. delivery_vehicle_attribute_value pode ser apenas de um dos tipos a seguir:
string_value

string

Valor de atributo digitado em string.

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

bool

Valor de atributo do tipo booleano.
number_value

double

Valor do atributo com digitação dupla.

DeliveryVehicleLocation

A localização, 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, o local do veículo é um local de GPS. Quando você receber uma resposta, o local do veículo poderá ser um local do GPS, um local complementar ou algum outro local aproximado. A fonte é especificada em location_sensor.
horizontal_accuracy
(deprecated)

DoubleValue

Descontinuado: use latlng_accuracy.
latlng_accuracy

DoubleValue

Precisão de location em metros como raio.
heading

Int32Value

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

DoubleValue

Descontinuado: use heading_accuracy.
heading_accuracy

DoubleValue

Precisão de heading em graus.
altitude

DoubleValue

Altitude em metros acima do WGS84.
vertical_accuracy
(deprecated)

DoubleValue

Descontinuado: 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. Descontinuado: use speed.
speed

DoubleValue

Velocidade do veículo em metros por segundo
speed_accuracy

DoubleValue

Precisão de speed em metros/segundo.
update_time

Timestamp

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

Timestamp

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

DeliveryVehicleLocationSensor

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

BoolValue

Indica se location está fixado em uma via.
is_gps_sensor_enabled

BoolValue

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

Int32Value

Somente entrada. Tempo (em segundos) desde que o local foi enviado pela primeira vez ao servidor. Esse valor será zero para a primeira atualização. Se o horário for desconhecido (por exemplo, quando o app for reiniciado), esse valor será redefinido para zero.
num_stale_updates
(deprecated)

Int32Value

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

LatLng

Localização do veículo bruto (não processado pelo road-snapper).
raw_location_time

Timestamp

Carimbo de data/hora associado ao local bruto.
raw_location_sensor

DeliveryVehicleLocationSensor

Origem do local bruto. O valor padrão é GPS.
raw_location_accuracy

DoubleValue

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

LatLng

Localização complementar fornecida pelo app integrado.
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 um raio, em metros.
road_snapped
(deprecated)

bool

Descontinuado: use is_road_snapped.

DeliveryVehicleLocationSensor

O sensor ou a metodologia usada para determinar o local.

Enums
UNKNOWN_SENSOR O sensor é não especificado ou desconhecido.
GPS GPS ou GPS associado.
NETWORK GPS assistido, ID da 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 da via mais provável.
CUSTOMER_SUPPLIED_LOCATION Um local fornecido pelo cliente de uma fonte independente. Normalmente, esse valor é usado para um local fornecido de fontes diferentes do dispositivo móvel que executa o SDK do Driver. Se a origem original for descrita por um dos outros valores de tipo enumerado, use esse valor. Os locais marcados como CUSTOMER_SUPPLIED_LOCATION geralmente são fornecidos por um last_location.supplemental_location_sensor do DeliveryVehicle.
FLEET_ENGINE_LOCATION Um local calculado pelo Fleet Engine com base nos indicadores 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 local em sistemas operacionais da Apple.

DeliveryVehicleNavigationStatus

O 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 Driver está no modo FREE_NAV.
ENROUTE_TO_DESTINATION A navegação guiada está disponível, e a navegação do app Driver 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 de solicitação padrão da API 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 de solicitação padrão da API 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 de solicitação padrão da API 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 de solicitação padrão da API 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 valor. Se você não especificar esse número, o servidor vai determinar o número de resultados a serem retornados.
page_token

string

Opcional. Um token de página recebido de uma chamada ListDeliveryVehicles anterior. Você precisa fornecer isso 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 http://aip.dev/160 para conferir exemplos da sintaxe de filtro. Se você não especificar um valor ou uma string vazia para o filtro, todos os veículos de entrega serão retornados.

As únicas consultas compatíveis com ListDeliveryVehicles são em atributos de 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 compatíveis com atributos são comparações de string. Para comparar com valores numéricos ou booleanos, os valores precisam ser citados explicitamente para serem tratados como strings (por exemplo, attributes.<key> = "10" ou attributes.<key> = "true").

O número máximo de restrições permitidas em uma consulta de filtro é 50. Uma restrição faz parte da consulta do formulário 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 viewport.

ListDeliveryVehiclesResponse

A mensagem de resposta ListDeliveryVehicles.

Campos
delivery_vehicles[]

DeliveryVehicle

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 que atenda aos critérios de filtro solicitados.
next_page_token

string

É possível transmitir esse token no ListDeliveryVehiclesRequest para continuar a listar os resultados. Quando todos os resultados forem retornados, esse campo não vai 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 de solicitação em todas as páginas.

ListTasksRequest

A mensagem de solicitação ListTasks.

Campos
header

DeliveryRequestHeader

Opcional. O cabeçalho de solicitação padrão da API 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 vai 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 seguinte.

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 a ser aplicada ao listar tarefas. Consulte http://aip.dev/160 para conferir exemplos de sintaxe de filtro. Se você não especificar um valor ou filtrar uma string vazia, todas as tarefas serão retornadas. Para saber mais sobre as propriedades de tarefas que podem ser filtradas, consulte Listar tarefas.

ListTasksResponse

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

Campos
tasks[]

Task

Conjunto de tarefas que atendem 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 nenhuma tarefa foi encontrada que atenda aos critérios de filtro solicitados.
next_page_token

string

Transmita esse token no ListTasksRequest para continuar listando 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 outros identificadores.

Campos
point

LatLng

As coordenadas do local.

Tarefa

Uma tarefa na API Delivery representa uma única ação a ser rastreada. Em geral, há uma distinção entre as tarefas relacionadas ao envio e as tarefas de pausa. Um envio pode ter várias tarefas associadas. Por exemplo, pode haver uma tarefa para a coleta e outra para a entrega ou transferência. Além disso, diferentes tarefas de um determinado envio podem ser tratadas por veículos diferentes. Por exemplo, um veículo pode fazer a coleta, levando o envio para o centro de distribuição, enquanto outro leva o mesmo envio do centro de distribuição ao local de entrega.

Observação: as APIs gRPC e REST 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 um 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 de 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 bruto).
task_outcome_location_source

TaskOutcomeLocationSource

Indica de onde veio o valor do task_outcome_location.
tracking_id

string

Imutável. Esse campo facilita o armazenamento de um ID para que você evite usar um mapeamento complicado. Não é possível definir tracking_id 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 comprimento máximo de 64 caracteres.
  • Normalizado de acordo com o Formulário de normalização C do 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 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 de normalização C do 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 obrigatório para todas as outras tarefas.
task_duration

Duration

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

TimeWindow

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

JourneySharingInfo

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

TaskTrackingViewConfig

A configuração para o acompanhamento de tarefas que especifica quais elementos de dados são visíveis para os usuários finais e em quais circunstâncias.
attributes[]

TaskAttribute

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

JourneySharingInfo

Campos específicos de compartilhamento da jornada.

Campos
remaining_vehicle_journey_segments[]

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.
last_location

DeliveryVehicleLocation

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

bool

Indica se o lastLocation do veículo pode ser fixado no current_route_segment. Esse valor é falso se last_location ou current_route_segment não existir. Esse valor é calculado pelo Fleet Engine. As atualizações dos 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 a Task.
CLOSED Quando o veículo passa pela parada para esta tarefa.

TaskOutcome

O resultado da tentativa de executar uma tarefa. Quando TaskState é fechado, TaskOutcome indica se ele foi concluído.

Enums
TASK_OUTCOME_UNSPECIFIED O resultado da tarefa antes de o valor ser definido.
SUCCEEDED A tarefa foi concluída.
FAILED A tarefa não foi concluída ou foi cancelada.

TaskOutcomeLocationSource

A identidade da origem que preencheu o task_outcome_location.

Enums
TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED O resultado da tarefa antes de ser definido.
PROVIDER O provedor especificou o task_outcome_location.
LAST_VEHICLE_LOCATION O provedor não especificou o task_outcome_location. Portanto, o Fleet Engine usou a última localização conhecida do veículo.

Tipo

O tipo de tarefa.

Enums
TYPE_UNSPECIFIED Por 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 de depósito ou de veículos de alimentação precisam usar o tipo SCHEDULED_STOP.
DELIVERY Uma tarefa de entrega é a ação realizada para entregar um envio a um cliente final. As entregas de veículos de depósito ou de veículos alimentadores precisam usar o tipo SCHEDULED_STOP.
SCHEDULED_STOP Uma tarefa de parada programada é usada para fins de planejamento. Por exemplo, ele pode representar a coleta ou entrega de remessas de veículos de apoio ou depósitos. Ele não deve ser usado para envios que são retirados 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 quando o veículo está sendo reabastecido.

TaskAttribute

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

Campos
key

string

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

string

Valor de atributo digitado em string.
bool_value

bool

Valor de atributo do tipo booleano.
number_value

double

Valor do atributo com digitação dupla.

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 vai usar uma heurística para decidir qual TaskTrackingInfo da tarefa será selecionado.

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 rastreamento de uma tarefa. * Precisa ser uma string Unicode válida. * Limitado a um comprimento máximo de 64 caracteres. * Normalizado de acordo com o Formulário de normalização C do Unicode. * Não pode conter nenhum dos seguintes caracteres ASCII: '/', ':', '?', ',' ou '#'.
vehicle_location

DeliveryVehicleLocation

O último local 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 da tarefa.
remaining_stop_count

Int32Value

Indica o número de paradas restantes do veículo até a parada da tarefa, incluindo a parada da tarefa. Por exemplo, se a próxima parada do veículo for a parada da 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 o horário de chegada estimado 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

Janela de tempo em que a tarefa precisa 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

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.
estimated_arrival_time_visibility

VisibilityOption

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

VisibilityOption

Campo que especifica quando o tempo estimado para a conclusão da tarefa 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.
remaining_driving_distance_visibility

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.
remaining_stop_count_visibility

VisibilityOption

Campo que especifica quando a contagem de paradas restantes pode ser 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.
vehicle_location_visibility

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.

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 fica visível para os usuários finais se a contagem de paradas restante for <= remaining_stop_count_threshold.
duration_until_estimated_arrival_time_threshold

Duration

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

int32

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

bool

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

bool

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.

TimeWindow

Um período.

Campos
start_time

Timestamp

Obrigatório. Horário de início do período.
end_time

Timestamp

Obrigatório. O horário de término do período (inclusive).

UpdateDeliveryVehicleRequest

A mensagem de solicitação UpdateDeliveryVehicle.

Campos
header

DeliveryRequestHeader

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

DeliveryVehicle

Obrigatório. A 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. A máscara de atualização 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 de solicitação padrão da API Delivery.
task

Task

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

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

Observação: não é possível mudar o valor de task_outcome depois de definir.

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

FieldMask

Obrigatório. A máscara de campo que indica quais campos da tarefa serão 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 segmento de viagem de um veículo, da parada anterior até a atual. Se for a primeira parada ativa, será do local atual do veículo até ela.

Campos
stop

VehicleStop

Especifica o local da parada e as Tasks associadas a ela. Alguns campos da VehicleStop podem não estar presentes se esse segmento de viagem fizer parte de JourneySharingInfo.
driving_distance_meters

Int32Value

Apenas saída. A distância percorrida da parada anterior até essa parada. Se a parada atual for a primeira na lista de segmentos da viagem, o ponto de partida será a localização do veículo registrada no momento em que essa parada foi adicionada à lista. Este campo pode não estar presente se o segmento da jornada fizer parte de JourneySharingInfo.
driving_duration

Duration

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

Se esse campo for 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 mostra a duração restante da viagem a partir do local conhecido mais recente do app de motorista, em vez do tempo de viagem da parada anterior.
path[]

LatLng

Apenas saída. O caminho da parada anterior até essa parada. Se a parada atual for a primeira na lista de segmentos da jornada, esse será o caminho do local atual do veículo até essa parada no momento em que ela foi adicionada à lista. Este campo pode não estar presente se o segmento da jornada fizer parte de JourneySharingInfo.

Se esse campo for 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). Isso fornece o trajeto de carro do local mais recente conhecido do app do motorista, em vez do trajeto 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. Esse campo não será preenchido na resposta de uma chamada GetTask.
tasks[]

TaskInfo

A lista de Tasks a serem executadas nessa parada. Esse campo não será preenchido na resposta de uma chamada GetTask.
state

State

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

Estado

O estado atual de uma VehicleStop.

Enums
STATE_UNSPECIFIED Desconhecido.
NEW Criado, mas não roteando ativamente.
ENROUTE Atribuído e roteamento ativo.
ARRIVED Chegou ao ponto. Assume que, quando o veículo está roteando para a próxima parada, 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. Esse campo não será preenchido na resposta de uma chamada GetTask. 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 de normalização C do Unicode.
  • Não pode conter nenhum dos seguintes caracteres ASCII: '/', ':', '?', ',' ou '#'.
task_duration

Duration

Apenas saída. O tempo necessário para realizar a tarefa.
target_time_window

TimeWindow

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