REST Resource: transitobject

Recurso: TransitObject

Representación JSON 
{
  "classReference": {
    object (TransitClass)
  },
  "ticketNumber": string,
  "passengerType": enum (PassengerType),
  "passengerNames": string,
  "tripId": string,
  "ticketStatus": enum (TicketStatus),
  "customTicketStatus": {
    object (LocalizedString)
  },
  "concessionCategory": enum (ConcessionCategory),
  "customConcessionCategory": {
    object (LocalizedString)
  },
  "ticketRestrictions": {
    object (TicketRestrictions)
  },
  "purchaseDetails": {
    object (PurchaseDetails)
  },
  "ticketLeg": {
    object (TicketLeg)
  },
  "ticketLegs": [
    {
      object (TicketLeg)
    }
  ],
  "hexBackgroundColor": string,
  "tripType": enum (TripType),
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "activationStatus": {
    object (ActivationStatus)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "deviceContext": {
    object (DeviceContext)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  }
}
Campos
classReference

object (TransitClass)

Es una copia de los campos heredados de la clase superior. Estos campos se recuperan durante una solicitud GET.
ticketNumber

string

El número del ticket. Este es un identificador único para el boleto en el sistema del operador de transporte público.
passengerType

enum (PassengerType)

Es la cantidad de pasajeros.
passengerNames

string

Son los nombres de los pasajeros a los que está asignado el boleto. El campo passengerType anterior tiene como objetivo brindarle a Google contexto sobre este campo.
tripId

string

Este ID se utiliza para agrupar boletos si el usuario guardó varios boletos para el mismo viaje.
ticketStatus

enum (TicketStatus)

El estado del ticket. Para los estados que afectan la visualización, usa el campo state en su lugar.
customTicketStatus

object (LocalizedString)

Es un estado personalizado para usar en el valor del estado del ticket cuando ticketStatus no proporciona la opción correcta. Es posible que no se establezcan ticketStatus ni customTicketStatus.
concessionCategory

enum (ConcessionCategory)

Indica la categoría de concesión de la entrada.
customConcessionCategory

object (LocalizedString)

Una categoría de concesión personalizada para usar cuando concessionCategory no ofrezca la opción adecuada. Es posible que no se establezcan concessionCategory ni customConcessionCategory.
ticketRestrictions

object (TicketRestrictions)

Información sobre el tipo de restricciones que se aplican para usar este boleto. Por ejemplo, qué días de la semana se debe utilizar o qué rutas se pueden tomar.
purchaseDetails

object (PurchaseDetails)

Detalles de compra de este boleto.
ticketLeg

object (TicketLeg)

Un único boleto contiene información de salida y llegada, además de información sobre la embarque y los asientos. Si se debe especificar más de un segmento, utiliza el campo ticketLegs en su lugar. Es posible que no se establezcan ticketLeg ni ticketLegs.
ticketLegs[]

object (TicketLeg)

Cada ticket puede contener una o más etapas. Cada tramo contiene información de salida y llegada, además de información sobre cómo subir al vehículo y cómo sentarse. Si solo se debe especificar un segmento, utiliza el campo ticketLeg en su lugar. Es posible que no se establezcan ticketLeg ni ticketLegs.
hexBackgroundColor

string

El color de fondo de la tarjeta. Si no se establece el color dominante de la imagen de héroe, se utiliza el color dominante del logotipo. El formato es #rrggbb, en el que rrggbb es un triplete RGB hexadecimal, como #ffcc00. También puedes usar la versión abreviada del triplete RGB, que es el número rgb, como #fc0.
tripType

enum (TripType)

Obligatorio. Es el tipo de viaje que representa este objeto de transporte público. Se usa para determinar el título del pase o el símbolo que se usará entre el origen y el destino.
id

string

Obligatorio. El identificador único de un objeto. Este ID debe ser único en todos los objetos de una entidad emisora. Este valor debe seguir el formato issuer ID.identifier donde la primera es emitida por Google y la última es la tuya. El identificador único solo debe incluir caracteres alfanuméricos, “.”, “_” o “-”.
classId

string

Obligatorio. La clase asociada con este objeto. La clase debe ser del mismo tipo que este objeto, ya debe existir y debe aprobarse.

Los IDs de clase deben seguir el formato issuer ID.identifier donde la primera es emitida por Google y la última es la tuya.
version
(deprecated)

string (int64 format)

Obsoleto
state

enum (State)

Obligatorio. Es el estado del objeto. Este campo se usa para determinar cómo se muestra un objeto en la app. Por ejemplo, un objeto inactive se mueve a la sección "Pases vencidos".
barcode

object (Barcode)

El tipo de código de barras y el valor.
messages[]

object (Message)

Un array de mensajes que se muestra en la app. Todos los usuarios de este objeto recibirán los mensajes asociados. La cantidad máxima de estos campos es 10.
validTimeInterval

object (TimeInterval)

El período del objeto será active y se podrá usar el objeto. El estado de un objeto cambiará a expired una vez transcurrido este período.
locations[]

object (LatLongPoint)

Nota: Actualmente, este campo no es compatible con la activación de notificaciones geográficas.
hasUsers

boolean

Indica si el objeto tiene usuarios. La plataforma establece este campo.
smartTapRedemptionValue

string

El valor que se transmitirá a una terminal certificada por Smart Tap a través de NFC para este objeto. Los campos enableSmartTap y redemptionIssuers a nivel de la clase también deben configurarse correctamente para que el pase admita el toque inteligente. Solo se admiten caracteres ASCII.
hasLinkedDevice

boolean

Indica si este objeto está vinculado actualmente a un solo dispositivo. La plataforma establece este campo cuando un usuario guarda el objeto y lo vincula a su dispositivo. Está diseñada para que lo usen socios seleccionados. Comunícate con el equipo de Asistencia para obtener más información.
disableExpirationNotification

boolean

Indica si las notificaciones deben suprimirse explícitamente. Si estableces este campo como verdadero, independientemente del campo messages, se suprimirán las notificaciones de vencimiento para el usuario. De forma predeterminada, este campo se establece en falso.

Actualmente, solo se puede configurar para ofertas.
infoModuleData

object (InfoModuleData)

Ya no está disponible. En su lugar, usa textModulesData.
imageModulesData[]

object (ImageModuleData)

Datos del módulo de imagen. La cantidad máxima de estos campos que se muestran es 1 para el nivel de objeto y 1 para el nivel de objeto de clase.
textModulesData[]

object (TextModuleData)

Datos del módulo de texto. Si en la clase también se definen los datos del módulo de texto, se mostrarán ambos. La cantidad máxima de campos que se muestran es 10 para el objeto y 10 para la clase.
activationStatus

object (ActivationStatus)

El estado de activación del objeto. Es obligatorio si la clase tiene configurado activationOptions.
rotatingBarcode

object (RotatingBarcode)

El tipo y valor de código de barras rotativos.
deviceContext

object (DeviceContext)

Contexto del dispositivo asociado con el objeto.
heroImage

object (Image)

Imagen opcional del banner que se muestra en el frente de la tarjeta. Si no hay ninguno, se mostrará la imagen principal de la clase. Si tampoco hay una hero image de la clase, no se mostrará nada.
groupingInfo

object (GroupingInfo)

Información que controla cómo se agrupan los pases.
passConstraints

object (PassConstraints)

Pasa restricciones para el objeto. Incluye limitar los comportamientos de NFC y capturas de pantalla.

PassengerType

Enumeradores
PASSENGER_TYPE_UNSPECIFIED
SINGLE_PASSENGER
singlePassenger

Alias heredado de SINGLE_PASSENGER. Ya no está disponible.
MULTIPLE_PASSENGERS
multiplePassengers

Alias heredado de MULTIPLE_PASSENGERS. Ya no está disponible.

TicketStatus

Enumeradores
TICKET_STATUS_UNSPECIFIED
USED
used

Alias heredado de USED. Ya no está disponible.
REFUNDED
refunded

Alias heredado de REFUNDED. Ya no está disponible.
EXCHANGED
exchanged

Alias heredado de EXCHANGED. Ya no está disponible.

ConcessionCategory

Enumeradores
CONCESSION_CATEGORY_UNSPECIFIED
ADULT
adult

Alias heredado de ADULT. Ya no está disponible.
CHILD
child

Alias heredado de CHILD. Ya no está disponible.
SENIOR
senior

Alias heredado de SENIOR. Ya no está disponible.

TicketRestrictions

Representación JSON 
{
  "routeRestrictions": {
    object (LocalizedString)
  },
  "routeRestrictionsDetails": {
    object (LocalizedString)
  },
  "timeRestrictions": {
    object (LocalizedString)
  },
  "otherRestrictions": {
    object (LocalizedString)
  }
}
Campos
routeRestrictions

object (LocalizedString)

Restricciones sobre las rutas que se pueden tomar. Por ejemplo, puede ser la cadena "Reservad CrossCountry solo trenes".
routeRestrictionsDetails

object (LocalizedString)

Obtén más detalles sobre los routeRestrictions anteriores.
timeRestrictions

object (LocalizedString)

Restricciones sobre los horarios en los que se puede utilizar este boleto.
otherRestrictions

object (LocalizedString)

Restricciones adicionales que no se incluyen en las categorías "ruta" ni "hora".

PurchaseDetails

Representación JSON 
{
  "purchaseReceiptNumber": string,
  "purchaseDateTime": string,
  "accountId": string,
  "confirmationCode": string,
  "ticketCost": {
    object (TicketCost)
  }
}
Campos
purchaseReceiptNumber

string

Número de recibo o identificador para hacer un seguimiento de la compra de la entrada a través del organismo que la vendió.
purchaseDateTime

string

Es la fecha y hora de compra de la entrada.

Se trata de una fecha y hora con formato extendido ISO 8601, con o sin desplazamiento. El tiempo se puede especificar con una precisión de hasta nanosegundos. Los desplazamientos se pueden especificar con segundos de precisión (aunque los segundos de desplazamiento no forman parte de ISO 8601).

Por ejemplo:

1985-04-12T23:20:50.52Z serían 20 minutos y 50.52 segundos después de la hora 23 del 12 de abril de 1985 en UTC.

1985-04-12T19:20:50.52-04:00 serían 20 minutos y 50.52 segundos después de la hora 19 del 12 de abril de 1985, 4 horas antes del UTC (el mismo instante que el ejemplo anterior). Si el evento fuera en Nueva York, equivaldría a la hora de verano del este (EDT). Recuerda que la compensación varía en las regiones que respetan el horario de verano, según la época del año.

1985-04-12T19:20:50.52 sería de 20 minutos y 50.52 segundos después de la hora 19 del 12 de abril de 1985 sin información de desplazamiento.

Sin la información de desplazamiento, es posible que algunas funciones enriquecidas no estén disponibles.
accountId

string

Es el ID de la cuenta que se usó para comprar el boleto.
confirmationCode

string

Es el código de confirmación de la compra. Puede ser igual para varios tickets diferentes y se usa para agrupar entradas.
ticketCost

object (TicketCost)

Es el costo del boleto.

TicketCost

Representación JSON 
{
  "faceValue": {
    object (Money)
  },
  "purchasePrice": {
    object (Money)
  },
  "discountMessage": {
    object (LocalizedString)
  }
}
Campos
faceValue

object (Money)

Es el valor nominal del boleto.
purchasePrice

object (Money)

Es el precio real de compra de la entrada, después de impuestos o descuentos.
discountMessage

object (LocalizedString)

Un mensaje que describe cualquier tipo de descuento que se aplicó.

TicketLeg

Representación JSON 
{
  "originStationCode": string,
  "originName": {
    object (LocalizedString)
  },
  "destinationStationCode": string,
  "destinationName": {
    object (LocalizedString)
  },
  "departureDateTime": string,
  "arrivalDateTime": string,
  "fareName": {
    object (LocalizedString)
  },
  "carriage": string,
  "platform": string,
  "zone": string,
  "ticketSeat": {
    object (TicketSeat)
  },
  "ticketSeats": [
    {
      object (TicketSeat)
    }
  ],
  "transitOperatorName": {
    object (LocalizedString)
  },
  "transitTerminusName": {
    object (LocalizedString)
  }
}
Campos
originStationCode

string

El código de la estación de origen Esto es obligatorio si destinationStationCode está presente o si originName no lo está.
originName

object (LocalizedString)

Es el nombre de la estación de origen. Esto es obligatorio si desinationName está presente o si originStationCode no lo está.
destinationStationCode

string

Es el código de la estación de destino.
destinationName

object (LocalizedString)

Es el nombre del destino.
departureDateTime

string

Es la fecha y hora de salida. Es obligatorio si no hay un intervalo de tiempo de validez configurado en el objeto de transporte público.

Se trata de una fecha y hora con formato extendido ISO 8601, con o sin desplazamiento. El tiempo se puede especificar con una precisión de hasta nanosegundos. Los desplazamientos se pueden especificar con segundos de precisión (aunque los segundos de desplazamiento no forman parte de ISO 8601).

Por ejemplo:

1985-04-12T23:20:50.52Z serían 20 minutos y 50.52 segundos después de la hora 23 del 12 de abril de 1985 en UTC.

1985-04-12T19:20:50.52-04:00 serían 20 minutos y 50.52 segundos después de la hora 19 del 12 de abril de 1985, 4 horas antes del UTC (el mismo instante que el ejemplo anterior). Si el evento fuera en Nueva York, equivaldría a la hora de verano del este (EDT). Recuerda que la compensación varía en las regiones que respetan el horario de verano, según la época del año.

1985-04-12T19:20:50.52 sería de 20 minutos y 50.52 segundos después de la hora 19 del 12 de abril de 1985 sin información de desplazamiento.

La parte de la fecha o la hora sin el desplazamiento se considera "fecha y hora local". Debe ser la fecha y hora local de la estación de origen. Por ejemplo, si la salida se produce a las 20 horas del 5 de junio de 2018 en la estación de origen, la parte de la fecha y la hora local debe ser 2018-06-05T20:00:00. Si la fecha/hora local en la estación de origen es 4 horas antes de UTC, se puede agregar una compensación de -04:00.

Sin la información de desplazamiento, es posible que algunas funciones enriquecidas no estén disponibles.
arrivalDateTime

string

Es la fecha y hora de llegada.

Se trata de una fecha y hora con formato extendido ISO 8601, con o sin desplazamiento. El tiempo se puede especificar con una precisión de hasta nanosegundos. Los desplazamientos se pueden especificar con segundos de precisión (aunque los segundos de desplazamiento no forman parte de ISO 8601).

Por ejemplo:

1985-04-12T23:20:50.52Z serían 20 minutos y 50.52 segundos después de la hora 23 del 12 de abril de 1985 en UTC.

1985-04-12T19:20:50.52-04:00 serían 20 minutos y 50.52 segundos después de la hora 19 del 12 de abril de 1985, 4 horas antes del UTC (el mismo instante que el ejemplo anterior). Si el evento fuera en Nueva York, equivaldría a la hora de verano del este (EDT). Recuerda que la compensación varía en las regiones que respetan el horario de verano, según la época del año.

1985-04-12T19:20:50.52 sería de 20 minutos y 50.52 segundos después de la hora 19 del 12 de abril de 1985 sin información de desplazamiento.

La parte de la fecha o la hora sin el desplazamiento se considera "fecha y hora local". Debe ser la fecha y hora locales de la estación de destino. Por ejemplo, si el evento ocurre a las 20 horas del 5 de junio de 2018 en la estación de destino, la parte de la fecha y la hora local debe ser 2018-06-05T20:00:00. Si la fecha/hora local en la estación de destino es 4 horas antes de UTC, se puede agregar una compensación de -04:00.

Sin la información de desplazamiento, es posible que algunas funciones enriquecidas no estén disponibles.
fareName

object (LocalizedString)

Es una descripción breve del nombre de la tarifa para este tramo del viaje. Por ejemplo, "Uso único en cualquier momento".
carriage

string

Es el nombre o número del tren o el barco que el pasajero debe subir.
platform

string

Es la plataforma o la puerta donde el pasajero puede subir al vagón.
zone

string

La zona de embarque dentro de la plataforma.
ticketSeat

object (TicketSeat)

El asiento reservado para los pasajeros Si se debe especificar más de una licencia, utiliza el campo ticketSeats en su lugar. Es posible que no se establezcan ticketSeat ni ticketSeats.
ticketSeats[]

object (TicketSeat)

El asiento reservado para los pasajeros Si solo se debe especificar una licencia, utiliza el campo ticketSeat en su lugar. Es posible que no se establezcan ticketSeat ni ticketSeats.
transitOperatorName

object (LocalizedString)

Indica el nombre del operador de transporte público que opera este tramo del viaje.
transitTerminusName

object (LocalizedString)

Estación terminal o destino del tren, el autobús, etcétera

TicketSeat

Representación JSON 
{
  "fareClass": enum (FareClass),
  "customFareClass": {
    object (LocalizedString)
  },
  "coach": string,
  "seat": string,
  "seatAssignment": {
    object (LocalizedString)
  }
}
Campos
fareClass

enum (FareClass)

El tipo de tarifa del asiento pagado
customFareClass

object (LocalizedString)

Un tipo de tarifa personalizada que se usará si no se aplica ninguna fareClass. Es posible que no se establezcan fareClass ni customFareClass.
coach

string

Es el identificador del vagón o vagón en el que se encuentra el asiento con boletos. P. ej. “10”
seat

string

Es el identificador del lugar donde se encuentra el asiento para la venta de entradas. P. ej. “42”. Si no hay un identificador específico, usa seatAssigment en su lugar.
seatAssignment

object (LocalizedString)

Asignación de asientos del pasajero. P. ej. "sin asiento específico". Se debe usar cuando no hay un identificador específico para usar en seat.

FareClass

Enumeradores
FARE_CLASS_UNSPECIFIED
ECONOMY
economy

Alias heredado de ECONOMY. Ya no está disponible.
FIRST
first

Alias heredado de FIRST. Ya no está disponible.
BUSINESS
business

Alias heredado de BUSINESS. Ya no está disponible.

TripType

Enumeradores
TRIP_TYPE_UNSPECIFIED
ROUND_TRIP
roundTrip

Alias heredado de ROUND_TRIP. Ya no está disponible.
ONE_WAY
oneWay

Alias heredado de ONE_WAY. Ya no está disponible.

ActivationStatus

El estado de activación del objeto. Este campo incluye el estado de activación si valioso es compatible con la activación.

Representación JSON 
{
  "state": enum (State)
}
Campos
state

enum (State)

Estado

Enumeradores
UNKNOWN_STATE
NOT_ACTIVATED No activada; este es el estado predeterminado
not_activated

Alias heredado de NOT_ACTIVATED. Ya no está disponible.
ACTIVATED Activada
activated

Alias heredado de ACTIVATED. Ya no está disponible.

DeviceContext

Contexto del dispositivo asociado con el objeto.

Representación JSON 
{
  "deviceToken": string
}
Campos
deviceToken

string

Si se configura, la información de canje solo se devolverá al dispositivo determinado cuando se active el objeto. No se debe usar como un identificador estable para rastrear el dispositivo de un usuario. Puede cambiar entre diferentes pases para el mismo dispositivo o incluso entre diferentes activaciones para el mismo dispositivo. Cuando se configura esto, los emisores también deben establecer hasLinkedDevice en el objeto que se activa.

Métodos

addmessage

 Agrega un mensaje al objeto de transporte público al que hace referencia el ID de objeto determinado.

get

 Muestra el objeto de transporte público con el ID de objeto determinado.

insert

 Inserta un objeto de transporte público con el ID y las propiedades especificados.

list

 Devuelve una lista de todos los objetos de transporte público de un ID de entidad emisora determinado.

patch

 Actualiza el objeto de transporte público al que hace referencia el ID de objeto determinado.

update

 Actualiza el objeto de transporte público al que hace referencia el ID de objeto determinado.