Shipment Tracking

Classe FleetEngineShipmentLocationProvider

Classe google.maps.journeySharing.FleetEngineShipmentLocationProvider

Provedor do local de envio.

Essa classe estende PollingLocationProvider.

Acesse chamando 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 rastrear remessas do Fleet Engine.
trackingId
Tipo:  string
O ID de rastreamento para a tarefa que esse provedor de localização observa. Defina este campo para iniciar o monitoramento.
Herdado: isPolling, pollingIntervalMillis
refresh
refresh()
Parâmetros: nenhum
Valor de retorno:  void
Atualiza explicitamente o local rastreado.
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 o provedor da localização da remessa.

authTokenFetcher
Fornece tokens JSON Web 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 pelo qual o veículo está passando.

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 alterações especificadas nele serão aplicadas à polilinha depois da criação dela, 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 ShipmentPolylineCustomizationFunctionParams para ver uma lista dos parâmetros fornecidos e seus usos.
deliveryVehicleMarkerCustomization optional
Tipo:  (function(ShipmentMarkerCustomizationFunctionParams): void)|MarkerOptions optional
Personalização aplicada ao marcador do veículo de entrega.

Use esse campo para especificar o estilo personalizado (como o ícone de um marcador) e a interatividade (como o processamento de cliques).
  • Se um objeto MarkerOptions for especificado, as alterações especificadas nele serão aplicadas ao marcador após a criação dele, 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 de 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 da mudança nos dados correspondentes a esse marcador.

    Consulte ShipmentMarkerCustomizationFunctionParams para conferir uma lista dos parâmetros fornecidos e os usos deles.
destinationMarkerCustomization optional
Tipo:  (function(ShipmentMarkerCustomizationFunctionParams): void)|MarkerOptions optional
Personalização aplicada ao marcador de destino.

Use esse campo para especificar o estilo personalizado (como o ícone de um marcador) e a interatividade (como o processamento de cliques).
  • Se um objeto MarkerOptions for especificado, as alterações especificadas nele serão aplicadas ao marcador após a criação dele, 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 de 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 da mudança nos dados correspondentes a esse marcador.

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

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

O intervalo de pesquisa padrão e mínimo é de 5.000 milissegundos. Se você definir o intervalo de pesquisa com um valor positivo mais baixo, 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 atravessar.

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 alterações especificadas nele serão aplicadas à polilinha depois da criação dela, 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 ShipmentPolylineCustomizationFunctionParams para ver uma lista dos parâmetros fornecidos e seus usos.
takenPolylineCustomization optional
Personalização aplicada à polilinha escolhida. Uma polilinha selecionada 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 alterações especificadas nele serão aplicadas à polilinha depois da criação dela, 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 ShipmentPolylineCustomizationFunctionParams para ver uma lista dos parâmetros fornecidos e seus usos.
trackingId optional
Tipo:  string optional
O ID de rastreamento da tarefa a ser monitorada imediatamente após o provedor de localização ser instanciado. Se não for especificado, o provedor de localização não vai começar a monitorar nenhuma tarefa. Use FleetEngineShipmentLocationProvider.trackingId para definir o ID de rastreamento e iniciar o monitoramento.

Interface FleetEngineShipmentLocationProviderUpdateEvent

Interface google.maps.journeySharing.FleetEngineShipmentLocationProviderUpdateEvent

O objeto do 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.