Fleet Tracking - Last Mile Fleet

Classe FleetEngineDeliveryVehicleLocationProvider

google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProvider classe
estende PollingLocationProvider
biblioteca "journeySharing"

Provedor de localização de veículos de entrega.

const {FleetEngineDeliveryVehicleLocationProvider} = await google.maps.importLibrary("journeySharing");
FleetEngineDeliveryVehicleLocationProvider
FleetEngineDeliveryVehicleLocationProvider(options)
Parâmetros:
Cria um novo provedor de localização para um veículo de entrega do Fleet Engine.
deliveryVehicleId
Tipo: string
ID do veículo que esse provedor de localização observa. Defina esse campo para rastrear um veículo.
shouldShowOutcomeLocations
Tipo: boolean optional
Opcionalmente, permita que os usuários mostrem o local do resultado da tarefa.
shouldShowTasks
Tipo: boolean optional
Se quiser, permita que os usuários mostrem as tarefas buscadas.
staleLocationThresholdMillis
Tipo: number
Este campo é somente leitura. Limite para localização desatualizada do veículo. Se o último local atualizado do veículo for mais antigo que esse limite, o veículo não será exibido.
taskFilterOptions
Retorna as opções de filtro a serem aplicadas ao buscar tarefas.
Herdado: isPolling, pollingIntervalMillis
Herdado: addListener
error
function(event)
Argumentos:
Evento que é acionado quando o provedor de localização encontra um erro.
update
function(event)
Evento acionado quando uma solicitação de atualização de dados do Fleet Engine é concluída.
Herdado: ispollingchange

Interface FleetEngineDeliveryVehicleLocationProviderOptions

Interface google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProviderOptions

Opções para o provedor de localização do veículo de entrega.

authTokenFetcher
Fornece JSON Web Tokens para autenticar o cliente no Fleet Engine.
projectId
Tipo: string
O ID do projeto do consumidor no console do Google Cloud.
activePolylineCustomization
opcional
Personalização aplicada à polilinha ativa. Uma polilinha ativa corresponde a uma parte do trajeto que o veículo está percorrendo no momento.

Use esse campo para especificar o estilo personalizado (como a cor da polilinha) e a interatividade (como o processamento de cliques).
  • Se um objeto PolylineOptions for especificado, as mudanças indicadas nele serão aplicadas à polilinha depois que ela for criada, substituindo as opções padrão, se houver.
  • Se uma função for especificada, ela será invocada uma vez quando a polilinha for criada. Nessa invocação, o parâmetro isNew no objeto de parâmetros da função é definido como true. Além disso, essa função é invocada quando as coordenadas da polilinha mudam ou quando o provedor de localização recebe dados do Fleet Engine, independentemente de os dados correspondentes a essa polilinha terem mudado.

    Consulte DeliveryVehiclePolylineCustomizationFunctionParams para ver uma lista de parâmetros fornecidos e os usos deles.
deliveryVehicleId
opcional
Tipo: string optional
O ID do veículo de entrega a ser rastreado imediatamente após a instanciação do provedor de localização. Se não for especificado, o provedor de localização não vai começar a rastrear nenhum veículo. Use FleetEngineDeliveryVehicleLocationProvider.deliveryVehicleId para definir o ID e iniciar o rastreamento.
deliveryVehicleMarkerCustomization
opcional
Personalização aplicada ao marcador do veículo de entrega.

Use esse campo para especificar o estilo personalizado (como o ícone do marcador) e a interatividade (como o processamento de cliques).
  • Se um objeto MarkerOptions for especificado, as mudanças especificadas nele serão aplicadas ao marcador após a criação, substituindo as opções padrão, se houver.
  • Se uma função for especificada, ela será invocada uma vez quando o marcador for criado, antes de ser adicionado à visualização do mapa. Nessa invocação, o parâmetro isNew no objeto de parâmetros da função é definido como true. Além disso, essa função é invocada quando o provedor de localização recebe dados do Fleet Engine, independentemente de os dados correspondentes a esse marcador terem mudado ou não.

    Consulte DeliveryVehicleMarkerCustomizationFunctionParams para ver uma lista de parâmetros fornecidos e os usos deles.
