Shipment Tracking

Clase FleetEngineShipmentLocationProvider.

Clase google.maps.journeySharing.FleetEngineShipmentLocationProvider

Proveedor de ubicación de envío.

Esta clase extiende PollingLocationProvider.

Para acceder, llama a const {FleetEngineShipmentLocationProvider} = await google.maps.importLibrary("journeySharing"). Consulta el artículo Bibliotecas de la API de Maps JavaScript.

FleetEngineShipmentLocationProvider
FleetEngineShipmentLocationProvider(options)
Parámetros: 
Crea un nuevo proveedor de ubicación para el seguimiento de envíos de Fleet Engine.
trackingId
Tipo:  string
Es el ID de seguimiento de la tarea que observa este proveedor de ubicación. Establece este campo para comenzar el seguimiento.
Heredado: isPolling, pollingIntervalMillis
refresh
refresh()
Parámetros: Ninguno
Valor que se devuelve:  void
Actualiza de forma explícita la ubicación a la que le hiciste seguimiento.
Heredado: addListener
error
function(event)
Argumentos: 
Evento que se activa cuando el proveedor de ubicación encuentra un error
update
function(event)
Evento que se activa cuando finaliza una solicitud de actualización de datos de Fleet Engine.
Heredado: ispollingchange

Interfaz de FleetEngineShipmentLocationProviderOptions

Interfaz de google.maps.journeySharing.FleetEngineShipmentLocationProviderOptions

Opciones del proveedor de ubicación de envío.

authTokenFetcher
Proporciona tokens web JSON para autenticar al cliente en Fleet Engine.
projectId
Tipo:  string
El ID del proyecto del consumidor de la consola de Google Cloud.
activePolylineCustomization optional
Personalización aplicada a la polilínea activa. Una polilínea activa corresponde a una parte de la ruta que el vehículo atraviesa actualmente.

Usa este campo para especificar un estilo personalizado (como el color de polilínea) y la interactividad (como el control de clics).
  • Si se especifica un objeto PolylineOptions, los cambios especificados se aplicarán a la polilínea después de crearla y sobrescribirán las opciones predeterminadas que existan.
  • Si se especifica una función, se invoca una vez cuando se crea la polilínea. (En esta invocación, el parámetro isNew del objeto de parámetros de función se establece en true). Además, se invoca esta función cuando cambian las coordenadas de la polilínea o cuando el proveedor de ubicación recibe datos de Fleet Engine, sin importar si cambiaron los datos correspondientes a esta polilínea.

    Consulta ShipmentPolylineCustomizationFunctionParams para obtener una lista de los parámetros proporcionados y sus usos.
deliveryVehicleMarkerCustomization optional
Tipo:  (function(ShipmentMarkerCustomizationFunctionParams): void)|MarkerOptions optional
Se aplicó una personalización al marcador del vehículo de entrega.

Usa este campo para especificar un estilo personalizado (como el ícono de marcador) y la interactividad (como el control de clics).
  • Si se especifica un objeto MarkerOptions, los cambios especificados se aplicarán al marcador después de que se cree y sobrescribirán las opciones predeterminadas que existan.
  • Si se especifica una función, esta se invoca una vez que se crea el marcador, antes de agregarla a la vista de mapa. (En esta invocación, el parámetro isNew del objeto de parámetros de función se establece en true). Además, esta función se invoca cuando el proveedor de ubicación recibe datos de Fleet Engine, independientemente de si los datos correspondientes a este marcador cambiaron.

    Consulta ShipmentMarkerCustomizationFunctionParams para obtener una lista de los parámetros proporcionados y sus usos.
destinationMarkerCustomization optional
Tipo:  (function(ShipmentMarkerCustomizationFunctionParams): void)|MarkerOptions optional
Se aplicó la personalización al marcador de destino.

