REST Resource: providers.trips

Recurso: Viaje

Metadatos del viaje

Representación JSON 
{
  "name": string,
  "vehicleId": string,
  "tripStatus": enum (TripStatus),
  "tripType": enum (TripType),
  "pickupPoint": {
    object (TerminalLocation)
  },
  "actualPickupPoint": {
    object (StopLocation)
  },
  "actualPickupArrivalPoint": {
    object (StopLocation)
  },
  "pickupTime": string,
  "intermediateDestinations": [
    {
      object (TerminalLocation)
    }
  ],
  "intermediateDestinationsVersion": string,
  "intermediateDestinationIndex": integer,
  "actualIntermediateDestinationArrivalPoints": [
    {
      object (StopLocation)
    }
  ],
  "actualIntermediateDestinations": [
    {
      object (StopLocation)
    }
  ],
  "dropoffPoint": {
    object (TerminalLocation)
  },
  "actualDropoffPoint": {
    object (StopLocation)
  },
  "dropoffTime": string,
  "remainingWaypoints": [
    {
      object (TripWaypoint)
    }
  ],
  "vehicleWaypoints": [
    {
      object (TripWaypoint)
    }
  ],
  "route": [
    {
      object (LatLng)
    }
  ],
  "currentRouteSegment": string,
  "currentRouteSegmentVersion": string,
  "currentRouteSegmentTraffic": {
    object (ConsumableTrafficPolyline)
  },
  "currentRouteSegmentTrafficVersion": string,
  "currentRouteSegmentEndPoint": {
    object (TripWaypoint)
  },
  "remainingDistanceMeters": integer,
  "etaToFirstWaypoint": string,
  "remainingTimeToFirstWaypoint": string,
  "remainingWaypointsVersion": string,
  "remainingWaypointsRouteVersion": string,
  "numberOfPassengers": integer,
  "lastLocation": {
    object (VehicleLocation)
  },
  "lastLocationSnappable": boolean,
  "view": enum (TripView)
}
Campos
name

string

Solo salida. En el formato "providers/{provider}/trips/{trip}"
vehicleId

string

Es el ID del vehículo que realiza este viaje.
tripStatus

enum (TripStatus)

Estado actual del viaje.
tripType

enum (TripType)

Es el tipo de viaje.
pickupPoint

object (TerminalLocation)

Ubicación en la que el cliente indica que lo retirarán.
actualPickupPoint

object (StopLocation)

Solo entrada. La ubicación real en la que se recogió al cliente Este campo permite que el proveedor proporcione comentarios sobre la información real de retiro.
actualPickupArrivalPoint

object (StopLocation)

Solo entrada. La hora y ubicación reales de la llegada del conductor al punto de partida Este campo es para que el proveedor proporcione comentarios sobre la información real de llegada al punto de partida.
pickupTime

string (Timestamp format)

Solo salida. Puede ser la hora estimada en el futuro a la que se recogerá a los pasajeros o la hora real en la que se buscaron.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
intermediateDestinations[]

object (TerminalLocation)

Paradas intermedias en función de las solicitudes del viaje (además de los puntos de partida y destino). Inicialmente, esta función no se admitirá para los viajes compartidos.
intermediateDestinationsVersion

string (Timestamp format)

Indica la última vez que se modificó intermediateDestinations. Tu servidor debe almacenar en caché este valor y pasarlo en UpdateTripRequest cuando actualice intermediateDestinationIndex para garantizar que no se cambie intermediateDestinations.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
intermediateDestinationIndex

integer

Cuando TripStatus es ENROUTE_TO_INTERMEDIATE_DESTINATION, es un número entre [0..N-1] que indica qué destino intermedio cruzará el vehículo a continuación. Cuando TripStatus es ARRIVED_AT_INTERMEDIATE_DESTINATION, un número entre [0..N-1] que indica en qué destino intermedio se encuentra el vehículo. El proveedor establece este valor. Si no hay intermediateDestinations, este campo se ignora.
actualIntermediateDestinationArrivalPoints[]