plannedStopMarkerCustomization
opcional
Personalização aplicada a um marcador de parada planejada.

Use esse campo para especificar o estilo personalizado (como o ícone do marcador) e a interatividade (como o processamento de cliques).
  • Se um objeto MarkerOptions for especificado, as mudanças especificadas nele serão aplicadas ao marcador após a criação, substituindo as opções padrão, se houver.
  • Se uma função for especificada, ela será invocada uma vez quando o marcador for criado, antes de ser adicionado à visualização do mapa. Nessa invocação, o parâmetro isNew no objeto de parâmetros da função é definido como true. Além disso, essa função é invocada quando o provedor de localização recebe dados do Fleet Engine, independentemente de os dados correspondentes a esse marcador terem mudado ou não.

    Consulte PlannedStopMarkerCustomizationFunctionParams para ver uma lista de parâmetros fornecidos e os usos deles.
pollingIntervalMillis
opcional
Tipo: number optional
Tempo mínimo entre as atualizações do local em milissegundos. Se levar mais de pollingIntervalMillis para buscar uma atualização de local, a próxima não será iniciada até que a atual seja concluída.

Definir esse valor como 0 desativa as atualizações de local recorrentes. Uma nova atualização do local é buscada se algum dos parâmetros observados pelo provedor de localização mudar.

O intervalo de sondagem padrão é de 5.000 milissegundos, que é o intervalo mínimo. Se você definir o intervalo de sondagem como um valor diferente de zero menor, 5000 será usado.
remainingPolylineCustomization
opcional
Personalização aplicada à polilinha restante. Uma polilinha restante corresponde a uma parte do trajeto que o veículo ainda não começou a percorrer.

Use esse campo para especificar o estilo personalizado (como a cor da polilinha) e a interatividade (como o processamento de cliques).
  • Se um objeto PolylineOptions for especificado, as mudanças indicadas nele serão aplicadas à polilinha depois que ela for criada, substituindo as opções padrão, se houver.
  • Se uma função for especificada, ela será invocada uma vez quando a polilinha for criada. Nessa invocação, o parâmetro isNew no objeto de parâmetros da função é definido como true. Além disso, essa função é invocada quando as coordenadas da polilinha mudam ou quando o provedor de localização recebe dados do Fleet Engine, independentemente de os dados correspondentes a essa polilinha terem mudado.

    Consulte DeliveryVehiclePolylineCustomizationFunctionParams para ver uma lista de parâmetros fornecidos e os usos deles.
shouldShowOutcomeLocations
opcional
Tipo: boolean optional
Booleano para mostrar ou ocultar os locais de resultado das tarefas buscadas.
shouldShowTasks
opcional
Tipo: boolean optional
Booleano para mostrar ou ocultar tarefas. Se definido como falso, o endpoint ListTasks não será chamado para buscar as tarefas. Somente as próximas paradas do veículo serão exibidas.
staleLocationThresholdMillis
opcional
Tipo: number optional
Limite para localização desatualizada do veículo. Se o último local atualizado do veículo for mais antigo que esse limite, o veículo não será exibido. O padrão é 24 horas em milissegundos. Se o limite for menor que 0 ou Infinity, ele será ignorado, e a localização do veículo não será considerada desatualizada.
takenPolylineCustomization
opcional
Personalização aplicada à polilinha percorrida. Uma polilinha percorrida corresponde a uma parte do trajeto que o veículo já percorreu.

Use esse campo para especificar o estilo personalizado (como a cor da polilinha) e a interatividade (como o processamento de cliques).
  • Se um objeto PolylineOptions for especificado, as mudanças indicadas nele serão aplicadas à polilinha depois que ela for criada, substituindo as opções padrão, se houver.
  • Se uma função for especificada, ela será invocada uma vez quando a polilinha for criada. Nessa invocação, o parâmetro isNew no objeto de parâmetros da função é definido como true. Além disso, essa função é invocada quando as coordenadas da polilinha mudam ou quando o provedor de localização recebe dados do Fleet Engine, independentemente de os dados correspondentes a essa polilinha terem mudado.

    Consulte DeliveryVehiclePolylineCustomizationFunctionParams para ver uma lista de parâmetros fornecidos e os usos deles.
