Method: providers.trips.search

获取特定车辆的所有行程信息。

HTTP 请求

POST https://fleetengine.googleapis.com/v1/{parent=providers/*}/trips:search

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。必须采用 providers/{provider} 格式。提供方必须是 Google Cloud 项目的 ID(例如 sample-cloud-project),进行此调用的服务账号所属的 Google Cloud 项目所属的项目。

请求正文

请求正文中包含结构如下的数据:

JSON 表示法
{
  "header": {
    object (RequestHeader)
  },
  "vehicleId": string,
  "activeTripsOnly": boolean,
  "pageSize": integer,
  "pageToken": string,
  "minimumStaleness": string
}
字段
header

object (RequestHeader)

标准 Fleet Engine 请求标头。

vehicleId

string

与请求中的行程相关联的车辆。如果未指定,返回的行程将不包含:

  • currentRouteSegment
  • remainingWaypoints
  • remainingDistanceMeters
  • etaToFirstWaypoint
activeTripsOnly

boolean

如果设置为 true,响应会包含影响司机路线的行程。

pageSize

integer

如果未设置,服务器会决定要返回的结果数。

pageToken

string

将此项设为之前在 SearchTripsResponse 中返回的值,以继续从之前的结果中继续操作。

minimumStaleness

string (Duration format)

如果指定,则返回在时间 (current - minimumStaleness) 之后未更新的行程。

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

响应正文

trip.search 响应消息。

如果成功,响应正文将包含结构如下的数据:

JSON 表示法
{
  "trips": [
    {
      object (Trip)
    }
  ],
  "nextPageToken": string
}
字段
trips[]

object (Trip)

所请求车辆的行程列表。

nextPageToken

string

在 SearchTripsRequest 中传递此令牌,以对列表结果进行分页。该 API 在每次调用时都会返回一个行程列表,如果没有更多结果,则行程列表为空。