REST Resource: providers.deliveryVehicles

Ресурс: Транспортное средство доставки

Сообщение DeliveryVehicle . Транспортное средство доставки доставляет грузы со склада в пункт доставки и из пункта самовывоза в склад. В некоторых случаях средства доставки также доставляют грузы непосредственно из места получения в место доставки.

Примечание. API-интерфейсы gRPC и REST используют разные соглашения об именах полей. Например, поле DeliveryVehicle.current_route_segment в API gRPC и поле DeliveryVehicle.currentRouteSegment в REST API относятся к одному и тому же полю.

JSON-представление 
{
  "name": string,
  "lastLocation": {
    object (DeliveryVehicleLocation)
  },
  "pastLocations": [
    {
      object (DeliveryVehicleLocation)
    }
  ],
  "navigationStatus": enum (DeliveryVehicleNavigationStatus),
  "currentRouteSegment": string,
  "currentRouteSegmentEndPoint": {
    object (LatLng)
  },
  "remainingDistanceMeters": integer,
  "remainingDuration": string,
  "remainingVehicleJourneySegments": [
    {
      object (VehicleJourneySegment)
    }
  ],
  "attributes": [
    {
      object (DeliveryVehicleAttribute)
    }
  ],
  "type": enum (DeliveryVehicleType)
}
Поля
name

string

Уникальное имя этого средства доставки. Формат: providers/{provider}/deliveryVehicles/{vehicle} .

lastLocation

object ( DeliveryVehicleLocation )

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

pastLocations[]

object ( DeliveryVehicleLocation )

Только ввод. Места, где это средство доставки побывало в прошлом, о которых еще не сообщалось в Fleet Engine. Это используется в UpdateDeliveryVehicleRequest для записи местоположений, которые ранее невозможно было отправить на сервер. Обычно это происходит, когда средство доставки не имеет подключения к Интернету.

navigationStatus

enum ( DeliveryVehicleNavigationStatus )

Навигационный статус транспортного средства доставки.

currentRouteSegment

string ( bytes format)

Закодированная ломаная линия, определяющая маршрут, по которому навигация рекомендует следовать до следующей путевой точки. Ваше приложение для водителя обновляет это, когда остановка достигнута или пройдена, а также когда навигация меняет маршрут. Эти LatLng возвращаются в Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) или Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) ​​для всех активных задач, назначенных Транспортному средству.

В некоторых случаях это поле может не использоваться для заполнения Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) или Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST):

  • Конечная точка currentRouteSegment не соответствует DeliveryVehicle.remaining_vehicle_journey_segments[0].stop (gRPC) или DeliveryVehicle.remainingVehicleJourneySegments[0].stop (REST).

  • Приложение-драйвер в последнее время не обновляло свое местоположение, поэтому последнее обновленное значение для этого поля могло быть устаревшим.

  • Приложение для водителя недавно обновило свое местоположение, но currentRouteSegment устарел и указывает на предыдущую остановку автомобиля.

В этих случаях Fleet Engine заполняет это поле маршрутом от последней пройденной VehicleStop до предстоящей VehicleStop, чтобы гарантировать, что потребитель этого поля имеет наилучшую доступную информацию о текущем пути транспортного средства доставки.

Строка в кодировке Base64.

currentRouteSegmentEndPoint

object ( LatLng )

Местоположение, где заканчивается currentRouteSegment . В настоящее время это значение не заполняется приложением водителя, но вы можете указать его при вызовах deliveryVehicles.patch . Это либо LatLng предстоящей остановки транспортного средства, либо последняя LatLng currentRouteSegment . Затем Fleet Engine сделает все возможное, чтобы интерполировать фактический VehicleStop .

Это поле игнорируется при вызовах deliveryVehicles.patch , если поле currentRouteSegment пусто.

remainingDistanceMeters

integer

Оставшееся расстояние поездки для currentRouteSegment . Приложение Driver обычно предоставляет это поле, но в некоторых случаях Fleet Engine переопределяет значение, отправленное приложением. Дополнительные сведения см. в разделе DeliveryVehicle.current_route_segment . Это поле возвращается в Task.remaining_vehicle_journey_segments[0].driving_distance_meters (gRPC) или Task.remainingVehicleJourneySegments[0].drivingDistanceMeters (REST) ​​для всех активных Task , назначенных средству доставки.

