REST Resource: projects.trips

资源：Trip

旅行。

JSON 表示法 
{
  "name": string,
  "config": {
    object (TripConfig)
  },
  "androidAppId": string,
  "iosAppId": string,
  "authToken": {
    object (AuthToken)
  },
  "state": enum (State),
  "execution": {
    object (TripExecution)
  },
  "createTime": string,
  "updateTime": string
}
字段
name

string

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

object (TripConfig)

不可变。行程的配置。
androidAppId

string

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

string

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

object (AuthToken)

仅限输出。一种不透明的令牌，用于授权访问，以便在 Google 地图或 Waze 中开始 NavConnect 行程，并授予这些应用更新行程的权限。仅由 trips.create 返回。
state

enum (State)

仅限输出。行程状态。
execution

object (TripExecution)

仅限输出。有关行程执行情况的最新数据。如果行程处于错误状态，则可能不会设置此字段。
createTime

string (Timestamp format)

仅限输出。行程的创建时间（以服务器时间为准）。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

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

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

TripConfig

行程的配置。

JSON 表示法 
{
  "enableHighFrequencyUpdates": boolean,
  "enablePubsub": boolean,
  "pubsubFieldMask": string,
  "enableRemainingRouteReporting": boolean
}
字段
enableHighFrequencyUpdates

boolean

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

注意：启用此功能后，系统会将行程记录在企业版层级的使用情况中，并按企业版层级的费率收费。
enablePubsub

boolean

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

string (FieldMask format)

可选。如果设置，则只有指定的部分 Trip 字段会包含在 pubsub 通知中。

如果未设置，则所有 Trip 字段都将包含在 Pub/Sub 通知中（默认行为）。

不支持以下字段：

  • androidAppId
  • iosAppId
  • authToken
  • config

注意：如果 enablePubsub 为 false，则忽略此字段。

这是完全限定字段名称的逗号分隔列表。示例："user.displayName,photo"。
enableRemainingRouteReporting

boolean

可选。是否为行程启用剩余路线报告。

注意：启用此功能后，系统会将行程记录在企业版层级的使用情况中，并按企业版层级的费率收费。

AuthToken

身份验证令牌。

JSON 表示法 
{
  "token": string,
  "expireTime": string
}
字段
token

string

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

string (Timestamp format)

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

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

州

所有可能的行程状态。

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

TripExecution

有关行程执行的数据。

JSON 表示法 
{
  "origin": {
    object (Location)
  },
  "destination": {
    object (Stop)
  },
  "location": {
    object (Location)
  },
  "remainingRoute": {
    object (Route)
  },
  "traveledDuration": string,
  "remainingDuration": string,
  "traveledDistanceMeters": integer,
  "remainingDistanceMeters": integer,
  "stopAddedInRoute": boolean
}
字段
origin

object (Location)

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

object (Stop)

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

object (Location)

仅限输出。表示运输工具最后已知位置的位置信号。如果可用，则为贴合道路的位置。
remainingRoute

object (Route)

仅限输出。提供路线剩余部分的多段线。
traveledDuration

string (Duration format)

仅限输出。截至目前的出行时间。

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。
remainingDuration

string (Duration format)

仅限输出。Google 估算的本次行程的剩余时间。

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。
traveledDistanceMeters

integer

仅限输出。从原点开始的行驶距离（以米为单位）。
remainingDistanceMeters

integer

仅限输出。距离目的地剩余的距离（以米为单位）。
stopAddedInRoute

boolean

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

位置

移动应用报告的位置。

JSON 表示法 
{
  "point": {
    object (LatLng)
  },
  "sourceTime": string,
  "serverTime": string
}
字段
point

object (LatLng)

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

string (Timestamp format)

仅限输出。位置信息的来源时间（由客户端指定）。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
serverTime

string (Timestamp format)

仅限输出。服务器收到相应位置更新的时间。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

LatLng

表示纬度/经度对的对象。该对象以一对双精度数表示，分别代表纬度度数和经度度数。除非另有说明，否则该对象必须符合 WGS84 标准。值必须介于标准化范围内。

JSON 表示法 
{
  "latitude": number,
  "longitude": number
}
字段
latitude

number

纬度（以度为单位）。它必须在 [-90.0, +90.0] 范围内。
longitude

number

经度（以度为单位）。它必须在 [-180.0, +180.0] 范围内。

停止

行程中要执行某些任务的停靠点。

JSON 表示法 
{
  "point": {
    object (LatLng)
  }
}
字段
point

object (LatLng)

必需。车站的位置（纬度/经度）。

路线

路线多段线。

JSON 表示法 
{
  "trafficInformation": [
    {
      object (SpeedReadingInterval)
    }
  ],

  // Union field format can be only one of the following:
  "simplePolyline": {
    object (SimplePolyline)
  },
  "encodedPolyline": string,
  "s2Polyline": string,
  "geoJson": {
    object
  }
  // End of list of possible types for union field format.
}
字段
trafficInformation[]

object (SpeedReadingInterval)

仅限输出。多段线上的路况信息，以速度读数间隔的形式描述。

注意：

  • 这些时间段不重叠。
  • 这些时间区间是连续的。
  • 这些区间涵盖整个折线。
  • 这些区间按索引升序排序。
  • 为每个间隔指定速度。

联合字段 format。路线格式。

填充的格式由 route_polyline_format 参数控制。如果未设置，则默认为简单折线。format 只能是下列其中一项：
simplePolyline

object (SimplePolyline)

仅限输出。以简单的 LatLng 列表形式表示的路线。
encodedPolyline

string

仅限输出。以编码多段线形式表示的路线。请参阅 https://developers.google.com/maps/documentation/utilities/polylinealgorithm。
s2Polyline

string (bytes format)

仅限输出。以编码 S2Polyline 形式表示的路线。请参阅 https://s2geometry.io/devguide/basic_types.html。

使用 base64 编码的字符串。
geoJson

object (Struct format)

仅限输出。以 GeoJSON LineString 格式表示的路线。请参阅 https://tools.ietf.org/html/rfc7946#section-3.1.4。

SimplePolyline

使用简单的点列表表示多段线。

JSON 表示法 
{
  "points": [
    {
      object (LatLng)
    }
  ]
}
字段
points[]

object (LatLng)

仅限输出。表示折线的点的有序列表。

SpeedReadingInterval

路径上连续路段的车流密度指示器。给定一条包含点 P_0、P_1、...、P_N（从零开始的索引）的路径，SpeedReadingInterval 会定义一个区间，并使用 Speed 个类别描述该区间的车流。

JSON 表示法 
{
  "speed": enum (Speed),
  "startPolylinePointIndex": integer,
  "endPolylinePointIndex": integer
}
字段
speed

enum (Speed)

仅限输出。相应时间间隔内的交通速度。
startPolylinePointIndex

integer

仅限输出。相应间隔在路径中的起始索引。
endPolylinePointIndex

integer

仅限输出。相应间隔在路径中的结束索引。

速度

基于流量数据的折线速度分类。

枚举
SPEED_UNSPECIFIED 未指定速度。
NORMAL 正常速度，无交通延误。
SLOW 检测到减速，车流量较少到中等。
TRAFFIC_JAM 交通延误，包括交通停滞。

方法

create

 创建行程。

get

 获取行程。