Usa este campo para especificar un estilo personalizado (como el ícono de marcador) y la interactividad (como el control de clics).
  • Si se especifica un objeto MarkerOptions, los cambios especificados se aplicarán al marcador después de que se cree y sobrescribirán las opciones predeterminadas que existan.
  • Si se especifica una función, esta se invoca una vez que se crea el marcador, antes de agregarla a la vista de mapa. (En esta invocación, el parámetro isNew del objeto de parámetros de función se establece en true). Además, esta función se invoca cuando el proveedor de ubicación recibe datos de Fleet Engine, independientemente de si los datos correspondientes a este marcador cambiaron.

    Consulta ShipmentMarkerCustomizationFunctionParams para obtener una lista de los parámetros proporcionados y sus usos.
pollingIntervalMillis optional
Tipo:  number optional
Tiempo mínimo entre la recuperación de las actualizaciones de ubicación en milisegundos. Si tarda más de pollingIntervalMillis en recuperar una actualización de ubicación, no se iniciará la próxima actualización de ubicación hasta que finalice la actual.

Si estableces este valor en 0, Infinity o un valor negativo, se inhabilitarán las actualizaciones automáticas de ubicación. Una nueva actualización de ubicación se recupera una vez si cambia el parámetro de ID de seguimiento (por ejemplo, el ID de seguimiento de envío del proveedor de ubicación de envío) o una opción de filtrado (por ejemplo, límites de viewports o filtros de atributos para proveedores de ubicación de flotas).

El intervalo de sondeo predeterminado y mínimo es de 5,000 milisegundos. Si configuras el intervalo de sondeo en un valor positivo más bajo, se almacena y usa 5,000.
remainingPolylineCustomization optional
Personalización de la polilínea restante Una polilínea restante corresponde a una parte de la ruta que el vehículo aún no ha comenzado a recorrer.

Usa este campo para especificar un estilo personalizado (como el color de polilínea) y la interactividad (como el control de clics).
  • Si se especifica un objeto PolylineOptions, los cambios especificados se aplicarán a la polilínea después de crearla y sobrescribirán las opciones predeterminadas que existan.
  • Si se especifica una función, se invoca una vez cuando se crea la polilínea. (En esta invocación, el parámetro isNew del objeto de parámetros de función se establece en true). Además, se invoca esta función cuando cambian las coordenadas de la polilínea o cuando el proveedor de ubicación recibe datos de Fleet Engine, sin importar si cambiaron los datos correspondientes a esta polilínea.

    Consulta ShipmentPolylineCustomizationFunctionParams para obtener una lista de los parámetros proporcionados y sus usos.
takenPolylineCustomization optional
Personalización aplicada a la polilínea tomada. Una polilínea tomada corresponde a una parte de la ruta que el vehículo ya recorrió.

Usa este campo para especificar un estilo personalizado (como el color de polilínea) y la interactividad (como el control de clics).
  • Si se especifica un objeto PolylineOptions, los cambios especificados se aplicarán a la polilínea después de crearla y sobrescribirán las opciones predeterminadas que existan.
  • Si se especifica una función, se invoca una vez cuando se crea la polilínea. (En esta invocación, el parámetro isNew del objeto de parámetros de función se establece en true). Además, se invoca esta función cuando cambian las coordenadas de la polilínea o cuando el proveedor de ubicación recibe datos de Fleet Engine, sin importar si cambiaron los datos correspondientes a esta polilínea.

    Consulta ShipmentPolylineCustomizationFunctionParams para obtener una lista de los parámetros proporcionados y sus usos.
trackingId optional
Tipo:  string optional
El ID de seguimiento de la tarea de la que se debe rastrear inmediatamente después de que se crea una instancia del proveedor de ubicación Si no se especifica, el proveedor de ubicación no comenzará a realizar el seguimiento de ninguna tarea. Utiliza FleetEngineShipmentLocationProvider.trackingId para establecer el ID de seguimiento y comenzar el seguimiento.

Interfaz de FleetEngineShipmentLocationProviderUpdateEvent

Interfaz de google.maps.journeySharing.FleetEngineShipmentLocationProviderUpdateEvent

El objeto de evento que se pasa al controlador de eventos cuando se activa el evento FleetEngineShipmentLocationProvider.update.

taskTrackingInfo optional
Tipo:  TaskTrackingInfo optional
Es la estructura de información de seguimiento de tareas que muestra la actualización. No se puede modificar.