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,
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  }
}
Campos
genericType

enum (GenericType)

Especifica a qué GenericType pertenece la tarjeta.
cardTitle

object (LocalizedString)

Obligatorio. 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 correspondiente en la vista de detalles del pase.
header

object (LocalizedString)

Obligatorio. El título del pase, como “Cupón de un 50% de descuento” o "Tarjeta de biblioteca" o "Cupón". Este campo es obligatorio y aparece en la fila de título de la vista de detalles del pase.
hexBackgroundColor

string

El color de fondo de la tarjeta Si no se establece, se usa el color dominante de la imagen principal. Si no se establece una imagen principal, se usa el color dominante del logotipo. Si no se establece, Google elegirá un color.
notifications

object (Notifications)

La configuración de notificaciones habilitada para este objeto.
id

string

Obligatorio. Es el identificador único de un objeto. Este ID debe ser único entre todos los objetos de una entidad emisora. 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, como ., _ 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 aprobarse.

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 valor del código de barras. Si el pase no tiene un código de barras, podemos permitir que la entidad emisora configure Barcode.alternative_text y muestre solo eso.
heroImage

object (Image)

Imagen del banner que se muestra en la parte frontal de la tarjeta (si está presente) La imagen se mostrará al 100% del ancho.
validTimeInterval

object (TimeInterval)

El período durante el cual este objeto se considerará válido o utilizable. Una vez transcurrido ese 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 también se define textModulesData 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)

Información que controla cómo se agrupan los pases.
smartTapRedemptionValue

string

El valor que se transmitirá a un terminal certificado para Smart Tap mediante NFC para este objeto. Los campos de nivel de clase enableSmartTap y redemptionIssuers también deben configurarse correctamente para que el pase sea compatible con el Toque inteligente. Solo se admiten caracteres ASCII.
rotatingBarcode

object (RotatingBarcode)

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

enum (State)

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 "Pases vencidos". sección. Si no se proporciona, el objeto se consideraría ACTIVE.
hasUsers

boolean

Indica si el objeto tiene usuarios. La plataforma establece este campo.
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 las restricciones en el objeto que se debe verificar antes de que el usuario intente guardar el pase. Ten en cuenta que estas restricciones solo se aplicarán durante el tiempo de guardado. Si las restricciones cambian después de que un usuario guarda un pase, las restricciones nuevas no se aplicarán a un pase ya guardado.

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 seguro de vivienda
GENERIC_ENTRY_TICKET Entradas
GENERIC_RECEIPT Recibos
GENERIC_OTHER Otro tipo

Notificaciones

Indica si el objeto debe tener habilitadas las notificaciones. Solo admitimos una de las siguientes propiedades: ExpiryNotification/futurosNotification. 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á una notificación en un momento específico antes de que venza la tarjeta.
upcomingNotification

object (UpcomingNotification)

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

ExpiryNotification

Indica que la entidad emisora desea que Google Wallet envíe notificaciones de vencimiento 2 días antes del vencimiento de 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 la entidad emisora desea que Google Wallet envíe una próxima notificación de validez de la tarjeta 1 día antes de que la tarjeta sea válida o utilizable.

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

boolean

Indica si el objeto debe tener habilitadas las próximas notificaciones.

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

list

 Devuelve una lista de todos los objetos genéricos de un ID de entidad emisora 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.