Fleet Tracking - Last Mile Fleet

Clase FleetEngineDeliveryVehicleLocationProvider

class google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProvider extends PollingLocationProvider, LocationProvider
library "journeySharing"

Proveedor de ubicación de vehículos de entrega

const {FleetEngineDeliveryVehicleLocationProvider} = await google.maps.importLibrary("journeySharing");
FleetEngineDeliveryVehicleLocationProvider
FleetEngineDeliveryVehicleLocationProvider(options)
Parámetros:
Crea un nuevo proveedor de ubicación para un vehículo de entrega de Fleet Engine.
deliveryVehicleId
Tipo: string
Es el ID del vehículo que observa este proveedor de ubicación. Establece este campo para hacer un seguimiento de un vehículo.
shouldShowOutcomeLocations
Tipo: boolean optional
De manera opcional, permite que los usuarios muestren la ubicación del resultado de la tarea.
shouldShowTasks
Tipo: boolean optional
De manera opcional, permite que los usuarios muestren las tareas recuperadas.
staleLocationThresholdMillis
Tipo: number
Este campo es de solo lectura. Es el umbral para la ubicación de un vehículo inactivo. Si la última ubicación actualizada del vehículo es anterior a este umbral, no se mostrará el vehículo.
taskFilterOptions
Devuelve las opciones de filtro que se aplicarán cuando se recuperen las tareas.
Heredado: isPolling, pollingIntervalMillis
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 FleetEngineDeliveryVehicleLocationProviderOptions

interfaz google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProviderOptions

Son las opciones para el proveedor de ubicación del vehículo de entrega.

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 DeliveryVehiclePolylineCustomizationFunctionParams para obtener una lista de los parámetros proporcionados y sus usos.
deliveryVehicleId
opcional
Tipo: string optional
Es el ID del vehículo de entrega del 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 ningún vehículo. Usa FleetEngineDeliveryVehicleLocationProvider.deliveryVehicleId para establecer el ID y comenzar el seguimiento.
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 DeliveryVehicleMarkerCustomizationFunctionParams para obtener una lista de los parámetros proporcionados y sus usos.
plannedStopMarkerCustomization
opcional
Es la personalización que se aplica a un marcador de parada planificada.

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 PlannedStopMarkerCustomizationFunctionParams 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, se inhabilitarán las actualizaciones de ubicación recurrentes. Se recupera una nueva ubicación actualizada si cambia alguno de los parámetros que observa el proveedor de ubicación.

El intervalo de sondeo predeterminado es de 5,000 milisegundos, que es el intervalo mínimo. Si estableces el intervalo de sondeo en un valor más bajo que no sea cero, se usará 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 DeliveryVehiclePolylineCustomizationFunctionParams para obtener una lista de los parámetros proporcionados y sus usos.
shouldShowOutcomeLocations
opcional
Tipo: boolean optional
Es un valor booleano para mostrar o, bien, ocultar las ubicaciones de los resultados de las tareas recuperadas.
shouldShowTasks
opcional
Tipo: boolean optional
Es un valor booleano para mostrar u ocultar tareas. Si se establece en falso, se evitará que se llame al extremo ListTasks para recuperar las tareas. Solo se mostrarán las próximas paradas del vehículo.
staleLocationThresholdMillis
opcional
Tipo: number optional
Es el umbral para la ubicación de un vehículo inactivo. Si la última ubicación actualizada del vehículo es anterior a este umbral, no se mostrará el vehículo. El valor predeterminado es de 24 horas en milisegundos. Si el umbral es menor que 0 o Infinity, se ignorará el umbral y la ubicación del vehículo no se considerará inactiva.
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 DeliveryVehiclePolylineCustomizationFunctionParams para obtener una lista de los parámetros proporcionados y sus usos.
taskFilterOptions
opcional
Son las opciones de filtro que se aplicarán cuando se recuperen las tareas. Las opciones pueden incluir un vehículo, una hora y un estado de la tarea específicos.
taskMarkerCustomization
opcional
Tipo: (function(TaskMarkerCustomizationFunctionParams): void)|MarkerOptions optional
Personalización aplicada a un marcador de tarea. Se renderiza un marcador de tarea en la ubicación planificada de cada tarea asignada al 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 TaskMarkerCustomizationFunctionParams para obtener una lista de los parámetros proporcionados y sus usos.
taskOutcomeMarkerCustomization
opcional
Tipo: function(TaskMarkerCustomizationFunctionParams): void optional
Personalización aplicada a un marcador de resultado de tarea. Se renderiza un marcador de resultado de la tarea en la ubicación real del resultado de cada tarea asignada al 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 TaskMarkerCustomizationFunctionParams para obtener una lista de los parámetros proporcionados y sus usos.

Interfaz FleetEngineTaskFilterOptions

interfaz google.maps.journeySharing.FleetEngineTaskFilterOptions

