Cómo hacer un seguimiento de los envíos con la biblioteca de seguimiento de envíos de JavaScript

La biblioteca de seguimiento de envíos de JavaScript te permite visualizar la ubicación de los vehículos y las ubicaciones de interés a las que se les hace un seguimiento en Fleet Engine. La biblioteca contiene un componente de mapa de JavaScript que es un reemplazo directo de una entidad google.maps.Map estándar y componentes de datos para conectarse con Fleet Engine. Con la biblioteca de seguimiento de envíos de JavaScript, puedes proporcionar una experiencia de seguimiento de envíos animada y personalizable desde tu aplicación web.

Componentes

La biblioteca de seguimiento de envíos de JavaScript proporciona componentes para visualizar el vehículo y la ruta a medida que se avanza a un destino, así como feeds de datos sin procesar para la hora de llegada estimada del conductor o la distancia restante para conducir.

Vista de mapa del seguimiento de envíos

El componente de vista de mapa permite visualizar la ubicación de vehículos y destinos. Si se conoce la ruta de un vehículo, el componente de vista de mapa le aplica animación a ese vehículo a medida que se mueve por su ruta prevista.

Proveedor de ubicación de envío

Un proveedor de ubicación de envíos proporciona información de ubicación para los objetos rastreados en el mapa de seguimiento de envíos para el seguimiento de envíos del primer y último kilómetro.

Puede usar el proveedor de ubicación de envío para realizar un seguimiento de lo siguiente:

  • Es la ubicación de retiro o entrega de un envío.
  • La ubicación y la ruta del vehículo de entrega.

Objetos de ubicación con seguimiento

El proveedor de ubicación realiza un seguimiento de la ubicación de los objetos como vehículos y destinos.

Ubicación de destino

La ubicación de destino es la ubicación donde termina un viaje. Para el seguimiento de envíos, es la ubicación planificada de la tarea.

Ubicación del vehículo

La ubicación del vehículo es la ubicación rastreada de un vehículo. De manera opcional, puede incluir una ruta para el vehículo.

Recuperador de tokens de autenticación

Para controlar el acceso a los datos de ubicación almacenados en Fleet Engine, debes implementar un servicio de creación de tokens web JSON (JWT) para Fleet Engine en tu servidor. Luego, implementa un recuperador de tokens de autenticación como parte de tu aplicación web con la biblioteca de JavaScript Journey Share para autenticar el acceso a los datos de ubicación.

Opciones de diseño

Los diseños de marcador y polilínea determinan el aspecto de los objetos de ubicación con seguimiento en el mapa. Puedes usar opciones de diseño personalizadas para cambiar el estilo predeterminado y que coincida con el de tu aplicación web.

Controla la visibilidad de las ubicaciones que sigues

En esta sección, se describen los controles de visibilidad de los objetos a los que se les realiza seguimiento en el mapa. Estas reglas se aplican a dos categorías de objetos:

  • Marcador de ubicación
  • Datos de tareas

Visibilidad del marcador de ubicación

Todos los marcadores de ubicación del origen y el destino se muestran siempre en el mapa. Por ejemplo, la ubicación de entrega de un envío se muestra siempre en el mapa, sin importar el estado de la entrega.

Visibilidad de los datos de la tarea

En esta sección, se describen las reglas de visibilidad predeterminadas que se aplican a los datos de tareas, como la ubicación del vehículo y la ruta restante. Puedes personalizar muchas tareas, pero no todas:

  • Tareas de falta de disponibilidad: No puedes personalizar la visibilidad de estas tareas.
  • Tareas activas del vehículo: Puedes personalizar este tipo de tareas.
  • Tareas de vehículos inactivos: No puedes personalizar la visibilidad de estas tareas.

Tareas de falta de disponibilidad

Si hay al menos una tarea de falta de disponibilidad (por ejemplo, si el conductor se toma un descanso o el vehículo se está recargando) en la ruta hacia la tarea de la que se hace un seguimiento, el vehículo no es visible. La hora de llegada estimada y la hora estimada de finalización de la tarea aún están disponibles.

Tareas activas del vehículo

El objeto TaskTrackingInfo proporciona una serie de elementos de datos que se pueden mostrar en la biblioteca de seguimiento de envío. De forma predeterminada, estos campos son visibles cuando la tarea se asigna al vehículo y cuando el vehículo se encuentra a menos de 5 paradas de la tarea. La visibilidad finaliza cuando se completa o cancela la tarea. Los campos son los siguientes:

  • Polilíneas de ruta
  • Tiempo estimado hasta la llegada
  • Tiempo estimado de finalización de la tarea
  • Distancia en automóvil restante para llegar a la tarea
  • Recuento de paradas restantes
  • Ubicación del vehículo