object (StopLocation)

Solo entrada. La hora y la ubicación reales de la llegada del conductor a un destino intermedio. Este campo permite que el proveedor proporcione comentarios sobre la información real de llegada a destinos intermedios.
actualIntermediateDestinations[]

object (StopLocation)

Solo entrada. Indica la hora y la ubicación reales en que y dónde se recogió al cliente desde un destino intermedio. Este campo permite que el proveedor proporcione comentarios sobre la información real de retiro en destinos intermedios.
dropoffPoint

object (TerminalLocation)

Ubicación en la que el cliente indica que se bajará.
actualDropoffPoint

object (StopLocation)

Solo entrada. La hora y la ubicación reales en las que se dejó al cliente. Este campo es para que el proveedor proporcione comentarios sobre la información real de entrega.
dropoffTime

string (Timestamp format)

Solo salida. Puede ser la hora estimada en el futuro a la que se bajarán los pasajeros en el destino final o la hora real en la que se bajarán.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
remainingWaypoints[]

object (TripWaypoint)

Solo salida. La ruta completa desde la ubicación actual hasta el punto de destino, inclusive. Esta ruta puede incluir puntos de referencia de otros viajes.
vehicleWaypoints[]

object (TripWaypoint)

Este campo admite la ordenación manual de los puntos de referencia para el viaje. Contiene todos los puntos de referencia restantes para el vehículo asignado, así como los puntos de referencia de partida y llegada para este viaje. Si el viaje no se asignó a un vehículo, Fleet Engine ignora este campo. Por motivos de privacidad, solo el servidor propaga este campo en las llamadas trips.update y trips.create, NO en las llamadas trips.get.
route[]

object (LatLng)

Solo salida. Es la ruta anticipada para este viaje a la primera entrada en remainingWaypoints. Ten en cuenta que el primer punto de referencia puede pertenecer a un viaje diferente.
currentRouteSegment

string

Solo salida. Es una ruta codificada al siguiente punto de referencia.

Nota: Este campo está diseñado solo para que lo usen el SDK del controlador y el SDK para consumidores. Aún no se admite la decodificación.
currentRouteSegmentVersion

string (Timestamp format)

Solo salida. Indica la última vez que se modificó la ruta.

Nota: Este campo solo está diseñado para que lo usen el SDK de Driver y el SDK de Consumer.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
currentRouteSegmentTraffic

object (ConsumableTrafficPolyline)

Solo salida. Indica las condiciones de tráfico a lo largo de la currentRouteSegment cuando están disponibles.

Nota: Este campo solo está diseñado para que lo usen el SDK de Driver y el SDK de Consumer.
currentRouteSegmentTrafficVersion

string (Timestamp format)

Solo salida. Indica la última vez que se modificó currentRouteSegmentTraffic.

Nota: Este campo está diseñado solo para que lo usen el SDK del controlador y el SDK para consumidores.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
currentRouteSegmentEndPoint

object (TripWaypoint)

Solo salida. El punto de referencia donde termina currentRouteSegment.
remainingDistanceMeters

integer

Solo salida. Es la distancia de conducción restante en el campo currentRouteSegment. El valor no se especifica si el viaje no está asignado a un vehículo, o si se completó o canceló.
etaToFirstWaypoint

string (Timestamp format)

Solo salida. La hora de llegada estimada al siguiente punto de referencia (la primera entrada en el campo remainingWaypoints). El valor no se especifica si el viaje no está asignado a un vehículo o si el viaje está inactivo (completado o cancelado).

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
remainingTimeToFirstWaypoint

string (Duration format)

Solo salida. Es la duración desde el momento en que se muestran los datos del viaje hasta la hora en Trip.eta_to_first_waypoint. El valor no se especifica si el viaje no está asignado a un vehículo o si el viaje está inactivo (completado o cancelado).

