索引
NavConnectService(接口)AuthToken(消息)CreateTripRequest(消息)GetTripRequest(消息)Location(消息)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} |
Location
移动应用报告的位置。
| 字段 | |
|---|---|
point |
仅限输出。位置的纬度/经度。 |
source_time |
仅限输出。客户端指示的位置来源时间。 |
server_time |
仅限输出。服务器收到此位置信息更新的时间。 |
Stop
行程中的停靠点,用于执行某些任务。
| 字段 | |
|---|---|
point |
必需。停靠点的位置,以纬度/经度表示。 |
Trip
行程。
| 字段 | |
|---|---|
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
所有可能的行程状态。
| 枚举 | |
|---|---|
STATE_UNSPECIFIED |
未指定行程状态。 |
NEW |
行程已创建,但尚未开始。 |
ENROUTE |
运输方正在前往目的地。 |
ARRIVED |
运输方已抵达目的地。 |
SUSPENDED |
行程已暂停。 |
FAILED |
行程未能成功完成。 |
CLIENT_ERROR |
由于客户端错误,行程失败。 |
TripConfig
行程的配置。
| 字段 | |
|---|---|
enable_high_frequency_updates |
可选。是否启用高频率行程更新。 注意:启用此功能会将行程记录在企业版层级用量下,并按企业版层级费率收费。 |
enable_pubsub |
可选。是否为行程启用 Pub/Sub 通知。 |
pubsub_field_mask |
可选。如果设置,Pub/Sub 通知中将仅包含行程字段的指定子集。 如果未设置,Pub/Sub 通知中将包含所有行程字段(默认行为)。 不支持以下字段:
注意:如果 |
TripExecution
有关行程执行的数据。
| 字段 | |
|---|---|
origin |
仅限输出。行程的起点,通常是运输方在 NavConnect 行程开始时的位置。 |
destination |
仅限输出。移动应用报告的行程目的地。 |
location |
仅限输出。表示运输方最新已知位置的位置信号。如果有道路贴靠位置,则此字段将是道路贴靠位置。 |
traveled_duration |
仅限输出。到目前为止的行驶时间。 |
remaining_duration |
仅限输出。Google 估计的此行程剩余时间。 |
traveled_distance_meters |
仅限输出。从起点行驶的距离(以米为单位)。 |
remaining_distance_meters |
仅限输出。到目的地的剩余距离(以米为单位)。 |
stop_added_in_route |
仅限输出。指明是否在路线中添加了停靠点。 |