Puedes personalizar la configuración de visibilidad por tarea si configuras el TaskTrackingViewConfig en una tarea cuando creas o actualizas la tarea en Fleet Engine. Esto crea reglas que determinan cuándo están disponibles los elementos de datos individuales, que se pueden basar en los siguientes criterios (denominados a continuación como opción de visibilidad):

  • Recuento de paradas restantes
  • Duración hasta la hora de llegada estimada
  • Distancia de conducción restante
  • Siempre visible
  • No visible nunca

Ten en cuenta que cada elemento de datos solo se puede asociar con una opción de visibilidad. No es posible combinar criterios usando OR u AND.

El siguiente es un ejemplo de personalización. Las reglas de esa personalización son las siguientes:

  • Muestra las polilíneas de la ruta si el vehículo se encuentra a menos de 3 paradas.
  • Muestra la hora de llegada estimada si la distancia de conducción restante es inferior a 5000 metros.
  • Nunca mostrar el recuento de paradas restante.
  • Cada otro campo conserva la visibilidad predeterminada que se muestra cuando el vehículo se encuentra a 5 paradas de la tarea.
"taskTrackingViewConfig": {
  "routePolylinePointsVisibility": {
    "remainingStopCountThreshold": 3
  },
  "estimatedArrivalTimeVisibility": {
    "remainingDrivingDistanceMetersThreshold": 5000
  },
  "remainingStopCountVisibility": {
    "never": true
  }
}

También puedes personalizar la configuración de visibilidad predeterminada para tu proyecto. Para ello, comunícate con el equipo de asistencia al cliente.

Reglas de visibilidad de la ubicación del vehículo y polilíneas de rutas:

Cuando se pueden ver las polilíneas de la ruta, la ubicación del vehículo también debe estarlo. De lo contrario, la ubicación del vehículo se puede indicar al final de las polilíneas. Esto significa que las polilíneas de rutas no pueden tener una opción de visibilidad menos restrictiva.

Debes seguir estas reglas para proporcionar una combinación válida de polilíneas de ruta y de visibilidad de la ubicación del vehículo:

  • Cuando las polilíneas de la ruta y la ubicación del vehículo tienen el mismo tipo de opción de visibilidad, ocurre lo siguiente:

    • Si la opción de visibilidad corresponde al recuento de paradas restante, la duración hasta la hora de llegada estimada o la distancia de conducción restante, las polilíneas de la ruta deben proporcionar un valor menor o igual que el valor establecido para esta opción de visibilidad para la ubicación del vehículo. A continuación, se muestra un ejemplo:
    "taskTrackingViewConfig": {
  "routePolylinePointsVisibility": {
    "remainingStopCountThreshold": 3
  },
  "vehicleLocationVisibility": {
    "remainingStopCountThreshold": 5
  },
}
    • Si las polilíneas de ruta tienen una opción de visibilidad siempre visible, la ubicación del vehículo también debe proporcionar esta opción.
    • Si la ubicación del vehículo tiene una opción de visibilidad nunca visible, las polilíneas de la ruta también deben proporcionar esa opción.

  • Cuando las polilíneas de la ruta y la ubicación del vehículo tienen tipos de opciones de visibilidad diferentes, la ubicación del vehículo solo es visible cuando se cumplen ambas opciones de visibilidad.

    A continuación, se muestra un ejemplo:

    "taskTrackingViewConfig": {
  "routePolylinePointsVisibility": {
    "remainingStopCountThreshold": 3
  },
  "vehicleLocationVisibility": {
    "remainingDrivingDistanceMetersThreshold": 3000
  },
}

    En este ejemplo, la ubicación del vehículo solo es visible si el recuento de paradas restante es de al menos 3 Y la distancia de conducción restante es de al menos 3,000 metros.

Cómo comenzar a usar la Biblioteca de recorridos compartidos de JavaScript

Antes de usar la biblioteca de JavaScript Journey Share, asegúrate de estar familiarizado con Fleet Engine y con obtener una clave de API.

Para hacer un seguimiento de una entrega, primero crea un reclamo de ID de seguimiento.

Cómo crear un reclamo de ID de seguimiento

Para realizar un seguimiento de un envío mediante el proveedor de ubicación de envío, crea un token web JSON (JWT) con una reclamación de ID de seguimiento.

Para crear la carga útil de JWT, agrega una reclamación adicional en la sección de autorización con la clave trackingid. Establece su valor según el ID de seguimiento del envío.

