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. Tiene el formato "providers/{provider}/trips/{trip}"

vehicleId

string

ID del vehículo que realiza este viaje.

tripStatus

enum (TripStatus)

Es el estado actual del viaje.

tripType

enum (TripType)

El tipo de viaje.

pickupPoint

object (TerminalLocation)

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

actualPickupPoint

object (StopLocation)

Solo entrada. Es la ubicación real en la que y donde se recogió al cliente. Este campo permite que el proveedor brinde comentarios sobre la información real de retiro.

actualPickupArrivalPoint

object (StopLocation)

Solo entrada. Es la hora y ubicación reales del conductor en su llegada al punto de partida. Este campo permite que el proveedor brinde comentarios sobre la información real de la llegada al punto de partida.

pickupTime

string (Timestamp format)

Solo salida. que puede ser la hora futura estimada en la que se recogió al pasajero o la hora real en la que se recogió.

Una marca de tiempo en formato RFC3339 UTC "Zulú", con 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 para que el viaje solicite (además del punto de partida y el destino) Al principio, no se admitirá para viajes compartidos.

intermediateDestinationsVersion

string (Timestamp format)

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

Una marca de tiempo en formato RFC3339 UTC "Zulú", con 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, un número entre [0..N-1] que indica con qué destino intermedio cruzará el vehículo. 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, se ignora este campo.

actualIntermediateDestinationArrivalPoints[]

object (StopLocation)

Solo entrada. Es la hora y el lugar reales de 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 el lugar reales en el que y cuando 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 entregará.

actualDropoffPoint

object (StopLocation)

Solo entrada. La hora y la ubicación reales en el momento y lugar en que se dejó al cliente. Este campo se usa para que el proveedor proporcione comentarios sobre la información real del destino.

dropoffTime

string (Timestamp format)

Solo salida. que puede ser la hora futura estimada en 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 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. 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 el ordenamiento 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 ignorará este campo. Por motivos de privacidad, el servidor solo propaga este campo en las llamadas a trips.update y trips.create, NO en las llamadas a trips.get.

route[]

object (LatLng)

Solo salida. Ruta prevista para este viaje a la primera entrada en los puntos de referencia restantes. Ten en cuenta que el primer punto de referencia puede pertenecer a un viaje diferente.

currentRouteSegment

string

Solo salida. Una ruta de acceso codificada para el siguiente punto de referencia.

Nota: Este campo está destinado solo para que lo usen el SDK de Driver 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 está destinado solo para que lo usen el SDK de Driver y el SDK para consumidores.

Una marca de tiempo en formato RFC3339 UTC "Zulú", con 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 currentRouteSegment cuando están disponibles.

Nota: Este campo está destinado solo para que lo usen el SDK de Driver y el SDK para consumidores.

currentRouteSegmentTrafficVersion

string (Timestamp format)

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

Nota: Este campo está destinado solo para que lo usen el SDK de Driver y el SDK para consumidores.

Una marca de tiempo en formato RFC3339 UTC "Zulú", con 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 en el que finaliza currentRouteSegment.

remainingDistanceMeters

integer

Solo salida. La distancia restante en automóvil en el campo currentRouteSegment. El valor no se especifica si el viaje no se asignó a un vehículo o si el viaje se completó o cancela.

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 (finalizado o cancelado).

Una marca de tiempo en formato RFC3339 UTC "Zulú", con 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 el tiempo que transcurre desde el momento en que se devuelven 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 (finalizado o cancelado).

Es una duración en segundos con hasta nueve dígitos decimales que termina en "s". Ejemplo: "3.5s".

remainingWaypointsVersion

string (Timestamp format)

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

Una marca de tiempo en formato RFC3339 UTC "Zulú", con 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 muestren si se actualizan.

Una marca de tiempo en formato RFC3339 UTC "Zulú", con 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 de este viaje y no incluye al conductor. Un vehículo debe tener capacidad disponible para devolverse en una respuesta vehicles.search.

lastLocation

object (VehicleLocation)

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

lastLocationSnappable

boolean

Solo salida. Indica si el lastLocation del vehículo se puede ajustar al currentRouteSegment. Es falso si no existen lastLocation o currentRouteSegment. Fleet Engine lo procesa. Se ignorará cualquier actualización de los clientes.

view

enum (TripView)

El subconjunto de campos de viaje que se propagan y la forma en que se deben interpretar.

TripStatus

Es el estado de un viaje que indica su progreso.

Enumeradores
UNKNOWN_TRIP_STATUS Predeterminado: se usa para el estado de viaje no especificado o no reconocido.
NEW Viaje creado recientemente.
ENROUTE_TO_PICKUP El conductor está en camino 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 llegada).
ENROUTE_TO_DROPOFF El conductor recogió al pasajero y está en camino al siguiente destino.
COMPLETE Se dejó al pasajero y se completó el viaje.
CANCELED El viaje se canceló antes de que el conductor, el pasajero o el proveedor de transporte compartido lo recogieran.

StopLocation

Indica la ubicación real en la que ocurrió una parada (recogida o destino).

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

object (LatLng)

Obligatorio. Denota la ubicación real.

timestamp

string (Timestamp format)

Indica cuándo se detuvo la parada.

Una marca de tiempo en formato RFC3339 UTC "Zulú", con 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. Ya no está disponible. Usa el campo de marca de tiempo.

Una marca de tiempo en formato RFC3339 UTC "Zulú", con 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 de trips.get. Consulta AIP-157 para obtener más contexto. Es probable que se agreguen vistas adicionales.

Enumeradores
TRIP_VIEW_UNSPECIFIED Es el valor predeterminado. Para la retrocompatibilidad, la API usará de forma predeterminada una vista de SDK. Para garantizar la estabilidad y asistencia, se recomienda a los clientes que seleccionen un TripView distinto de SDK.
SDK Incluye campos que pueden no ser interpretables o compatibles mediante las bibliotecas disponibles de forma pública.
JOURNEY_SHARING_V1S Los campos de viaje se propagan para el caso de uso de Viajes compartidos. Esta vista está diseñada para las comunicaciones de servidor a servidor.

Métodos

create

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

get

Obtén información sobre un solo viaje.
Accede a todos los viajes para un vehículo específico.

update

Actualiza los datos del viaje.