taskFilterOptions
opcional
Opções de filtro para aplicar ao buscar tarefas. As opções podem incluir veículo, horário e status da tarefa específicos.
taskMarkerCustomization
opcional
Tipo: (function(TaskMarkerCustomizationFunctionParams): void)|MarkerOptions optional
Personalização aplicada a um marcador de tarefa. Um marcador de tarefa é renderizado no local planejado de cada tarefa atribuída ao veículo de entrega.

Use esse campo para especificar o estilo personalizado (como o ícone do marcador) e a interatividade (como o processamento de cliques).
  • Se um objeto MarkerOptions for especificado, as mudanças especificadas nele serão aplicadas ao marcador após a criação, substituindo as opções padrão, se houver.
  • Se uma função for especificada, ela será invocada uma vez quando o marcador for criado, antes de ser adicionado à visualização do mapa. Nessa invocação, o parâmetro isNew no objeto de parâmetros da função é definido como true. Além disso, essa função é invocada quando o provedor de localização recebe dados do Fleet Engine, independentemente de os dados correspondentes a esse marcador terem mudado ou não.

    Consulte TaskMarkerCustomizationFunctionParams para ver uma lista de parâmetros fornecidos e os usos deles.
taskOutcomeMarkerCustomization
opcional
Tipo: function(TaskMarkerCustomizationFunctionParams): void optional
Personalização aplicada a um marcador de resultado de tarefa. Um marcador de resultado da tarefa é renderizado no local real do resultado de cada tarefa atribuída ao veículo de entrega.

Use esse campo para especificar o estilo personalizado (como o ícone do marcador) e a interatividade (como o processamento de cliques).
  • Se um objeto MarkerOptions for especificado, as mudanças especificadas nele serão aplicadas ao marcador após a criação, substituindo as opções padrão, se houver.
  • Se uma função for especificada, ela será invocada uma vez quando o marcador for criado, antes de ser adicionado à visualização do mapa. Nessa invocação, o parâmetro isNew no objeto de parâmetros da função é definido como true. Além disso, essa função é invocada quando o provedor de localização recebe dados do Fleet Engine, independentemente de os dados correspondentes a esse marcador terem mudado ou não.

    Consulte TaskMarkerCustomizationFunctionParams para ver uma lista de parâmetros fornecidos e os usos deles.

Interface FleetEngineTaskFilterOptions

Interface google.maps.journeySharing.FleetEngineTaskFilterOptions

Opções de filtragem para tarefas no provedor de localização de veículos de entrega.

completionTimeFrom
opcional
Tipo: Date optional
Limite inferior exclusivo para o horário de conclusão da tarefa. Usado para filtrar tarefas que foram concluídas após o horário especificado.
completionTimeTo
opcional
Tipo: Date optional
Limite superior exclusivo para o horário de conclusão da tarefa. Usado para filtrar tarefas que foram concluídas antes do horário especificado.
state
opcional
Tipo: string optional
O estado da tarefa. Os valores válidos são OPEN ou CLOSED.

Interface FleetEngineDeliveryVehicleLocationProviderUpdateEvent

Interface google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProviderUpdateEvent

O objeto de evento transmitido ao manipulador de eventos quando o evento FleetEngineDeliveryVehicleLocationProvider.update é acionado.

completedVehicleJourneySegments
opcional
Os trechos da viagem que foram concluídos por este veículo. Não modificável.
deliveryVehicle
opcional
Tipo: DeliveryVehicle optional
A estrutura de dados do veículo de entrega retornada pela atualização. Não modificável.
tasks
opcional
Tipo: Array<Task> optional
A lista de tarefas atendidas por este veículo de entrega. Não modificável.

Classe FleetEngineDeliveryFleetLocationProvider

google.maps.journeySharing.FleetEngineDeliveryFleetLocationProvider classe
estende PollingLocationProvider
biblioteca "journeySharing"

Provedor de localização da frota de entrega.