En el siguiente ejemplo, se muestra cómo crear un token para realizar un seguimiento por ID de seguimiento:

{
  "alg": "RS256",
  "typ": "JWT",
  "kid": "private_key_id_of_consumer_service_account"
}
.
{
  "iss": "consumer@yourgcpproject.iam.gserviceaccount.com",
  "sub": "consumer@yourgcpproject.iam.gserviceaccount.com",
  "aud": "https://fleetengine.googleapis.com/",
  "iat": 1511900000,
  "exp": 1511903600,
  "scope": "https://www.googleapis.com/auth/xapi",
  "authorization": {
     "trackingid": "tid_54321",
   }
}

Crea un recuperador de tokens de autenticación

Puedes crear un recuperador de tokens de autenticación para recuperar un token emitido con las reclamaciones apropiadas en tus servidores mediante un certificado de cuenta de servicio para tu proyecto. Es importante crear solo tokens en tus servidores y nunca compartir tus certificados con ningún cliente. De lo contrario, pondrás en riesgo la seguridad de tu sistema.

El recuperador debe mostrar una estructura de datos con dos campos, unidos en una promesa:

  • Una cadena token
  • Un número expiresInSeconds. Un token vence en este período después de la recuperación.

La biblioteca de seguimiento de envíos de JavaScript solicita un token a través del recuperador de tokens de autenticación cuando se cumple alguna de las siguientes condiciones:

  • No tiene un token válido, como cuando no llama al recuperador cuando se carga una página nueva o cuando el recuperador no ha devuelto con un token.
  • El token que recuperó ya venció.
  • El token que recuperó está en el plazo de un minuto a partir de su vencimiento.

De lo contrario, la biblioteca usa el token válido que se emitió anteriormente y no llama al recuperador.

En el siguiente ejemplo, se muestra cómo crear un recuperador de token de autenticación:

JavaScript

function authTokenFetcher(options) {
  // options is a record containing two keys called
  // serviceType and context. The developer should
  // generate the correct SERVER_TOKEN_URL and request
  // based on the values of these fields.
  const response = await fetch(SERVER_TOKEN_URL);
  if (!response.ok) {
    throw new Error(response.statusText);
  }
  const data = await response.json();
  return {
    token: data.Token,
    expiresInSeconds: data.ExpiresInSeconds
  };
}

TypeScript

function authTokenFetcher(options: {
  serviceType: google.maps.journeySharing.FleetEngineServiceType,
  context: google.maps.journeySharing.AuthTokenContext,
}): Promise<google.maps.journeySharing.AuthToken> {
  // The developer should generate the correct
  // SERVER_TOKEN_URL based on options.
  const response = await fetch(SERVER_TOKEN_URL);
  if (!response.ok) {
    throw new Error(response.statusText);
  }
  const data = await response.json();
  return {
    token: data.token,
    expiresInSeconds: data.expiration_timestamp_ms - Date.now(),
  };
}

Cuando implementes el extremo del servidor para acuñar los tokens, ten en cuenta lo siguiente:

  • El extremo debe mostrar una hora de vencimiento para el token; en el ejemplo anterior, se da como data.ExpiresInSeconds.
  • El recuperador de tokens de autenticación debe pasar la hora de vencimiento (en segundos, desde el momento de la recuperación) a la biblioteca, como se muestra en el ejemplo.
  • SERVER_TOKEN_URL depende de tu implementación de backend. Estas son las URLs para el backend de la app de ejemplo:
    • https://SERVER_URL/token/delivery_driver/DELIVERY_VEHICLE_ID
    • https://SERVER_URL/token/delivery_consumer/TRACKING_ID
    • https://SERVER_URL/token/fleet_reader

Cómo cargar un mapa desde HTML

En el siguiente ejemplo, se muestra cómo cargar la biblioteca de seguimiento de envío de JavaScript desde una URL especificada. El parámetro devolución de llamada ejecuta la función initMap después de que se carga la API. El atributo defer permite que el navegador continúe renderizando el resto de tu página mientras se carga la API.

<script src="https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY&callback=initMap&libraries=journeySharing" defer></script>

Sigue un envío

En esta sección, se muestra cómo usar la biblioteca de seguimiento de envíos de JavaScript para seguir el retiro o la entrega de un envío. Asegúrate de cargar la biblioteca desde la función de devolución de llamada especificada en la etiqueta de la secuencia de comandos antes de ejecutar el código.

Cómo crear una instancia de un proveedor de ubicación de envío

La biblioteca de seguimiento de envío de JavaScript predefine un proveedor de ubicación para la API de entrega de Flet Engine. Usa el ID del proyecto y una referencia a la fábrica de tokens para crear una instancia.

