@googlemaps/fleetengine 0.1.0

package/build/protos/google/maps/fleetengine/v1/trip_api.proto

@@ -0,0 +1,377 @@
+// Copyright 2023 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package maps.fleetengine.v1;
+
+import "google/api/annotations.proto";
+import "google/api/client.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/api/routing.proto";
+import "google/maps/fleetengine/v1/fleetengine.proto";
+import "google/maps/fleetengine/v1/header.proto";
+import "google/maps/fleetengine/v1/trips.proto";
+import "google/protobuf/duration.proto";
+import "google/protobuf/empty.proto";
+import "google/protobuf/field_mask.proto";
+import "google/protobuf/timestamp.proto";
+
+option csharp_namespace = "Google.Maps.FleetEngine.V1";
+option go_package = "cloud.google.com/go/maps/fleetengine/apiv1/fleetenginepb;fleetenginepb";
+option java_multiple_files = true;
+option java_outer_classname = "TripApi";
+option java_package = "google.maps.fleetengine.v1";
+option objc_class_prefix = "CFE";
+
+// Trip management service.
+service TripService {
+  option (google.api.default_host) = "fleetengine.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/cloud-platform";
+
+  // Creates a trip in the Fleet Engine and returns the new trip.
+  rpc CreateTrip(CreateTripRequest) returns (Trip) {
+    option (google.api.http) = {
+      post: "/v1/{parent=providers/*}/trips"
+      body: "trip"
+    };
+    option (google.api.routing) = {
+      routing_parameters {
+        field: "parent"
+        path_template: "{provider_id=providers/*}"
+      }
+    };
+  }
+
+  // Get information about a single trip.
+  rpc GetTrip(GetTripRequest) returns (Trip) {
+    option (google.api.http) = {
+      get: "/v1/{name=providers/*/trips/*}"
+    };
+    option (google.api.routing) = {
+      routing_parameters {
+        field: "name"
+        path_template: "{provider_id=providers/*}"
+      }
+    };
+  }
+
+  // Report billable trip usage.
+  rpc ReportBillableTrip(ReportBillableTripRequest)
+      returns (google.protobuf.Empty) {
+    option (google.api.http) = {
+      post: "/v1/{name=providers/*/billableTrips/*}:report"
+      body: "*"
+    };
+    option (google.api.routing) = {
+      routing_parameters {
+        field: "name"
+        path_template: "{provider_id=providers/*}"
+      }
+    };
+  }
+
+  // Get all the trips for a specific vehicle.
+  rpc SearchTrips(SearchTripsRequest) returns (SearchTripsResponse) {
+    option (google.api.http) = {
+      post: "/v1/{parent=providers/*}/trips:search"
+      body: "*"
+    };
+    option (google.api.routing) = {
+      routing_parameters {
+        field: "parent"
+        path_template: "{provider_id=providers/*}"
+      }
+    };
+  }
+
+  // Updates trip data.
+  rpc UpdateTrip(UpdateTripRequest) returns (Trip) {
+    option (google.api.http) = {
+      put: "/v1/{name=providers/*/trips/*}"
+      body: "trip"
+    };
+    option (google.api.routing) = {
+      routing_parameters {
+        field: "name"
+        path_template: "{provider_id=providers/*}"
+      }
+    };
+  }
+}
+
+// CreateTrip request message.
+message CreateTripRequest {
+  // The standard Fleet Engine request header.
+  RequestHeader header = 1;
+
+  // Required. Must be in the format `providers/{provider}`.
+  // 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.
+  string parent = 3 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "fleetengine.googleapis.com/Trip"
+    }
+  ];
+
+  // Required. Unique Trip ID.
+  // Subject to the following restrictions:
+  //
+  // * Must be a valid Unicode string.
+  // * Limited to a maximum length of 64 characters.
+  // * Normalized according to [Unicode Normalization Form C]
+  // (http://www.unicode.org/reports/tr15/).
+  // * May not contain any of the following ASCII characters: '/', ':', '?',
+  // ',', or '#'.
+  string trip_id = 5 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. Trip entity to create.
+  //
+  // When creating a Trip, the following fields are required:
+  //
+  // * `trip_type`
+  // * `pickup_point`
+  //
+  // The following fields are used if you provide them:
+  //
+  // * `number_of_passengers`
+  // * `vehicle_id`
+  // * `dropoff_point`
+  // * `intermediate_destinations`
+  // * `vehicle_waypoints`
+  //
+  // All other Trip fields are ignored. For example, all trips start with a
+  // `trip_status` of `NEW` even if you pass in a `trip_status` of `CANCELED` in
+  // the creation request.
+  //
+  // Only `EXCLUSIVE` trips support `intermediate_destinations`.
+  //
+  // When `vehicle_id` is set for a shared trip, you must supply
+  // the list of `Trip.vehicle_waypoints` to specify the order of the remaining
+  // waypoints for the vehicle, otherwise the waypoint order will be
+  // undetermined.
+  //
+  // When you specify `Trip.vehicle_waypoints`, the list must contain all
+  // the remaining waypoints of the vehicle's trips, with no extra waypoints.
+  // You must order these waypoints such that for a given trip, the pickup
+  // point is before intermediate destinations, and all intermediate
+  // destinations come before the drop-off point. An `EXCLUSIVE` trip's
+  // waypoints must not interleave with any other trips.
+  //
+  // The `trip_id`, `waypoint_type` and `location` fields are used, and all
+  // other TripWaypoint fields in `vehicle_waypoints` are ignored.
+  Trip trip = 4 [(google.api.field_behavior) = REQUIRED];
+}
+
+// GetTrip request message.
+message GetTripRequest {
+  // The standard Fleet Engine request header.
+  RequestHeader header = 1;
+
+  // 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.
+  string name = 3 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "fleetengine.googleapis.com/Trip"
+    }
+  ];
+
+  // The subset of Trip fields that should be returned and their interpretation.
+  TripView view = 11;
+
+  // 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.
+  google.protobuf.Timestamp current_route_segment_version = 6;
+
+  // Indicates the minimum timestamp (exclusive) for which
+  // `Trip.remaining_waypoints` are retrieved. If they are unchanged since this
+  // timestamp, the `remaining_waypoints` are not set in the response. If this
+  // field is unspecified, `remaining_waypoints` is always retrieved.
+  google.protobuf.Timestamp remaining_waypoints_version = 7;
+
+  // 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`.
+  PolylineFormatType route_format_type = 8;
+
+  // Indicates the minimum timestamp (exclusive) for which
+  // `Trip.current_route_segment_traffic` is retrieved. If traffic data are
+  // unchanged since this timestamp, the `current_route_segment_traffic` 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.
+  google.protobuf.Timestamp current_route_segment_traffic_version = 9;
+
+  // 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 `remaining_waypoints_route_version` is
+  // unspecified, traffic and path are always retrieved.
+  google.protobuf.Timestamp remaining_waypoints_route_version = 10;
+}
+
+// ReportBillableTrip request message.
+message ReportBillableTripRequest {
+  // Selector for different solution types of a reported trip.
+  enum SolutionType {
+    // The default value. For backwards-compatibility, the API will use
+    // `ON_DEMAND_RIDESHARING_AND_DELIVERIES` by default which is the first
+    // supported solution type.
+    SOLUTION_TYPE_UNSPECIFIED = 0;
+
+    // The solution is an on-demand ridesharing and deliveries trip.
+    ON_DEMAND_RIDESHARING_AND_DELIVERIES = 1;
+  }
+
+  // Required. Must be in the format
+  // `providers/{provider}/billableTrips/{billable_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.
+  string name = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. Two letter country code of the country where the trip takes
+  // place. Price is defined according to country code.
+  string country_code = 3 [(google.api.field_behavior) = REQUIRED];
+
+  // The platform upon which the request was issued.
+  BillingPlatformIdentifier platform = 5;
+
+  // The identifiers that are directly related to the trip being reported. These
+  // are usually IDs (for example, session IDs) of pre-booking operations done
+  // before the trip ID is available. The number of `related_ids` is
+  // limited to 50.
+  repeated string related_ids = 6;
+
+  // The type of GMP product solution (for example,
+  // `ON_DEMAND_RIDESHARING_AND_DELIVERIES`) used for the reported trip.
+  SolutionType solution_type = 7;
+}
+
+// UpdateTrip request message.
+message UpdateTripRequest {
+  // The standard Fleet Engine request header.
+  RequestHeader header = 1;
+
+  // Required. Must be in the format
+  // `providers/{provider}/trips/{trip}`. The provider must
+  // be the Project ID (for example, `sample-consumer-project`) of the Google
+  // Cloud Project of which the service account making this call is a member.
+  string name = 3 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. The Trip associated with the update.
+  //
+  // The following fields are maintained by the Fleet Engine. Do not update
+  // them using Trip.update.
+  //
+  // * `current_route_segment`
+  // * `current_route_segment_end_point`
+  // * `current_route_segment_traffic`
+  // * `current_route_segment_traffic_version`
+  // * `current_route_segment_version`
+  // * `dropoff_time`
+  // * `eta_to_next_waypoint`
+  // * `intermediate_destinations_version`
+  // * `last_location`
+  // * `name`
+  // * `number_of_passengers`
+  // * `pickup_time`
+  // * `remaining_distance_meters`
+  // * `remaining_time_to_first_waypoint`
+  // * `remaining_waypoints`
+  // * `remaining_waypoints_version`
+  // * `route`
+  //
+  // When you update the `Trip.vehicle_id` for a shared trip, you must supply
+  // the list of `Trip.vehicle_waypoints` to specify the order of the remaining
+  // waypoints, otherwise the order will be undetermined.
+  //
+  // When you specify `Trip.vehicle_waypoints`, the list must contain all
+  // the remaining waypoints of the vehicle's trips, with no extra waypoints.
+  // You must order these waypoints such that for a given trip, the pickup
+  // point is before intermediate destinations, and all intermediate
+  // destinations come before the drop-off point. An `EXCLUSIVE` trip's
+  // waypoints must not interleave with any other trips.
+  // The `trip_id`, `waypoint_type` and `location` fields are used, and all
+  // other TripWaypoint fields in `vehicle_waypoints` are ignored.
+  //
+  // To avoid a race condition for trips with multiple destinations, you
+  // should provide `Trip.intermediate_destinations_version` when updating
+  // the trip status to `ENROUTE_TO_INTERMEDIATE_DESTINATION`. The
+  // `Trip.intermediate_destinations_version` passed must be consistent with
+  // Fleet Engine's version. If it isn't, the request fails.
+  Trip trip = 4 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. The field mask indicating which fields in Trip to update.
+  // The `update_mask` must contain at least one field.
+  google.protobuf.FieldMask update_mask = 5
+      [(google.api.field_behavior) = REQUIRED];
+}
+
+// SearchTrips request message.
+message SearchTripsRequest {
+  // The standard Fleet Engine request header.
+  RequestHeader header = 1;
+
+  // Required. Must be in the format `providers/{provider}`.
+  // 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.
+  string parent = 3 [(google.api.field_behavior) = REQUIRED];
+
+  // The vehicle associated with the trips in the request. If unspecified, the
+  // returned trips do not contain:
+  //
+  // * `current_route_segment`
+  // * `remaining_waypoints`
+  // * `remaining_distance_meters`
+  // * `eta_to_first_waypoint`
+  string vehicle_id = 4;
+
+  // If set to true, the response includes Trips that influence a driver's
+  // route.
+  bool active_trips_only = 5;
+
+  // If not set, the server decides the number of results to return.
+  int32 page_size = 6;
+
+  // Set this to a value previously returned in the `SearchTripsResponse` to
+  // continue from previous results.
+  string page_token = 7;
+
+  // If specified, returns the trips that have not been updated after the time
+  // `(current - minimum_staleness)`.
+  google.protobuf.Duration minimum_staleness = 8;
+}
+
+// SearchTrips response message.
+message SearchTripsResponse {
+  // The list of trips for the requested vehicle.
+  repeated Trip trips = 1;
+
+  // Pass this token in the SearchTripsRequest to page through list results. The
+  // API returns a trip list on each call, and when no more results remain the
+  // trip list is empty.
+  string next_page_token = 2;
+}

