Shipment Tracking

Classe FleetEngineShipmentLocationProvider

Classe google.maps.journeySharing.FleetEngineShipmentLocationProvider

Provedor de localização de envio.

Essa classe estende PollingLocationProvider.

Acesse ligando para const {FleetEngineShipmentLocationProvider} = await google.maps.importLibrary("journeySharing").
Consulte Bibliotecas na API Maps JavaScript.

FleetEngineShipmentLocationProvider
FleetEngineShipmentLocationProvider(options)
Parâmetros:
Cria um novo provedor de localização para o rastreamento de remessas do Fleet Engine.
trackingId
Tipo:string
O ID de rastreamento da tarefa que este provedor de localizações observa. Defina esse campo para começar o rastreamento.
Herdado: isPolling, pollingIntervalMillis
refresh
refresh()
Parâmetros:nenhum
Valor de retorno:void
Atualiza explicitamente o local monitorado.
Herdado: addListener
error
function(event)
Argumentos: 
Evento 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 FleetEngineShipmentLocationProviderOptions

Interface google.maps.journeySharing.FleetEngineShipmentLocationProviderOptions

Opções para provedor de local de envio.

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 optional
Personalização aplicada à polilinha ativa. Uma polilinha ativa corresponde a uma parte do trajeto que o veículo está percorrendo.

Use este campo para especificar estilos personalizados (como cor da polilinha) e interatividade (como processamento de cliques).
  • Se um objeto PolylineOptions for especificado, as mudanças 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 local recebe dados do Fleet Engine, independente de os dados correspondentes a essa polilinha terem mudado.

    Consulte ShipmentPolylineCustomizationFunctionParams para ver uma lista de parâmetros fornecidos e seus usos.
deliveryVehicleMarkerCustomization optional
Personalização aplicada ao marcador do veículo de entrega.

Use este campo para especificar estilos personalizados (como ícone de marcador) e interatividade (como processamento de cliques).
  • Se um objeto MarkerOptions for especificado, as mudanças nele serão aplicadas ao marcador depois que ele for criado, substituindo as opções padrão, se existirem.
  • 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, independente de os dados correspondentes a esse marcador terem mudado.

    Consulte ShipmentMarkerCustomizationFunctionParams para ver uma lista de parâmetros fornecidos e seus usos.
destinationMarkerCustomization optional
Personalização aplicada ao marcador de destino.

Use este campo para especificar estilos personalizados (como ícone de marcador) e interatividade (como processamento de cliques).
  • Se um objeto MarkerOptions for especificado, as mudanças nele serão aplicadas ao marcador depois que ele for criado, substituindo as opções padrão, se existirem.
  • 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, independente de os dados correspondentes a esse marcador terem mudado.

    Consulte ShipmentMarkerCustomizationFunctionParams para ver uma lista de parâmetros fornecidos e seus usos.
pollingIntervalMillis optional
Tipo:number optional
Tempo mínimo entre a busca de atualizações de localização em milissegundos. Se levar mais de pollingIntervalMillis para buscar uma atualização de local, a próxima atualização não será iniciada até que a atual termine.

Definir esse valor como 0, Infinity ou um valor negativo desativa as atualizações automáticas de local. Uma nova atualização de local é buscada uma vez se o parâmetro de ID de rastreamento (por exemplo, o ID de rastreamento do envio do provedor de local de envio) ou uma opção de filtragem (por exemplo, limites da janela de visualização ou filtros de atributos para provedores de local da frota) mudar.

O intervalo de sondagem padrão e mínimo é de 5.000 milissegundos. Se você definir o intervalo de pesquisa como um valor positivo menor, 5.000 será armazenado e usado.
remainingPolylineCustomization optional
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 este campo para especificar estilos personalizados (como cor da polilinha) e interatividade (como processamento de cliques).
  • Se um objeto PolylineOptions for especificado, as mudanças 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 local recebe dados do Fleet Engine, independente de os dados correspondentes a essa polilinha terem mudado.

    Consulte ShipmentPolylineCustomizationFunctionParams para ver uma lista de parâmetros fornecidos e seus usos.
takenPolylineCustomization optional
Personalização aplicada à polilinha capturada. Uma polilinha percorrida corresponde a uma parte do trajeto que o veículo já fez.

Use este campo para especificar estilos personalizados (como cor da polilinha) e interatividade (como processamento de cliques).
  • Se um objeto PolylineOptions for especificado, as mudanças 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 local recebe dados do Fleet Engine, independente de os dados correspondentes a essa polilinha terem mudado.

    Consulte ShipmentPolylineCustomizationFunctionParams para ver uma lista de parâmetros fornecidos e seus usos.
trackingId optional
Tipo:string optional
O ID de rastreamento da tarefa a ser rastreada imediatamente após a criação da instância do provedor de local. Se não for especificado, o provedor de local não vai iniciar o rastreamento de nenhuma tarefa. Use FleetEngineShipmentLocationProvider.trackingId para definir o ID de rastreamento e começar a rastrear.

Interface FleetEngineShipmentLocationProviderUpdateEvent

Interface google.maps.journeySharing.FleetEngineShipmentLocationProviderUpdateEvent

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

taskTrackingInfo optional
Tipo:TaskTrackingInfo optional
A estrutura de informações de rastreamento de tarefas retornada pela atualização. Não modificável.