JavaScript

locationProvider =
    new google.maps.journeySharing
        .FleetEngineShipmentLocationProvider({
          projectId: 'your-project-id',
          authTokenFetcher: authTokenFetcher, // the token fetcher defined in the previous step

          // Optionally, you may specify tracking ID to
          // immediately start tracking.
          trackingId: 'your-tracking-id',
});

TypeScript

locationProvider =
    new google.maps.journeySharing
        .FleetEngineShipmentLocationProvider({
          projectId: 'your-project-id',
          authTokenFetcher: authTokenFetcher, // the token fetcher defined in the previous step

          // Optionally, you may specify tracking ID to
          // immediately start tracking.
          trackingId: 'your-tracking-id',
});

Cómo inicializar la vista de mapa

Después de cargar la biblioteca de JavaScript Journey Share, inicializa la vista de mapa y agrégala a la página HTML. Tu página debe contener un elemento <div> que contenga la vista de mapa. En el siguiente ejemplo, el elemento <div> se llama map_canvas.

Para evitar condiciones de carrera, establece el ID de seguimiento del proveedor de ubicación en la devolución de llamada que se invoca después de inicializar el mapa.

JavaScript

const mapView = new 
    google.maps.journeySharing.JourneySharingMapView({
  element: document.getElementById('map_canvas'), 
  locationProviders: [locationProvider],
  vehicleMarkerSetup: vehicleMarkerSetup,
  anticipatedRoutePolylineSetup:
      anticipatedRoutePolylineSetup,
  // Any undefined styling options will use defaults.
});

// If you did not specify a tracking ID in the location
// provider constructor, you may do so here.
// Location tracking will start as soon as this is set.
locationProvider.trackingId = 'your-tracking-id';

// Give the map an initial viewport to allow it to 
// initialize; otherwise the 'ready' event above may 
// not fire. The user also has access to the mapView
// object to customize as they wish.
mapView.map.setCenter({lat: 37.2, lng: -121.9});
mapView.map.setZoom(14);

TypeScript

const mapView = new 
    google.maps.journeySharing.JourneySharingMapView({
  document.getElementById('map_canvas'),
  locationProviders: [locationProvider],
  vehicleMarkerSetup: vehicleMarkerSetup,
  anticipatedRoutePolylineSetup:
      anticipatedRoutePolylineSetup,
 // Any undefined styling options will use defaults.
});

// If you did not specify a tracking ID in the location
// provider constructor, you may do so here.
// Location tracking will start as soon as this is set.
locationProvider.trackingId = 'your-tracking-id';

// Give the map an initial viewport to allow it to
// initialize; otherwise the 'ready' event above may 
// not fire. The user also has access to the mapView
// object to customize as they wish.
mapView.map.setCenter({lat: 37.2, lng: -121.9});
mapView.map.setZoom(14);

ID de seguimiento

El ID de seguimiento proporcionado al proveedor de ubicación puede corresponder a varias tareas, por ejemplo, una tarea de retiro y entrega para el mismo paquete, o varios intentos de entrega fallidos. Se selecciona una tarea para que se muestre en el mapa de seguimiento del envío. La tarea que se mostrará se determina de la siguiente manera:

  1. Si hay exactamente una tarea de retiro abierta, se muestra. Se genera un error si hay varias tareas de retiro abiertas.
  2. Si hay exactamente una tarea de entrega abierta, se mostrará. Se genera un error si hay varias tareas de entrega abiertas.
  3. Si hay tareas de entrega cerradas, haz lo siguiente:
    • Si hay exactamente una tarea de entrega cerrada, se muestra.
    • Si hay varias tareas de entrega cerradas, se mostrará la que tenga el tiempo de resultado más reciente.
    • Si hay varias tareas de entrega cerradas, ninguna de las cuales tiene un tiempo de resultado, se genera un error.
  4. Si hay tareas de retiro cerradas, haz lo siguiente:
    • Si hay exactamente una tarea de retiro cerrada, se muestra.
    • Si hay varias tareas de retiro cerradas, se mostrará la que tenga la hora de resultado más reciente.
    • Si hay varias tareas de retiro cerradas y ninguna de ellas tiene un tiempo de resultado, se genera un error.
  5. De lo contrario, no se muestra ninguna tarea.

Cómo escuchar eventos de cambio

Puedes recuperar información meta sobre una tarea desde el objeto de información de seguimiento de tareas mediante el proveedor de ubicación. La metainformación incluye la hora de llegada estimada, la cantidad de paradas restantes y la distancia restante antes de la recogida o la entrega. Los cambios en la metainformación activan un evento update. En el siguiente ejemplo, se muestra cómo escuchar estos eventos de cambio.

