Package google.maps.navconnect.v1

Индекс

Сервис для клиентов NavConnect, позволяющий создавать и получать маршруты.

CreateTrip

rpc CreateTrip( CreateTripRequest ) returns ( Trip )

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

Области полномочий

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

  • https://www.googleapis.com/auth/cloud-platform
Разрешения IAM

Для работы с parent ресурсом требуются следующие разрешения IAM :

  • navigationconnect.trips.create

Для получения более подробной информации см. документацию IAM .

GetTrip

rpc GetTrip( GetTripRequest ) returns ( Trip )

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

Области полномочий

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

  • https://www.googleapis.com/auth/cloud-platform
Разрешения IAM

Для доступа к ресурсу name требуются следующие разрешения IAM :

  • navigationconnect.trips.get

Для получения более подробной информации см. документацию IAM .

AuthToken

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

Поля
token

string

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

expire_time

Timestamp

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

CreateTripRequest

Сообщение запроса для NavConnectService.CreateTrip.

Поля
parent

string

Обязательно. Родительский ресурс, под которым будет создана эта поездка. Формат: projects/{project_number}

trip_id

string

Обязательно. Идентификатор, который будет использоваться для поездки и станет заключительной частью названия ресурса поездки.

Это значение должно быть допустимым UUID в соответствии со стандартом RFC-4122.

trip

Trip

Обязательно. Путешествие для творчества.

GetTripRequest

Запрос сообщения для NavConnectService.GetTrip.

Поля
name

string

Обязательно. Название ресурса поездки, которую нужно получить. Формат: projects/{project}/trips/{trip_id}

route_polyline_format

RoutePolylineFormat

Необязательный параметр. Формат возвращаемой полилинии маршрута. Если не указан, будет возвращена полилиния маршрута SIMPLE .

RoutePolylineFormat

Задает формат полилинии маршрута.

Перечисления
ROUTE_POLYLINE_FORMAT_UNSPECIFIED Формат полилинии маршрута не указан.
SIMPLE Полилиния маршрута возвращается в виде простого массива точек, представленного как google.type.LatLng .
ENCODED Полилиния маршрута возвращается в виде закодированной строки. См. https://developers.google.com/maps/documentation/utilities/polylinealgorithm .
S2ENCODED Полилиния маршрута закодирована как S2Polyline. См. https://s2geometry.io/devguide/basic_types.html .
GEO_JSON Полилиния маршрута возвращается в виде объекта GeoJSON LineString. См. https://tools.ietf.org/html/rfc7946#section-3.1.4 .

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

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

Поля
point

LatLng

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

source_time

Timestamp

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

server_time

Timestamp

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

Маршрут

Полилиния маршрута.

Поля
traffic_information[]

SpeedReadingInterval

Только вывод. Информация о дорожной ситуации на полилинии представлена ​​в виде интервалов измерения скорости.

ПРИМЕЧАНИЯ:

  • Интервалы не перекрываются.
  • Эти интервалы смежны.
  • Интервалы охватывают всю полилинию.
  • Интервалы отсортированы по возрастающему индексу.
  • Для каждого интервала указана скорость.

format поля Союза. Формат маршрута.

Формат заполнения определяется параметром route_polyline_format . Если он не задан, по умолчанию используется простая полилиния. format может принимать только одно из следующих значений:

simple_polyline

SimplePolyline

Только вывод. Маршрут в виде простого списка широт и долгот.

encoded_polyline

string

Только вывод. Маршрут в виде закодированной полилинии. См. https://developers.google.com/maps/documentation/utilities/polylinealgorithm .

s2_polyline

bytes

Только вывод. Маршрут в виде закодированной S2Polyline. См. https://s2geometry.io/devguide/basic_types.html .

geo_json

Struct

Только вывод. Маршрут в формате GeoJSON LineString. См. https://tools.ietf.org/html/rfc7946#section-3.1.4 .

SimplePolyline

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

Поля
points[]

LatLng

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

Интервал скорочтения

Индикатор плотности трафика на непрерывном участке пути. Для заданного пути с точками P_0, P_1, ..., P_N (индекс от нуля) параметр SpeedReadingInterval определяет интервал и описывает трафик на этом участке, используя категории Speed .

Поля
speed

Speed

Только вывод. Скорость движения в этом интервале.

start_polyline_point_index

int32

Только вывод. Начальный индекс этого интервала в пути.

end_polyline_point_index

int32

Только вывод. Конечный индекс этого интервала в пути.

Скорость

Классификация скорости по полилинии на основе данных о дорожном движении.

Перечисления
SPEED_UNSPECIFIED Скорость не указана.
NORMAL Нормальная скорость, без задержек движения.
SLOW Обнаружено замедление движения, интенсивность движения от низкой до средней.
TRAFFIC_JAM Задержки движения, в том числе и полная остановка транспорта.

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

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

Поля
point

LatLng

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

Путешествие

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

Поля
name

string

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

config

TripConfig

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

android_app_id

string

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

ios_app_id

string

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

auth_token

AuthToken

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

state

State

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

execution

TripExecution

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

create_time

Timestamp

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

update_time

Timestamp

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

Состояние

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

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

TripConfig

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

Поля
enable_high_frequency_updates

bool

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

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

enable_pubsub

bool

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

pubsub_field_mask

FieldMask

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

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

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

  • android_app_id
  • ios_app_id
  • auth_token
  • config

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

enable_remaining_route_reporting

bool

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

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

TripExecution

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

Поля
origin

Location

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

destination

Stop

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

location

Location

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

remaining_route

Route

Только для вывода. Предоставляет полилинию для оставшейся части маршрута.

traveled_duration

Duration

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

remaining_duration

Duration

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

traveled_distance_meters

int32

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

remaining_distance_meters

int32

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

stop_added_in_route

bool

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