Fleet Tracking - On Demand Rides & Delivery

Класс FleetEngineVehicleLocationProvider

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

Поставщик данных о местоположении транспортного средства.

const {FleetEngineVehicleLocationProvider} = await google.maps.importLibrary("journeySharing");
FleetEngineVehicleLocationProvider
FleetEngineVehicleLocationProvider(options)
Параметры:
Создает нового поставщика местоположения для транспортного средства Fleet Engine.
TRAFFIC_AWARE_ACTIVE_POLYLINE_CUSTOMIZATION_FUNCTION
TRAFFIC_AWARE_ACTIVE_POLYLINE_CUSTOMIZATION_FUNCTION(params)
Параметры:
Возвращаемое значение: нет.
Функция настройки ломаной линии, которая окрашивает активную ломаную линию в соответствии с показаниями скорости. Укажите эту функцию в качестве FleetEngineVehicleLocationProviderOptions.activePolylineCustomization, чтобы отобразить ломаную линию с учетом трафика для активной ломаной линии.
TRAFFIC_AWARE_REMAINING_POLYLINE_CUSTOMIZATION_FUNCTION
TRAFFIC_AWARE_REMAINING_POLYLINE_CUSTOMIZATION_FUNCTION(params)
Параметры:
Возвращаемое значение: нет.
Функция настройки ломаной линии, которая окрашивает оставшуюся часть ломаной линии в соответствии с показаниями скорости. Укажите эту функцию в качестве FleetEngineVehicleLocationProviderOptions.remainingPolylineCustomization, чтобы отрисовать ломаную линию с учетом трафика для оставшейся части маршрута.
staleLocationThresholdMillis
Тип: number
Это поле доступно только для чтения. Пороговое значение для устаревшего местоположения транспортного средства. Если последнее обновленное местоположение транспортного средства старше этого порогового значения, транспортное средство не будет отображаться.
vehicleId
Тип: string
Идентификатор транспортного средства, за которым наблюдает этот поставщик данных о местоположении. Задайте это поле, чтобы отслеживать транспортное средство.
Унаследованные: isPolling, pollingIntervalMillis
Унаследованные: addListener
error
function(event)
Аргументы:
Событие, которое активируется, когда поставщик данных о местоположении сталкивается с ошибкой.
update
function(event)
Событие, которое активируется, когда запрос на обновление данных Fleet Engine завершен.
Унаследованные: ispollingchange

Интерфейс FleetEngineVehicleLocationProviderOptions

интерфейс google.maps.journeySharing.FleetEngineVehicleLocationProviderOptions

Параметры поставщика данных о местоположении автомобиля.

authTokenFetcher
Предоставляет веб-токены JSON для аутентификации клиента в Fleet Engine.
projectId
Тип: string
Идентификатор проекта клиента из консоли Google Cloud.
activePolylineCustomization
необязательно
Настройки, примененные к активной ломаной линии. Активная ломаная линия соответствует части маршрута, по которой в данный момент движется транспортное средство.

Используйте это поле, чтобы задать собственный стиль (например, цвет ломаной линии) и интерактивность (например, обработку кликов).
  • Если указан объект PolylineOptions, то заданные в нем изменения применяются к ломаной линии после ее создания, перезаписывая ее параметры по умолчанию, если они есть.
  • Если указана функция, она вызывается один раз при создании ломаной линии. (При этом вызове параметр isNew в объекте параметров функции имеет значение true). Кроме того, эта функция вызывается, когда меняются координаты ломаной линии или когда поставщик данных о местоположении получает данные от Fleet Engine, независимо от того, изменились ли данные, соответствующие этой ломаной линии.

    Список предоставленных параметров и их использование приведены в VehiclePolylineCustomizationFunctionParams.
destinationMarkerCustomization
необязательно
Настройки, примененные к маркеру пункта назначения поездки.

Используйте это поле, чтобы задать собственный стиль (например, значок маркера) и интерактивность (например, обработку кликов).
  • Если указан объект MarkerOptions, то после создания маркера к нему применяются изменения, указанные в этом объекте, и перезаписываются параметры по умолчанию, если они есть.
  • Если указана функция, она вызывается один раз при создании маркера, прежде чем он будет добавлен в представление карты. При этом вызове параметр isNew в объекте параметров функции имеет значение true. Кроме того, эта функция вызывается, когда поставщик данных о местоположении получает данные от Fleet Engine, независимо от того, изменились ли данные, соответствующие этому маркеру.

    Список предоставленных параметров и их использование см. в VehicleWaypointMarkerCustomizationFunctionParams.
intermediateDestinationMarkerCustomization
необязательно
Настройки, примененные к маркерам промежуточных пунктов назначения в поездке.

Используйте это поле, чтобы задать собственный стиль (например, значок маркера) и интерактивность (например, обработку кликов).
  • Если указан объект MarkerOptions, то после создания маркера к нему применяются изменения, указанные в этом объекте, и перезаписываются параметры по умолчанию, если они есть.
  • Если указана функция, она вызывается один раз при создании маркера, прежде чем он будет добавлен в представление карты. При этом вызове параметр isNew в объекте параметров функции имеет значение true. Кроме того, эта функция вызывается, когда поставщик данных о местоположении получает данные от Fleet Engine, независимо от того, изменились ли данные, соответствующие этому маркеру.

    Список предоставленных параметров и их использование см. в VehicleWaypointMarkerCustomizationFunctionParams.
