REST Resource: genericobject

Recurso: GenericObject

Objeto genérico

Representación JSON 
{
  "genericType": enum (GenericType),
  "cardTitle": {
    object (LocalizedString)
  },
  "subheader": {
    object (LocalizedString)
  },
  "header": {
    object (LocalizedString)
  },
  "logo": {
    object (Image)
  },
  "hexBackgroundColor": string,
  "notifications": {
    object (Notifications)
  },
  "id": string,
  "classId": string,
  "barcode": {
    object (Barcode)
  },
  "heroImage": {
    object (Image)
  },
  "validTimeInterval": {
    object (TimeInterval)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "smartTapRedemptionValue": string,
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "state": enum (State),
  "hasUsers": boolean,
  "messages": [
    {
      object (Message)
    }
  ],
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ],
  "linkedObjectIds": [
    string
  ]
}
Campos
genericType

enum (GenericType)

Especifica a qué GenericType pertenece la tarjeta.
cardTitle

object (LocalizedString)

Obligatorio. Es el encabezado del pase. Por lo general, es el nombre de la empresa, como "XXX Gym" o "AAA Insurance". Este campo es obligatorio y aparece en la fila del encabezado en la parte superior del pase.
subheader

object (LocalizedString)

La etiqueta de título del pase, como la ubicación en la que se puede usar. Aparece justo encima del título en la fila del título de la vista de detalles del pase.
header

object (LocalizedString)

Obligatorio. Es el título del pase, como “Cupón de un 50% de descuento”, “Tarjeta de biblioteca” o “Cupón”. Este campo es obligatorio y aparece en la fila del título de la vista de detalles del pase.
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 una imagen hero, se usa el color dominante del logotipo. Si no se establece el logotipo, Google elegirá un color.
notifications

object (Notifications)

Es la configuración de notificaciones que está habilitada para este objeto.
id

string

Obligatorio. Es el identificador único de un objeto. Este ID debe ser único para todos los objetos de un emisor. Este valor debe seguir el formato issuerID.identifier, en el que Google emite issuerID y tú eliges identifier. El identificador único solo puede incluir caracteres alfanuméricos, ., _ o -.
classId

string

Obligatorio. La clase asociada con este objeto. La clase debe ser del mismo tipo que este objeto, ya debe existir y debe estar aprobada.

Los IDs de clase deben seguir el formato issuerID.identifier, en el que Google emite issuerID y tú eliges identifier.
barcode

object (Barcode)

El tipo y el valor del código de barras. Si el pase no tiene un código de barras, podemos permitir que la entidad emisora establezca Barcode.alternate_text y muestre solo eso.
heroImage

object (Image)

Es la imagen del banner que se muestra en el frente de la tarjeta, si corresponde. La imagen se mostrará con un ancho del 100%.
validTimeInterval

object (TimeInterval)

Es el período durante el cual este objeto se considerará válido o utilizable. Cuando transcurra el período, el objeto se considerará vencido, lo que afectará la renderización en los dispositivos del usuario.
imageModulesData[]

object (ImageModuleData)

Datos del módulo de imagen. Cuando se establezcan ambas opciones, solo se renderizarán una de las imágenes de la clase y una a nivel del objeto.
textModulesData[]

object (TextModuleData)

Datos del módulo de texto Si textModulesData también se define en la clase, se mostrarán ambos. La cantidad máxima de estos campos que se muestran es 10 para la clase y 10 para el objeto.
groupingInfo

object (GroupingInfo)

Es la información que controla cómo se agrupan los pases.
smartTapRedemptionValue

string

Es el valor que se transmitirá a una terminal certificada de Smart Tap a través de NFC para este objeto. Los campos a nivel de la clase enableSmartTap y redemptionIssuers también deben configurarse correctamente para que el pase admita el Toque inteligente. Solo se admiten caracteres ASCII.
rotatingBarcode

object (RotatingBarcode)

La configuración o los detalles del código de barras rotativo.
state

enum (State)

Es el estado del objeto. Este campo se usa para determinar cómo se muestra un objeto en la app. Por ejemplo, un objeto inactive se mueve a la sección "Pasos vencidos". Si no se proporciona, el objeto se considerará ACTIVE.
hasUsers

boolean

Indica si el objeto tiene usuarios. La plataforma establece este campo.
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 10.
passConstraints

object (PassConstraints)

Pasa las restricciones del objeto. Incluye la limitación de los comportamientos de NFC y capturas de pantalla.
saveRestrictions

object (SaveRestrictions)