const {FleetEngineDeliveryFleetLocationProvider} = await google.maps.importLibrary("journeySharing");
FleetEngineDeliveryFleetLocationProvider
FleetEngineDeliveryFleetLocationProvider(options)
Parâmetros:
Cria um novo provedor de localização para veículos rastreados pelo Fleet Engine.
deliveryVehicleFilter
Tipo: string optional
O filtro aplicado ao buscar os veículos de entrega.
locationRestriction
Os limites em que os veículos de entrega serão rastreados. Se nenhum limite for definido, nenhum veículo de entrega será rastreado. Para rastrear todos os veículos de entrega, independentemente do local, defina limites equivalentes ao planeta inteiro.
staleLocationThresholdMillis
Tipo: number
Este campo é somente leitura. Limite para localização desatualizada do veículo. Se o último local atualizado do veículo for mais antigo que esse limite, o veículo não será exibido.
Herdado: isPolling, pollingIntervalMillis
Herdado: addListener
update
function(event)
Evento acionado quando uma solicitação de atualização de dados do Fleet Engine é concluída.
Herdado: ispollingchange

Interface FleetEngineDeliveryFleetLocationProviderOptions

Interface google.maps.journeySharing.FleetEngineDeliveryFleetLocationProviderOptions

Opções para o provedor de localização da frota de entrega.

authTokenFetcher
Fornece JSON Web Tokens para autenticar o cliente no Fleet Engine.
projectId
Tipo: string
O ID do projeto do consumidor no console do Google Cloud.
deliveryVehicleFilter
opcional
Tipo: string optional
Uma consulta de filtro para aplicar ao buscar veículos de entrega. Esse filtro é transmitido diretamente para o Fleet Engine.

Consulte ListDeliveryVehiclesRequest.filter para ver os formatos compatíveis.

Os filtros válidos para atributos precisam ter o prefixo "attributes". Por exemplo, attributes.x = "y" ou attributes."x y" = "z".
deliveryVehicleMarkerCustomization
opcional
Personalização aplicada a um marcador de veículo de entrega.

Use esse campo para especificar o estilo personalizado (como o ícone do marcador) e a interatividade (como o processamento de cliques).
  • Se um objeto MarkerOptions for especificado, as mudanças especificadas nele serão aplicadas ao marcador após a criação, substituindo as opções padrão, se houver.
  • Se uma função for especificada, ela será invocada uma vez quando o marcador for criado, antes de ser adicionado à visualização do mapa. Nessa invocação, o parâmetro isNew no objeto de parâmetros da função é definido como true. Além disso, essa função é invocada quando o provedor de localização recebe dados do Fleet Engine, independentemente de os dados correspondentes a esse marcador terem mudado ou não.

    Consulte DeliveryVehicleMarkerCustomizationFunctionParams para ver uma lista de parâmetros fornecidos e os usos deles.
locationRestriction
opcional
Os limites de latitude/longitude em que os veículos serão rastreados imediatamente após a instanciação do provedor de localização. Se não for definido, o provedor de localização não vai começar a rastrear nenhum veículo. Use FleetEngineDeliveryFleetLocationProvider.locationRestriction para definir os limites e iniciar o rastreamento. Para rastrear todos os veículos de entrega, independentemente do local, defina limites equivalentes ao planeta inteiro.
staleLocationThresholdMillis
opcional
Tipo: number optional
Limite para localização desatualizada do veículo. Se o último local atualizado do veículo for mais antigo que esse limite, o veículo não será exibido. O padrão é 24 horas em milissegundos. Se o limite for menor que zero ou Infinity, ele será ignorado, e a localização do veículo não será considerada desatualizada.

Interface FleetEngineDeliveryFleetLocationProviderUpdateEvent

Interface google.maps.journeySharing.FleetEngineDeliveryFleetLocationProviderUpdateEvent

O objeto de evento transmitido ao manipulador de eventos quando o evento FleetEngineDeliveryFleetLocationProvider.update é acionado.

deliveryVehicles
opcional
Tipo: Array<DeliveryVehicle> optional
A lista de veículos de entrega retornada pela consulta. Não modificável.