JavaScript

locationProvider.addListener('update', e => {
  // e.taskTrackingInfo contains data that may be useful
  // to the rest of the UI.
  console.log(e.taskTrackingInfo.remainingStopCount);
});

TypeScript

locationProvider.addListener('update',
    (e: google.maps.journeySharing.FleetEngineShipmentLocationProviderUpdateEvent) => {
  // e.taskTrackingInfo contains data that may be useful
  // to the rest of the UI.
  console.log(e.taskTrackingInfo.remainingStopCount);
});

Cómo solucionar errores

Los errores que surgen de forma asíncrona cuando se solicita información de envío activan eventos de error. En el siguiente ejemplo, se muestra cómo escuchar estos eventos para controlar los errores.

JavaScript

locationProvider.addListener('error', e => {
  // e.error is the error that triggered the event.
  console.error(e.error);
});

TypeScript

locationProvider.addListener('error', (e: google.maps.ErrorEvent) => {
  // e.error is the error that triggered the event.
  console.error(e.error);
});

Nota: Asegúrate de unir las llamadas a la biblioteca en bloques try...catch para controlar errores inesperados.

Detener el seguimiento

Para evitar que el proveedor de ubicación realice el seguimiento del envío, quita el ID de seguimiento del proveedor de ubicación.

JavaScript

locationProvider.trackingId = '';

TypeScript

locationProvider.trackingId = '';

Quitar el proveedor de ubicación de la vista de mapa

En el siguiente ejemplo, se muestra cómo quitar un proveedor de ubicación de la vista de mapa.

JavaScript

mapView.removeLocationProvider(locationProvider);

TypeScript

mapView.removeLocationProvider(locationProvider);

Personalizar la apariencia del mapa base

Para personalizar el aspecto del componente de mapas, aplica diseño a tu mapa con herramientas basadas en la nube o estableciendo opciones directamente en el código.

Cómo usar el diseño de mapas basado en Cloud

El diseño de mapas basado en Cloud te permite crear y editar diseños de mapa para cualquiera de tus apps que usen Google Maps desde la consola de Google Cloud, sin necesidad de hacer cambios en tu código. Los diseños de mapa se guardan como IDs de mapa en tu proyecto de Cloud. Para aplicar un diseño a tu mapa de seguimiento de envíos de JavaScript, especifica un mapId cuando crees el JourneySharingMapView. El campo mapId no se puede cambiar ni agregar después de crear una instancia de JourneySharingMapView. En el siguiente ejemplo, se muestra cómo habilitar un diseño de mapa creado anteriormente con un ID de mapa.

JavaScript

const mapView = new google.maps.journeySharing.JourneySharingMapView({
  element: document.getElementById('map_canvas'),
  locationProviders: [locationProvider],
  mapOptions: {
    mapId: 'YOUR_MAP_ID'
  }
  // Any other styling options.
});

TypeScript

const mapView = new google.maps.journeySharing.JourneySharingMapView({
  element: document.getElementById('map_canvas'),
  locationProviders: [locationProvider],
  mapOptions: {
    mapId: 'YOUR_MAP_ID'
  }
  // Any other styling options.
});

Usa el diseño de mapas basado en código

Otra forma de personalizar el diseño de mapa es establecer mapOptions cuando crees el JourneySharingMapView.

JavaScript

const mapView = new google.maps.journeySharing.JourneySharingMapView({
  element: document.getElementById('map_canvas'),
  locationProviders: [locationProvider],
  mapOptions: {
    styles: [
      {
        "featureType": "road.arterial",
        "elementType": "geometry",
        "stylers": [
          { "color": "#CCFFFF" }
        ]
      }
    ]
  }
});

TypeScript

const mapView = new google.maps.journeySharing.JourneySharingMapView({
  element: document.getElementById('map_canvas'),
  locationProviders: [locationProvider],
  mapOptions: {
    styles: [
      {
        "featureType": "road.arterial",
        "elementType": "geometry",
        "stylers": [
          { "color": "#CCFFFF" }
        ]
      }
    ]
  }
});

Cómo usar las personalizaciones de los marcadores

Con la biblioteca de seguimiento de envíos de JavaScript, puedes personalizar el aspecto de los marcadores que se agregan al mapa. Para ello, especifica las personalizaciones de los marcadores, que la biblioteca de seguimiento de envíos aplica antes de agregar marcadores al mapa y con cada actualización de los marcadores.