Son restricciones sobre el objeto que se deben verificar antes de que el usuario intente guardar el pase. Ten en cuenta que estas restricciones solo se aplicarán durante el tiempo de ahorro. Si las restricciones cambiaron después de que un usuario guardó el pase, las nuevas restricciones no se aplicarán a un pase que ya se haya guardado.
valueAddedModuleData[]

object (ValueAddedModuleData)

Datos opcionales del módulo de valor agregado. Máximo de diez en el objeto.
linkedObjectIds[]

string

linkedObjectIds es una lista de otros objetos, como entradas para eventos, lealtad, ofertas, genéricos, tarjetas de regalo, transporte público y tarjetas de embarque, que se deben adjuntar automáticamente a este objeto genérico. Si un usuario hubiera guardado esta tarjeta genérica, estos linkedObjectIds se enviarían automáticamente a la billetera del usuario (a menos que haya desactivado la configuración para recibir esos pases vinculados).

Asegúrate de que los objetos presentes en linkedObjectIds ya estén insertados. De lo contrario, las llamadas fallarán. Una vez vinculados, los objetos vinculados no se pueden desvincular. No puedes vincular objetos que pertenezcan a otro emisor. Existe un límite para la cantidad de objetos que se pueden vincular a un solo objeto. Una vez que se alcance el límite, se ignorarán en silencio los objetos vinculados nuevos en la llamada.

Los IDs de objetos deben seguir el formato issuer ID.identifier, donde Google emite el primero y tú eliges el segundo.

GenericType

Es el tipo de tarjeta genérica.

Enumeraciones
GENERIC_TYPE_UNSPECIFIED Tipo genérico sin especificar.
GENERIC_SEASON_PASS Pase de temporada
GENERIC_UTILITY_BILLS Facturas de servicios
GENERIC_PARKING_PASS Pase de estacionamiento
GENERIC_VOUCHER Cupón
GENERIC_GYM_MEMBERSHIP Tarjetas de membresía de gimnasio
GENERIC_LIBRARY_MEMBERSHIP Tarjetas de membresía de biblioteca
GENERIC_RESERVATIONS Reservas
GENERIC_AUTO_INSURANCE Tarjetas de seguro de automóviles
GENERIC_HOME_INSURANCE Tarjetas de seguros de vivienda
GENERIC_ENTRY_TICKET Entradas
GENERIC_RECEIPT Recibos
GENERIC_LOYALTY_CARD Tarjetas de lealtad. Ten en cuenta que se recomienda usar un tipo de pase de tarjeta de lealtad exclusivo en lugar de este tipo genérico. Un tipo de pase de tarjeta de lealtad dedicado ofrece más funciones y atributos que un tipo de pase genérico.
GENERIC_OTHER Otro tipo

Notificaciones

Indica si el objeto debe tener habilitada la notificación. Solo admitimos uno de ExpiryNotification/UpcomingNotification. expiryNotification tiene prioridad sobre upcomingNotification. En otras palabras, si se configura expiryNotification, se ignora el campo upcomingNotification.

Representación JSON 
{
  "expiryNotification": {
    object (ExpiryNotification)
  },
  "upcomingNotification": {
    object (UpcomingNotification)
  }
}
Campos
expiryNotification

object (ExpiryNotification)

Se activaría una notificación en un momento específico antes de que venza la tarjeta.
upcomingNotification

object (UpcomingNotification)

Se activaría una notificación en un momento específico antes de que se pueda usar la tarjeta.

ExpiryNotification

Indica que el emisor desea que la Billetera de Google envíe notificaciones de vencimiento 2 días antes de que venza la tarjeta.

Representación JSON 
{
  "enableNotification": boolean
}
Campos
enableNotification

boolean

Indica si el objeto debe tener habilitada la notificación de vencimiento.

UpcomingNotification

Indica que el emisor desea que la Billetera de Google envíe una notificación de próxima validez de la tarjeta 1 día antes de que esta se vuelva válida o utilizable.

Representación JSON 
{
  "enableNotification": boolean
}
Campos
enableNotification

boolean

Indica si el objeto debe tener habilitada la notificación próxima.

Métodos

addmessage

 Agrega un mensaje al objeto genérico al que hace referencia el ID de objeto determinado.

get

 Devuelve el objeto genérico con el ID de objeto determinado.

insert

 Inserta un objeto genérico con el ID y las propiedades determinados.

list

 Muestra una lista de todos los objetos genéricos para un ID de emisor determinado.

patch

 Actualiza el objeto genérico al que hace referencia el ID de objeto determinado.

update

 Actualiza el objeto genérico al que hace referencia el ID de objeto determinado.