Shipment Tracking

Clase FleetEngineShipmentLocationProvider

google.maps.journeySharing.FleetEngineShipmentLocationProvider class
extends PollingLocationProvider
library "journeySharing"

Es el proveedor de ubicación del envío.

const {FleetEngineShipmentLocationProvider} = await google.maps.importLibrary("journeySharing");
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 de retorno: void
Actualiza de forma explícita la ubicación registrada.
Heredado: addListener
error
function(event)
Argumentos:
Es el evento que se activa cuando el proveedor de ubicación encuentra un error.
update
function(event)
Es el evento que se activa cuando finaliza una solicitud de actualización de datos de Fleet Engine.
Heredado: ispollingchange

Interfaz FleetEngineShipmentLocationProviderOptions

Interfaz google.maps.journeySharing.FleetEngineShipmentLocationProviderOptions

Son las opciones para el proveedor de ubicación del envío.

authTokenFetcher
Proporciona tokens web JSON para autenticar el cliente en Fleet Engine.
projectId
Tipo: string
Es el ID del proyecto del consumidor de la consola de Google Cloud.
activePolylineCustomization
opcional
Es la personalización que se aplica a la polilínea activa. Una polilínea activa corresponde a una parte de la ruta que el vehículo está recorriendo en ese momento.

Usa este campo para especificar un estilo personalizado (como el color de la polilínea) y la interactividad (como el control de clics).
  • Si se especifica un objeto PolylineOptions, los cambios que se indiquen en él se aplicarán a la polilínea después de que se cree, lo que reemplazará sus opciones predeterminadas si existen.
  • 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 la función se establece en true). Además, esta función se invoca cuando cambian las coordenadas de la polilínea o cuando el proveedor de ubicación recibe datos de Fleet Engine, independientemente de si cambiaron los datos correspondientes a esta polilínea.

    Consulta ShipmentPolylineCustomizationFunctionParams para obtener una lista de los parámetros proporcionados y sus usos.
deliveryVehicleMarkerCustomization
opcional
Es la personalización que se aplica 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 que se indiquen en él se aplicarán al marcador después de que se haya creado, lo que reemplazará sus opciones predeterminadas si existen.
  • Si se especifica una función, se invoca una vez cuando se crea el marcador, antes de que se agregue a la vista de mapa. (En esta invocación, el parámetro isNew del objeto de parámetros de la 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 cambiaron los datos correspondientes a este marcador.

    Consulta ShipmentMarkerCustomizationFunctionParams para obtener una lista de los parámetros proporcionados y sus usos.
destinationMarkerCustomization
opcional
Es la personalización que se aplica 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 que se indiquen en él se aplicarán al marcador después de que se haya creado, lo que reemplazará sus opciones predeterminadas si existen.
  • Si se especifica una función, se invoca una vez cuando se crea el marcador, antes de que se agregue a la vista de mapa. (En esta invocación, el parámetro isNew del objeto de parámetros de la 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 cambiaron los datos correspondientes a este marcador.

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

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

El intervalo de sondeo predeterminado y mínimo es de 5,000 milisegundos. Si estableces el intervalo de sondeo en un valor positivo más bajo, se almacena y se usa 5000.
remainingPolylineCustomization
opcional
Se aplicó la personalización a la polilínea restante. Una polilínea restante corresponde a una parte de la ruta que el vehículo aún no comenzó a recorrer.

Usa este campo para especificar un estilo personalizado (como el color de la polilínea) y la interactividad (como el control de clics).
  • Si se especifica un objeto PolylineOptions, los cambios que se indiquen en él se aplicarán a la polilínea después de que se cree, lo que reemplazará sus opciones predeterminadas si existen.
  • 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 la función se establece en true). Además, esta función se invoca cuando cambian las coordenadas de la polilínea o cuando el proveedor de ubicación recibe datos de Fleet Engine, independientemente de si cambiaron los datos correspondientes a esta polilínea.

    Consulta ShipmentPolylineCustomizationFunctionParams para obtener una lista de los parámetros proporcionados y sus usos.
takenPolylineCustomization
opcional
Es la personalización que se aplica 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 la polilínea) y la interactividad (como el control de clics).
  • Si se especifica un objeto PolylineOptions, los cambios que se indiquen en él se aplicarán a la polilínea después de que se cree, lo que reemplazará sus opciones predeterminadas si existen.
  • 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 la función se establece en true). Además, esta función se invoca cuando cambian las coordenadas de la polilínea o cuando el proveedor de ubicación recibe datos de Fleet Engine, independientemente de si cambiaron los datos correspondientes a esta polilínea.

    Consulta ShipmentPolylineCustomizationFunctionParams para obtener una lista de los parámetros proporcionados y sus usos.
trackingId
opcional
Tipo: string optional
Es el ID de seguimiento de la tarea de la que se hará un seguimiento inmediatamente después de que se cree una instancia del proveedor de ubicación. Si no se especifica, el proveedor de ubicación no inicia el seguimiento de ninguna tarea. Usa FleetEngineShipmentLocationProvider.trackingId para establecer el ID de seguimiento y comenzar el seguimiento.

Interfaz FleetEngineShipmentLocationProviderUpdateEvent

Interfaz google.maps.journeySharing.FleetEngineShipmentLocationProviderUpdateEvent

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

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