- Recurso: TransitObject
- PassengerType
- TicketStatus
- ConcessionCategory
- TicketRestrictions
- PurchaseDetails
- TicketCost
- TicketLeg
- TicketSeat
- FareClass
- TripType
- ActivationStatus
- Estado
- DeviceContext
- Métodos
Recurso: TransitObject
Representación JSON |
---|
{ "classReference": { object ( |
Campos | |
---|---|
classReference |
Una copia de los campos heredados de la clase superior. Estos campos se recuperan durante un GET. |
ticketNumber |
Es el número del ticket. Es un identificador único para el boleto en el sistema del operador de transporte público. |
passengerType |
Indica la cantidad de pasajeros. |
passengerNames |
Son los nombres de los pasajeros a los que se asigna el boleto. El campo |
tripId |
Este ID se usa para agrupar boletos si el usuario guardó varios boletos para el mismo viaje. |
ticketStatus |
Es el estado del ticket. Para los estados que afectan la pantalla, usa el campo |
customTicketStatus |
Es un estado personalizado para usar en el valor del estado del ticket cuando |
concessionCategory |
Indica la categoría de concesión del boleto. |
customConcessionCategory |
Una categoría de concesión personalizada para usar cuando |
ticketRestrictions |
Información sobre el tipo de restricciones que existen para usar este boleto. Por ejemplo, qué días de la semana se debe usar o qué rutas se pueden tomar. |
purchaseDetails |
Detalles de compra de este boleto. |
ticketLeg |
Un solo tramo de boleto contiene información de salida y llegada, junto con información sobre el embarque y cómo sentarse. Si se debe especificar más de un segmento, usa el campo |
ticketLegs[] |
Cada boleto puede contener una o más etapas. Cada tramo contiene información de salidas y llegadas, además de información sobre el embarque y los asientos. Si solo se debe especificar un segmento, usa el campo |
hexBackgroundColor |
El color de fondo de la tarjeta Si no se establece el color dominante de la imagen principal, se usa el color dominante del logotipo. El formato es #rrggbb, en el que rrggbb es un triplete RGB hexadecimal, como |
tripType |
Obligatorio. Es el tipo de viaje que representa este objeto de transporte público. Se usa para determinar el título del pase y qué símbolo usar entre el origen y el destino. |
id |
Obligatorio. Es el identificador único de un objeto. Este ID debe ser único entre todos los objetos de una entidad emisora. Este valor debe seguir el formato issuer ID.identifier, en el que Google emite el primero y tú eliges el segundo. El identificador único solo debe incluir caracteres alfanuméricos, “.”, “_” o “-”. |
classId |
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, en el que Google emite el primero y tú eliges el segundo. |
version |
Obsoleto |
state |
Obligatorio. El estado del objeto. Este campo se usa para determinar cómo se muestra un objeto en la app. Por ejemplo, un objeto |
barcode |
El tipo y valor del código de barras. |
messages[] |
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 |
El período en el que será |
locations[] |
Nota: Por el momento, este campo no se admite para activar notificaciones geográficas. |
hasUsers |
Indica si el objeto tiene usuarios. La plataforma establece este campo. |
smartTapRedemptionValue |
El valor que se transmitirá a un terminal certificado para Smart Tap mediante NFC para este objeto. Los campos de nivel de clase |
hasLinkedDevice |
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 la usen socios seleccionados. Comunícate con el equipo de asistencia para obtener más información. |
disableExpirationNotification |
Indica si se deben suprimir explícitamente las notificaciones. Si se establece este campo como verdadero, independientemente del campo Por el momento, esta opción solo se puede configurar para las ofertas. |
infoModuleData |
Obsoleta. En su lugar, usa textModulesData. |
imageModulesData[] |
Datos del módulo de imagen La cantidad máxima de estos campos que se muestran es 1 desde el nivel de objeto y 1 para el nivel de objeto de clase. |
textModulesData[] |
Datos del módulo de texto Si también se definen datos del módulo de texto en la clase, se mostrarán ambos. La cantidad máxima de estos campos que se muestran es 10 para el objeto y 10 para la clase. |
linksModuleData |
Vincula los datos del módulo. Si los datos del módulo de vínculos también se definen en la clase, se mostrarán ambos. |
appLinkData |
Vínculo opcional a la app o al sitio web que se mostrará como un botón en la parte frontal del pase. Si se proporciona AppLinkData para la clase correspondiente, solo se mostrará el objeto AppLinkData. |
activationStatus |
El estado de activación del objeto. Es obligatorio si la clase tiene configurado |
rotatingBarcode |
El tipo y el valor del código de barras rotativo. |
deviceContext |
Contexto del dispositivo asociado con el objeto. |
heroImage |
Imagen del banner opcional que se muestra en el frente de la tarjeta. Si no hay ninguno, se mostrará la imagen principal de la clase, si está presente. Si la imagen principal de la clase tampoco está presente, no se mostrará nada. |
groupingInfo |
Información que controla cómo se agrupan los pases. |
passConstraints |
Pasa las restricciones del objeto. Incluye la limitación de los comportamientos de NFC y capturas de pantalla. |
saveRestrictions |
Son las restricciones en el objeto que se debe verificar antes de que el usuario intente guardar el pase. Ten en cuenta que estas restricciones solo se aplicarán durante el tiempo de guardado. Si las restricciones cambian después de que un usuario guarda un pase, las restricciones nuevas no se aplicarán a un pase ya guardado. |
PassengerType
Enumeraciones | |
---|---|
PASSENGER_TYPE_UNSPECIFIED |
|
SINGLE_PASSENGER |
|
singlePassenger |
Alias heredado de |
MULTIPLE_PASSENGERS |
|
multiplePassengers |
Alias heredado de |
TicketStatus
Enumeraciones | |
---|---|
TICKET_STATUS_UNSPECIFIED |
|
USED |
|
used |
Alias heredado de |
REFUNDED |
|
refunded |
Alias heredado de |
EXCHANGED |
|
exchanged |
Alias heredado de |
ConcessionCategory
Enumeraciones | |
---|---|
CONCESSION_CATEGORY_UNSPECIFIED |
|
ADULT |
|
adult |
Alias heredado de |
CHILD |
|
child |
Alias heredado de |
SENIOR |
|
senior |
Alias heredado de |
TicketRestrictions
Representación JSON |
---|
{ "routeRestrictions": { object ( |
Campos | |
---|---|
routeRestrictions |
Restricciones sobre las rutas que se pueden tomar. Por ejemplo, puede ser la cadena "Solo trenes CrossCountry reservados". |
routeRestrictionsDetails |
Obtén más detalles sobre el |
timeRestrictions |
Restricciones relativas a los horarios en que se puede usar este boleto. |
otherRestrictions |
Restricciones adicionales que no se incluyen en la "ruta" o "tiempo" categorías. |
PurchaseDetails
Representación JSON |
---|
{
"purchaseReceiptNumber": string,
"purchaseDateTime": string,
"accountId": string,
"confirmationCode": string,
"ticketCost": {
object ( |
Campos | |
---|---|
purchaseReceiptNumber |
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 |
Es la fecha y hora de compra del boleto. Esta es una fecha y hora de formato extendido ISO 8601, con o sin desplazamiento. El tiempo se puede especificar con una precisión de nanosegundos. Los desplazamientos se pueden especificar con precisión de segundos (aunque los segundos de desplazamiento no formen parte de ISO 8601). Por ejemplo:
Sin información de desplazamiento, es posible que algunas funciones enriquecidas no estén disponibles. |
accountId |
ID de la cuenta que se usó para comprar la entrada. |
confirmationCode |
Es el código de confirmación de la compra. Puede ser el mismo para varios boletos diferentes y se usa para agrupar entradas. |
ticketCost |
Es el costo del boleto. |
TicketCost
Representación JSON |
---|
{ "faceValue": { object ( |
Campos | |
---|---|
faceValue |
Es el valor nominal del ticket. |
purchasePrice |
Es el precio de compra real del boleto, después de impuestos o descuentos. |
discountMessage |
Un mensaje que describe cualquier tipo de descuento que se aplicó. |
TicketLeg
Representación JSON |
---|
{ "originStationCode": string, "originName": { object ( |
Campos | |
---|---|
originStationCode |
El código de la estación de origen. Se requiere si |
originName |
El nombre de la estación de origen. Se requiere si |
destinationStationCode |
Es el código de la estación de destino. |
destinationName |
Es el nombre del destino. |
departureDateTime |
La fecha y hora de salida. Esto es obligatorio si no se establece un intervalo de tiempo de validez en el objeto de transporte público. Esta es una fecha y hora de formato extendido ISO 8601, con o sin desplazamiento. El tiempo se puede especificar con una precisión de nanosegundos. Los desplazamientos se pueden especificar con precisión de segundos (aunque los segundos de desplazamiento no formen parte de ISO 8601). Por ejemplo:
La parte de la fecha y hora sin el desplazamiento se considera como la "fecha y hora locales". Debe ser la fecha y hora local en la estación de origen. Por ejemplo, si la salida se realiza a las 20 horas del 5 de junio de 2018 en la estación de origen, la parte de fecha y hora local debe ser Sin información de desplazamiento, es posible que algunas funciones enriquecidas no estén disponibles. |
arrivalDateTime |
La fecha/hora de llegada. Esta es una fecha y hora de formato extendido ISO 8601, con o sin desplazamiento. El tiempo se puede especificar con una precisión de nanosegundos. Los desplazamientos se pueden especificar con precisión de segundos (aunque los segundos de desplazamiento no formen parte de ISO 8601). Por ejemplo:
La parte de la fecha y hora sin el desplazamiento se considera como la "fecha y hora locales". Debe ser la fecha y la hora locales en la estación de destino. Por ejemplo, si el evento se lleva a cabo a las 20 horas del 5 de junio de 2018 en la estación de destino, la parte de fecha y hora local debe ser Sin información de desplazamiento, es posible que algunas funciones enriquecidas no estén disponibles. |
fareName |
Es una descripción breve o el nombre de la tarifa correspondiente a este tramo del viaje. P. ej., “Siempre de uso único”. |
carriage |
Indica el nombre o número del tren o del barco que el pasajero debe subir. |
platform |
Es la plataforma o la puerta por la que el pasajero puede subir al vagón. |
zone |
Indica la zona de abordaje dentro de la plataforma. |
ticketSeat |
El asiento reservado para los pasajeros. Si se especificará más de una licencia, usa el campo |
ticketSeats[] |
El asiento reservado para los pasajeros. Si solo se especificará un asiento, usa el campo |
transitOperatorName |
Es el nombre del operador de transporte público que opera este tramo de un viaje. |
transitTerminusName |
Terminal o destino del tren, autobús, etcétera |
TicketSeat
Representación JSON |
---|
{ "fareClass": enum ( |
Campos | |
---|---|
fareClass |
Indica el tipo de tarifa del asiento que se factura. |
customFareClass |
Indica un tipo de tarifa personalizada que se utilizará si no se aplica ninguna |
coach |
Es el identificador del vagón o vagón de tren en el que se encuentra el asiento del boleto. P. ej. “10” |
seat |
Es el identificador de dónde se encuentra la licencia para la venta. P. ej. “42” Si no hay un identificador específico, usa |
seatAssignment |
La asignación del asiento del pasajero. P. ej. “sin asiento específico”. Se usa cuando no hay un identificador específico para usar en |
FareClass
Enumeraciones | |
---|---|
FARE_CLASS_UNSPECIFIED |
|
ECONOMY |
|
economy |
Alias heredado de |
FIRST |
|
first |
Alias heredado de |
BUSINESS |
|
business |
Alias heredado de |
TripType
Enumeraciones | |
---|---|
TRIP_TYPE_UNSPECIFIED |
|
ROUND_TRIP |
|
roundTrip |
Alias heredado de |
ONE_WAY |
|
oneWay |
Alias heredado de |
ActivationStatus
El estado de activación del objeto. Este campo incluye el estado de activación si el valor es compatible con la activación.
Representación JSON |
---|
{
"state": enum ( |
Campos | |
---|---|
state |
|
Estado
Enumeraciones | |
---|---|
UNKNOWN_STATE |
|
NOT_ACTIVATED |
No activada; este es el estado predeterminado |
not_activated |
Alias heredado de |
ACTIVATED |
Activado |
activated |
Alias heredado de |
DeviceContext
Contexto del dispositivo asociado con el objeto.
Representación JSON |
---|
{ "deviceToken": string } |
Campos | |
---|---|
deviceToken |
Si se establece, solo se mostrará la información de canje en el dispositivo determinado tras la activación del objeto. No debe usarse como un identificador estable para rastrear el dispositivo de un usuario. Puede cambiar entre diferentes pases del mismo dispositivo o incluso entre distintas activaciones para el mismo dispositivo. Cuando se configura este parámetro, los emisores también deben configurar hasLinkedDevice en el objeto que se activa. |
Métodos |
|
---|---|
|
Agrega un mensaje al objeto de transporte público al que hace referencia el ID de objeto determinado. |
|
Devuelve el objeto de transporte público con el ID de objeto especificado. |
|
Inserta un objeto de transporte público con el ID y las propiedades especificados. |
|
Devuelve una lista de todos los objetos de transporte público de un ID de entidad emisora determinado. |
|
Actualiza el objeto de transporte público al que hace referencia el ID de objeto determinado. |
|
Actualiza el objeto de transporte público al que hace referencia el ID de objeto determinado. |