- 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 |
Es una copia de los campos heredados de la clase superior. Estos campos se recuperan durante una solicitud GET. |
ticketNumber |
El número del ticket. Este es un identificador único para el boleto en el sistema del operador de transporte público. |
passengerType |
Es la cantidad de pasajeros. |
passengerNames |
Son los nombres de los pasajeros a los que está asignado el boleto. El campo |
tripId |
Este ID se utiliza para agrupar boletos si el usuario guardó varios boletos para el mismo viaje. |
ticketStatus |
El estado del ticket. Para los estados que afectan la visualización, 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 de la entrada. |
customConcessionCategory |
Una categoría de concesión personalizada para usar cuando |
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 |
Detalles de compra de este boleto. |
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[] |
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 |
hexBackgroundColor |
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 |
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 |
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 |
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 |
Obsoleto |
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 |
barcode |
El tipo de código de barras y el valor. |
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 del objeto será |
locations[] |
Nota: Actualmente, este campo no es compatible con la activación de notificaciones geográficas. |
hasUsers |
Indica si el objeto tiene usuarios. La plataforma establece este campo. |
smartTapRedemptionValue |
El valor que se transmitirá a una terminal certificada por Smart Tap a través de NFC para este objeto. Los campos |
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 lo usen socios seleccionados. Comunícate con el equipo de Asistencia para obtener más información. |
disableExpirationNotification |
Indica si las notificaciones deben suprimirse explícitamente. Si estableces este campo como verdadero, independientemente del campo Actualmente, solo se puede configurar para ofertas. |
infoModuleData |
Ya no está disponible. En su lugar, usa textModulesData. |
imageModulesData[] |
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[] |
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. |
linksModuleData |
Datos del módulo de vínculos. Si también se definen datos del módulo de vínculos 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 el objeto AppLinkData de la clase correspondiente únicamente, se mostrará. |
activationStatus |
El estado de activación del objeto. Es obligatorio si la clase tiene configurado |
rotatingBarcode |
El tipo y valor de código de barras rotativos. |
deviceContext |
Contexto del dispositivo asociado con el objeto. |
heroImage |
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 |
Información que controla cómo se agrupan los pases. |
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 |
MULTIPLE_PASSENGERS |
|
multiplePassengers |
Alias heredado de |
TicketStatus
Enumeradores | |
---|---|
TICKET_STATUS_UNSPECIFIED |
|
USED |
|
used |
Alias heredado de |
REFUNDED |
|
refunded |
Alias heredado de |
EXCHANGED |
|
exchanged |
Alias heredado de |
ConcessionCategory
Enumeradores | |
---|---|
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 "Reservad CrossCountry solo trenes". |
routeRestrictionsDetails |
Obtén más detalles sobre los |
timeRestrictions |
Restricciones sobre los horarios en los que se puede utilizar este boleto. |
otherRestrictions |
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 ( |
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 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:
Sin la información de desplazamiento, es posible que algunas funciones enriquecidas no estén disponibles. |
accountId |
Es el ID de la cuenta que se usó para comprar el boleto. |
confirmationCode |
Es el código de confirmación de la compra. Puede ser igual para varios tickets 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 boleto. |
purchasePrice |
Es el precio real de compra de la entrada, 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 Esto es obligatorio si |
originName |
Es el nombre de la estación de origen. Esto es obligatorio si |
destinationStationCode |
Es el código de la estación de destino. |
destinationName |
Es el nombre del destino. |
departureDateTime |
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:
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 Sin la información de desplazamiento, es posible que algunas funciones enriquecidas no estén disponibles. |
arrivalDateTime |
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:
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 Sin la información de desplazamiento, es posible que algunas funciones enriquecidas no estén disponibles. |
fareName |
Es una descripción breve del nombre de la tarifa para este tramo del viaje. Por ejemplo, "Uso único en cualquier momento". |
carriage |
Es el nombre o número del tren o el barco que el pasajero debe subir. |
platform |
Es la plataforma o la puerta donde el pasajero puede subir al vagón. |
zone |
La zona de embarque dentro de la plataforma. |
ticketSeat |
El asiento reservado para los pasajeros Si se debe especificar más de una licencia, utiliza el campo |
ticketSeats[] |
El asiento reservado para los pasajeros Si solo se debe especificar una licencia, utiliza el campo |
transitOperatorName |
Indica el nombre del operador de transporte público que opera este tramo del viaje. |
transitTerminusName |
Estación terminal o destino del tren, el autobús, etcétera |
TicketSeat
Representación JSON |
---|
{ "fareClass": enum ( |
Campos | |
---|---|
fareClass |
El tipo de tarifa del asiento pagado |
customFareClass |
Un tipo de tarifa personalizada que se usará si no se aplica ninguna |
coach |
Es el identificador del vagón o vagón en el que se encuentra el asiento con boletos. P. ej. “10” |
seat |
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 |
seatAssignment |
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 |
FareClass
Enumeradores | |
---|---|
FARE_CLASS_UNSPECIFIED |
|
ECONOMY |
|
economy |
Alias heredado de |
FIRST |
|
first |
Alias heredado de |
BUSINESS |
|
business |
Alias heredado de |
TripType
Enumeradores | |
---|---|
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 valioso es compatible con la activación.
Representación JSON |
---|
{
"state": enum ( |
Campos | |
---|---|
state |
|
Estado
Enumeradores | |
---|---|
UNKNOWN_STATE |
|
NOT_ACTIVATED |
No activada; este es el estado predeterminado |
not_activated |
Alias heredado de |
ACTIVATED |
Activada |
activated |
Alias heredado de |
DeviceContext
Contexto del dispositivo asociado con el objeto.
Representación JSON |
---|
{ "deviceToken": string } |
Campos | |
---|---|
deviceToken |
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 |
|
---|---|
|
Agrega un mensaje al objeto de transporte público al que hace referencia el ID de objeto determinado. |
|
Muestra el objeto de transporte público con el ID de objeto determinado. |
|
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. |