Una duración en segundos con hasta nueve dígitos decimales, que terminan en “s”. Ejemplo: "3.5s".
remainingWaypointsVersion

string (Timestamp format)

Solo salida. Indica la última vez que se modificó remainingWaypoints (se agregó, se quitó o se cambió un punto de referencia).

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
remainingWaypointsRouteVersion

string (Timestamp format)

Solo salida. Indica la última vez que se modificaron remainingWaypoints.path_to_waypoint y remainingWaypoints.traffic_to_waypoint. Tu app cliente debe almacenar en caché este valor y pasarlo en GetTripRequest para garantizar que las rutas y el tráfico de remainingWaypoints solo se devuelvan si se actualizan.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
numberOfPassengers

integer

Inmutable. Indica la cantidad de pasajeros en este viaje y no incluye al conductor. Un vehículo debe tener una capacidad disponible para que se muestre en una respuesta de vehicles.search.
lastLocation

object (VehicleLocation)

Solo salida. Indica la última ubicación registrada del vehículo a lo largo de la ruta.
lastLocationSnappable

boolean

Solo salida. Indica si el lastLocation del vehículo se puede ajustar a currentRouteSegment. Falso si lastLocation o currentRouteSegment no existen. Fleet Engine lo calcula. Se ignorarán las actualizaciones de los clientes.
view

enum (TripView)

Es el subconjunto de campos de viaje que se propagan y cómo se deben interpretar.

TripStatus

El estado de un viaje que indica su progreso.

Enumeraciones
UNKNOWN_TRIP_STATUS Es el valor predeterminado que se usa para el estado de viaje no especificado o no reconocido.
NEW Viaje recién creado.
ENROUTE_TO_PICKUP El conductor se dirige al punto de partida.
ARRIVED_AT_PICKUP El conductor llegó al punto de partida.
ARRIVED_AT_INTERMEDIATE_DESTINATION El conductor llegó a un destino intermedio y está esperando al pasajero.
ENROUTE_TO_INTERMEDIATE_DESTINATION El conductor se dirige a un destino intermedio (no al punto de destino).
ENROUTE_TO_DROPOFF El conductor recogió al pasajero y está de camino al siguiente destino.
COMPLETE Se dejó al pasajero y se completó el viaje.
CANCELED El conductor, el pasajero o el proveedor de viajes compartidos canceló el viaje antes de la partida.

StopLocation

Es la ubicación real donde se produjo una parada (ascenso o descenso).

Representación JSON 
{
  "point": {
    object (LatLng)
  },
  "timestamp": string,
  "stopTime": string
}
Campos
point

object (LatLng)

Obligatorio. Indica la ubicación real.
timestamp

string (Timestamp format)

Indica cuándo ocurrió la parada.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
stopTime
(deprecated)

string (Timestamp format)

Solo entrada. Obsoleta. Usa el campo de marca de tiempo.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

TripView

Selector para diferentes conjuntos de campos de viaje en una respuesta trips.get. Consulta AIP-157 para obtener contexto. Es probable que se agreguen vistas adicionales.

Enumeraciones
TRIP_VIEW_UNSPECIFIED Es el valor predeterminado. Para brindar retrocompatibilidad, la API usará una vista de SDK de forma predeterminada. Para garantizar la estabilidad y la compatibilidad, se recomienda a los clientes seleccionar un TripView distinto de SDK.
SDK Incluye campos que tal vez no se puedan interpretar ni admitir mediante bibliotecas disponibles públicamente.
JOURNEY_SHARING_V1S Los campos de viaje se propagan para el caso de uso de Compartir viaje. Esta vista está diseñada para las comunicaciones de servidor a servidor.

Métodos

create

 Crea un viaje en Fleet Engine y muestra el viaje nuevo.

get

 Obtén información sobre un solo viaje.
Obtener todos los viajes de un vehículo específico

update

 Actualiza los datos de viajes.