Package google.maps.roads.selection.v1

Индекс

Выбор дорог

Определение сервиса для API выбора дорог.

Пакетное создание выбранных маршрутов

rpc BatchCreateSelectedRoutes( BatchCreateSelectedRoutesRequest ) returns ( BatchCreateSelectedRoutesResponse )

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

Области авторизации

Требуется следующая область OAuth:

  • https://www.googleapis.com/auth/cloud-platform
СоздатьВыбранныйМаршрут

rpc CreateSelectedRoute( CreateSelectedRouteRequest ) returns ( SelectedRoute )

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

Области авторизации

Требуется следующая область OAuth:

  • https://www.googleapis.com/auth/cloud-platform
УдалитьВыбранныйМаршрут

rpc DeleteSelectedRoute( DeleteSelectedRouteRequest ) returns ( Empty )

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

Области авторизации

Требуется следующая область OAuth:

  • https://www.googleapis.com/auth/cloud-platform
GetSelectedRoute

rpc GetSelectedRoute( GetSelectedRouteRequest ) returns ( SelectedRoute )

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

Области авторизации

Требуется следующая область OAuth:

  • https://www.googleapis.com/auth/cloud-platform
СписокВыбранныхМаршрутов

rpc ListSelectedRoutes( ListSelectedRoutesRequest ) returns ( ListSelectedRoutesResponse )

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

Области авторизации

Требуется следующая область OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Пакетное создание выбранных маршрутов

Запрос на создание нескольких SelectedRoute .

Поля
parent

string

Необязательно. Ресурс проекта, общий для всех выбранных маршрутов. Формат: projects/{project}. Если этот параметр задан, родительское поле в сообщениях CreateSelectedRouteRequest должно быть либо пустым, либо совпадать с этим полем.

requests[]

CreateSelectedRouteRequest

Обязательно. Запрос с указанием выбранного маршрута для создания. В пакете можно создать не более 1000 выбранных маршрутов.

Пакетное создание выбранных маршрутов

Ответ на создание нескольких SelectedRoute .

Поля
selected_routes[]

SelectedRoute

Созданы выбранные маршруты.

CreateSelectedRouteRequest

Запрос на создание SelectedRoute .

Поля
parent

string

Обязательно. Проект, в котором будет создан SelectedRoute . Формат: projects/{project}

selected_route

SelectedRoute

Обязательно. SelectedRoute для создания.

selected_route_id

string

Необязательно. Идентификатор, используемый для SelectedRoute , который станет последним компонентом имени ресурса SelectedRoute .

Это значение должно содержать от 4 до 63 символов. Допустимые символы: «az», «AZ», «0-9» или «-». Если значение не указано или пусто, UUID будет сгенерирован после создания ресурса.

DeleteSelectedRouteRequest

Запрос на удаление SelectedRoute .

Поля
name

string

Обязательно. Имя выбранного маршрута для удаления. Формат: projects/{project}/selectedRoutes/{selected_route}

GetSelectedRouteRequest

Запрос на получение SelectedRoute .

Поля
name

string

Обязательно. Имя SelectedRoute для извлечения. Формат: projects/{project}/selectedRoutes/{selected_route}

ListSelectedRoutesRequest

Запрос на включение в список SelectedRoute s.

Поля
parent

string

Обязательно. Родительский проект, из которого будут запрошены все объекты SelectedRoute . Формат: projects/{project}/selectedRoutes

page_size

int32

Необязательно. Количество результатов, которые должны быть возвращены для данной страницы. Если не указано, значение по умолчанию — 100. При указании значения 0 будет установлено значение по умолчанию. Максимальное значение — 5000; любое значение выше 5000 будет установлено как 5000.

page_token

string

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

ListSelectedRoutesResponse

Ответ, в котором перечислены SelectedRoute .

Поля
selected_routes[]

SelectedRoute

Страница SelectedRoutes, сохраненная в проекте, указанном в запросе.

next_page_token

string

Токен, который можно отправить как page_token для получения следующей страницы. Если это поле пусто, последующих страниц нет.

Выбранный маршрут

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

Поля
name

string

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

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

display_name

string

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

create_time

Timestamp

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

state

State

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

route_attributes

map<string, string>

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

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

DynamicRoute

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

validation_error

ValidationError

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

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

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

Поля
origin

LatLng

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

destination

LatLng

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

intermediates[]

LatLng

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

Состояние

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

Перечисления
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 Маршрут имеет низкую загруженность дорог (по нему проезжает очень мало людей).