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)
  }
}
Campos
transitOperatorName

object (LocalizedString)

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

enum (TransitType)

Obligatorio. El tipo de transporte público que representa esta clase, como "autobús".
watermark

object (Image)

Imagen de marca de agua para mostrar en el dispositivo del usuario.
languageOverride

string

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

object (LocalizedString)

Una etiqueta personalizada para el valor del nombre de la terminal de transporte público (transitObject.ticketLeg.transitTerminusName).
customTicketNumberLabel

object (LocalizedString)

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

object (LocalizedString)

Una etiqueta personalizada que se usa para el valor de restricciones de ruta (transitObject.ticketRestrictions.routeRestrictions).
customRouteRestrictionsDetailsLabel

object (LocalizedString)

Una etiqueta personalizada para usar en el valor de los detalles de las restricciones de ruta (transitObject.ticketRestrictions.routeRestrictionsDetails).
customTimeRestrictionsLabel

object (LocalizedString)

Una etiqueta personalizada que se usa para el valor de los detalles de las restricciones de tiempo (transitObject.ticketRestrictions.timeRestrictions).
customOtherRestrictionsLabel

object (LocalizedString)

Una etiqueta personalizada para usar en el otro valor de restricciones (transitObject.ticketRestrictions.otherRestrictions).
customPurchaseReceiptNumberLabel

object (LocalizedString)

Una etiqueta personalizada que se usa para el valor del número del recibo de compra (transitObject.purchaseDetails.purchaseReceiptNumber).
customConfirmationCodeLabel

object (LocalizedString)

Una etiqueta personalizada que se usa 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)

Una etiqueta personalizada para usar para el valor del precio de compra (transitObject.purchaseDetails.ticketCost.purchasePrice).
customDiscountMessageLabel

object (LocalizedString)

Una etiqueta personalizada que se usa en el valor del mensaje de descuento para transporte público (transitObject.purchaseDetails.ticketCost.discountMessage).
customCarriageLabel

object (LocalizedString)

Una etiqueta personalizada que se usa para el valor de carro (transitObject.ticketLeg.carriage).
customSeatLabel

object (LocalizedString)

Una etiqueta personalizada para usar en el valor de ubicación de asientos (transitObject.ticketLeg.ticketSeat.seat).
customCoachLabel

object (LocalizedString)

Una etiqueta personalizada para usar para el valor de coaching (transitObject.ticketLeg.ticketSeat.coach).
customPlatformLabel

object (LocalizedString)

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

object (LocalizedString)

Una etiqueta personalizada que se usa para el valor de la zona de embarque (transitObject.ticketLeg.zone).
customFareClassLabel

object (LocalizedString)

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

object (LocalizedString)

Es una etiqueta personalizada que se usa 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 usa 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 la estableces, Google recurrirá a un conjunto de campos predeterminado para mostrar.
enableSingleLegItinerary

boolean

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

string

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
(deprecated)

string (int64 format)

Obsoleto
issuerName

string

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[]

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.
allowMultipleUsersPerObject
(deprecated)

boolean

Ya no está disponible. Usa multipleDevicesAndHoldersAllowedStatus en su lugar.
homepageUri

object (Uri)

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[]

object (LatLongPoint)

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

enum (ReviewStatus)

Obligatorio. Estado de la clase. Este campo se puede configurar como draft o underReview mediante las llamadas a la API de inserción, parche o actualización. Una vez que el estado de revisión cambie de draft, no se podrá 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 actualizas una clase que ya es approved, debes seguir estableciendo este campo en underReview.
review

object (Review)

Los comentarios de revisión que establece la plataforma cuando una clase está marcada como approved o rejected.
infoModuleData
(deprecated)

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.
redemptionIssuers[]

string (int64 format)

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

object (Image)

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
(deprecated)

object (Image)

Ya no está disponible.
enableSmartTap

boolean

Identifica si esta clase es compatible con el Toque 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

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.
localizedIssuerName

object (LocalizedString)

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

enum (MultipleDevicesAndHoldersAllowedStatus)

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

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

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)

Opciones de activación para un ticket activable
viewUnlockRequirement

enum (ViewUnlockRequirement)

Consulta las opciones de Requisito de desbloqueo para el boleto de transporte público.

TransitType

Enumeradores
TRANSIT_TYPE_UNSPECIFIED
BUS
bus

Alias heredado de BUS. Ya no está disponible.
RAIL
rail

Alias heredado de RAIL. Ya no está disponible.
TRAM
tram

Alias heredado de TRAM. Ya no está disponible.
FERRY
ferry

Alias heredado de FERRY. Ya no está disponible.
OTHER
other

Alias heredado de OTHER. Ya no está disponible.

ActivationOptions

ActivationOptions para la clase

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

string

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

boolean

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

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 especificados.

list

 Devuelve una lista de todas las clases de transporte público de un ID de entidad emisora 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.