Package google.maps.navconnect.v1

索引

供 NavConnect 客户端创建和获取行程的服务。

CreateTrip

rpc CreateTrip(CreateTripRequest) returns (Trip)

创建行程。必须先调用此方法,移动应用才能开始行程。返回的行程将设置 auth_token 字段。

授权范围

需要以下 OAuth 范围:

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

rpc GetTrip(GetTripRequest) returns (Trip)

获取行程。

授权范围

需要以下 OAuth 范围:

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

AuthToken

身份验证令牌。

字段
token

string

仅限输出。应传递给移动应用的身份验证令牌。

expire_time

Timestamp

仅限输出。身份验证令牌的到期时间。

CreateTripRequest

NavConnectService.CreateTrip 的请求消息。

字段
parent

string

必需。将在其下创建此行程的父级资源。格式:projects/{project_number}

trip_id

string

必需。用于行程的 ID,该 ID 将成为行程资源名称的最后一个组成部分。

此值必须是有效的 RFC-4122 UUID。

trip

Trip

必需。要创建的行程。

GetTripRequest

NavConnectService.GetTrip 的请求消息。

字段
name

string

必需。要获取的行程的资源名称。格式:projects/{project}/trips/{trip_id}

Location

移动应用报告的位置。

字段
point

LatLng

仅限输出。位置的纬度/经度。

source_time

Timestamp

仅限输出。客户端指示的位置来源时间。

server_time

Timestamp

仅限输出。服务器收到此位置信息更新的时间。

Stop

行程中的停靠点,用于执行某些任务。

字段
point

LatLng

必需。停靠点的位置,以纬度/经度表示。

Trip

行程。

字段
name

string

仅限输出。标识符。行程的资源名称。格式:projects/{project_number}/trips/{trip_id}。

config

TripConfig

不可变。行程的配置。

android_app_id

string

仅限输入。不可变。将使用行程的移动应用的 Android 应用 ID。必须设置 android_app_idios_app_id 中的至少一个。

ios_app_id

string

仅限输入。不可变。将使用行程的移动应用的 iOS 软件包 ID。必须设置 android_app_idios_app_id 中的至少一个。

auth_token

AuthToken

仅限输出。不透明令牌,用于授权在 Google 地图或 Waze 中开始 NavConnect 行程,并授予这些应用更新行程的权限。仅由 CreateTrip 返回。

state

State

仅限输出。行程状态。

execution

TripExecution

仅限输出。有关行程执行的最新数据。如果行程处于错误状态,则可能未设置此字段。

create_time

Timestamp

仅限输出。行程创建时服务器的时间。

update_time

Timestamp

仅限输出。服务器收到最新行程更新的时间。

State

所有可能的行程状态。

枚举
STATE_UNSPECIFIED 未指定行程状态。
NEW 行程已创建,但尚未开始。
ENROUTE 运输方正在前往目的地。
ARRIVED 运输方已抵达目的地。
SUSPENDED 行程已暂停。
FAILED 行程未能成功完成。
CLIENT_ERROR 由于客户端错误,行程失败。

TripConfig

行程的配置。

字段
enable_high_frequency_updates

bool

可选。是否启用高频率行程更新。

注意:启用此功能会将行程记录在企业版层级用量下,并按企业版层级费率收费。

enable_pubsub

bool

可选。是否为行程启用 Pub/Sub 通知。

pubsub_field_mask

FieldMask

可选。如果设置,Pub/Sub 通知中将仅包含行程字段的指定子集。

如果未设置,Pub/Sub 通知中将包含所有行程字段(默认行为)。

不支持以下字段:

  • android_app_id
  • ios_app_id
  • auth_token
  • config

注意:如果 enable_pubsub 为 false,则忽略此字段。

TripExecution

有关行程执行的数据。

字段
origin

Location

仅限输出。行程的起点,通常是运输方在 NavConnect 行程开始时的位置。

destination

Stop

仅限输出。移动应用报告的行程目的地。

location

Location

仅限输出。表示运输方最新已知位置的位置信号。如果有道路贴靠位置,则此字段将是道路贴靠位置。

traveled_duration

Duration

仅限输出。到目前为止的行驶时间。

remaining_duration

Duration

仅限输出。Google 估计的此行程剩余时间。

traveled_distance_meters

int32

仅限输出。从起点行驶的距离(以米为单位)。

remaining_distance_meters

int32

仅限输出。到目的地的剩余距离(以米为单位)。

stop_added_in_route

bool

仅限输出。指明是否在路线中添加了停靠点。