Rastrear remessas com a biblioteca de rastreamento de envio JavaScript

A biblioteca JavaScript Shipment Tracking permite visualizar a localização de veículos e os locais de interesse rastreados no Fleet Engine. A biblioteca contém um componente de mapa JavaScript que é uma substituição simples para uma entidade google.maps.Map padrão e componentes de dados para se conectar ao Fleet Engine. Com a biblioteca JavaScript Shipment Tracking, você poderá oferecer uma experiência de rastreamento de remessa animada e personalizável a partir do seu aplicativo da Web.

Componentes

A biblioteca JavaScript Shipment Tracking fornece componentes para visualização do veículo e do trajeto à medida que ele avança até um destino, além de feeds de dados brutos para o HEC de um motorista ou a distância restante.

Visualização de mapa do rastreamento de envio

O componente de visualização de mapa mostra a localização de veículos e destinos. Se o trajeto de um veículo for conhecido, o componente de visualização de mapa vai animar o veículo à medida que ele se mover pelo caminho previsto.

Provedor do local de envio

Um provedor de localização de remessas insere informações de localização de objetos rastreados no mapa de rastreamento de entregas na primeira e última milha.

Você pode usar o provedor de localização de remessa para rastrear:

  • O local de retirada ou entrega de uma remessa.
  • A localização e a rota do veículo de entrega.

Objetos de local rastreados

O provedor de localização rastreia a localização de objetos, como veículos e destinos.

Local de destino

O local de destino é o local onde uma jornada termina. Para o rastreamento de remessas, é o local da tarefa planejada.

Localização do veículo

O local do veículo é o local monitorado de um veículo. Ele pode incluir um trajeto para o veículo.

Coletor de tokens de autenticação

Para controlar o acesso aos dados de local armazenados no Fleet Engine, implemente um serviço de criação de JSON Web Token (JWT) para o Fleet Engine no seu servidor. Em seguida, implemente um coletor de tokens de autenticação como parte do seu aplicativo da Web, usando a biblioteca de compartilhamento de jornada do JavaScript para autenticar o acesso aos dados de local.

Opções de estilo

Os estilos de marcador e polilinha determinam a aparência dos objetos de local rastreados no mapa. Use as opções de estilo personalizado para alterar o estilo padrão de acordo com o do seu aplicativo da Web.

Controlar a visibilidade dos locais rastreados

Esta seção descreve os controles de visibilidade para objetos rastreados no mapa. Essas regras se aplicam a duas categorias de objetos:

  • Marcador de local
  • Dados da tarefa

Visibilidade do marcador de local

Todos os marcadores de local para a origem e o destino são sempre mostrados no mapa. Por exemplo, um local de entrega de remessa é sempre mostrado no mapa, independentemente do estado da entrega.

Visibilidade dos dados da tarefa

Nesta seção, descrevemos as regras de visibilidade padrão que se aplicam aos dados da tarefa, como a localização do veículo e o trajeto restante. É possível personalizar muitas tarefas, mas não todas:

  • Tarefas de indisponibilidade: não é possível personalizar a visibilidade dessas tarefas.
  • Tarefas ativas no veículo : você pode personalizar esse tipo de tarefa.
  • Tarefas com veículos inativos -- Não é possível personalizar a visibilidade dessas tarefas.

Tarefas de indisponibilidade

Se houver pelo menos uma tarefa de indisponibilidade (por exemplo, o motorista está fazendo uma pausa ou se o veículo está sendo reabastecido) no trajeto até a tarefa que está sendo rastreada, o veículo não será visível. O horário estimado de chegada e o tempo estimado de conclusão da tarefa ainda estão disponíveis.

Tarefas ativas com o veículo

O objeto TaskTrackingInfo fornece vários elementos de dados que podem ser visualizados na Biblioteca Shipment Tracking. Por padrão, esses campos ficam visíveis quando a tarefa é atribuída ao veículo e quando o veículo está a até cinco paradas da tarefa. A visibilidade termina quando a tarefa é concluída ou cancelada. Os campos são os seguintes:

  • Polilinhas do trajeto
  • Tempo estimado para chegada
  • Tempo estimado para a conclusão da tarefa
  • Distância de carro restante até a tarefa
  • Contagem de paradas restantes
  • Localização do veículo

