Recurso: TransitClass
Representación JSON |
---|
{ "transitOperatorName": { object ( |
Campos | |
---|---|
transitOperatorName |
Es el nombre del operador de transporte público. |
logo |
Obligatorio. Es la imagen del logotipo del ticket. Esta imagen aparece en la vista de detalles de la tarjeta de la app. |
transitType |
Obligatorio. El tipo de transporte público que representa esta clase, como "autobús". |
watermark |
Imagen de marca de agua para mostrar en el dispositivo del usuario. |
languageOverride |
Si este campo está presente, los boletos de transporte público que se publican en el dispositivo de un usuario siempre estarán en este idioma. Representa la etiqueta de idioma BCP 47. Los valores de ejemplo son "en-US", "en-GB", "de" o "de-AT". |
customTransitTerminusNameLabel |
Una etiqueta personalizada para el valor del nombre de la terminal de transporte público ( |
customTicketNumberLabel |
Es una etiqueta personalizada que se usa para el valor del número de ticket ( |
customRouteRestrictionsLabel |
Una etiqueta personalizada que se usa para el valor de restricciones de ruta ( |
customRouteRestrictionsDetailsLabel |
Una etiqueta personalizada para usar en el valor de los detalles de las restricciones de ruta ( |
customTimeRestrictionsLabel |
Una etiqueta personalizada que se usa para el valor de los detalles de las restricciones de tiempo ( |
customOtherRestrictionsLabel |
Una etiqueta personalizada para usar en el otro valor de restricciones ( |
customPurchaseReceiptNumberLabel |
Una etiqueta personalizada que se usa para el valor del número del recibo de compra ( |
customConfirmationCodeLabel |
Una etiqueta personalizada que se usa para el valor del código de confirmación ( |
customPurchaseFaceValueLabel |
Es una etiqueta personalizada que se usa para el valor nominal de la compra ( |
customPurchasePriceLabel |
Una etiqueta personalizada para usar para el valor del precio de compra ( |
customDiscountMessageLabel |
Una etiqueta personalizada que se usa en el valor del mensaje de descuento para transporte público ( |
customCarriageLabel |
Una etiqueta personalizada que se usa para el valor de carro ( |
customSeatLabel |
Una etiqueta personalizada para usar en el valor de ubicación de asientos ( |
customCoachLabel |
Una etiqueta personalizada para usar para el valor de coaching ( |
customPlatformLabel |
Es una etiqueta personalizada que se usa para el valor de la plataforma de embarque ( |
customZoneLabel |
Una etiqueta personalizada que se usa para el valor de la zona de embarque ( |
customFareClassLabel |
Es una etiqueta personalizada que se usa para el valor del tipo de tarifa ( |
customConcessionCategoryLabel |
Es una etiqueta personalizada que se usa para el valor de la categoría de concesión de transporte público ( |
customFareNameLabel |
Es una etiqueta personalizada que se usa para el valor del nombre de la tarifa de transporte público ( |
classTemplateInfo |
Información de la plantilla sobre cómo se debe mostrar la clase. Si no la estableces, Google recurrirá a un conjunto de campos predeterminado para mostrar. |
enableSingleLegItinerary |
Controla la visualización del itinerario de un solo tramo para esta clase. De forma predeterminada, un itinerario solo se mostrará para viajes de varios tramos. |
id |
Obligatorio. Es el identificador único de una clase. Este ID debe ser único en todas las clases 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. Tu identificador único solo debe incluir caracteres alfanuméricos, “.”, “_” o “-”. |
version |
Obsoleto |
issuerName |
Obligatorio. El nombre de la entidad emisora. La longitud máxima recomendada es de 20 caracteres para garantizar que se muestre toda la cadena en pantallas más pequeñas. |
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. |
allowMultipleUsersPerObject |
Ya no está disponible. Usa |
homepageUri |
El URI de la página principal de tu aplicación. La propagación del URI en este campo da como resultado el mismo comportamiento que si se propaga un URI en linksModuleData (cuando se renderiza un objeto, se muestra un vínculo a la página principal en lo que generalmente se consideraría la sección linksModuleData del objeto). |
locations[] |
Nota: Actualmente, este campo no es compatible con la activación de notificaciones geográficas. |
reviewStatus |
Obligatorio. Estado de la clase. Este campo se puede configurar como Debes mantener este campo en Debes establecer este campo en Cuando actualizas una clase que ya es |
review |
Los comentarios de revisión que establece la plataforma cuando una clase está marcada como |
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 los datos del módulo de vínculos en el objeto, se mostrarán ambos. |
redemptionIssuers[] |
Identifica qué entidades emisoras de canje pueden canjear el pase con Smart Tap. Las entidades emisoras de canje se identifican con su ID de entidad emisora. Las entidades emisoras de canje deben tener al menos una clave de Toque inteligente configurada. Los campos |
countryCode |
Es el código de país que se usa para mostrar el país de la tarjeta (si el usuario no se encuentra en ese país) y contenido localizado cuando no está disponible en la configuración regional del usuario. |
heroImage |
Imagen opcional del banner que se muestra en el frente de la tarjeta. Si no hay ninguno, no se mostrará nada. La imagen se mostrará con un ancho del 100%. |
wordMark |
Ya no está disponible. |
enableSmartTap |
Identifica si esta clase es compatible con el Toque inteligente. Los campos |
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 |
localizedIssuerName |
Cadenas traducidas para emisorName La longitud máxima recomendada es de 20 caracteres para garantizar que se muestre toda la cadena en pantallas más pequeñas. |
multipleDevicesAndHoldersAllowedStatus |
Identifica si varios usuarios y dispositivos guardarán el mismo objeto que haga referencia a esta clase. |
callbackOptions |
Opciones de devolución de llamada que el usuario final usará para devolver la llamada a la entidad emisora cada vez que el usuario final guarde o borre un objeto de esta clase. Todos los objetos de esta clase son aptos para la devolución de llamada. |
securityAnimation |
Información opcional sobre la animación de seguridad. Si se establece, se renderizará una animación de seguridad en los detalles del pase. |
activationOptions |
Opciones de activación para un ticket activable |
viewUnlockRequirement |
Consulta las opciones de Requisito de desbloqueo para el boleto de transporte público. |
wideLogo |
Es el logotipo ancho del ticket. Cuando se proporciona, se utiliza en lugar del logotipo en la esquina superior izquierda de la vista de tarjetas. |
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 correspondiente que se usará en su lugar. |
TransitType
Enumeradores | |
---|---|
TRANSIT_TYPE_UNSPECIFIED |
|
BUS |
|
bus |
Alias heredado de |
RAIL |
|
rail |
Alias heredado de |
TRAM |
|
tram |
Alias heredado de |
FERRY |
|
ferry |
Alias heredado de |
OTHER |
|
other |
Alias heredado de |
ActivationOptions
ActivationOptions para la clase
Representación JSON |
---|
{ "activationUrl": string, "allowReactivation": boolean } |
Campos | |
---|---|
activationUrl |
Es una URL HTTPS que admite semánticas de REST. Se usaría a fin de solicitar la activación a los socios para un valor específico, activado por los usuarios. |
allowReactivation |
Marca para permitir que los usuarios realicen una llamada de activación desde otro dispositivo. Esto permite que el cliente renderice el botón de activación habilitado incluso si activationStatus está en ACTIVATED, pero el dispositivo solicitado es diferente del dispositivo actual. |
Métodos |
|
---|---|
|
Agrega un mensaje a la clase de transporte público a la que hace referencia el ID de clase determinado. |
|
Muestra la clase de transporte público con el ID de clase determinado. |
|
Inserta una clase de transporte público con el ID y las propiedades especificados. |
|
Devuelve una lista de todas las clases de transporte público de un ID de entidad emisora determinado. |
|
Actualiza la clase de transporte público a la que hace referencia el ID de clase determinado. |
|
Actualiza la clase de transporte público a la que hace referencia el ID de clase determinado. |