REST Resource: selection.v1.projects.selectedRoutes

Ресурс: SelectedRoute

SelectedRoute представляет собой определенный маршрут, по которому клиент хочет периодически получать информацию (например, длительность) для предусмотренных контрактом вариантов использования.

JSON-представление 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "state": enum (State),
  "routeAttributes": {
    string: string,
    ...
  },

  // Union field route_type can be only one of the following:
  "dynamicRoute": {
    object (DynamicRoute)
  }
  // End of list of possible types for union field route_type.
  "validationError": enum (ValidationError)
}
Поля
name

string

Идентификатор. Имя ресурса SelectedRoute .

Формат: projects/{project}/selectedRoutes/{selectedRoute}

displayName

string

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

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" .

state

enum ( State )

Только вывод. Состояние выбранного маршрута.

routeAttributes

map (key: string, value: string)

Необязательные. Пользовательские атрибуты для выбранного маршрута. Их добавление позволяет фильтровать/группировать маршруты при получении исторической и актуальной информации о маршрутах. Поддерживается до 10 атрибутов для каждого маршрута. Каждый ключ и значение должны быть непустой строкой и содержать до 100 символов. Ключи не должны начинаться с «goog».

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

Поле объединения route_type . В настоящее время поддерживается только DynamicRoute . route_type может быть только одним из следующих:
dynamicRoute

object ( DynamicRoute )

SelectedRoute — это динамический маршрут.

validationError

enum ( ValidationError )

Только вывод. Ошибка проверки выбранного маршрута в состоянии STATE_INVALID.

Динамический маршрут

Это маршрут с промежуточными точками (начальная, конечная и промежуточные). Фактический маршрут гарантированно проходит через все промежуточные точки, но может периодически меняться из-за меняющейся дорожной обстановки.

JSON-представление 
{
  "origin": {
    object (LatLng)
  },
  "destination": {
    object (LatLng)
  },
  "intermediates": [
    {
      object (LatLng)
    }
  ]
}
Поля
origin

object ( LatLng )

Обязательно. Начальная точка маршрута.

destination

object ( LatLng )

Обязательно. Конечная точка маршрута.

intermediates[]

object ( LatLng )

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

Широта и долгота

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

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

number

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

longitude

number

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

Состояние

Состояние выбранного маршрута.

Перечисления
STATE_UNSPECIFIED Состояние этого маршрута не установлено.
STATE_SCHEDULING Маршрут создан и составляется.
STATE_RUNNING Маршрут создан и имеет активное расписание.
STATE_DELETING Маршрут отмечен для удаления.
STATE_VALIDATING Маршрут находится в процессе утверждения.
STATE_INVALID Маршрут недействителен по одному из критериев проверки.

Ошибка проверки

Ошибка проверки выбранного маршрута.

Перечисления
VALIDATION_ERROR_UNSPECIFIED Ошибка проверки данного маршрута не установлена.
VALIDATION_ERROR_ROUTE_OUTSIDE_JURISDICTION Маршрут находится за пределами юрисдикции проекта.
VALIDATION_ERROR_LOW_ROAD_USAGE Маршрут имеет низкую загруженность дорог (по нему проезжает очень мало людей).

Методы

batchCreate

 Создает несколько SelectedRoutes и запускает расписание для периодического извлечения информации из кэша для каждого из маршрутов.

create

 Создает SelectedRoute и запускает расписание для периодического извлечения кэшированной информации для маршрута.

delete

 Удаляет указанный SelectedRoute для указанного проекта.

get

 Получает SelectedRoute, как указано его именем.

list

 Выводит список всех выбранных маршрутов для указанного проекта с разбивкой на страницы.