Fleet Engine игнорирует это поле в UpdateDeliveryVehicleRequest , если поле currentRouteSegment пусто.

remainingDuration

string ( Duration format)

Оставшееся время в пути для currentRouteSegment . Приложение Driver обычно предоставляет это поле, но в некоторых случаях Fleet Engine переопределит значение, отправленное приложением. Дополнительные сведения см. в разделе DeliveryVehicle.current_route_segment . Это поле возвращается в Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) или Task.remainingVehicleJourneySegments[0].drivingDuration (REST) ​​для всех активных задач, назначенных средству доставки.

Fleet Engine игнорирует это поле в UpdateDeliveryVehicleRequest , если поле currentRouteSegment пусто.

Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « s ». Пример: "3.5s" .

remainingVehicleJourneySegments[]

object ( VehicleJourneySegment )

Сегменты поездки, назначенные этому Транспортному средству доставки, начиная с последнего указанного местоположения Транспортного средства. Это поле не будет заполнено в ответе deliveryVehicles.list .

attributes[]

object ( DeliveryVehicleAttribute )

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

type

enum ( DeliveryVehicleType )

Тип этого средства доставки. Если этот параметр не установлен, по умолчанию будет установлено значение AUTO .

ДоставкаТранспортНавигацияСтатус

Статус навигации автомобиля.

Перечисления
UNKNOWN_NAVIGATION_STATUS Неопределенный статус навигации.
NO_GUIDANCE Навигация в приложении «Драйвер» находится в режиме FREE_NAV .
ENROUTE_TO_DESTINATION Доступна пошаговая навигация, а навигация в приложении для водителей перешла в режим GUIDED_NAV .
OFF_ROUTE Транспортное средство вышло за пределы предложенного маршрута.
ARRIVED_AT_DESTINATION Транспортное средство находится примерно в 50 метрах от места назначения.

ДоставкаТранспортное средствоАтрибут

Описывает атрибут транспортного средства как пару ключ-значение. Длина строки «ключ:значение» не может превышать 256 символов.

JSON-представление 
{
  "key": string,
  "value": string,

  // Union field delivery_vehicle_attribute_value can be only one of the
  // following:
  "stringValue": string,
  "boolValue": boolean,
  "numberValue": number
  // End of list of possible types for union field
  // delivery_vehicle_attribute_value.
}
Поля
key

string

Ключ атрибута.

value

string

Значение атрибута.

Поле объединения delivery_vehicle_attribute_value . Значение атрибута может иметь строковый, логический или двойной тип. delivery_vehicle_attribute_value может быть только одним из следующих:
stringValue

string

Значение атрибута строкового типа.

Примечание. Это идентично полю value , которое со временем станет устаревшим. Для методов создания или обновления можно использовать любое поле, но настоятельно рекомендуется использовать stringValue . Если установлены и stringValue , и value , они должны быть идентичными, иначе будет выдана ошибка. Оба поля заполняются в ответах.

boolValue

boolean

Значение атрибута логического типа.

numberValue

number

Значение атрибута с двойным типом.

ДоставкаТип Транспортного средства

Тип средства доставки.

Перечисления
DELIVERY_VEHICLE_TYPE_UNSPECIFIED Значение не используется.
AUTO Автомобиль.
TWO_WHEELER Мотоцикл, мопед или другое двухколесное транспортное средство.
BICYCLE Транспорт, приводимый в движение человеком.
PEDESTRIAN Транспортер-человек, обычно идущий или бегущий, передвигающийся по пешеходным дорожкам.

Методы

create

 Создает и возвращает новый DeliveryVehicle .

delete

 Удаляет DeliveryVehicle из Fleet Engine.

get

 Возвращает указанный экземпляр DeliveryVehicle .

list

 Получает все объекты DeliveryVehicle , соответствующие указанным критериям фильтрации.

patch

 Записывает обновленные данные DeliveryVehicle в Fleet Engine и назначает Tasks DeliveryVehicle .