É possível personalizar a configuração de visibilidade para cada tarefa, definindo o TaskTrackingViewConfig em uma tarefa ao criar ou atualizar a tarefa no Fleet Engine. Isso cria regras de quando elementos de dados individuais estão disponíveis. Elas podem ser baseadas nos seguintes critérios (chamados de opção de visibilidade abaixo):

  • Contagem de paradas restantes
  • Duração até o horário previsto de chegada
  • Distância de carro restante
  • Sempre visível
  • Nunca visíveis

Cada elemento de dados só pode ser associado a uma opção de visibilidade. Não é possível combinar critérios usando OR ou AND.

Confira abaixo um exemplo de personalização. As regras dessa personalização são:

  • Mostre as polilinhas do trajeto se o veículo estiver a até três paradas.
  • Mostrar o HEC se a distância de carro restante for menor do que 5.000 metros.
  • Nunca mostrar o número de paradas restantes.
  • Todos os outros campos mantêm a visibilidade padrão mostrada quando o veículo está a cinco paradas da tarefa.
"taskTrackingViewConfig": {
  "routePolylinePointsVisibility": {
    "remainingStopCountThreshold": 3
  },
  "estimatedArrivalTimeVisibility": {
    "remainingDrivingDistanceMetersThreshold": 5000
  },
  "remainingStopCountVisibility": {
    "never": true
  }
}

Você também pode personalizar a configuração de visibilidade padrão para seu projeto. Para isso, entre em contato com a equipe de suporte.

Regras de visibilidade da localização de veículos e polilinhas do trajeto:

Quando as polilinhas do trajeto estão visíveis, a localização do veículo também precisa estar visível. Caso contrário, ela pode ser indicada pelo final das polilinhas. Isso significa que as polilinhas do trajeto não podem ter uma opção de visibilidade menos restritiva.

Estas regras precisam ser seguidas para fornecer uma combinação válida de polilinhas do trajeto e visibilidade do local do veículo:

  • Quando as polilinhas do trajeto e a localização do veículo têm o mesmo tipo de opção de visibilidade:

    • Se a opção de visibilidade for o número de paradas restantes, a duração até o HEC ou a distância restante de carro, as polilinhas do trajeto precisam ter um valor menor ou igual ao definido nessa opção de visibilidade para o local do veículo. Confira um exemplo:
    "taskTrackingViewConfig": {
  "routePolylinePointsVisibility": {
    "remainingStopCountThreshold": 3
  },
  "vehicleLocationVisibility": {
    "remainingStopCountThreshold": 5
  },
}
    • Se as polilinhas do trajeto tiverem uma opção de visibilidade sempre visível, a localização do veículo também precisará fornecer uma opção de visibilidade sempre visível.
    • Se a localização do veículo tiver uma opção de visibilidade "Nunca visível", as polilinhas do trajeto também precisarão fornecer a opção "Nunca visível".

  • Quando as polilinhas do trajeto e a localização do veículo têm tipos de opção de visibilidade diferentes, a localização do veículo só aparece quando as duas opções de visibilidade são satisfeitas.

    Confira um exemplo:

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

    Neste exemplo, a localização do veículo só fica visível se o número de paradas restantes for pelo menos três E a distância de carro restante for de pelo menos 3.000 metros.

Introdução à biblioteca de compartilhamento de jornada do JavaScript

Antes de usar a biblioteca de compartilhamento de jornada JavaScript, conheça o Fleet Engine e saiba como acessar uma chave de API.

Para rastrear uma entrega, primeiro crie uma reivindicação de ID de acompanhamento.

Criar uma reivindicação do ID de acompanhamento

Para rastrear uma remessa usando o provedor de local de envio, crie um JSON Web Token (JWT) com uma declaração de ID de rastreamento.

Para criar o payload do JWT, adicione uma declaração extra na seção de autorização com a chave trackingid. Defina o valor como o ID de rastreamento de frete.

O exemplo a seguir mostra como criar um token para acompanhamento por ID de acompanhamento:

{
  "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",
   }
}

Criar um coletor de tokens de autenticação

