REST Resource: genericobject

Recurso: GenericObject

ID de objeto genérico siguiente: 121

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

enum (GenericType)

Especifica a qué GenericType pertenece la tarjeta.
cardTitle

object (LocalizedString)

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

object (LocalizedString)

Es 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 de título en la vista de detalles del pase.
header

object (LocalizedString)

Obligatorio. Es el título del pase, como “cupón de 50% de descuento”, “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 la estableces, se utilizará el color dominante de la imagen principal y, si no se establece, se usará el color dominante del logotipo. De lo contrario, Google elegirá un color.
notifications

object (Notifications)

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

string

Obligatorio. El identificador único de un objeto. Este ID debe ser único en 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, ., _ 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 de código de barras y el valor. Si el pase no tiene un código de barras, podemos permitir que la entidad emisora configure Barcode.alternate_text y muestre solo eso.
heroImage

object (Image)

Imagen de banner que se muestra en el frente de la tarjeta, si está presente. La imagen se mostrará con el ancho del 100%.
validTimeInterval

object (TimeInterval)

El período durante el cual se considerará que este objeto es válido o utilizable Cuando pase 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. Solo una de las imágenes de la clase y una del nivel de objeto se renderizarán cuando se configuren ambas.
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 una terminal certificada por Smart Tap a través de NFC para este objeto. Los campos enableSmartTap y redemptionIssuers a nivel de la clase 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 rotativos.
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 "Pases vencidos". 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 restricciones para el objeto. Incluye limitar los comportamientos de NFC y capturas de pantalla.

GenericType

Es el tipo de tarjeta genérica.

Enumeradores
GENERIC_TYPE_UNSPECIFIED Tipo genérico no especificado.
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 necesita tener habilitadas las notificaciones. Se admite solo una de las siguientes opciones: ExpiryNotification o parece 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)

Las notificaciones se activan en un momento específico antes de que la tarjeta se pueda usar.

ExpiryNotification

Indica que la entidad emisora quiere que la Billetera de Google envíe notificaciones de vencimiento 2 días antes de la fecha de vencimiento de la tarjeta.

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

boolean

Indica si el objeto debe tener habilitadas las notificaciones de vencimiento.

UpcomingNotification

Indica que la entidad emisora desea que la Billetera de Google envíe una notificación sobre la validez de la tarjeta 1 día antes de que esta se pueda usar o sea válida.

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 del objeto determinado.

get

 Muestra el objeto genérico con el ID de objeto dado.

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.