REST Resource: genericobject

{
  "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
  ]
}

enum (GenericType)

Especifica a qué GenericType pertenece la tarjeta.

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.

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.

object (LocalizedString)

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

object (Image)

Es la imagen del logotipo del pase. Esta imagen se muestra en la vista de detalles de la tarjeta, en la esquina superior izquierda, y también en la vista de lista o miniatura. Si no hay un logotipo, la primera letra de cardTitle se mostrará como logotipo.

string

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.

object (Notifications)

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

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

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.

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.

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

object (TimeInterval)

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

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.

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 de 10 de la clase y 10 del objeto.

object (LinksModuleData)

Vincula los datos del módulo. Si linksModuleData también se define en la clase, se mostrarán ambos. La cantidad máxima de estos campos que se muestran es de 10 de la clase y 10 del objeto.

object (AppLinkData)

Es un vínculo opcional a una app o un sitio web que se mostrará como un botón en la parte frontal del pase. Si se proporciona AppLinkData para la clase correspondiente, solo se mostrará el objeto AppLinkData.

object (GroupingInfo)

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

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.

object (RotatingBarcode)

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

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.

boolean

Indica si el objeto tiene usuarios. La plataforma establece este campo.

object (Message)

Una matriz 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.

object (PassConstraints)

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

object (Image)

Es el logotipo ancho del pase. Si se proporciona, se usará en lugar del logotipo en la parte superior izquierda de la vista de la tarjeta.

object (SaveRestrictions)

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

object (ValueAddedModuleData)

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

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.

{
  "expiryNotification": {
    object (ExpiryNotification)
  },
  "upcomingNotification": {
    object (UpcomingNotification)
  }
}

object (ExpiryNotification)

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

object (UpcomingNotification)

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

{
  "enableNotification": boolean
}

boolean

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

{
  "enableNotification": boolean
}

boolean

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