Fleet Tracking - Last Mile Fleet

Класс FleetEngineDeliveryVehicleLocationProvider

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

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

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

Интерфейс FleetEngineDeliveryVehicleLocationProviderOptions

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

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

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

    Список предоставленных параметров и их использование приведены в DeliveryVehiclePolylineCustomizationFunctionParams.
deliveryVehicleId
необязательно
Тип: string optional
Идентификатор транспортного средства доставки, которое нужно отслеживать сразу после создания экземпляра поставщика местоположения. Если идентификатор не указан, поставщик геолокации не начнет отслеживать транспортное средство. Чтобы задать идентификатор и начать отслеживание, используйте FleetEngineDeliveryVehicleLocationProvider.deliveryVehicleId.
deliveryVehicleMarkerCustomization
необязательно
Настройка, примененная к маркеру транспортного средства доставки.

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

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

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

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

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

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

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

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

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

    Список предоставленных параметров и их использование приведены в DeliveryVehiclePolylineCustomizationFunctionParams.
taskFilterOptions
необязательно
Параметры фильтра, которые будут применяться при получении задач. Например, можно указать транспортное средство, время и статус задачи.
taskMarkerCustomization
необязательно
Тип: (function(TaskMarkerCustomizationFunctionParams): void)|MarkerOptions optional
Настройка, примененная к маркеру задачи. Маркер задачи отображается в запланированном местоположении каждой задачи, назначенной транспортному средству доставки.

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

    Список предоставленных параметров и их использование см. в TaskMarkerCustomizationFunctionParams.
taskOutcomeMarkerCustomization
необязательно
Тип: function(TaskMarkerCustomizationFunctionParams): void optional
Настройка, примененная к маркеру результата задачи. Маркер результата задачи отображается в фактическом местоположении результата каждой задачи, назначенной транспортному средству доставки.

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

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

Интерфейс FleetEngineTaskFilterOptions

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

Параметры фильтрации задач в поставщике местоположения транспортного средства доставки.
completionTimeFrom
необязательно
Тип: Date optional
Нижняя граница времени выполнения задачи (не включается). Используется для фильтрации задач, выполненных после указанного времени.
completionTimeTo
необязательно
Тип: Date optional
Верхняя граница времени выполнения задачи (не включается). Используется для фильтрации задач, которые были выполнены до указанного времени.
state
необязательно
Тип: string optional
Статус задачи. Допустимые значения: OPEN (открыто) или CLOSED (закрыто).

Интерфейс FleetEngineDeliveryVehicleLocationProviderUpdateEvent

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

Объект события, передаваемый обработчику событий при активации события FleetEngineDeliveryVehicleLocationProvider.update.
completedVehicleJourneySegments
необязательно
Тип: Array<VehicleJourneySegment> optional
Отрезки маршрута, которые уже пройдены этим транспортным средством. Неизменяемый.
deliveryVehicle
необязательно
Тип: DeliveryVehicle optional
Структура данных транспортного средства доставки, возвращенная обновлением. Неизменяемый.
tasks
необязательно
Тип: Array<Task> optional
Список задач, выполняемых этим транспортным средством доставки. Неизменяемый.

Класс FleetEngineDeliveryFleetLocationProvider

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

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

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

Интерфейс FleetEngineDeliveryFleetLocationProviderOptions

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

Варианты поставщика данных о местоположении автопарка доставки.
authTokenFetcher
Предоставляет веб-токены JSON для аутентификации клиента в Fleet Engine.
projectId
Тип: string
Идентификатор проекта клиента из консоли Google Cloud.
deliveryVehicleFilter
необязательно
Тип: string optional
Запрос фильтра, который будет применяться при получении транспортных средств доставки. Этот фильтр передается непосредственно в Fleet Engine.

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

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

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

    Список предоставленных параметров и их использование см. в DeliveryVehicleMarkerCustomizationFunctionParams.
locationRestriction
необязательно
Границы широты и долготы, в пределах которых нужно отслеживать транспортные средства сразу после создания экземпляра поставщика геоданных. Если границы не заданы, поставщик данных о местоположении не начнет отслеживать транспортные средства. Чтобы задать границы и начать отслеживание, используйте FleetEngineDeliveryFleetLocationProvider.locationRestriction. Чтобы отслеживать все транспортные средства доставки независимо от местоположения, установите границы, эквивалентные всей Земле.
staleLocationThresholdMillis
необязательно
Тип: number optional
Пороговое значение для устаревшего местоположения транспортного средства. Если последнее обновленное местоположение транспортного средства старше этого порогового значения, транспортное средство не будет отображаться. По умолчанию – 24 часа в миллисекундах. Если пороговое значение меньше нуля или равно Infinity, оно будет игнорироваться, а местоположение транспортного средства не будет считаться устаревшим.

Интерфейс FleetEngineDeliveryFleetLocationProviderUpdateEvent

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

Объект события, передаваемый обработчику событий при активации события FleetEngineDeliveryFleetLocationProvider.update.
deliveryVehicles
необязательно
Тип: Array<DeliveryVehicle> optional
Список транспортных средств доставки, возвращенных запросом. Неизменяемый.