originMarkerCustomization
необязательно
Настройки, примененные к маркеру начальной точки поездки.

Используйте это поле, чтобы задать собственный стиль (например, значок маркера) и интерактивность (например, обработку кликов).
  • Если указан объект MarkerOptions, то после создания маркера к нему применяются изменения, указанные в этом объекте, и перезаписываются параметры по умолчанию, если они есть.
  • Если указана функция, она вызывается один раз при создании маркера, прежде чем он будет добавлен в представление карты. При этом вызове параметр isNew в объекте параметров функции имеет значение true. Кроме того, эта функция вызывается, когда поставщик данных о местоположении получает данные от Fleet Engine, независимо от того, изменились ли данные, соответствующие этому маркеру.

    Список предоставленных параметров и их использование см. в VehicleWaypointMarkerCustomizationFunctionParams.
pollingIntervalMillis
необязательно
Тип: number optional
Минимальное время между получением обновлений местоположения в миллисекундах. Если на получение данных о местоположении уходит больше pollingIntervalMillis, следующее обновление не начнется, пока не завершится текущее.

Если задать значение 0, регулярные обновления местоположения будут отключены. Новое уведомление о местоположении запрашивается, если меняется любой из параметров, отслеживаемых поставщиком геолокации.

По умолчанию интервал опроса составляет 5000 миллисекунд (минимальное значение). Если вы установите меньшее ненулевое значение, будет использоваться 5000.
remainingPolylineCustomization
необязательно
Настройки применены к оставшейся части ломаной линии. Оставшаяся ломаная линия соответствует части маршрута, которую транспортное средство ещё не начало проходить.

Используйте это поле, чтобы задать собственный стиль (например, цвет ломаной линии) и интерактивность (например, обработку кликов).
  • Если указан объект PolylineOptions, то заданные в нем изменения применяются к ломаной линии после ее создания, перезаписывая ее параметры по умолчанию, если они есть.
  • Если указана функция, она вызывается один раз при создании ломаной линии. (При этом вызове параметр isNew в объекте параметров функции имеет значение true). Кроме того, эта функция вызывается, когда меняются координаты ломаной линии или когда поставщик данных о местоположении получает данные от Fleet Engine, независимо от того, изменились ли данные, соответствующие этой ломаной линии.

    Список предоставленных параметров и их использование приведены в VehiclePolylineCustomizationFunctionParams.
staleLocationThresholdMillis
необязательно
Тип: number optional
Пороговое значение для устаревшего местоположения транспортного средства. Если последнее обновленное местоположение транспортного средства старше этого порогового значения, транспортное средство не будет отображаться. По умолчанию – 24 часа в миллисекундах. Если пороговое значение меньше 0 или равно Infinity, оно будет игнорироваться, а местоположение транспортного средства не будет считаться устаревшим.
takenPolylineCustomization
необязательно
Настройки, примененные к выбранной ломаной линии. Пройденная ломаная линия соответствует части маршрута, которую транспортное средство уже преодолело.

Используйте это поле, чтобы задать собственный стиль (например, цвет ломаной линии) и интерактивность (например, обработку кликов).
  • Если указан объект PolylineOptions, то заданные в нем изменения применяются к ломаной линии после ее создания, перезаписывая ее параметры по умолчанию, если они есть.
  • Если указана функция, она вызывается один раз при создании ломаной линии. (При этом вызове параметр isNew в объекте параметров функции имеет значение true). Кроме того, эта функция вызывается, когда меняются координаты ломаной линии или когда поставщик данных о местоположении получает данные от Fleet Engine, независимо от того, изменились ли данные, соответствующие этой ломаной линии.

    Список предоставленных параметров и их использование приведены в VehiclePolylineCustomizationFunctionParams.
vehicleId
необязательно
Тип: string optional
Идентификатор транспортного средства, который нужно отслеживать сразу после создания экземпляра поставщика данных о местоположении. Если идентификатор не указан, поставщик геолокации не начнет отслеживать транспортное средство. Чтобы задать идентификатор и начать отслеживание, используйте FleetEngineVehicleLocationProvider.vehicleId.
vehicleMarkerCustomization
необязательно
Тип: (function(VehicleMarkerCustomizationFunctionParams): void)|MarkerOptions optional
Настройки, примененные к маркеру транспортного средства.

Используйте это поле, чтобы задать собственный стиль (например, значок маркера) и интерактивность (например, обработку кликов).
  • Если указан объект MarkerOptions, то после создания маркера к нему применяются изменения, указанные в этом объекте, и перезаписываются параметры по умолчанию, если они есть.
  • Если указана функция, она вызывается один раз при создании маркера, прежде чем он будет добавлен в представление карты. При этом вызове параметр isNew в объекте параметров функции имеет значение true. Кроме того, эта функция вызывается, когда поставщик данных о местоположении получает данные от Fleet Engine, независимо от того, изменились ли данные, соответствующие этому маркеру.

    Список предоставленных параметров и их использование см. в VehicleMarkerCustomizationFunctionParams.

