索引
NavConnectService(接口)AuthToken(消息)CreateTripRequest(消息)GetTripRequest(消息)GetTripRequest.RoutePolylineFormat(枚举)Location(消息)Route(消息)SimplePolyline(消息)SpeedReadingInterval(消息)SpeedReadingInterval.Speed(枚举)Stop(消息)Trip(消息)Trip.State(枚举)TripConfig(消息)TripExecution(消息)
NavConnectService
供 NavConnect 客户端创建和获取行程的服务。
| CreateTrip |
|---|
|
创建行程。必须在移动应用开始行程之前调用此方法。返回的行程将设置
|
| GetTrip |
|---|
|
获取行程。
|
AuthToken
身份验证令牌。
| 字段 | |
|---|---|
token |
仅限输出。应传递给移动应用的身份验证令牌。 |
expire_time |
仅限输出。身份验证令牌的过期时间。 |
CreateTripRequest
针对 NavConnectService.CreateTrip 的请求消息。
| 字段 | |
|---|---|
parent |
必需。将创建相应行程的父级资源。格式:projects/{project_number} |
trip_id |
必需。要用于行程的 ID,该 ID 将成为行程资源名称的最后一个组成部分。 此值必须是有效的 RFC-4122 UUID。 |
trip |
必需。要创建的行程。 |
GetTripRequest
针对 NavConnectService.GetTrip 的请求消息。
| 字段 | |
|---|---|
name |
必需。要获取的行程的资源名称。格式:projects/{project}/trips/{trip_id} |
route_polyline_format |
可选。要返回的路线多段线的格式。如果未设置,则返回 |
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 |
仅限输出。地理位置的纬度/经度。 |
source_time |
仅限输出。位置信息的来源时间(由客户端指定)。 |
server_time |
仅限输出。服务器收到相应位置更新的时间。 |
路线
路线多段线。
| 字段 | |
|---|---|
traffic_information[] |
仅限输出。多段线上的流量信息,以速度读取间隔的形式描述。 注意:
|
联合字段 填充的格式由 |
|
simple_polyline |
仅限输出。以简单的 LatLng 列表形式表示的路线。 |
encoded_polyline |
仅限输出。以编码多段线形式表示的路线。请参阅 https://developers.google.com/maps/documentation/utilities/polylinealgorithm。 |
s2_polyline |
仅限输出。以编码 S2Polyline 形式表示的路线。请参阅 https://s2geometry.io/devguide/basic_types.html。 |
geo_json |
仅限输出。以 GeoJSON LineString 格式表示的路线。请参阅 https://tools.ietf.org/html/rfc7946#section-3.1.4。 |
SimplePolyline
使用简单的点列表表示多段线。
| 字段 | |
|---|---|
points[] |
仅限输出。表示折线的点的有序列表。 |
SpeedReadingInterval
路径上连续路段的车流密度指示器。给定一条包含点 P_0、P_1、...、P_N(从零开始的索引)的路径,SpeedReadingInterval 会定义一个区间,并使用 Speed 个类别描述该区间的车流。
| 字段 | |
|---|---|
speed |
仅限输出。相应时间间隔内的交通速度。 |
start_polyline_point_index |
仅限输出。相应间隔在路径中的起始索引。 |
end_polyline_point_index |
仅限输出。相应间隔在路径中的结束索引。 |
速度
基于流量数据的折线速度分类。
| 枚举 | |
|---|---|
SPEED_UNSPECIFIED |
未指定速度。 |
NORMAL |
正常速度,无交通延误。 |
SLOW |
检测到减速,车流量较少到中等。 |
TRAFFIC_JAM |
交通延误,包括交通停滞。 |
停止
行程中要执行某些任务的停靠点。
| 字段 | |
|---|---|
point |
必需。车站的位置(纬度/经度)。 |
行程
旅行。
| 字段 | |
|---|---|
name |
仅限输出。标识符。行程的资源名称。格式:projects/{project_number}/trips/{trip_id}。 |
config |
不可变。行程的配置。 |
android_app_id |
仅限输入。不可变。将使用行程的移动应用的 Android 应用 ID。必须至少设置 |
ios_app_id |
仅限输入。不可变。将使用行程的移动应用的 iOS 软件包 ID。必须至少设置 |
auth_token |
仅限输出。一种不透明的令牌,用于授权访问,以便在 Google 地图或 Waze 中开始 NavConnect 行程,并授予这些应用更新行程的权限。仅由 |
state |
仅限输出。行程状态。 |
execution |
仅限输出。有关行程执行情况的最新数据。如果行程处于错误状态,则可能不会设置此字段。 |
create_time |
仅限输出。行程的创建时间(以服务器时间为准)。 |
update_time |
仅限输出。服务器收到最新行程更新的时间。 |
州
所有可能的行程状态。
| 枚举 | |
|---|---|
STATE_UNSPECIFIED |
未指定行程状态。 |
NEW |
行程已创建,但尚未开始。 |
ENROUTE |
运输方正在前往目的地。 |
ARRIVED |
运输人员已抵达目的地。 |
SUSPENDED |
行程已暂停。 |
FAILED |
行程未能成功完成。 |
CLIENT_ERROR |
由于客户端错误,行程失败。 |
CANCELED |
行程由开发者明确取消。 |
TripConfig
行程的配置。
| 字段 | |
|---|---|
enable_high_frequency_updates |
可选。是否启用高频行程更新。 注意:启用此功能后,系统会根据企业版层级的使用情况记录行程,并按企业版层级的费率收费。 |
enable_pubsub |
可选。是否为相应行程启用 Pub/Sub 通知。 |
pubsub_field_mask |
可选。如果设置,则只有指定的部分 Trip 字段会包含在 pubsub 通知中。 如果未设置,则所有 Trip 字段都将包含在 Pub/Sub 通知中(默认行为)。 不支持以下字段:
注意:如果 |
enable_remaining_route_reporting |
可选。是否为行程启用剩余路线报告。 注意:启用此功能后,系统会将行程记录在企业版层级的使用情况中,并按企业版层级的费率收费。 |
TripExecution
有关行程执行的数据。
| 字段 | |
|---|---|
origin |
仅限输出。行程的起点,通常是运输方在 NavConnect 行程开始时的位置。 |
destination |
仅限输出。移动应用报告的行程目的地。 |
location |
仅限输出。表示运输工具最后已知位置的位置信号。如果可用,则为贴合道路的位置。 |
remaining_route |
仅限输出。提供路线剩余部分的多段线。 |
traveled_duration |
仅限输出。截至目前的出行时间。 |
remaining_duration |
仅限输出。Google 估算的本次行程的剩余时间。 |
traveled_distance_meters |
仅限输出。从原点开始的行驶距离(以米为单位)。 |
remaining_distance_meters |
仅限输出。距离目的地剩余的距离(以米为单位)。 |
stop_added_in_route |
仅限输出。指明是否在路线中添加了经停点。 |