Shipment Tracking

Clase FleetEngineShipmentLocationProvider

Clase google.maps.journeySharing.FleetEngineShipmentLocationProvider

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

Esta clase extiende PollingLocationProvider.

Para acceder, llama a const {FleetEngineShipmentLocationProvider} = await google.maps.importLibrary("journeySharing"). Consulta 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
El ID de seguimiento de la tarea que observa este proveedor de ubicación. Establece este campo para comenzar a hacer un seguimiento.
Heredado: isPolling, pollingIntervalMillis
refresh
refresh()
Parámetros:  Ninguno
Valor que se muestra:  void
Actualiza de forma explícita la ubicación del seguimiento.
Heredado: addListener
error
function(event)
Argumentos: 
Es un evento que se activa cuando el proveedor de ubicación encuentra un error.
update
function(event)
Es un evento que se activa cuando finaliza una solicitud de actualización de datos de Fleet Engine.
Heredado: ispollingchange

Interfaz FleetEngineShipmentLocationProviderOptions

Interfaz de 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
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 por la que el vehículo está circulando en ese momento.

Usa este campo para especificar el diseño personalizado (como el color del polilínea) y la interactividad (como el manejo de clics).
  • Si se especifica un objeto PolylineOptions, los cambios que se especifican en él se aplican a la polilínea después de que se crea, reemplazando sus opciones predeterminadas si existen.
  • Si se especifica una función, se invoca una vez cuando se crea el polilinea. (En esta invocación, el parámetro isNew en el objeto de parámetros de la función se establece en true). Además, esta función se invoca cuando cambian las coordenadas del polilínea o cuando el proveedor de ubicación recibe datos de Fleet Engine, independientemente de si los datos correspondientes a este polilínea cambiaron.

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

Usa este campo para especificar estilos personalizados (como el ícono de marcador) y la interactividad (como el manejo de clics).
  • Si se especifica un objeto MarkerOptions, los cambios que se especifican en él se aplican al marcador después de que se crea, reemplazando 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 del mapa. (En esta invocación, el parámetro isNew en el 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 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
Personalización aplicada al marcador de destino.

Usa este campo para especificar estilos personalizados (como el ícono de marcador) y la interactividad (como el manejo de clics).
  • Si se especifica un objeto MarkerOptions, los cambios que se especifican en él se aplican al marcador después de que se crea, reemplazando 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 del mapa. (En esta invocación, el parámetro isNew en el 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 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
Es el tiempo mínimo entre la recuperación de actualizaciones de ubicación en milisegundos. Si tarda más de pollingIntervalMillis en recuperar una actualización de ubicación, la siguiente actualización de ubicación no se inicia hasta que finaliza la actual.

Si estableces este valor en 0, Infinity o un valor negativo, se inhabilitan las actualizaciones automáticas de ubicación. Se recupera una nueva actualización de ubicación una vez que 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 flotas).

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 almacenará y usará 5000.
remainingPolylineCustomization optional
Personalización aplicada a la polilínea restante. Una polilínea restante corresponde a una parte de la ruta por la que el vehículo aún no comenzó a circular.

Usa este campo para especificar el diseño personalizado (como el color del polilínea) y la interactividad (como el manejo de clics).
  • Si se especifica un objeto PolylineOptions, los cambios que se especifican en él se aplican a la polilínea después de que se crea, reemplazando sus opciones predeterminadas si existen.
  • Si se especifica una función, se invoca una vez cuando se crea el polilinea. (En esta invocación, el parámetro isNew en el objeto de parámetros de la función se establece en true). Además, esta función se invoca cuando cambian las coordenadas del polilínea o cuando el proveedor de ubicación recibe datos de Fleet Engine, independientemente de si los datos correspondientes a este polilínea cambiaron.

    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 recorrida corresponde a una parte de la ruta que el vehículo ya recorrió.

Usa este campo para especificar el diseño personalizado (como el color del polilínea) y la interactividad (como el manejo de clics).
  • Si se especifica un objeto PolylineOptions, los cambios que se especifican en él se aplican a la polilínea después de que se crea, reemplazando sus opciones predeterminadas si existen.
  • Si se especifica una función, se invoca una vez cuando se crea el polilinea. (En esta invocación, el parámetro isNew en el objeto de parámetros de la función se establece en true). Además, esta función se invoca cuando cambian las coordenadas del polilínea o cuando el proveedor de ubicación recibe datos de Fleet Engine, independientemente de si los datos correspondientes a este polilínea cambiaron.

    Consulta ShipmentPolylineCustomizationFunctionParams para obtener una lista de los parámetros proporcionados y sus usos.
trackingId optional
Tipo:  string optional
Es el ID de seguimiento de la tarea a la que se le 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 comenzará a hacer un seguimiento de ninguna tarea. Usa FleetEngineShipmentLocationProvider.trackingId para establecer el ID de seguimiento y comenzar a hacer un seguimiento.

FleetEngineShipmentLocationProviderUpdateEvent

Interfaz de google.maps.journeySharing.FleetEngineShipmentLocationProviderUpdateEvent

Es 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.