package/build/protos/google/maps/fleetengine/v1/trips.proto

@@ -0,0 +1,311 @@
+// Copyright 2023 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package maps.fleetengine.v1;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/maps/fleetengine/v1/fleetengine.proto";
+import "google/maps/fleetengine/v1/traffic.proto";
+import "google/protobuf/duration.proto";
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/wrappers.proto";
+import "google/type/latlng.proto";
+
+option csharp_namespace = "Google.Maps.FleetEngine.V1";
+option go_package = "cloud.google.com/go/maps/fleetengine/apiv1/fleetenginepb;fleetenginepb";
+option java_multiple_files = true;
+option java_outer_classname = "Trips";
+option java_package = "google.maps.fleetengine.v1";
+option objc_class_prefix = "CFE";
+
+// Trip metadata.
+message Trip {
+  option (google.api.resource) = {
+    type: "fleetengine.googleapis.com/Trip"
+    pattern: "providers/{provider}/trips/{trip}"
+  };
+
+  // Output only. In the format "providers/{provider}/trips/{trip}"
+  string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // ID of the vehicle making this trip.
+  string vehicle_id = 2;
+
+  // Current status of the trip.
+  TripStatus trip_status = 3;
+
+  // The type of the trip.
+  TripType trip_type = 4;
+
+  // Location where customer indicates they will be picked up.
+  TerminalLocation pickup_point = 5;
+
+  // Input only. The actual location when and where customer was picked up.
+  // This field is for provider to provide feedback on actual pickup
+  // information.
+  StopLocation actual_pickup_point = 22
+      [(google.api.field_behavior) = INPUT_ONLY];
+
+  // Input only. The actual time and location of the driver arrival at
+  // the pickup point.
+  // This field is for provider to provide feedback on actual arrival
+  // information at the pickup point.
+  StopLocation actual_pickup_arrival_point = 32
+      [(google.api.field_behavior) = INPUT_ONLY];
+
+  // Output only. Either the estimated future time when the rider(s) will be
+  // picked up, or the actual time when they were picked up.
+  google.protobuf.Timestamp pickup_time = 6
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Intermediate stops in order that the trip requests (in addition
+  // to pickup and dropoff). Initially this will not be supported for shared
+  // trips.
+  repeated TerminalLocation intermediate_destinations = 14;
+
+  // Indicates the last time the `intermediate_destinations` was modified.
+  // Your server should cache this value and pass it in `UpdateTripRequest`
+  // when update `intermediate_destination_index` to ensure the
+  // `intermediate_destinations` is not changed.
+  google.protobuf.Timestamp intermediate_destinations_version = 25;
+
+  // 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 the
+  // vehicle is at. The provider sets this value. If there are no
+  // `intermediate_destinations`, this field is ignored.
+  int32 intermediate_destination_index = 15;
+
+  // Input only. The actual time and location of the driver's arrival at
+  // an intermediate destination.
+  // This field is for provider to provide feedback on actual arrival
+  // information at intermediate destinations.
+  repeated StopLocation actual_intermediate_destination_arrival_points = 33
+      [(google.api.field_behavior) = INPUT_ONLY];
+
+  // Input only. The actual time and location when and where the customer was
+  // picked up from an intermediate destination. This field is for provider to
+  // provide feedback on actual pickup information at intermediate destinations.
+  repeated StopLocation actual_intermediate_destinations = 34
+      [(google.api.field_behavior) = INPUT_ONLY];
+
+  // Location where customer indicates they will be dropped off.
+  TerminalLocation dropoff_point = 7;
+
+  // Input only. The actual time and location when and where customer was
+  // dropped off. This field is for provider to provide feedback on actual
+  // dropoff information.
+  StopLocation actual_dropoff_point = 23
+      [(google.api.field_behavior) = INPUT_ONLY];
+
+  // Output only. Either the estimated future time when the rider(s) will be
+  // dropped off at the final destination, or the actual time when they were
+  // dropped off.
+  google.protobuf.Timestamp dropoff_time = 8
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The full path from the current location to the dropoff point,
+  // inclusive. This path could include waypoints from other trips.
+  repeated TripWaypoint remaining_waypoints = 16
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // This field supports manual ordering of the waypoints for the trip. It
+  // contains all of the remaining waypoints for the assigned vehicle, as well
+  // as the pickup and drop-off waypoints for this trip. If the trip hasn't been
+  // assigned to a vehicle, then Fleet Engine ignores this field. For privacy
+  // reasons, this field is only populated by the server on `UpdateTrip` and
+  // `CreateTrip` calls, NOT on `GetTrip` calls.
+  repeated TripWaypoint vehicle_waypoints = 20;
+
+  // Output only. Anticipated route for this trip to the first entry in
+  // remaining_waypoints. Note that the first waypoint may belong to a different
+  // trip.
+  repeated google.type.LatLng route = 9
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. An encoded path to the next waypoint.
+  //
+  // Note: This field is intended only for use by the Driver SDK and Consumer
+  // SDK. Decoding is not yet supported.
+  string current_route_segment = 21 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Indicates the last time the route was modified.
+  //
+  // Note: This field is intended only for use by the Driver SDK and Consumer
+  // SDK.
+  google.protobuf.Timestamp current_route_segment_version = 17
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Indicates the traffic conditions along the
+  // `current_route_segment` when they're available.
+  //
+  // Note: This field is intended only for use by the Driver SDK and Consumer
+  // SDK.
+  ConsumableTrafficPolyline current_route_segment_traffic = 28
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Indicates the last time the `current_route_segment_traffic`
+  // was modified.
+  //
+  // Note: This field is intended only for use by the Driver SDK and Consumer
+  // SDK.
+  google.protobuf.Timestamp current_route_segment_traffic_version = 30
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The waypoint where `current_route_segment` ends.
+  TripWaypoint current_route_segment_end_point = 24
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The remaining driving distance in the `current_route_segment`
+  // field. The value is unspecified if the trip is not assigned to a vehicle,
+  // or the trip is completed or cancelled.
+  google.protobuf.Int32Value remaining_distance_meters = 12
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The ETA to the next waypoint (the first entry in the
+  // `remaining_waypoints` field). The value is unspecified if the trip is not
+  // assigned to a vehicle, or the trip is inactive (completed or cancelled).
+  google.protobuf.Timestamp eta_to_first_waypoint = 13
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The duration from when the Trip data is returned to the time
+  // in `Trip.eta_to_first_waypoint`. The value is unspecified if the trip is
+  // not assigned to a vehicle, or the trip is inactive (completed or
+  // cancelled).
+  google.protobuf.Duration remaining_time_to_first_waypoint = 27
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Indicates the last time that `remaining_waypoints` was changed
+  // (a waypoint was added, removed, or changed).
+  google.protobuf.Timestamp remaining_waypoints_version = 19
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Indicates the last time the
+  // `remaining_waypoints.path_to_waypoint` and
+  // `remaining_waypoints.traffic_to_waypoint` were modified. Your client app
+  // should cache this value and pass it in `GetTripRequest` to ensure the
+  // paths and traffic for `remaining_waypoints` are only returned if updated.
+  google.protobuf.Timestamp remaining_waypoints_route_version = 29
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Immutable. Indicates the number of passengers on this trip and does not
+  // include the driver. A vehicle must have available capacity to be returned
+  // in a `SearchVehicles` response.
+  int32 number_of_passengers = 10 [(google.api.field_behavior) = IMMUTABLE];
+
+  // Output only. Indicates the last reported location of the vehicle along the
+  // route.
+  VehicleLocation last_location = 11
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Indicates whether the vehicle's `last_location` can be snapped
+  // to the current_route_segment. False if `last_location` or
+  // `current_route_segment` doesn't exist.
+  // It is computed by Fleet Engine. Any update from clients will be ignored.
+  bool last_location_snappable = 26 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // The subset of Trip fields that are populated and how they should be
+  // interpreted.
+  TripView view = 31;
+}
+
+// The actual location where a stop (pickup/dropoff) happened.
+message StopLocation {
+  // Required. Denotes the actual location.
+  google.type.LatLng point = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // Indicates when the stop happened.
+  google.protobuf.Timestamp timestamp = 2;
+
+  // Input only. Deprecated.  Use the timestamp field.
+  google.protobuf.Timestamp stop_time = 3
+      [deprecated = true, (google.api.field_behavior) = INPUT_ONLY];
+}
+
+// The status of a trip indicating its progression.
+enum TripStatus {
+  // Default, used for unspecified or unrecognized trip status.
+  UNKNOWN_TRIP_STATUS = 0;
+
+  // Newly created trip.
+  NEW = 1;
+
+  // The driver is on their way to the pickup point.
+  ENROUTE_TO_PICKUP = 2;
+
+  // The driver has arrived at the pickup point.
+  ARRIVED_AT_PICKUP = 3;
+
+  // The driver has arrived at an intermediate destination and is waiting for
+  // the rider.
+  ARRIVED_AT_INTERMEDIATE_DESTINATION = 7;
+
+  // The driver is on their way to an intermediate destination
+  // (not the dropoff point).
+  ENROUTE_TO_INTERMEDIATE_DESTINATION = 8;
+
+  // The driver has picked up the rider and is on their way to the
+  // next destination.
+  ENROUTE_TO_DROPOFF = 4;
+
+  // The rider has been dropped off and the trip is complete.
+  COMPLETE = 5;
+
+  // The trip was canceled prior to pickup by the driver, rider, or
+  // rideshare provider.
+  CANCELED = 6;
+}
+
+// A set of values that indicate upon which platform the request was issued.
+enum BillingPlatformIdentifier {
+  // Default. Used for unspecified platforms.
+  BILLING_PLATFORM_IDENTIFIER_UNSPECIFIED = 0;
+
+  // The platform is a client server.
+  SERVER = 1;
+
+  // The platform is a web browser.
+  WEB = 2;
+
+  // The platform is an Android mobile device.
+  ANDROID = 3;
+
+  // The platform is an IOS mobile device.
+  IOS = 4;
+
+  // Other platforms that are not listed in this enumeration.
+  OTHERS = 5;
+}
+
+// Selector for different sets of Trip fields in a `GetTrip` response.  See
+// [AIP-157](https://google.aip.dev/157) for context. Additional views are
+// likely to be added.
+enum TripView {
+  // The default value. For backwards-compatibility, the API will default to an
+  // SDK view. To ensure stability and support, customers are
+  // advised to select a `TripView` other than `SDK`.
+  TRIP_VIEW_UNSPECIFIED = 0;
+
+  // Includes fields that may not be interpretable or supportable using
+  // publicly available libraries.
+  SDK = 1;
+
+  // Trip fields are populated for the Journey Sharing use case. This view is
+  // intended for server-to-server communications.
+  JOURNEY_SHARING_V1S = 2;
+}