Ресурс: Поездка
Метаданные поездки.
JSON-представление |
---|
{ "name": string, "vehicleId": string, "tripStatus": enum ( |
Поля | |
---|---|
name | Только вывод. В формате "providers/{provider}/trips/{trip}" |
vehicleId | Идентификатор транспортного средства, совершающего эту поездку. |
tripStatus | Текущий статус поездки. |
tripType | Тип поездки. |
pickupPoint | Место, где клиент укажет, что его заберут. |
actualPickupPoint | Только ввод. Фактическое место, где и когда был забран клиент. Это поле предназначено для поставщика, чтобы предоставить отзыв о фактической информации о забранном. |
actualPickupArrivalPoint | Только ввод. Фактическое время и место прибытия водителя в пункт выдачи. Это поле предназначено для предоставления поставщиком обратной связи по фактической информации о прибытии в пункт выдачи. |
pickupTime | Только вывод. Либо предполагаемое будущее время, когда пассажир(ы) будут забраны, либо фактическое время, когда они были забраны. Использует RFC 3339, где сгенерированный вывод всегда будет Z-нормализованным и использует 0, 3, 6 или 9 дробных цифр. Смещения, отличные от "Z", также принимаются. Примеры: |
intermediateDestinations[] | Промежуточные остановки в порядке, который запрашивает поездка (в дополнение к посадке и высадке). Первоначально это не будет поддерживаться для совместных поездок. |
intermediateDestinationsVersion | Указывает последний раз, когда был изменен Использует RFC 3339, где сгенерированный вывод всегда будет Z-нормализованным и использует 0, 3, 6 или 9 дробных цифр. Смещения, отличные от "Z", также принимаются. Примеры: |
intermediateDestinationIndex | Когда |
actualIntermediateDestinationArrivalPoints[] | Только ввод. Фактическое время и место прибытия водителя в промежуточный пункт назначения. Это поле предназначено для предоставления поставщиком обратной связи по фактической информации о прибытии в промежуточные пункты назначения. |
actualIntermediateDestinations[] | Только ввод. Фактическое время и место, когда и где клиент был забран из промежуточного пункта назначения. Это поле предназначено для поставщика, чтобы предоставить обратную связь по фактической информации о забранных автомобилях в промежуточных пунктах назначения. |
dropoffPoint | Место, где клиент укажет, что его высадят. |
actualDropoffPoint | Только ввод. Фактическое время и место, где и когда был высажен клиент. Это поле предназначено для поставщика, чтобы предоставить отзыв о фактической информации о высадке. |
dropoffTime | Только вывод. Либо предполагаемое будущее время высадки пассажира(ов) в конечном пункте назначения, либо фактическое время высадки. Использует RFC 3339, где сгенерированный вывод всегда будет Z-нормализованным и использует 0, 3, 6 или 9 дробных цифр. Смещения, отличные от "Z", также принимаются. Примеры: |
remainingWaypoints[] | Только вывод. Полный путь от текущего местоположения до точки высадки, включительно. Этот путь может включать путевые точки из других поездок. |
vehicleWaypoints[] | Это поле поддерживает ручное упорядочивание точек маршрута для поездки. Оно содержит все оставшиеся точки маршрута для назначенного транспортного средства, а также точки посадки и высадки для этой поездки. Если поездка не была назначена транспортному средству, то Fleet Engine игнорирует это поле. В целях конфиденциальности это поле заполняется сервером только при вызовах |
route[] | Только вывод. Ожидаемый маршрут для этой поездки к первой записи в remainWaypoints. Обратите внимание, что первая точка маршрута может принадлежать другой поездке. |
currentRouteSegment | Только вывод. Закодированный путь к следующей точке маршрута. Примечание: Это поле предназначено только для использования Driver SDK и Consumer SDK. Декодирование пока не поддерживается. |
currentRouteSegmentVersion | Только вывод. Указывает время последнего изменения маршрута. Примечание: это поле предназначено только для использования Driver SDK и Consumer SDK. Использует RFC 3339, где сгенерированный вывод всегда будет Z-нормализованным и использует 0, 3, 6 или 9 дробных цифр. Смещения, отличные от "Z", также принимаются. Примеры: |
currentRouteSegmentTraffic | Только вывод. Указывает условия движения по Примечание: это поле предназначено только для использования Driver SDK и Consumer SDK. |
currentRouteSegmentTrafficVersion | Только вывод. Указывает последний раз, когда Примечание: это поле предназначено только для использования Driver SDK и Consumer SDK. Использует RFC 3339, где сгенерированный вывод всегда будет Z-нормализованным и использует 0, 3, 6 или 9 дробных цифр. Смещения, отличные от "Z", также принимаются. Примеры: |
currentRouteSegmentEndPoint | Только вывод. Точка маршрута, где заканчивается |
remainingDistanceMeters | Только вывод. Оставшееся расстояние в поле |
etaToFirstWaypoint | Только вывод. ETA до следующей точки маршрута (первая запись в поле Использует RFC 3339, где сгенерированный вывод всегда будет Z-нормализованным и использует 0, 3, 6 или 9 дробных цифр. Смещения, отличные от "Z", также принимаются. Примеры: |
remainingTimeToFirstWaypoint | Только вывод. Длительность с момента возврата данных о поездке до времени в Длительность в секундах с дробной частью до девяти цифр, заканчивающаяся на ' |
remainingWaypointsVersion | Только вывод. Указывает последний раз, когда Использует RFC 3339, где сгенерированный вывод всегда будет Z-нормализованным и использует 0, 3, 6 или 9 дробных цифр. Смещения, отличные от "Z", также принимаются. Примеры: |
remainingWaypointsRouteVersion | Только вывод. Указывает последний раз, когда Использует RFC 3339, где сгенерированный вывод всегда будет Z-нормализованным и использует 0, 3, 6 или 9 дробных цифр. Смещения, отличные от "Z", также принимаются. Примеры: |
numberOfPassengers | Неизменяемый. Указывает количество пассажиров в этой поездке и не включает водителя. Транспортное средство должно иметь доступную вместимость для возврата в ответе |
lastLocation | Только вывод. Указывает последнее сообщенное местоположение транспортного средства на маршруте. |
lastLocationSnappable | Только вывод. Указывает, можно ли привязать |
view | Подмножество полей Trip, которые заполняются, и способ их интерпретации. |
attributes[] | Список пользовательских атрибутов Trip. Каждый атрибут должен иметь уникальный ключ. |
TripStatus
Статус поездки, указывающий на ее ход.
Перечисления | |
---|---|
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 ( |
Поля | |
---|---|
point | Обязательно. Обозначает фактическое местоположение. |
timestamp | Указывает, когда произошла остановка. Использует RFC 3339, где сгенерированный вывод всегда будет Z-нормализованным и использует 0, 3, 6 или 9 дробных цифр. Смещения, отличные от "Z", также принимаются. Примеры: |
stopTime | Только ввод. Устарело. Используйте поле метки времени. Использует RFC 3339, где сгенерированный вывод всегда будет Z-нормализованным и использует 0, 3, 6 или 9 дробных цифр. Смещения, отличные от "Z", также принимаются. Примеры: |
TripView
Селектор для различных наборов полей Trip в ответе trips.get
. См. AIP-157 для контекста. Вероятно, будут добавлены дополнительные представления.
Перечисления | |
---|---|
TRIP_VIEW_UNSPECIFIED | Значение по умолчанию. Для обратной совместимости API по умолчанию будет использовать вид SDK. Для обеспечения стабильности и поддержки клиентам рекомендуется выбирать TripView , отличный от SDK . |
SDK | Включает поля, которые могут быть неинтерпретируемыми или неподдерживаемыми с использованием общедоступных библиотек. |
JOURNEY_SHARING_V1S | Поля Trip заполняются для варианта использования Journey Sharing. Это представление предназначено для связи сервер-сервер. |
Атрибут поездки
Описывает атрибут поездки как пару ключ-значение. Длина строки "ключ:значение" не может превышать 256 символов.
JSON-представление |
---|
{ "key": string, // Union field |
Поля | |
---|---|
key | Ключ атрибута. Ключи не могут содержать символ двоеточия (:). |
Поле объединения trip_attribute_value . Значение атрибута может быть строковым, логическим или двойным. trip_attribute_value может быть только одним из следующих: | |
stringValue | Значение атрибута, типизированное как строка. |
boolValue | Значение атрибута логического типа. |
numberValue | Значение атрибута двойного типа. |
Методы | |
---|---|
| Создает рейс в Fleet Engine и возвращает новый рейс. |
| Удаляет одну поездку. |
| Получите информацию об одной поездке. |
| Получите все поездки для определенного транспортного средства. |
| Обновляет данные о поездке. |
Ресурс: Поездка
Метаданные поездки.
JSON-представление |
---|
{ "name": string, "vehicleId": string, "tripStatus": enum ( |
Поля | |
---|---|
name | Только вывод. В формате "providers/{provider}/trips/{trip}" |
vehicleId | Идентификатор транспортного средства, совершающего эту поездку. |
tripStatus | Текущий статус поездки. |
tripType | Тип поездки. |
pickupPoint | Место, где клиент укажет, что его заберут. |
actualPickupPoint | Только ввод. Фактическое место, где и когда был забран клиент. Это поле предназначено для поставщика, чтобы предоставить отзыв о фактической информации о забранном. |
actualPickupArrivalPoint | Только ввод. Фактическое время и место прибытия водителя в пункт выдачи. Это поле предназначено для предоставления поставщиком обратной связи по фактической информации о прибытии в пункт выдачи. |
pickupTime | Только вывод. Либо предполагаемое будущее время, когда пассажир(ы) будут забраны, либо фактическое время, когда они были забраны. Использует RFC 3339, где сгенерированный вывод всегда будет Z-нормализованным и использует 0, 3, 6 или 9 дробных цифр. Смещения, отличные от "Z", также принимаются. Примеры: |
intermediateDestinations[] | Промежуточные остановки в порядке, который запрашивает поездка (в дополнение к посадке и высадке). Первоначально это не будет поддерживаться для совместных поездок. |
intermediateDestinationsVersion | Указывает последний раз, когда был изменен Использует RFC 3339, где сгенерированный вывод всегда будет Z-нормализованным и использует 0, 3, 6 или 9 дробных цифр. Смещения, отличные от "Z", также принимаются. Примеры: |
intermediateDestinationIndex | Когда |
actualIntermediateDestinationArrivalPoints[] | Только ввод. Фактическое время и место прибытия водителя в промежуточный пункт назначения. Это поле предназначено для предоставления поставщиком обратной связи по фактической информации о прибытии в промежуточные пункты назначения. |
actualIntermediateDestinations[] | Только ввод. Фактическое время и место, когда и где клиент был забран из промежуточного пункта назначения. Это поле предназначено для поставщика, чтобы предоставить обратную связь по фактической информации о забранных автомобилях в промежуточных пунктах назначения. |
dropoffPoint | Место, где клиент укажет, что его высадят. |
actualDropoffPoint | Только ввод. Фактическое время и место, где и когда был высажен клиент. Это поле предназначено для поставщика, чтобы предоставить отзыв о фактической информации о высадке. |
dropoffTime | Только вывод. Либо предполагаемое будущее время высадки пассажира(ов) в конечном пункте назначения, либо фактическое время высадки. Использует RFC 3339, где сгенерированный вывод всегда будет Z-нормализованным и использует 0, 3, 6 или 9 дробных цифр. Смещения, отличные от "Z", также принимаются. Примеры: |
remainingWaypoints[] | Только вывод. Полный путь от текущего местоположения до точки высадки, включительно. Этот путь может включать путевые точки из других поездок. |
vehicleWaypoints[] | Это поле поддерживает ручное упорядочивание точек маршрута для поездки. Оно содержит все оставшиеся точки маршрута для назначенного транспортного средства, а также точки посадки и высадки для этой поездки. Если поездка не была назначена транспортному средству, то Fleet Engine игнорирует это поле. В целях конфиденциальности это поле заполняется сервером только при вызовах |
route[] | Только вывод. Ожидаемый маршрут для этой поездки к первой записи в remainWaypoints. Обратите внимание, что первая точка маршрута может принадлежать другой поездке. |
currentRouteSegment | Только вывод. Закодированный путь к следующей точке маршрута. Примечание: Это поле предназначено только для использования Driver SDK и Consumer SDK. Декодирование пока не поддерживается. |
currentRouteSegmentVersion | Только вывод. Указывает время последнего изменения маршрута. Примечание: это поле предназначено только для использования Driver SDK и Consumer SDK. Использует RFC 3339, где сгенерированный вывод всегда будет Z-нормализованным и использует 0, 3, 6 или 9 дробных цифр. Смещения, отличные от "Z", также принимаются. Примеры: |
currentRouteSegmentTraffic | Только вывод. Указывает условия движения по Примечание: это поле предназначено только для использования Driver SDK и Consumer SDK. |
currentRouteSegmentTrafficVersion | Только вывод. Указывает последний раз, когда Примечание: это поле предназначено только для использования Driver SDK и Consumer SDK. Использует RFC 3339, где сгенерированный вывод всегда будет Z-нормализованным и использует 0, 3, 6 или 9 дробных цифр. Смещения, отличные от "Z", также принимаются. Примеры: |
currentRouteSegmentEndPoint | Только вывод. Точка маршрута, где заканчивается |
remainingDistanceMeters | Только вывод. Оставшееся расстояние в поле |
etaToFirstWaypoint | Только вывод. ETA до следующей точки маршрута (первая запись в поле Использует RFC 3339, где сгенерированный вывод всегда будет Z-нормализованным и использует 0, 3, 6 или 9 дробных цифр. Смещения, отличные от "Z", также принимаются. Примеры: |
remainingTimeToFirstWaypoint | Только вывод. Длительность с момента возврата данных о поездке до времени в Длительность в секундах с дробной частью до девяти цифр, заканчивающаяся на ' |
remainingWaypointsVersion | Только вывод. Указывает последний раз, когда Использует RFC 3339, где сгенерированный вывод всегда будет Z-нормализованным и использует 0, 3, 6 или 9 дробных цифр. Смещения, отличные от "Z", также принимаются. Примеры: |
remainingWaypointsRouteVersion | Только вывод. Указывает последний раз, когда Использует RFC 3339, где сгенерированный вывод всегда будет Z-нормализованным и использует 0, 3, 6 или 9 дробных цифр. Смещения, отличные от "Z", также принимаются. Примеры: |
numberOfPassengers | Неизменяемый. Указывает количество пассажиров в этой поездке и не включает водителя. Транспортное средство должно иметь доступную вместимость для возврата в ответе |
lastLocation | Только вывод. Указывает последнее сообщенное местоположение транспортного средства на маршруте. |
lastLocationSnappable | Только вывод. Указывает, можно ли привязать |
view | Подмножество полей Trip, которые заполняются, и способ их интерпретации. |
attributes[] | Список пользовательских атрибутов Trip. Каждый атрибут должен иметь уникальный ключ. |
TripStatus
Статус поездки, указывающий на ее ход.
Перечисления | |
---|---|
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 ( |
Поля | |
---|---|
point | Обязательно. Обозначает фактическое местоположение. |
timestamp | Указывает, когда произошла остановка. Использует RFC 3339, где сгенерированный вывод всегда будет Z-нормализованным и использует 0, 3, 6 или 9 дробных цифр. Смещения, отличные от "Z", также принимаются. Примеры: |
stopTime | Только ввод. Устарело. Используйте поле метки времени. Использует RFC 3339, где сгенерированный вывод всегда будет Z-нормализованным и использует 0, 3, 6 или 9 дробных цифр. Смещения, отличные от "Z", также принимаются. Примеры: |
TripView
Селектор для различных наборов полей Trip в ответе trips.get
. См. AIP-157 для контекста. Вероятно, будут добавлены дополнительные представления.
Перечисления | |
---|---|
TRIP_VIEW_UNSPECIFIED | Значение по умолчанию. Для обратной совместимости API по умолчанию будет использовать вид SDK. Для обеспечения стабильности и поддержки клиентам рекомендуется выбирать TripView , отличный от SDK . |
SDK | Включает поля, которые могут быть неинтерпретируемыми или неподдерживаемыми с использованием общедоступных библиотек. |
JOURNEY_SHARING_V1S | Поля Trip заполняются для варианта использования Journey Sharing. Это представление предназначено для связи сервер-сервер. |
Атрибут поездки
Описывает атрибут поездки как пару ключ-значение. Длина строки "ключ:значение" не может превышать 256 символов.
JSON-представление |
---|
{ "key": string, // Union field |
Поля | |
---|---|
key | Ключ атрибута. Ключи не могут содержать символ двоеточия (:). |
Поле объединения trip_attribute_value . Значение атрибута может быть строковым, логическим или двойным. trip_attribute_value может быть только одним из следующих: | |
stringValue | Значение атрибута, типизированное как строка. |
boolValue | Значение атрибута логического типа. |
numberValue | Значение атрибута двойного типа. |
Методы | |
---|---|
| Создает рейс в Fleet Engine и возвращает новый рейс. |
| Удаляет одну поездку. |
| Получите информацию об одной поездке. |
| Получите все поездки для определенного транспортного средства. |
| Обновляет данные о поездке. |