É possível criar um coletor de tokens de autenticação para recuperar um token criado com as declarações apropriadas nos seus servidores usando o certificado de conta de serviço do seu projeto. É importante criar tokens apenas nos seus servidores e nunca compartilhar seus certificados com nenhum cliente. Caso contrário, você comprometerá a segurança do sistema.

O coletor precisa retornar uma estrutura de dados com dois campos, encapsulados em uma promessa:

  • Uma string token.
  • Um número expiresInSeconds. Um token expira nesse período após a busca.

A biblioteca JavaScript Shipment Tracking solicita um token pelo coletor de tokens de autenticação quando uma das seguintes condições é verdadeira:

  • Não tem um token válido, como quando não chamou o coletor em um novo carregamento de página ou quando o coletor não retornou com um token.
  • O token buscado anteriormente expirou.
  • O token buscado anteriormente está dentro de um minuto para expirar.

Caso contrário, a biblioteca vai usar o token válido emitido anteriormente e não chamará o coletor.

O exemplo a seguir mostra como criar um coletor de tokens de autenticação:

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(),
  };
}

Ao implementar o endpoint do lado do servidor para criar os tokens, lembre-se do seguinte:

  • O endpoint precisa retornar um prazo de validade para o token. No exemplo acima, ele é fornecido como data.ExpiresInSeconds.
  • O coletor de tokens de autenticação precisa passar o tempo de expiração (em segundos, a partir do momento da busca) para a biblioteca, conforme mostrado no exemplo.
  • O SERVER_TOKEN_URL depende da implementação do back-end. Estes são os URLs do back-end do app de exemplo:
    • https://SERVER_URL/token/delivery_driver/DELIVERY_VEHICLE_ID
    • https://SERVER_URL/token/delivery_consumer/TRACKING_ID
    • https://SERVER_URL/token/fleet_reader

Carregar um mapa usando o HTML

O exemplo abaixo mostra como carregar a biblioteca JavaScript Shipment Tracking de um URL especificado. O parâmetro callback executa a função initMap após o carregamento da API. O atributo defer permite que o navegador continue renderizando o restante da página enquanto a API é carregada.

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

Seguir uma remessa

Nesta seção, mostramos como usar a biblioteca JavaScript Shipment Tracking para acompanhar a coleta ou a entrega de um frete. Carregue a biblioteca da função de callback especificada na tag de script antes de executar o código.

Instancie um provedor de localização de remessas

A biblioteca JavaScript Shipment Tracking predefine um provedor de localização para a API Fleet Engine Deliveries. Use seu ID do projeto e uma referência à sua fábrica de tokens para instanciá-lo.

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',
});

Inicializar a visualização de mapa

Depois de carregar a biblioteca, inicialize a visualização de mapa e adicione à página HTML. Sua página deve conter um elemento <div> que contenha a visualização de mapa. No exemplo a seguir, o elemento <div> é denominado map_canvas.

Para evitar disputas, defina o ID de acompanhamento para o provedor de localização na chamada de retorno invocada após a inicialização do 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 acompanhamento

O ID de acompanhamento fornecido ao provedor de localização pode corresponder a várias tarefas. Por exemplo, uma tarefa de retirada e uma entrega do mesmo pacote ou várias tentativas de entrega com falha. Uma tarefa foi selecionada para ser mostrada no mapa de rastreamento de envios. A tarefa a ser mostrada é determinada da seguinte maneira:

  1. Se houver exatamente uma tarefa de retirada aberta, ela será exibida. Um erro será gerado se houver várias tarefas de retirada abertas.
  2. Se houver exatamente uma tarefa de entrega aberta, ela será mostrada. Um erro será gerado se houver várias tarefas de entrega em aberto.
  3. Se houver tarefas de entrega fechadas:
    • Se houver exatamente uma tarefa de entrega fechada, ela será mostrada.
    • Se houver várias tarefas de entrega encerradas, aquela com o tempo de saída mais recente será mostrada.
    • Se houver várias tarefas de entrega fechadas e nenhuma delas tiver um tempo de resultado, será gerado um erro.
  4. Se houver tarefas de retirada fechadas:
    • Se houver exatamente uma tarefa de retirada fechada, ela será mostrada.
    • Se houver várias tarefas de retirada fechadas, aquela com o horário de saída mais recente será mostrada.
    • Se houver várias tarefas de retirada fechadas e nenhuma delas tiver um tempo de resultado, será gerado um erro.
  5. Caso contrário, nenhuma tarefa será exibida.