Son las opciones de filtrado para las tareas en el proveedor de ubicación de vehículos de entrega.

completionTimeFrom
opcional
Tipo: Date optional
Es el límite inferior exclusivo para el tiempo de finalización de la tarea. Se usa para filtrar las tareas que se completaron después de la hora especificada.
completionTimeTo
opcional
Tipo: Date optional
Es el límite superior exclusivo para la hora de finalización de la tarea. Se usa para filtrar las tareas que se completaron antes de la hora especificada.
state
opcional
Tipo: string optional
Es el estado de la tarea. Los valores válidos son OPEN o CLOSED.

Interfaz FleetEngineDeliveryVehicleLocationProviderUpdateEvent

interfaz google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProviderUpdateEvent

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

completedVehicleJourneySegments
opcional
Son los tramos del viaje que completó este vehículo. No se puede modificar.
deliveryVehicle
opcional
Tipo: DeliveryVehicle optional
Es la estructura de datos del vehículo de entrega que devuelve la actualización. No se puede modificar.
tasks
opcional
Tipo: Array<Task> optional
Es la lista de tareas que entrega este vehículo de entrega. No se puede modificar.

Clase FleetEngineDeliveryFleetLocationProvider

class google.maps.journeySharing.FleetEngineDeliveryFleetLocationProvider extends PollingLocationProvider, LocationProvider
library "journeySharing"

Proveedor de ubicación de la flota de entrega

const {FleetEngineDeliveryFleetLocationProvider} = await google.maps.importLibrary("journeySharing");
FleetEngineDeliveryFleetLocationProvider
FleetEngineDeliveryFleetLocationProvider(options)
Parámetros:
Crea un nuevo proveedor de ubicación para los vehículos a los que Fleet Engine hace un seguimiento.
deliveryVehicleFilter
Tipo: string optional
Es el filtro que se aplica cuando se recuperan los vehículos de entrega.
locationRestriction
Son los límites dentro de los cuales se deben seguir los vehículos de entrega. Si no se establecen límites, no se hará un seguimiento de los vehículos de entrega. Para hacer un seguimiento de todos los vehículos de entrega, independientemente de su ubicación, establece límites equivalentes a toda la Tierra.
staleLocationThresholdMillis
Tipo: number
Este campo es de solo lectura. Es el umbral para la ubicación de un vehículo inactivo. Si la última ubicación actualizada del vehículo es anterior a este umbral, no se mostrará el vehículo.
Heredado: isPolling, pollingIntervalMillis
Heredado: addListener
update
function(event)
Es el evento que se activa cuando finaliza una solicitud de actualización de datos de Fleet Engine.
Heredado: ispollingchange

Interfaz FleetEngineDeliveryFleetLocationProviderOptions

interfaz google.maps.journeySharing.FleetEngineDeliveryFleetLocationProviderOptions

Opciones para el proveedor de ubicación de la flota de entrega.

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.
deliveryVehicleFilter
opcional
Tipo: string optional
Es una consulta de filtro que se aplica cuando se recuperan los vehículos de entrega. Este filtro se pasa directamente a Fleet Engine.

Consulta ListDeliveryVehiclesRequest.filter para conocer los formatos admitidos.

Ten en cuenta que los filtros válidos para los atributos deben tener el prefijo "attributes". Por ejemplo, attributes.x = "y" o attributes."x y" = "z".
deliveryVehicleMarkerCustomization
opcional
Personalización aplicada a un marcador de 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 DeliveryVehicleMarkerCustomizationFunctionParams para obtener una lista de los parámetros proporcionados y sus usos.
locationRestriction
opcional
Son los límites de latitud y longitud dentro de los cuales se deben seguir los vehículos inmediatamente después de que se crea una instancia del proveedor de ubicación. Si no se establece, el proveedor de ubicación no comenzará a hacer un seguimiento de ningún vehículo. Usa FleetEngineDeliveryFleetLocationProvider.locationRestriction para establecer los límites y comenzar el seguimiento. Para hacer un seguimiento de todos los vehículos de entrega, independientemente de su ubicación, establece límites equivalentes a toda la Tierra.
staleLocationThresholdMillis
opcional
Tipo: number optional
Es el umbral para la ubicación de un vehículo inactivo. Si la última ubicación actualizada del vehículo es anterior a este umbral, no se mostrará el vehículo. El valor predeterminado es de 24 horas en milisegundos. Si el umbral es menor que cero o Infinity, se ignorará y la ubicación del vehículo no se considerará inactiva.

Interfaz FleetEngineDeliveryFleetLocationProviderUpdateEvent

interfaz google.maps.journeySharing.FleetEngineDeliveryFleetLocationProviderUpdateEvent

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

deliveryVehicles
opcional
Tipo: Array<DeliveryVehicle> optional
Es la lista de vehículos de entrega que devuelve la consulta. No se puede modificar.