Method: providers.trips.get

Get information about a single trip.

HTTP request

GET https://fleetengine.googleapis.com/v1/{name=providers/*/trips/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Must be in the format providers/{provider}/trips/{trip}. The provider must be the Project ID (for example, sample-cloud-project) of the Google Cloud Project of which the service account making this call is a member.

Query parameters

Parameters
header

object (RequestHeader)

The standard Fleet Engine request header.
view

enum (TripView)

The subset of Trip fields that should be returned and their interpretation.
currentRouteSegmentVersion

string (Timestamp format)

Indicates the minimum timestamp (exclusive) for which Trip.route or Trip.current_route_segment data are retrieved. If route data are unchanged since this timestamp, the route field is not set in the response. If a minimum is unspecified, the route data are always retrieved.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
remainingWaypointsVersion

string (Timestamp format)

Indicates the minimum timestamp (exclusive) for which Trip.remaining_waypoints are retrieved. If they are unchanged since this timestamp, the remainingWaypoints are not set in the response. If this field is unspecified, remainingWaypoints is always retrieved.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
routeFormatType

enum (PolylineFormatType)

The returned current route format, LAT_LNG_LIST_TYPE (in Trip.route), or ENCODED_POLYLINE_TYPE (in Trip.current_route_segment). The default is LAT_LNG_LIST_TYPE.
currentRouteSegmentTrafficVersion

string (Timestamp format)

Indicates the minimum timestamp (exclusive) for which Trip.current_route_segment_traffic is retrieved. If traffic data are unchanged since this timestamp, the currentRouteSegmentTraffic field is not set in the response. If a minimum is unspecified, the traffic data are always retrieved. Note that traffic is only available for On-Demand Rides and Deliveries Solution customers.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
remainingWaypointsRouteVersion

string (Timestamp format)

Indicates the minimum timestamp (exclusive) for which Trip.remaining_waypoints.traffic_to_waypoint and Trip.remaining_waypoints.path_to_waypoint data are retrieved. If data are unchanged since this timestamp, the fields above are not set in the response. If remainingWaypointsRouteVersion is unspecified, traffic and path are always retrieved.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Trip.

PolylineFormatType

The type of polyline format.

Enums
UNKNOWN_FORMAT_TYPE The format is unspecified or unknown.
LAT_LNG_LIST_TYPE A list of google.type.LatLng.
ENCODED_POLYLINE_TYPE A polyline encoded with a polyline compression algorithm. Decoding is not yet supported.