Detectar eventos de mudança

É possível recuperar metainformações sobre uma tarefa do objeto de informações de rastreamento de tarefas usando o provedor de localização. As metainformações incluem HEC, número de paradas restantes e distância restante antes do embarque ou da entrega. Alterações nas informações meta acionam um evento update. O exemplo a seguir mostra como detectar esses eventos de mudança.

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);
});

Solucionar erros

Os erros que surgem de forma assíncrona da solicitação de informações de remessa acionam eventos de erro. O exemplo a seguir mostra como detectar esses eventos para lidar com erros.

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);
});

Observação:una as chamadas de biblioteca em blocos try...catch para lidar com erros imprevistos.

Parar monitoramento

Para impedir que o provedor de localização rastreie a remessa, remova o ID de rastreamento dele.

JavaScript

locationProvider.trackingId = '';

TypeScript

locationProvider.trackingId = '';

Remover o provedor de localização da visualização de mapa

O exemplo a seguir mostra como remover um provedor de localização da visualização de mapa.

JavaScript

mapView.removeLocationProvider(locationProvider);

TypeScript

mapView.removeLocationProvider(locationProvider);

Personalizar a aparência do mapa de base

Para personalizar a aparência do componente de mapas, estilize seu mapa usando ferramentas baseadas na nuvem ou definindo opções diretamente no código.

Usar a Estilização de mapas baseada na nuvem

Com a Estilização de mapas baseada na nuvem, você pode criar e editar estilos para qualquer um dos seus apps que usam o Google Maps no console do Google Cloud, sem precisar mudar o código. Os estilos são salvos como IDs no seu projeto do Cloud. Para aplicar um estilo ao mapa de rastreamento de envio em JavaScript, especifique um mapId ao criar o JourneySharingMapView. O campo mapId não pode ser alterado ou adicionado após o JourneySharingMapView ser instanciado. O exemplo a seguir mostra como ativar um estilo de mapa criado anteriormente com um ID do 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.
});

Usar a Estilização de mapas baseada em código

Outra maneira de personalizar a estilização do mapa é definir mapOptions ao criar o 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" }
        ]
      }
    ]
  }
});

Usar personalizações de marcadores

Com a biblioteca JavaScript Shipment Tracking, você pode personalizar a aparência dos marcadores adicionados ao mapa. Para isso, especifique as personalizações do marcador, que são aplicadas pela biblioteca Shipment Tracking antes de adicionar marcadores ao mapa e a cada atualização deles.

A personalização mais simples é especificar um objeto MarkerOptions que será aplicado a todos os marcadores do mesmo tipo. As alterações especificadas no objeto são aplicadas depois que cada marcador é criado, substituindo as opções padrão.

Uma opção mais avançada é especificar uma função de personalização. Com as funções de personalização, é possível estilizar os marcadores com base em dados, além de adicionar interatividade aos marcadores, como o processamento de cliques. Especificamente, o Shipment Tracking transmite dados para a função de personalização sobre o tipo de objeto que o marcador representa: veículo ou destino. Isso permite que o estilo do marcador seja alterado com base no estado atual do próprio elemento do marcador (por exemplo, o número de paradas planejadas restantes até o destino). Também é possível mesclar dados de fontes externas ao Fleet Engine e estilizar o marcador com base nessas informações.

A biblioteca Shipment Tracking fornece os seguintes parâmetros de personalização em FleetEngineShipmentLocationProviderOptions:

Mudar o estilo dos marcadores usando MarkerOptions

O exemplo a seguir mostra como configurar o estilo de um marcador de veículo com um objeto MarkerOptions. Siga este padrão para personalizar o estilo de qualquer marcador usando uma das personalizações listadas acima.

JavaScript

deliveryVehicleMarkerCustomization = {
  cursor: 'grab'
};

TypeScript

deliveryVehicleMarkerCustomization = {
  cursor: 'grab'
};

Mudar o estilo dos marcadores usando funções de personalização

