REST Resource: transitclass

Recurso: TransitClass

Representación JSON 
{
  "transitOperatorName": {
    object (LocalizedString)
  },
  "logo": {
    object (Image)
  },
  "transitType": enum (TransitType),
  "watermark": {
    object (Image)
  },
  "languageOverride": string,
  "customTransitTerminusNameLabel": {
    object (LocalizedString)
  },
  "customTicketNumberLabel": {
    object (LocalizedString)
  },
  "customRouteRestrictionsLabel": {
    object (LocalizedString)
  },
  "customRouteRestrictionsDetailsLabel": {
    object (LocalizedString)
  },
  "customTimeRestrictionsLabel": {
    object (LocalizedString)
  },
  "customOtherRestrictionsLabel": {
    object (LocalizedString)
  },
  "customPurchaseReceiptNumberLabel": {
    object (LocalizedString)
  },
  "customConfirmationCodeLabel": {
    object (LocalizedString)
  },
  "customPurchaseFaceValueLabel": {
    object (LocalizedString)
  },
  "customPurchasePriceLabel": {
    object (LocalizedString)
  },
  "customDiscountMessageLabel": {
    object (LocalizedString)
  },
  "customCarriageLabel": {
    object (LocalizedString)
  },
  "customSeatLabel": {
    object (LocalizedString)
  },
  "customCoachLabel": {
    object (LocalizedString)
  },
  "customPlatformLabel": {
    object (LocalizedString)
  },
  "customZoneLabel": {
    object (LocalizedString)
  },
  "customFareClassLabel": {
    object (LocalizedString)
  },
  "customConcessionCategoryLabel": {
    object (LocalizedString)
  },
  "customFareNameLabel": {
    object (LocalizedString)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "enableSingleLegItinerary": boolean,
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "activationOptions": {
    object (ActivationOptions)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideLogo": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
Campos
transitOperatorName

object (LocalizedString)

Es el nombre del operador de transporte público.
transitType

enum (TransitType)

Es obligatorio. Es el tipo de transporte público que representa esta clase, como "bus".
watermark

object (Image)

Es la imagen de la marca de agua que se mostrará en el dispositivo del usuario.
languageOverride

string

Si este campo está presente, los boletos de transporte público que se entreguen al dispositivo de un usuario siempre estarán en este idioma. Representa la etiqueta de idioma BCP 47. Algunos valores de ejemplo son "en-US", "en-GB", "de" o "de-AT".
customTransitTerminusNameLabel

object (LocalizedString)

Es una etiqueta personalizada que se usará para el valor del nombre de la terminal de transporte público (transitObject.ticketLeg.transitTerminusName).
customTicketNumberLabel

object (LocalizedString)

Es una etiqueta personalizada que se usará para el valor del número de ticket (transitObject.ticketNumber).
customRouteRestrictionsLabel

object (LocalizedString)

Es una etiqueta personalizada que se usará para el valor de restricciones de la ruta (transitObject.ticketRestrictions.routeRestrictions).
customRouteRestrictionsDetailsLabel

object (LocalizedString)

Es una etiqueta personalizada que se usará para el valor de los detalles de las restricciones de la ruta (transitObject.ticketRestrictions.routeRestrictionsDetails).
customTimeRestrictionsLabel

object (LocalizedString)

Es una etiqueta personalizada que se usará para el valor de los detalles de las restricciones de tiempo (transitObject.ticketRestrictions.timeRestrictions).
customOtherRestrictionsLabel

object (LocalizedString)

Es una etiqueta personalizada que se usará para el valor de otras restricciones (transitObject.ticketRestrictions.otherRestrictions).
customPurchaseReceiptNumberLabel

object (LocalizedString)

Es una etiqueta personalizada que se usará para el valor del número de recibo de compra (transitObject.purchaseDetails.purchaseReceiptNumber).
customConfirmationCodeLabel

object (LocalizedString)

Es una etiqueta personalizada que se usará para el valor del código de confirmación (transitObject.purchaseDetails.confirmationCode).
customPurchaseFaceValueLabel

object (LocalizedString)

Es una etiqueta personalizada que se usa para el valor nominal de la compra (transitObject.purchaseDetails.ticketCost.faceValue).
customPurchasePriceLabel

object (LocalizedString)

Es una etiqueta personalizada que se usará para el valor del precio de compra (transitObject.purchaseDetails.ticketCost.purchasePrice).
customDiscountMessageLabel

object (LocalizedString)

Es una etiqueta personalizada que se usará para el valor del mensaje de descuento por tiempo en tránsito (transitObject.purchaseDetails.ticketCost.discountMessage).
customCarriageLabel

object (LocalizedString)

Es una etiqueta personalizada que se usa para el valor de transporte (transitObject.ticketLeg.carriage).
customSeatLabel

object (LocalizedString)

Es una etiqueta personalizada que se usará para el valor de la ubicación del asiento (transitObject.ticketLeg.ticketSeat.seat).
customCoachLabel

object (LocalizedString)

Es una etiqueta personalizada que se usará para el valor de la etiqueta de carro (transitObject.ticketLeg.ticketSeat.coach).
customPlatformLabel

object (LocalizedString)

Es una etiqueta personalizada que se usará para el valor de la plataforma de embarque (transitObject.ticketLeg.platform).
customZoneLabel

object (LocalizedString)

Es una etiqueta personalizada que se usará para el valor de la zona de embarque (transitObject.ticketLeg.zone).
customFareClassLabel

object (LocalizedString)

Es una etiqueta personalizada que se usa para el valor de la clase de tarifa (transitObject.ticketLeg.ticketSeat.fareClass).
customConcessionCategoryLabel

object (LocalizedString)

Es una etiqueta personalizada que se usará para el valor de la categoría de concesión de transporte público (transitObject.concessionCategory).
customFareNameLabel

object (LocalizedString)

Es una etiqueta personalizada que se usará para el valor del nombre de la tarifa de transporte público (transitObject.ticketLeg.fareName).
classTemplateInfo

object (ClassTemplateInfo)

Información de la plantilla sobre cómo se debe mostrar la clase. Si no se establece, Google usará un conjunto predeterminado de campos para mostrar.
enableSingleLegItinerary

boolean

Controla la visualización del itinerario de una sola escala para esta clase. De forma predeterminada, un itinerario solo se mostrará para viajes de varios tramos.
id

string

Es obligatorio. Es el identificador único de una clase. Este ID debe ser único para todas las clases de un emisor. Este valor debe seguir el formato issuer ID.identifier, donde Google emite el primero y tú eliges el segundo. Tu identificador único solo debe incluir caracteres alfanuméricos, '.', '_' o '-'.
version
(deprecated)

string (int64 format)

Obsoleto
issuerName

string

Es obligatorio. Es el nombre de la entidad emisora. La longitud máxima recomendada es de 20 caracteres para garantizar que se muestre la cadena completa en pantallas más pequeñas.
messages[]

object (Message)

Es un array de mensajes que se muestran en la app. Todos los usuarios de este objeto recibirán los mensajes asociados. La cantidad máxima de estos campos es de 10.
allowMultipleUsersPerObject
(deprecated)

boolean

Obsoleta. Usa multipleDevicesAndHoldersAllowedStatus en su lugar.
homepageUri

object (Uri)

Es el URI de la página principal de tu aplicación. Si propagas el URI en este campo, se produce exactamente el mismo comportamiento que si propagas un URI en linksModuleData (cuando se renderiza un objeto, se muestra un vínculo a la página principal en lo que se suele considerar la sección linksModuleData del objeto).
locations[]
(deprecated)

object (LatLongPoint)

Nota: Por el momento, este campo no es compatible para activar notificaciones geográficas.
reviewStatus

enum (ReviewStatus)

Es obligatorio. Es el estado de la clase. Este campo se puede establecer en draft o underReview con las llamadas a la API de inserción, parche o actualización. Una vez que se cambia el estado de la revisión de draft, es posible que no se pueda volver a cambiar a draft.

Debes mantener este campo en draft cuando la clase esté en desarrollo. No se puede usar una clase draft para crear ningún objeto.

Debes establecer este campo en underReview cuando creas que la clase está lista para usarse. La plataforma establecerá automáticamente este campo en approved y se podrá usar de inmediato para crear o migrar objetos.

Cuando actualices una clase que ya es approved, debes seguir configurando este campo como underReview.
review

object (Review)

Los comentarios de revisión que establece la plataforma cuando una clase se marca como approved o rejected
infoModuleData
(deprecated)

object (InfoModuleData)

Obsoleta. 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 a nivel del objeto y 1 a nivel del objeto de clase.
textModulesData[]

object (TextModuleData)

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

string (int64 format)

Identifica qué emisores de canje pueden canjear el pase a través de Smart Tap. Las entidades emisoras de canjes se identifican por su ID de emisor. Los emisores de canje deben tener configurada al menos una clave de Smart Tap.

Los campos enableSmartTap y smartTapRedemptionLevel a nivel del objeto también deben configurarse correctamente para que un pase admita el Toque inteligente.
countryCode

string

Es el código de país que se usa para mostrar el país de la tarjeta (cuando el usuario no está en ese país) y para mostrar contenido localizado cuando no está disponible en la configuración regional del usuario.
heroImage

object (Image)

Es la imagen de banner opcional que se muestra en la parte frontal de la tarjeta. Si no hay ninguno, no se mostrará nada. La imagen se mostrará al 100% de ancho.
wordMark
(deprecated)

object (Image)

Obsoleta.
enableSmartTap

boolean

Identifica si esta clase admite el Presionar con el dedo inteligente. Los campos redemptionIssuers y smartTapRedemptionLevel a nivel del objeto también deben configurarse correctamente para que un pase admita el Toque inteligente.
hexBackgroundColor

string

Es el color de fondo de la tarjeta. Si no se establece, se usa el color dominante de la imagen hero y, si no se establece ninguna imagen hero, se usa 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 #rgb, como #fc0.
localizedIssuerName

object (LocalizedString)

Cadenas traducidas para issuerName. La longitud máxima recomendada es de 20 caracteres para garantizar que se muestre la cadena completa en pantallas más pequeñas.
multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

Identifica si varios usuarios y dispositivos guardarán el mismo objeto que hace referencia a esta clase.
callbackOptions

object (CallbackOptions)

Son opciones de devolución de llamada que se usarán para llamar al emisor 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

object (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

object (ActivationOptions)

Son las opciones de activación para un boleto activable.
viewUnlockRequirement

enum (ViewUnlockRequirement)

Consulta las opciones de requisitos de desbloqueo para la tarjeta de transporte público.
notifyPreference

enum (NotificationSettingsForUpdates)

Indica si las actualizaciones de campos de esta clase deben activar notificaciones. Cuando se establece en NOTIFY, intentaremos activar una notificación de actualización de campo para los usuarios. Estas notificaciones solo se enviarán a los usuarios si el campo forma parte de una lista de entidades permitidas. Si se establece en DO_NOT_NOTIFY o NOTIFICATION_SETTINGS_UNSPECIFIED, no se activará ninguna notificación. Este parámetro de configuración es efímero y se debe establecer con cada solicitud PATCH o UPDATE. De lo contrario, no se activará una notificación.
valueAddedModuleData[]

object (ValueAddedModuleData)

Datos opcionales del módulo de valor agregado. Máximo de diez en la clase. Para un pase, solo se mostrarán diez, dando prioridad a los del objeto.

TransitType

Enumeraciones
TRANSIT_TYPE_UNSPECIFIED
BUS
bus

Es el alias heredado de BUS. Obsoleta.
RAIL
rail

Es el alias heredado de RAIL. Obsoleta.
TRAM
tram

Es el alias heredado de TRAM. Obsoleta.
FERRY
ferry

Es el alias heredado de FERRY. Obsoleta.
OTHER
other

Es el alias heredado de OTHER. Obsoleta.

ActivationOptions

ActivationOptions para la clase

Representación JSON 
{
  "activationUrl": string,
  "allowReactivation": boolean
}
Campos
activationUrl

string

URL HTTPS que admite semántica REST Se usaría para solicitar la activación de los socios para un recurso valioso determinado que activan los usuarios.
allowReactivation

boolean

Marca para permitir que los usuarios realicen llamadas de activación desde diferentes dispositivos. Esto permite que el cliente renderice el botón de activación habilitado, incluso si el activationStatus es ACTIVATED, pero el dispositivo solicitado es diferente del dispositivo actual.

Métodos

addmessage

 Agrega un mensaje a la clase de transporte público a la que hace referencia el ID de clase determinado.

get

 Muestra la clase de transporte público con el ID de clase determinado.

insert

 Inserta una clase de transporte público con el ID y las propiedades determinados.

list

 Muestra una lista de todas las clases de tránsito para un ID de emisor determinado.

patch

 Actualiza la clase de transporte público a la que hace referencia el ID de clase determinado.

update

 Actualiza la clase de transporte público a la que hace referencia el ID de clase determinado.