REST Resource: providers.trips

Ресурс: Поездка

Метаданные поездки.

JSON-представление 
{
  "name": string,
  "vehicleId": string,
  "tripStatus": enum (TripStatus),
  "tripType": enum (TripType),
  "pickupPoint": {
    object (TerminalLocation)
  },
  "actualPickupPoint": {
    object (StopLocation)
  },
  "actualPickupArrivalPoint": {
    object (StopLocation)
  },
  "pickupTime": string,
  "intermediateDestinations": [
    {
      object (TerminalLocation)
    }
  ],
  "intermediateDestinationsVersion": string,
  "intermediateDestinationIndex": integer,
  "actualIntermediateDestinationArrivalPoints": [
    {
      object (StopLocation)
    }
  ],
  "actualIntermediateDestinations": [
    {
      object (StopLocation)
    }
  ],
  "dropoffPoint": {
    object (TerminalLocation)
  },
  "actualDropoffPoint": {
    object (StopLocation)
  },
  "dropoffTime": string,
  "remainingWaypoints": [
    {
      object (TripWaypoint)
    }
  ],
  "vehicleWaypoints": [
    {
      object (TripWaypoint)
    }
  ],
  "route": [
    {
      object (LatLng)
    }
  ],
  "currentRouteSegment": string,
  "currentRouteSegmentVersion": string,
  "currentRouteSegmentTraffic": {
    object (ConsumableTrafficPolyline)
  },
  "currentRouteSegmentTrafficVersion": string,
  "currentRouteSegmentEndPoint": {
    object (TripWaypoint)
  },
  "remainingDistanceMeters": integer,
  "etaToFirstWaypoint": string,
  "remainingTimeToFirstWaypoint": string,
  "remainingWaypointsVersion": string,
  "remainingWaypointsRouteVersion": string,
  "numberOfPassengers": integer,
  "lastLocation": {
    object (VehicleLocation)
  },
  "lastLocationSnappable": boolean,
  "view": enum (TripView)
}
Поля
name

string

Только вывод. В формате "провайдеры/{провайдер}/поездки/{поездка}"

vehicle Id

string

Идентификатор транспортного средства, совершающего эту поездку.

trip Status

enum ( TripStatus )

Текущий статус поездки.

trip Type

enum ( TripType )

Тип поездки.

pickup Point

object ( TerminalLocation )

Место, где клиент укажет, что его заберут.

actual Pickup Point

object ( StopLocation )

Только ввод. Фактическое место, когда и где забрали клиента. Это поле предназначено для того, чтобы поставщик предоставил отзыв о фактической информации о получении.

actual Pickup Arrival Point

object ( StopLocation )

Только ввод. Фактическое время и место прибытия водителя в пункт выдачи. Это поле предназначено для предоставления поставщиком информации о фактическом прибытии в пункт выдачи.

pickup Time

string ( Timestamp format)

Только вывод. Либо предполагаемое время в будущем, когда гонщика(ов) заберут, либо фактическое время, когда их заберут.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

intermediate Destinations[]

object ( TerminalLocation )

Промежуточные остановки в соответствии с запросами на поездку (помимо посадки и высадки). Первоначально эта функция не будет поддерживаться для совместных поездок.

intermediate Destinations Version

string ( Timestamp format)

Указывает, когда в последний раз было изменено intermediateDestinations . Ваш сервер должен кэшировать это значение и передавать его в UpdateTripRequest при обновлении intermediateDestinationIndex , чтобы гарантировать, что intermediateDestinations не будет изменен.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

intermediate Destination Index

integer

Когда TripStatus имеет значение ENROUTE_TO_INTERMEDIATE_DESTINATION , число между [0..N-1], указывающее, какой промежуточный пункт назначения транспортное средство пересечет следующим. Когда TripStatus имеет значение ARRIVED_AT_INTERMEDIATE_DESTINATION , число между [0..N-1], указывающее, в каком промежуточном пункте назначения находится транспортное средство. Это значение устанавливает провайдер. Если intermediateDestinations нет, это поле игнорируется.

actual Intermediate Destination Arrival Points[]

object ( StopLocation )

Только ввод. Фактическое время и место прибытия водителя в промежуточный пункт назначения. Это поле предназначено для предоставления поставщиком информации о фактическом прибытии в промежуточные пункты назначения.

actual Intermediate Destinations[]

object ( StopLocation )

Только ввод. Фактическое время и место, когда и где клиента забрали из промежуточного пункта назначения. Это поле предназначено для предоставления поставщиком обратной связи о фактической информации о получении в промежуточных пунктах назначения.

dropoff Point

object ( TerminalLocation )

Место, где клиент указывает, что его высадят.

actual Dropoff Point

object ( StopLocation )

Только ввод. Фактическое время и место, когда и где высадили клиента. Это поле предназначено для предоставления поставщиком обратной связи по фактической информации о возврате.

dropoff Time

string ( Timestamp format)

Только вывод. Либо предполагаемое будущее время, когда пассажир(ы) будут высажены в конечном пункте назначения, либо фактическое время, когда они были высажены.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

remaining Waypoints[]

object ( TripWaypoint )

Только вывод. Полный путь от текущего местоположения до точки высадки включительно. Этот путь может включать путевые точки из других поездок.

vehicle Waypoints[]

object ( TripWaypoint )

Это поле поддерживает ручной заказ путевых точек для поездки. Он содержит все оставшиеся путевые точки для назначенного транспортного средства, а также путевые точки посадки и высадки для этой поездки. Если поездка не назначена транспортному средству, Fleet Engine игнорирует это поле. По соображениям конфиденциальности это поле заполняется сервером только при вызовах trips.update и trips.create , а НЕ при вызовах trips.get .