O exemplo a seguir mostra como configurar o estilo de um marcador de veículo. Siga esse padrão para personalizar o estilo de qualquer marcador usando qualquer um dos parâmetros de personalização listados acima.

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}`);
  };

Adicionar o gerenciamento de cliques aos marcadores

O exemplo a seguir mostra como adicionar o gerenciamento de cliques a um marcador de veículo. Siga este padrão para adicionar o processamento de cliques a qualquer marcador usando os parâmetros de personalização listados acima.

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.
      });
    }
  };

Usar personalizações de polilinha

Com a biblioteca Shipment Tracking, você também pode personalizar a aparência da rota da remessa no mapa. A biblioteca cria um objeto google.maps.Polyline para cada par de coordenadas no caminho ativo ou restante da remessa. Você pode definir o estilo dos objetos Polyline especificando personalizações de polilinha. Em seguida, a biblioteca aplica essas personalizações em duas situações: antes de adicionar os objetos ao mapa e quando os dados usados para os objetos mudam.

Assim como na personalização de marcadores, você pode especificar um conjunto de PolylineOptions a ser aplicado a todos os objetos Polyline correspondentes quando eles são criados ou atualizados.

Da mesma forma, é possível especificar uma função de personalização. As funções de personalização permitem aplicar estilos individuais aos objetos com base nos dados enviados pelo Fleet Engine. A função pode mudar o estilo de cada objeto com base no estado atual da frete. Por exemplo, colorir o objeto Polyline em uma tonalidade mais profunda ou torná-lo mais espesso quando o veículo está se movendo mais devagar. É possível até mesclar fontes de fora do Fleet Engine e estilizar o objeto Polyline com base nessas informações.

Você pode especificar as personalizações usando os parâmetros fornecidos em FleetEngineShipmentLocationProviderOptions. Você pode definir personalizações para diferentes estados de caminho na jornada do veículo: já percorrido, viajando ativamente ou ainda não percorrido. Os parâmetros são os seguintes:

Mude o estilo dos objetos Polyline usando PolylineOptions.

O exemplo a seguir mostra como configurar o estilo de um objeto Polyline com PolylineOptions. Siga esse padrão para personalizar o estilo de qualquer objeto Polyline usando qualquer uma das personalizações de polilinha listadas anteriormente.

JavaScript

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

TypeScript

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

Mudar o estilo dos objetos Polyline usando funções de personalização

O exemplo abaixo mostra como configurar o estilo de um objeto Polyline ativo. Siga esse padrão para personalizar o estilo de qualquer objeto Polyline usando qualquer um dos parâmetros de personalização de polilinha listados 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'});
      }
    }
  };

Controlar a visibilidade de objetos Polyline

Por padrão, todos os objetos Polyline ficam visíveis. Para tornar um objeto Polyline invisível, defina a propriedade visible dele:

JavaScript

remainingPolylineCustomization = {visible: false};

TypeScript

remainingPolylineCustomization = {visible: false};

Mostrar um InfoWindow para um veículo ou marcador de local

Você pode usar um InfoWindow para mostrar mais informações sobre um veículo ou marcador de local.

O exemplo a seguir mostra como criar um InfoWindow e anexá-lo a um marcador de veí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();

Desativar ajuste automático

Para impedir que o mapa ajuste automaticamente a janela de visualização ao veículo e ao trajeto previsto, desative o ajuste automático. O exemplo abaixo mostra como desativar o ajuste automático ao configurar a visualização de mapa do compartilhamento de jornada.

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();

Substituir um mapa

Você pode usar a biblioteca JavaScript Shipment Tracking para substituir um mapa que inclua marcadores ou outras personalizações sem perder essas personalizações.

Por exemplo, suponha que você tenha uma página da Web com uma entidade google.maps.Map padrão em que um marcador é exibido:

<!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 adicionar a biblioteca de compartilhamento de jornada do JavaScript:

  1. Adicione o código da fábrica de tokens de autenticação.
  2. Inicialize um provedor de localização na função initMap().
  3. Inicialize a visualização de mapa na função initMap(). A visualização contém o mapa.
  4. Mova sua personalização para a função de callback referente à inicialização da visualização do mapa.
  5. Adicione a biblioteca de localização ao carregador de API.

O exemplo a seguir mostra as mudanças que precisam ser feitas:

<!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>

Se você tiver um pacote rastreado com o ID especificado perto de Uluru, ele vai ser renderizado no mapa.