La personalización más simple consiste en especificar un objeto MarkerOptions que se aplicará a todos los marcadores del mismo tipo. Los cambios especificados en el objeto se aplican después de crear cada marcador y reemplazan cualquier opción predeterminada.

Una opción más avanzada es especificar una función de personalización. Las funciones de personalización permiten diseñar los marcadores según los datos y agregarles interactividad, como el manejo de clics. Específicamente, el seguimiento de envíos pasa datos a la función de personalización sobre el tipo de objeto que representa el marcador: vehículo o destino. Esto permite que el diseño del marcador cambie en función del estado actual del elemento del marcador (por ejemplo, la cantidad de paradas planificadas que faltan hasta el destino). Incluso puedes unirlos a datos de fuentes externas a Fleet Engine y definir el diseño del marcador en función de esa información.

La biblioteca de Shipment Tracking proporciona los siguientes parámetros de personalización en FleetEngineShipmentLocationProviderOptions:

Cómo cambiar el estilo de los marcadores con MarkerOptions

En el siguiente ejemplo, se muestra cómo configurar el diseño de un marcador de vehículo con un objeto MarkerOptions. Sigue este patrón para personalizar el diseño de cualquier marcador con cualquiera de las personalizaciones de marcadores mencionadas anteriormente.

JavaScript

deliveryVehicleMarkerCustomization = {
  cursor: 'grab'
};

TypeScript

deliveryVehicleMarkerCustomization = {
  cursor: 'grab'
};

Cómo cambiar el estilo de los marcadores con las funciones de personalización

En el siguiente ejemplo, se muestra cómo configurar el diseño de un marcador de vehículo. Sigue este patrón para personalizar el diseño de cualquier marcador con cualquiera de los parámetros de personalización de marcadores mencionados anteriormente.

JavaScript

deliveryVehicleMarkerCustomization =
  (params) => {
    var stopsLeft = params.taskTrackingInfo.remainingStopCount;
    params.marker.setLabel(`${stopsLeft}`);
  };

TypeScript

deliveryVehicleMarkerCustomization =
  (params: ShipmentMarkerCustomizationFunctionParams) => {
    const stopsLeft = params.taskTrackingInfo.remainingStopCount;
    params.marker.setLabel(`${stopsLeft}`);
  };

Cómo agregar control de clics a los marcadores

En el siguiente ejemplo, se muestra cómo agregar el control de clics a un marcador de vehículo. Sigue este patrón para agregar el control de clics a cualquier marcador usando cualquiera de los parámetros de personalización de marcadores mencionados anteriormente.

JavaScript

deliveryVehicleMarkerCustomization =
  (params) => {
    if (params.isNew) {
      params.marker.addListener('click', () => {
        // Perform desired action.
      });
    }
  };

TypeScript

deliveryVehicleMarkerCustomization =
  (params: ShipmentMarkerCustomizationFunctionParams) => {
    if (params.isNew) {
      params.marker.addListener('click', () => {
        // Perform desired action.
      });
    }
  };

Cómo personalizar las polilíneas

Con la biblioteca de seguimiento de envíos, también puedes personalizar el aspecto de la ruta del envío en el mapa. La biblioteca crea un objeto google.maps.Polyline para cada par de coordenadas en la ruta activa o restante del envío. Puedes aplicar ajustes de diseño a los objetos Polyline especificando personalizaciones de polilíneas. Luego, la biblioteca aplica estas personalizaciones en dos situaciones: antes de agregar los objetos al mapa y cuando los datos utilizados para los objetos cambian.

Al igual que con la personalización de marcadores, puedes especificar un conjunto de PolylineOptions para que se aplique a todos los objetos Polyline coincidentes cuando se creen o actualicen.

Del mismo modo, puedes especificar una función de personalización. Las funciones de personalización permiten un diseño individual de los objetos según los datos que envía Fleet Engine. La función puede cambiar el diseño de cada objeto según el estado actual del envío; por ejemplo, si le aplicas un color más profundo al objeto Polyline o lo hace más grueso cuando el vehículo se mueve más lento. Incluso puedes unirte desde fuentes fuera de Fleet Engine y diseñar el objeto Polyline en función de esa información.

Puedes especificar las personalizaciones con los parámetros proporcionados en FleetEngineShipmentLocationProviderOptions. Puedes configurar personalizaciones para diferentes estados de ruta en el recorrido del vehículo (ya recorrido, viajando activamente o aún no recorrido). Los parámetros son los siguientes:

Cambia el diseño de los objetos Polyline con PolylineOptions