route[]

object ( LatLng )

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

current Route Segment

string

Только вывод. Закодированный путь к следующей путевой точке.

Примечание. Это поле предназначено только для использования Driver SDK и Consumer SDK. Декодирование пока не поддерживается.

current Route Segment Version

string ( Timestamp format)

Только вывод. Указывает последний раз, когда маршрут был изменен.

Примечание. Это поле предназначено только для использования Driver SDK и Consumer SDK.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

current Route Segment Traffic

object ( ConsumableTrafficPolyline )

Только вывод. Указывает условия трафика в сегменте currentRouteSegment , когда они доступны.

Примечание. Это поле предназначено только для использования Driver SDK и Consumer SDK.

current Route Segment Traffic Version

string ( Timestamp format)

Только вывод. Указывает, когда в последний раз был изменен currentRouteSegmentTraffic .

Примечание. Это поле предназначено только для использования Driver SDK и Consumer SDK.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

current Route Segment End Point

object ( TripWaypoint )

Только вывод. Путевая точка, где заканчивается currentRouteSegment .

remaining Distance Meters

integer

Только вывод. Оставшееся расстояние поездки в поле currentRouteSegment . Значение не указывается, если поездка не назначена транспортному средству или поездка завершена или отменена.

eta To First Waypoint

string ( Timestamp format)

Только вывод. Расчетное время прибытия до следующей путевой точки (первая запись в поле remainingWaypoints ). Значение не указывается, если поездка не закреплена за транспортным средством или поездка неактивна (завершена или отменена).

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

remaining Time To First Waypoint

string ( Duration format)

Только вывод. Продолжительность с момента возврата данных Trip до времени в Trip.eta_to_first_waypoint . Значение не указывается, если поездка не закреплена за транспортным средством или поездка неактивна (завершена или отменена).

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

remaining Waypoints Version

string ( Timestamp format)

Только вывод. Указывает, когда в последний раз были изменены remainingWaypoints (путевая точка была добавлена, удалена или изменена).

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

remaining Waypoints Route Version

string ( Timestamp format)

Только вывод. Указывает, когда в последний раз были изменены remainingWaypoints.path_to_waypoint и remainingWaypoints.traffic_to_waypoint . Ваше клиентское приложение должно кэшировать это значение и передать его в GetTripRequest чтобы гарантировать, что пути и трафик для remainingWaypoints возвращаются только в случае обновления.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

number Of Passengers

integer

Неизменяемый. Указывает количество пассажиров в поездке, не включая водителя. Транспортное средство должно иметь доступную мощность, чтобы его можно было вернуть в ответе vehicles.search .

last Location

object ( VehicleLocation )

Только вывод. Указывает последнее зарегистрированное местоположение транспортного средства на маршруте.

last Location Snappable

boolean

Только вывод. Указывает, можно ли привязать lastLocation транспортного средства к текущемуRouteSegment. False, если lastLocation или currentRouteSegment не существует. Его рассчитывает Fleet Engine. Любые обновления от клиентов будут игнорироваться.

view

enum ( TripView )

Подмножество заполняемых полей «Поездка» и их интерпретация.

Статус поездки

Статус поездки с указанием ее хода.

Перечисления
UNKNOWN_TRIP_STATUS По умолчанию, используется для неуказанного или нераспознанного статуса отключения.
NEW Недавно созданная поездка.
ENROUTE_TO_PICKUP Водитель направляется к месту посадки.
ARRIVED_AT_PICKUP Водитель прибыл в пункт выдачи.
ARRIVED_AT_INTERMEDIATE_DESTINATION Водитель прибыл в промежуточный пункт назначения и ждет пассажира.
ENROUTE_TO_INTERMEDIATE_DESTINATION Водитель находится на пути к промежуточному пункту назначения (не к месту высадки).
ENROUTE_TO_DROPOFF Водитель подобрал пассажира и направляется к следующему пункту назначения.
COMPLETE Гонщика высадили, и поездка завершена.
CANCELED Поездка была отменена до ее получения водителем, пассажиром или поставщиком услуг совместного использования поездок.

ОстановитьМестоположение

Фактическое место, где произошла остановка (посадка/высадка).

JSON-представление 
{
  "point": {
    object (LatLng)
  },
  "timestamp": string,
  "stopTime": string
}
Поля
point

object ( LatLng )

Необходимый. Обозначает фактическое местоположение.

timestamp

string ( Timestamp format)

Указывает, когда произошла остановка.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

stopTime
(deprecated)

string ( Timestamp format)

Только ввод. Устарело. Используйте поле отметки времени.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

ТрипВью

Селектор для различных наборов полей Trip в ответе trips.get . Контекст см. в AIP-157 . Вероятно, будут добавлены дополнительные представления.

Перечисления
TRIP_VIEW_UNSPECIFIED Значение по умолчанию. Для обеспечения обратной совместимости API по умолчанию будет использовать представление SDK. Чтобы обеспечить стабильность и поддержку, клиентам рекомендуется выбирать TripView отличный от SDK .
SDK Включает поля, которые невозможно интерпретировать или поддерживать с помощью общедоступных библиотек.
JOURNEY_SHARING_V1S Поля поездки заполняются для варианта использования «Совместное путешествие». Это представление предназначено для связи между серверами.

Методы

create

 Создает поездку в Fleet Engine и возвращает новую поездку.

get

 Получите информацию об одной поездке.
Получите все поездки для конкретного автомобиля.

update

 Обновляет данные о поездке.