Índice
DeliveryService
(interface)BatchCreateTasksRequest
(mensagem)BatchCreateTasksResponse
(mensagem)CreateDeliveryVehicleRequest
(mensagem)CreateTaskRequest
(mensagem)DeliveryRequestHeader
(mensagem)DeliveryRequestHeader.Platform
(enum)DeliveryRequestHeader.SdkType
(enum)DeliveryVehicle
(mensagem)DeliveryVehicle.DeliveryVehicleType
(enum)DeliveryVehicleAttribute
(mensagem)DeliveryVehicleLocation
(mensagem)DeliveryVehicleLocationSensor
(enum)DeliveryVehicleNavigationStatus
(enum)GetDeliveryVehicleRequest
(mensagem)GetTaskRequest
(mensagem)GetTaskTrackingInfoRequest
(mensagem)ListDeliveryVehiclesRequest
(mensagem)ListDeliveryVehiclesResponse
(mensagem)ListTasksRequest
(mensagem)ListTasksResponse
(mensagem)LocationInfo
(mensagem)Task
(mensagem)Task.JourneySharingInfo
(mensagem)Task.State
(enum)Task.TaskOutcome
(enum)Task.TaskOutcomeLocationSource
(enum)Task.Type
(enum)TaskAttribute
(mensagem)TaskTrackingInfo
(mensagem)TaskTrackingViewConfig
(mensagem)TaskTrackingViewConfig.VisibilityOption
(mensagem)TimeWindow
(mensagem)UpdateDeliveryVehicleRequest
(mensagem)UpdateTaskRequest
(mensagem)VehicleJourneySegment
(mensagem)VehicleStop
(mensagem)VehicleStop.State
(enum)VehicleStop.TaskInfo
(mensagem)
DeliveryService
O serviço de entrega de última milha.
BatchCreateTasks |
---|
Cria e retorna um lote de novos objetos |
CreateDeliveryVehicle |
---|
Cria e retorna um novo |
CreateTask |
---|
Cria e retorna um novo objeto |
GetDeliveryVehicle |
---|
Retorna a instância |
GetTask |
---|
Recebe informações sobre um |
GetTaskTrackingInfo |
---|
Retorna a instância |
ListDeliveryVehicles |
---|
Recebe todos os |
ListTasks |
---|
Recebe todos os |
UpdateDeliveryVehicle |
---|
Grava dados atualizados de |
UpdateTask |
---|
Atualiza os dados de |
BatchCreateTasksRequest
A mensagem de solicitação BatchCreateTask
.
Campos | |
---|---|
header |
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 |
parent |
Obrigatório. O recurso pai compartilhado por todas as tarefas. Esse valor precisa estar no formato |
requests[] |
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[] |
As tarefas criadas. |
CreateDeliveryVehicleRequest
A mensagem de solicitação CreateDeliveryVehicle
.
Campos | |
---|---|
header |
Opcional. O cabeçalho de solicitação padrão da API Delivery. |
parent |
Obrigatório. Precisa estar no formato |
delivery_ |
Obrigatório. O ID do veículo de entrega precisa ser exclusivo e estar sujeito às seguintes restrições:
|
delivery_ |
Obrigatório. A entidade
Observação: o campo |
CreateTaskRequest
A mensagem de solicitação CreateTask
.
Campos | |
---|---|
header |
Opcional. O cabeçalho de solicitação padrão da API Delivery. |
parent |
Obrigatório. Precisa estar no formato |
task_ |
Obrigatório. O ID da tarefa precisa ser exclusivo, mas não pode ser um ID de rastreamento de frete. Para armazenar um ID de rastreamento de frete, use o campo
|
task |
Obrigatório. A entidade Task a ser criada. Ao criar uma tarefa, os seguintes campos são obrigatórios:
Observação: o campo |
DeliveryRequestHeader
Um RequestHeader contém campos comuns a todas as solicitações de RPC de entrega.
Campos | |
---|---|
language_ |
O código de idioma BCP-47, como "pt-BR" ou "en-US". 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 do campo: |
region_ |
Obrigatório. Código regional CLDR da região de origem da solicitação. Exemplo de valor do campo: |
sdk_ |
Versão do SDK de chamada, se aplicável. O formato da versão é "major.minor.patch", por exemplo: |
os_ |
Versão do sistema operacional em que o SDK de chamada está sendo executado. Exemplos de valor de campo: |
device_ |
Modelo do dispositivo em que o SDK de chamada está sendo executado. Exemplos de valor de campo: |
sdk_ |
O tipo de SDK que envia a solicitação. |
maps_ |
Versão do MapSDK da qual o SDK de chamada depende, se aplicável. O formato da versão é "major.minor.patch", por exemplo: |
nav_ |
Versão do NavSDK da qual o SDK de chamada depende, se aplicável. O formato da versão é "major.minor.patch", exemplo: |
platform |
Plataforma do SDK que faz a chamada. |
manufacturer |
Fabricante do dispositivo Android do SDK de chamada, aplicável apenas para SDKs do Android. Exemplo de valor do campo: |
android_ |
Nível da API do Android do SDK de chamada, aplicável apenas a SDKs do Android. Exemplo de valor do campo: |
trace_ |
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 vem 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 será usado se sdk_type for omitido. |
CONSUMER |
O SDK de chamada é o consumidor. |
DRIVER |
O SDK de 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 as remessas 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 |
O nome exclusivo desse veículo de entrega. O formato é |
last_ |
O último local relatado do veículo de entrega. |
navigation_ |
O status de navegação do veículo de entrega. |
current_ |
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 Há alguns casos em que esse campo pode não ser usado para preencher
Nesses casos, o Fleet Engine preenche esse campo com um trajeto desde o VehicleStop enviado 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_ |
O local em que o Esse campo é ignorado em chamadas |
remaining_ |
A distância de carro restante do percurso O Fleet Engine vai ignorar esse campo em |
remaining_ |
O tempo restante de viagem para o O Fleet Engine vai ignorar esse campo em |
remaining_ |
Os segmentos de viagem atribuídos a esse veículo de entrega, começando pelo local mais recente informado. Esse campo não será preenchido na resposta de |
attributes[] |
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 |
O tipo do veículo de entrega. Se não for definido, o padrão será |
DeliveryVehicleType
O tipo de veículo de entrega.
Enums | |
---|---|
DELIVERY_VEHICLE_TYPE_UNSPECIFIED |
O valor não é usado. |
AUTO |
Um automóvel. |
TWO_WHEELER |
Uma moto, ciclomoto ou outro veículo de duas rodas |
BICYCLE |
Transporte humano. |
PEDESTRIAN |
Um transportador humano, geralmente caminhando ou correndo, viajando por vias 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 |
A chave do atributo. |
value |
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_ |
Valor de atributo digitado em string. Observação: esse campo é idêntico ao |
bool_ |
Valor de atributo do tipo booleano. |
number_ |
Valor de atributo com dois tipos. |
DeliveryVehicleLocation
O local, a velocidade e a direção de um veículo em um momento específico.
Campos | |
---|---|
location |
O local do veículo. Quando enviado ao Fleet Engine, o local do veículo é um local de GPS. Quando você receber a resposta, o local do veículo poderá ser um local do GPS, um local complementar ou algum outro local aproximado. A fonte é especificada em |
horizontal_accuracy |
Descontinuado: use |
latlng_ |
Precisão de |
heading |
Direção em que o veículo está se movendo em graus. 0 representa o norte. O intervalo válido é [0, 360]. |
bearing_accuracy |
Descontinuado: use |
heading_ |
Precisão de |
altitude |
Altitude em metros acima do WGS84. |
vertical_accuracy |
Descontinuado: use |
altitude_ |
Precisão de |
speed_kmph |
Velocidade do veículo em quilômetros por hora. Descontinuado: use |
speed |
Velocidade do veículo em metros por segundo |
speed_ |
Precisão de |
update_ |
O horário em que o |
server_ |
Apenas saída. A hora em que o servidor recebeu as informações de local. |
location_ |
Provedor de dados de local (por exemplo, |
is_ |
Indica se |
is_ |
Somente entrada. Indica se o sensor de GPS está ativado no dispositivo móvel. |
time_ |
Somente entrada. Tempo (em segundos) desde que esse 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 |
Somente entrada. Obsoleto: outros indicadores agora são usados para determinar se um local está desatualizado. |
raw_ |
Local do veículo bruto (não processado pelo road-snapper). |
raw_ |
Carimbo de data/hora associado ao local bruto. |
raw_ |
Origem do local bruto. O valor padrão é |
raw_ |
Precisão de |
supplemental_ |
Localização complementar fornecida pelo app de integração. |
supplemental_ |
Carimbo de data/hora associado ao local complementar. |
supplemental_ |
Origem do local complementar. O valor padrão é |
supplemental_ |
Precisão de |
road_snapped |
Descontinuado: use |
DeliveryVehicleLocationSensor
O sensor ou a metodologia usados para determinar o local.
Enums | |
---|---|
UNKNOWN_SENSOR |
O sensor é não especificado ou desconhecido. |
GPS |
GPS ou GPS assistido. |
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 fonte original for descrita por um dos outros valores de tipo enumerado, use esse valor. Os locais marcados como CUSTOMER_SuppPLIED_LOCATION geralmente são fornecidos pelo last_location.supplemental_location_sensor de um Veículo de entrega. |
FLEET_ENGINE_LOCATION |
Um local calculado 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 |
O provedor de localização combinada do Android. |
CORE_LOCATION |
O provedor de local em sistemas operacionais da Apple. |
GetDeliveryVehicleRequest
A mensagem de solicitação GetDeliveryVehicle
.
Campos | |
---|---|
header |
Opcional. O cabeçalho de solicitação padrão da API Delivery. |
name |
Obrigatório. Precisa estar no formato |
GetTaskRequest
A mensagem de solicitação GetTask
.
Campos | |
---|---|
header |
Opcional. O cabeçalho de solicitação padrão da API Delivery. |
name |
Obrigatório. Precisa estar no formato |
GetTaskTrackingInfoRequest
A mensagem de solicitação GetTaskTrackingInfoRequest
.
Campos | |
---|---|
header |
Opcional. O cabeçalho de solicitação padrão da API Delivery. |
name |
Obrigatório. Precisa estar no formato |
ListDeliveryVehiclesRequest
A mensagem de solicitação ListDeliveryVehicles
.
Campos | |
---|---|
header |
Opcional. O cabeçalho de solicitação padrão da API Delivery. |
parent |
Obrigatório. Precisa estar no formato |
page_ |
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_ |
Opcional. Um token de página recebido de uma chamada Ao paginar, todos os outros parâmetros fornecidos para |
filter |
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 O número máximo de restrições permitido em uma consulta de filtro é 50. Uma restrição faz parte da consulta do formulário |
viewport |
Opcional. Um filtro que limita os veículos retornados àqueles cujo último local conhecido estava na área retangular definida pelo viewport. |
ListDeliveryVehiclesResponse
A mensagem de resposta ListDeliveryVehicles
.
Campos | |
---|---|
delivery_ |
O conjunto de veículos de entrega que atende 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_ |
É possível transmitir esse token no |
total_ |
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 |
Opcional. O cabeçalho de solicitação padrão da API Delivery. |
parent |
Obrigatório. Precisa estar no formato |
page_ |
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_ |
Opcional. Um token de página recebido de uma chamada Ao paginar, todos os outros parâmetros fornecidos para |
filter |
Opcional. Uma consulta de filtro para aplicar 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[] |
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_ |
Transmita esse token no |
total_ |
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 |
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 a ele. Por exemplo, pode haver uma tarefa para o embarque e outra para a entrega ou baldeação. 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 |
Precisa estar no formato |
type |
Obrigatório. Imutável. Define o tipo da tarefa. Por exemplo, uma pausa ou um envio. |
state |
Obrigatório. O estado de execução atual da tarefa. |
task_ |
O resultado da Tarefa. |
task_ |
O carimbo de data/hora que indica quando o resultado do |
task_ |
O local em que o resultado do |
task_ |
Indica a origem do valor de |
tracking_ |
Imutável. Esse campo facilita o armazenamento de um ID para que você evite usar um mapeamento complicado. Não é possível definir
|
delivery_ |
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:
|
planned_ |
Imutável. O local em que a tarefa será concluída. Opcional para tarefas |
task_ |
Obrigatório. Imutável. O tempo necessário para executar uma tarefa nesse local. |
target_ |
Janela de tempo em que a tarefa precisa ser concluída. |
journey_ |
Apenas saída. Campos específicos para compartilhamento de jornadas. Não é preenchido quando o estado é |
task_ |
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[] |
Uma lista de atributos de tarefas personalizados. Cada atributo precisa ter uma chave exclusiva. |
JourneySharingInfo
Campos específicos do compartilhamento da jornada.
Campos | |
---|---|
remaining_ |
Informações de rastreamento das paradas que o veículo atribuído fará antes de concluir esta Tarefa. Essa lista pode conter paradas de outras tarefas. O primeiro segmento, |
last_ |
Indica o último local informado do veículo atribuído. |
last_ |
Indica se o lastLocation do veículo pode ser vinculado ao |
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 do depósito ou alimentador precisam 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 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 remessas que são retiradas ou devolvidas por 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 |
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 string, booleano ou duplo. Se nenhum deles for definido, o string_value do TaskAttribute será armazenado como a string vazia "". task_attribute_value só pode ser um dos seguintes: |
|
string_ |
Valor de atributo digitado em string. |
bool_ |
Valor de atributo do tipo booleano. |
number_ |
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 |
Precisa estar no formato |
tracking_ |
Imutável. O ID de acompanhamento 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_ |
O último local do veículo. |
route_ |
Uma lista de pontos que, quando conectados, formam uma polilinha do trajeto esperado do veículo até o local da tarefa. |
remaining_ |
Indica o número de paradas que o veículo resta até a parada da tarefa ser alcançada, 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_ |
A distância total restante em metros até o |
estimated_ |
O carimbo de data/hora que indica o horário estimado de chegada até o local da parada. |
estimated_ |
O carimbo de data/hora que indica o tempo de conclusão estimado de uma tarefa. |
state |
O estado de execução atual da tarefa. |
task_ |
O resultado da tentativa de executar uma tarefa. |
task_ |
O carimbo de data/hora que indica quando o resultado da tarefa foi definido pelo provedor. |
planned_ |
Imutável. O local em que a tarefa será concluída. |
target_ |
A janela de tempo em que a tarefa deve ser concluída. |
attributes[] |
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_ |
O 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_ |
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_ |
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_ |
Campo que especifica quando a distância restante da viagem pode ser mostrada. Se este campo não for especificado, será usada a configuração de visibilidade padrão para esses dados no nível do projeto. |
remaining_ |
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_ |
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_ |
Esse elemento de dados fica visível para os usuários finais se a contagem de paradas restante for <= remaining_stop_count_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_ |
Esse elemento de dados vai ficar visível para os usuários finais se a distância de carro restante em metros <= legacy_driving_distance_meters_threshold. |
always |
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 |
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_ |
Obrigatório. Horário de início do período. |
end_ |
Obrigatório. O horário de término da janela (inclusive). |
UpdateDeliveryVehicleRequest
A mensagem de solicitação UpdateDeliveryVehicle
.
Campos | |
---|---|
header |
Opcional. O cabeçalho de solicitação padrão da API Delivery. |
delivery_ |
Obrigatório. A atualização da entidade |
update_ |
Obrigatório. Uma máscara de campo que indica quais campos É uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: |
UpdateTaskRequest
A mensagem de solicitação UpdateTask
.
Campos | |
---|---|
header |
Opcional. O cabeçalho de solicitação padrão da API Delivery. |
task |
Obrigatório. A tarefa associada à atualização. Os campos a seguir são mantidos pelo Fleet Engine. Não atualize usando
Observação: não é possível mudar o valor de Se a tarefa foi atribuída a um veículo de entrega, não defina o estado dela como "CONCLUÍDA" usando |
update_ |
Obrigatório. A máscara de campo que indica quais campos da tarefa serão atualizados. Observação: o É uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: |
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 |
Especifica o local da parada e as |
driving_ |
Apenas saída. A distância percorrida da parada anterior até essa parada. Se a parada atual for a primeira da lista de segmentos da viagem, o ponto de partida será o local do veículo registrado no momento em que essa parada foi adicionada à lista. Este campo pode não estar presente se o segmento da jornada fizer parte de |
driving_ |
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 |
path[] |
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 Se esse campo for definido no caminho |
VehicleStop
Descreve um ponto em que um veículo para para realizar uma ou mais Task
s.
Campos | |
---|---|
planned_ |
Obrigatório. O local da parada. Os locais nos |
tasks[] |
Lista de |
state |
O estado da |
Estado
O estado atual de um VehicleStop
.
Enums | |
---|---|
STATE_UNSPECIFIED |
Desconhecido. |
NEW |
Criado, mas não roteando ativamente. |
ENROUTE |
Atribuído e roteamento ativo. |
ARRIVED |
Chegou na parada. 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_ |
O ID da tarefa. Esse campo não será preenchido na resposta de uma chamada
|
task_ |
Apenas saída. O tempo necessário para realizar a tarefa. |
target_ |
Apenas saída. A janela de tempo em que a tarefa deve ser concluída. Isso é definido apenas na resposta a |