REST Resource: projects.trips

Источник: Поездка

Путешествие.

JSON-представление 
{
  "name": string,
  "config": {
    object (TripConfig)
  },
  "androidAppId": string,
  "iosAppId": string,
  "authToken": {
    object (AuthToken)
  },
  "state": enum (State),
  "execution": {
    object (TripExecution)
  },
  "createTime": string,
  "updateTime": string
}
Поля
name

string

Только вывод. Идентификатор. Название ресурса поездки. Формат: projects/{project_number}/trips/{tripId}.

config

object ( TripConfig )

Неизменяемый. Конфигурация для поездки.

androidAppId

string

Только ввод. Неизменяемый. Идентификатор Android-приложения, которое будет использовать данные о поездке. Необходимо указать хотя бы один из параметров: androidAppId или iosAppId .

iosAppId

string

Только для ввода. Неизменяемый. Идентификатор пакета iOS мобильного приложения, которое будет использовать поездку. Должен быть указан хотя бы один из параметров: androidAppId или iosAppId .

authToken

object ( AuthToken )

Только для вывода. Непрозрачный токен, разрешающий доступ к началу поездки NavConnect в Google Maps или Waze и предоставляющий этим приложениям доступ к обновлению поездки. Возвращается только функцией trips.create .

state

enum ( State )

Только вывод. Состояние поездки.

execution

object ( TripExecution )

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

createTime

string ( Timestamp format)

Только вывод. Время по данным сервера на момент создания поездки.

Используется RFC 3339, согласно которому генерируемый вывод всегда будет Z-нормализован и будет содержать 0, 3, 6 или 9 дробных знаков. Допускаются также смещения, отличные от "Z". Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

updateTime

string ( Timestamp format)

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

Используется RFC 3339, согласно которому генерируемый вывод всегда будет Z-нормализован и будет содержать 0, 3, 6 или 9 дробных знаков. Допускаются также смещения, отличные от "Z". Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

TripConfig

Настройка поездки.

JSON-представление 
{
  "enableHighFrequencyUpdates": boolean,
  "enablePubsub": boolean,
  "pubsubFieldMask": string
}
Поля
enableHighFrequencyUpdates

boolean

Необязательно. Включить ли частое обновление информации о поездках.

ПРИМЕЧАНИЕ: Включение этой функции регистрирует поездку в рамках тарифов корпоративного уровня и оплачивается по тарифам корпоративного уровня.

enablePubsub

boolean

Необязательно. Включить ли уведомления от издателя/подписчика о поездке.

pubsubFieldMask

string ( FieldMask format)

Необязательно. Если задано, в уведомления pubsub будет включено только указанное подмножество полей Trip.

Если этот параметр не задан, все поля Trip будут включены в уведомления pubsub (поведение по умолчанию).

Следующие поля не поддерживаются:

  • androidAppId
  • iosAppId
  • authToken
  • config

Примечание: это поле игнорируется, если enablePubsub имеет значение false.

Это список полных имен полей, разделенных запятыми. Пример: "user.displayName,photo" .

AuthToken

Аутентификационный токен.

JSON-представление 
{
  "token": string,
  "expireTime": string
}
Поля
token

string

Только для вывода. Токен аутентификации, который должен быть передан в мобильное приложение.

expireTime

string ( Timestamp format)

Только вывод. Время истечения срока действия токена аутентификации.

Используется RFC 3339, согласно которому генерируемый вывод всегда будет Z-нормализован и будет содержать 0, 3, 6 или 9 дробных знаков. Допускаются также смещения, отличные от "Z". Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

Состояние

Все возможные состояния поездки.

Перечисления
STATE_UNSPECIFIED Штат, в котором находится поездка, не указан.
NEW Поездка была организована, но еще не началась.
ENROUTE Транспортное средство находится в пути к месту назначения.
ARRIVED Транспортное средство прибыло в пункт назначения.
SUSPENDED Поездка была отменена.
FAILED Поездка не завершилась успешно.
CLIENT_ERROR Поездка сорвалась из-за ошибки клиента.

TripExecution

Данные о ходе поездки.

JSON-представление 
{
  "origin": {
    object (Location)
  },
  "destination": {
    object (Stop)
  },
  "location": {
    object (Location)
  },
  "traveledDuration": string,
  "remainingDuration": string,
  "traveledDistanceMeters": integer,
  "remainingDistanceMeters": integer,
  "stopAddedInRoute": boolean
}
Поля
origin

object ( Location )

Только вывод. Начальная точка маршрута, которая, как правило, представляет собой местоположение перевозчика в начале поездки по системе NavConnect.

destination

object ( Stop )

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

location

object ( Location )

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

traveledDuration

string ( Duration format)

Только вывод. Время, пройденное до настоящего момента.

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

remainingDuration

string ( Duration format)

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

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

traveledDistanceMeters

integer

Только вывод. Расстояние, пройденное от начала координат, в метрах.

remainingDistanceMeters

integer

Только вывод. Расстояние до пункта назначения в метрах.

stopAddedInRoute

boolean

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

Расположение

Местоположение, указанное в мобильном приложении.

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

object ( LatLng )

Только вывод. Координаты (широта/долгота).

sourceTime

string ( Timestamp format)

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

Используется RFC 3339, согласно которому генерируемый вывод всегда будет Z-нормализован и будет содержать 0, 3, 6 или 9 дробных знаков. Допускаются также смещения, отличные от "Z". Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

serverTime

string ( Timestamp format)

Только вывод. Время, когда сервер получил это обновление местоположения.

Используется RFC 3339, согласно которому генерируемый вывод всегда будет Z-нормализован и будет содержать 0, 3, 6 или 9 дробных знаков. Допускаются также смещения, отличные от "Z". Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

LatLng

Объект, представляющий пару координат широты и долготы. Он выражается в виде пары чисел с плавающей запятой (double), обозначающих градусы широты и долготы. Если не указано иное, этот объект должен соответствовать стандарту WGS84 . Значения должны находиться в пределах нормализованных диапазонов.

JSON-представление 
{
  "latitude": number,
  "longitude": number
}
Поля
latitude

number

Широта в градусах. Она должна находиться в диапазоне [-90,0, +90,0].

longitude

number

Долгота в градусах. Она должна находиться в диапазоне [-180,0, +180,0].

Останавливаться

Остановка в пути, где необходимо выполнить какое-либо задание.

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

object ( LatLng )

Обязательно. Местоположение остановки в формате широта/долгота.

Методы

create

 Создает маршрут поездки.

get

 Отправляется в путешествие.