En el siguiente ejemplo, se muestra cómo configurar el diseño de un objeto Polyline con PolylineOptions. Sigue este patrón para personalizar el diseño de cualquier objeto Polyline con cualquiera de las personalizaciones de polilíneas mencionadas anteriormente.

JavaScript

activePolylineCustomization = {
  strokeWidth: 5,
  strokeColor: 'black',
};

TypeScript

activePolylineCustomization = {
  strokeWidth: 5,
  strokeColor: 'black',
};

Cambia el estilo de los objetos Polyline con las funciones de personalización

En el siguiente ejemplo, se muestra cómo configurar el diseño de un objeto Polyline activo. Sigue este patrón para personalizar el diseño de cualquier objeto Polyline con cualquiera de los parámetros de personalización de polilíneas mencionados anteriormente.

JavaScript

// Color the Polyline objects in green if the vehicle is nearby.
activePolylineCustomization =
  (params) => {
    const distance = params.taskTrackingInfo.remainingDrivingDistanceMeters;
    if (distance < 1000) {

      // params.polylines contains an ordered list of Polyline objects for
      // the path.
      for (const polylineObject of params.polylines) {
        polylineObject.setOptions({strokeColor: 'green'});
      }
    }
  };

TypeScript

// Color the Polyline objects in green if the vehicle is nearby.
activePolylineCustomization =
  (params: ShipmentPolylineCustomizationFunctionParams) => {
    const distance = params.taskTrackingInfo.remainingDrivingDistanceMeters;
    if (distance < 1000) {

      // params.polylines contains an ordered list of Polyline objects for
      // the path.
      for (const polylineObject of params.polylines) {
        polylineObject.setOptions({strokeColor: 'green'});
      }
    }
  };

Controla la visibilidad de los objetos Polyline

De forma predeterminada, todos los objetos Polyline son visibles. Para hacer que un objeto Polyline sea invisible, configura su propiedad visible:

JavaScript

remainingPolylineCustomization = {visible: false};

TypeScript

remainingPolylineCustomization = {visible: false};

Cómo mostrar una InfoWindow para un marcador de ubicación o vehículo

Puedes usar un objeto InfoWindow para mostrar información adicional sobre un marcador de ubicación o vehículo.

En el siguiente ejemplo, se muestra cómo crear un objeto InfoWindow y adjuntarlo a un marcador de vehículo:

JavaScript

// 1. Create an info window.
const infoWindow = new google.maps.InfoWindow(
    {disableAutoPan: true});

locationProvider.addListener('update', e => {
  const stopsCount =
      e.taskTrackingInfo.remainingStopCount;
  infoWindow.setContent(
      `Your vehicle is ${stopsCount} stops away.`);

  // 2. Attach the info window to a vehicle marker.
  // This property can return multiple markers.
  const marker = mapView.vehicleMarkers[0];
  infoWindow.open(mapView.map, marker);
});

// 3. Close the info window.
infoWindow.close();

TypeScript

// 1. Create an info window.
const infoWindow = new google.maps.InfoWindow(
    {disableAutoPan: true});

locationProvider.addListener('update', (e: google.maps.journeySharing.FleetEngineShipmentLocationProviderUpdateEvent) => {
  const stopsCount =
      e.taskTrackingInfo.remainingStopCount;
  infoWindow.setContent(
      `Your vehicle is ${stopsCount} stops away.`);

  // 2. Attach the info window to a vehicle marker.
  // This property can return multiple markers.
  const marker = mapView.vehicleMarkers[0];
  infoWindow.open(mapView.map, marker);
});

// 3. Close the info window.
infoWindow.close();

Inhabilitar el ajuste automático

Puedes impedir que el mapa ajuste automáticamente el viewport al vehículo y a la ruta prevista si inhabilitas el ajuste automático. En el siguiente ejemplo, se muestra cómo inhabilitar el ajuste automático cuando configuras la vista de mapa para compartir el recorrido.

JavaScript

const mapView = new
    google.maps.journeySharing.JourneySharingMapView({
  element: document.getElementById('map_canvas'),
  locationProviders: [locationProvider],
  automaticViewportMode:
      google.maps.journeySharing
          .AutomaticViewportMode.NONE,
  ...
});

TypeScript

// 1. Create an info window.
const infoWindow = new google.maps.InfoWindow(
    {disableAutoPan: true});

locationProvider.addListener('update', (e: google.maps.journeySharing.FleetEngineShipmentLocationProviderUpdateEvent) => {
  const stopsCount =
      e.taskTrackingInfo.remainingStopCount;
  infoWindow.setContent(
      `Your vehicle is ${stopsCount} stops away.`);

  // 2. Attach the info window to a vehicle marker.   
  // This property can return multiple markers.
  const marker = mapView.vehicleMarkers[0];
  infoWindow.open(mapView.map, marker);
});