Интерфейс FleetEngineVehicleLocationProviderUpdateEvent

интерфейс google.maps.journeySharing.FleetEngineVehicleLocationProviderUpdateEvent

Объект события, передаваемый обработчику событий при активации события FleetEngineVehicleLocationProvider.update.

trips
необязательно
Тип: Array<Trip> optional
Список рейсов, выполненных этим транспортным средством. Неизменяемый.
vehicle
необязательно
Тип: Vehicle optional
Структура данных транспортного средства, возвращаемая обновлением. Неизменяемый.

Класс FleetEngineFleetLocationProvider

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

Поставщик данных о местоположении автопарка.

const {FleetEngineFleetLocationProvider} = await google.maps.importLibrary("journeySharing");
FleetEngineFleetLocationProvider
FleetEngineFleetLocationProvider(options)
Параметры:
Создает нового поставщика данных о местоположении для транспортных средств, отслеживаемых Fleet Engine.
locationRestriction
Границы, в пределах которых нужно отслеживать транспортные средства. Если границы не заданы, транспортные средства не отслеживаются. Чтобы отслеживать все транспортные средства независимо от местоположения, задайте границы, эквивалентные всей Земле.
staleLocationThresholdMillis
Тип: number
Это поле доступно только для чтения. Пороговое значение для устаревшего местоположения транспортного средства. Если последнее обновленное местоположение транспортного средства старше этого порогового значения, транспортное средство не будет отображаться.
vehicleFilter
Тип: string optional
Фильтр, примененный при получении транспортных средств.
Унаследованные: isPolling, pollingIntervalMillis
Унаследованные: addListener
update
function(event)
Событие, которое активируется, когда запрос на обновление данных Fleet Engine завершен.
Унаследованные: ispollingchange

Интерфейс FleetEngineFleetLocationProviderOptions

интерфейс google.maps.journeySharing.FleetEngineFleetLocationProviderOptions

Параметры поставщика данных о местоположении автопарка.

authTokenFetcher
Предоставляет веб-токены JSON для аутентификации клиента в Fleet Engine.
projectId
Тип: string
Идентификатор проекта клиента из консоли Google Cloud.
locationRestriction
необязательно
Границы широты и долготы, в пределах которых нужно отслеживать транспортные средства сразу после создания экземпляра поставщика геоданных. Если границы не заданы, поставщик данных о местоположении не начнет отслеживать транспортные средства. Чтобы задать границы и начать отслеживание, используйте FleetEngineFleetLocationProvider.locationRestriction. Чтобы отслеживать все транспортные средства независимо от местоположения, задайте границы, эквивалентные всей Земле.
staleLocationThresholdMillis
необязательно
Тип: number optional
Пороговое значение для устаревшего местоположения транспортного средства. Если последнее обновленное местоположение транспортного средства старше этого порогового значения, транспортное средство не будет отображаться. По умолчанию – 24 часа в миллисекундах. Если пороговое значение меньше нуля или равно Infinity, оно будет игнорироваться, а местоположение транспортного средства не будет считаться устаревшим.
vehicleFilter
необязательно
Тип: string optional
Запрос фильтра, который будет применяться при получении транспортных средств. Этот фильтр передается непосредственно в Fleet Engine.

Поддерживаемые форматы перечислены в разделе ListVehiclesRequest.filter.

Обратите внимание, что у допустимых фильтров для атрибутов должен быть префикс attributes. Примеры: attributes.x = "y" или attributes."x y" = "z".
vehicleMarkerCustomization
необязательно
Тип: function(VehicleMarkerCustomizationFunctionParams): void optional
Настройка, примененная к маркеру транспортного средства.

Используйте это поле, чтобы задать собственный стиль (например, значок маркера) и интерактивность (например, обработку кликов).
  • Если указан объект MarkerOptions, то после создания маркера к нему применяются изменения, указанные в этом объекте, и перезаписываются параметры по умолчанию, если они есть.
  • Если указана функция, она вызывается один раз при создании маркера, прежде чем он будет добавлен в представление карты. При этом вызове параметр isNew в объекте параметров функции имеет значение true. Кроме того, эта функция вызывается, когда поставщик данных о местоположении получает данные от Fleet Engine, независимо от того, изменились ли данные, соответствующие этому маркеру.

    Список предоставленных параметров и их использование см. в VehicleMarkerCustomizationFunctionParams.

Интерфейс FleetEngineFleetLocationProviderUpdateEvent

интерфейс google.maps.journeySharing.FleetEngineFleetLocationProviderUpdateEvent

Объект события, передаваемый обработчику событий при активации события FleetEngineFleetLocationProvider.update.

vehicles
необязательно
Тип: Array<Vehicle> optional
Список транспортных средств, возвращенных запросом. Неизменяемый.