TripLog

  • This document describes the TripLog resource in Fleet Engine, which logs trip details such as status, vehicle information, pickup/dropoff locations, and intermediate destinations.

  • TripLog provides fields for tracking actual pickup, dropoff, and intermediate destination locations and arrival times, offering insights into trip progress.

  • StopLocationLog is a sub-resource within TripLog used to record the precise location and timestamp of pickup/dropoff events for detailed analysis.

  • Several fields within TripLog utilize timestamps and durations to record crucial timing information, allowing for comprehensive trip monitoring and analysis.

The log of a Trip resource in Fleet Engine.

JSON representation 
{
  "name": string,
  "status": enum (TripStatusLog),
  "tripType": enum (TripTypeLog),
  "vehicleId": string,
  "lastLocation": {
    object (VehicleLocationLog)
  },
  "currentRouteSegmentEndPoint": {
    object (TripWaypointLog)
  },
  "pickupPoint": {
    object (TerminalLocationLog)
  },
  "actualPickupPoint": {
    object (StopLocationLog)
  },
  "actualPickupArrivalPoint": {
    object (StopLocationLog)
  },
  "pickupTime": string,
  "intermediateDestinations": [
    {
      object (TerminalLocationLog)
    }
  ],
  "intermediateDestinationIndex": integer,
  "intermediateDestinationsVersion": string,
  "actualIntermediateDestinations": [
    {
      object (StopLocationLog)
    }
  ],
  "actualIntermediateDestinationArrivalPoints": [
    {
      object (StopLocationLog)
    }
  ],
  "dropoffPoint": {
    object (TerminalLocationLog)
  },
  "actualDropoffPoint": {
    object (StopLocationLog)
  },
  "dropoffTime": string,
  "remainingDistanceMeters": integer,
  "etaToFirstWaypoint": string,
  "remainingTimeToFirstWaypoint": string,
  "numberOfPassengers": integer,
  "currentRouteSegmentTraffic": {
    object (ConsumableTrafficPolylineLog)
  },
  "attributes": [
    {
      object (TripAttributeLog)
    }
  ]
}
Fields
name

string

The trip resource name in the format of providers/{providerId}/trips/{tripId}.
status

enum (TripStatusLog)

The trip status.
tripType

enum (TripTypeLog)

The type of the trip.
vehicleId

string

The ID of the vehicle that the trip is assigned to.
lastLocation

object (VehicleLocationLog)

The last reported location of the vehicle along the route.
currentRouteSegmentEndPoint

object (TripWaypointLog)

The waypoint where the currentRouteSegment ends.
pickupPoint

object (TerminalLocationLog)

Location where customer indicates they will be picked up.
actualPickupPoint

object (StopLocationLog)

The actual location where customer was picked up.
actualPickupArrivalPoint

object (StopLocationLog)

The actual time and location of the driver arrival at the pickup point. This field lets a provider give feedback on actual arrival information at the pickup point.
pickupTime

string (Timestamp format)

The customer's drop-off time. May be future or past.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
intermediateDestinations[]

object (TerminalLocationLog)

Intermediate stops in requested order (in addition to pickup and dropoff).
intermediateDestinationIndex

integer

When TripStatus is ENROUTE_TO_INTERMEDIATE_DESTINATION, a number between [0..N-1] indicating which intermediate destination the vehicle will cross next. When TripStatus is ARRIVED_AT_INTERMEDIATE_DESTINATION, a number between [0..N-1] indicating which intermediate destination is the vehicle's current location.
intermediateDestinationsVersion

string (Timestamp format)

The version of the intermediate destinations given

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
actualIntermediateDestinations[]

object (StopLocationLog)

The actual time and location when and where the customer was picked up from an intermediate destination. This field lets a provider give feedback on actual pickup information at intermediate destinations.
actualIntermediateDestinationArrivalPoints[]

object (StopLocationLog)

The actual time and location of the driver's arrival at an intermediate destination. This field lets a provider give feedback on actual arrival information at intermediate destinations.
dropoffPoint

object (TerminalLocationLog)

Location where customer indicates they will be dropped off.
actualDropoffPoint

object (StopLocationLog)

The actual location where customer was dropped off.
dropoffTime

string (Timestamp format)

Time when customer will be or was dropped off.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
remainingDistanceMeters

integer

The remaining driving distance in the current route segment.
etaToFirstWaypoint

string (Timestamp format)

The ETA to the next waypoint (the first entry in Trip.remaining_waypoints field).

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
remainingTimeToFirstWaypoint

string (Duration format)

The remaining time to the next waypoint (the first entry in Trip.remaining_waypoints field).

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
numberOfPassengers

integer

Indicates the number of passengers on this trip and does not include the driver. A vehicle must have available capacity to be returned in SearchVehicles.
currentRouteSegmentTraffic

object (ConsumableTrafficPolylineLog)

When available, the traffic conditions along the currentRouteSegment.
attributes[]

object (TripAttributeLog)

A list of custom Trip attributes.

StopLocationLog

The actual location where a stop (pickup/dropoff) happens.

JSON representation 
{
  "timestamp": string,
  "point": {
    object (LatLng)
  }
}
Fields
timestamp

string (Timestamp format)

The timestamp when the location is recorded.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
point

object (LatLng)

Denotes the actual location of the stop.

TripAttributeLog

An attribute expressed as key-value pair that is associated with a Trip.

JSON representation 
{
  "key": string,

  // Union field trip_attribute_value can be only one of the following:
  "stringValue": string,
  "boolValue": boolean,
  "numberValue": number
  // End of list of possible types for union field trip_attribute_value.
}
Fields
key

string

The attribute's key.
Union field trip_attribute_value. The attribute's value, can be in string, bool, or double type. trip_attribute_value can be only one of the following:
stringValue

string

String typed attribute value.
boolValue

boolean

Boolean typed attribute value.
numberValue

number

Double typed attribute value.