// 3. Close the info window.
infoWindow.close();

Cómo reemplazar un mapa existente

Puedes utilizar la biblioteca de seguimiento de envíos de JavaScript para reemplazar un mapa existente que incluya marcadores y otras personalizaciones sin perderlas.

Por ejemplo, supongamos que tienes una página web con una entidad google.maps.Map estándar en la que se muestra un marcador:

<!DOCTYPE html>
<html>
  <head>
    <style>
       /* Set the size of the div element that contains the map */
      #map {
        height: 400px;  /* The height is 400 pixels */
        width: 100%;  /* The width is the width of the web page */
       }
    </style>
  </head>
  <body>
    <h3>My Google Maps Demo</h3>
    <!--The div element for the map -->
    <div id="map"></div>
    <script>
// Initialize and add the map
function initMap() {
  // The location of Uluru
  var uluru = {lat: -25.344, lng: 131.036};
  // The map, initially centered at Mountain View, CA.
  var map = new google.maps.Map(document.getElementById('map'));
  map.setOptions({center: {lat: 37.424069, lng: -122.0916944}, zoom: 14});

  // The marker, now positioned at Uluru
  var marker = new google.maps.Marker({position: uluru, map: map});
}
    </script>
    <!-- Load the API from the specified URL.
       * The async attribute allows the browser to render the page while the API loads.
       * The key parameter will contain your own API key (which is not needed for this tutorial).
       * The callback parameter executes the initMap() function.
    -->
    <script defer src="https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY&callback=initMap">
    </script>
  </body>
</html>

Para agregar la biblioteca de JavaScript Journey Share, sigue estos pasos:

  1. Agrega el código para la fábrica del token de autenticación.
  2. Inicializa un proveedor de ubicación en la función initMap().
  3. Inicializa la vista de mapa en la función initMap(). La vista contiene el mapa.
  4. Mueve tu personalización a la función de devolución de llamada para inicializar la vista de mapa.
  5. Agrega la biblioteca de ubicaciones al cargador de API.

En el siguiente ejemplo, se muestran los cambios que se deben realizar:

<!DOCTYPE html>
<html>
  <head>
    <style>
       /* Set the size of the div element that contains the map */
      #map {
        height: 400px;  /* The height is 400 pixels */
        width: 100%;  /* The width is the width of the web page */
       }
    </style>
  </head>
  <body>
    <h3>My Google Maps Demo</h3>
    <!--The div element for the map -->
    <div id="map"></div>
    <script>
let locationProvider;

// (1) Authentication Token Fetcher
function authTokenFetcher(options) {
  // options is a record containing two keys called 
  // serviceType and context. The developer should
  // generate the correct SERVER_TOKEN_URL and request
  // based on the values of these fields.
  const response = await fetch(SERVER_TOKEN_URL);
      if (!response.ok) {
        throw new Error(response.statusText);
      }
      const data = await response.json();
      return {
        token: data.Token,
        expiresInSeconds: data.ExpiresInSeconds
      };
}

// Initialize and add the map
function initMap() {
  // (2) Initialize location provider.
  locationProvider = new google.maps.journeySharing.FleetEngineShipmentLocationProvider({
    YOUR_PROVIDER_ID,
    authTokenFetcher,
  });

  // (3) Initialize map view (which contains the map).
  const mapView = new google.maps.journeySharing.JourneySharingMapView({
    element: document.getElementById('map'),
    locationProviders: [locationProvider],
    // any styling options
  });

  locationProvider.trackingId = TRACKING_ID;

    // (4) Add customizations like before.

    // The location of Uluru
    var uluru = {lat: -25.344, lng: 131.036};
    // The map, initially centered at Mountain View, CA.
    var map = mapView.map;
    map.setOptions({center: {lat: 37.424069, lng: -122.0916944}, zoom: 14});
    // The marker, now positioned at Uluru
    var marker = new google.maps.Marker({position: uluru, map: map});
  };

    </script>
    <!-- Load the API from the specified URL
      * The async attribute allows the browser to render the page while the API loads
      * The key parameter will contain your own API key (which is not needed for this tutorial)
      * The callback parameter executes the initMap() function
      *
      * (5) Add the journey sharing library to the API loader.
    -->
    <script defer
    src="https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY&callback=initMap&libraries=journeySharing">
    </script>
  </body>
</html>

Si tienes un paquete rastreado con el ID especificado cerca de Uluru, ahora se renderizará en el mapa.