REST Resource: giftcardclass

{
  "kind": string,
  "merchantName": string,
  "programLogo": {
    object (Image)
  },
  "pinLabel": string,
  "eventNumberLabel": string,
  "allowBarcodeRedemption": boolean,
  "localizedMerchantName": {
    object (LocalizedString)
  },
  "localizedPinLabel": {
    object (LocalizedString)
  },
  "localizedEventNumberLabel": {
    object (LocalizedString)
  },
  "cardNumberLabel": string,
  "localizedCardNumberLabel": {
    object (LocalizedString)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "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)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideProgramLogo": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}

string

Identifica qué tipo de recurso es. Valor: la cadena fija "walletobjects#giftCardClass".

string

Es el nombre del comercio, como "Adam's Apparel". Es posible que la app muestre puntos suspensivos después de los primeros 20 caracteres para garantizar que se muestre la cadena completa en pantallas más pequeñas.

object (Image)

Es el logotipo de la empresa o el programa de tarjetas de regalo. Este logotipo se muestra en las vistas de detalles y de lista de la app.

string

Es la etiqueta que se mostrará para el PIN, como "PIN de 4 dígitos".

string

Es la etiqueta que se mostrará para el número de evento, como "Nº de evento objetivo".

boolean

Determina si el comercio admite el canje de tarjetas de regalo con un código de barras. Si es verdadero, la app muestra un código de barras para la tarjeta de regalo en la pantalla Detalles de la tarjeta de regalo. Si es falsa, no se mostrará un código de barras.

object (LocalizedString)

Cadenas traducidas para merchantName. Es posible que la app muestre puntos suspensivos después de los primeros 20 caracteres para garantizar que se muestre la cadena completa en pantallas más pequeñas.

object (LocalizedString)

Cadenas traducidas para pinLabel.

object (LocalizedString)

Se tradujeron las cadenas para la eventNumberLabel.

string

Es la etiqueta que se mostrará para el número de tarjeta, como "Número de tarjeta".

object (LocalizedString)

Cadenas traducidas para cardNumberLabel.

object (ClassTemplateInfo)

Información de plantilla sobre cómo se debe mostrar la clase. Si no la estableces, Google recurrirá a un conjunto predeterminado de campos para mostrar.

string

Obligatorio. Es el identificador único de una clase. Este ID debe ser único para todas las clases de un emisor. Este valor debe seguir el formato issuer ID.identifier, donde Google emite el primero y tú eliges el segundo. Tu identificador único solo debe incluir caracteres alfanuméricos, '.', '_' o '-'.

string (int64 format)

Obsoleto

string

Obligatorio. Nombre de la entidad emisora. La longitud máxima recomendada es de 20 caracteres para garantizar que se muestre la cadena completa en pantallas más pequeñas.

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.

boolean

Obsoleta. Usa multipleDevicesAndHoldersAllowedStatus en su lugar.

object (Uri)

Es el URI de la página principal de tu aplicación. Si propagas el URI en este campo, se produce exactamente el mismo comportamiento que si propagas un URI en linksModuleData (cuando se renderiza un objeto, se muestra un vínculo a la página principal en lo que se suele considerar la sección linksModuleData del objeto).

object (LatLongPoint)

Nota: Por el momento, este campo no es compatible para activar notificaciones geográficas.

enum (ReviewStatus)

Obligatorio. Es el estado de la clase. Este campo se puede establecer en draft o underReview con las llamadas a la API de inserción, parche o actualización. Una vez que se cambia el estado de la revisión de draft, es posible que no se pueda 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 actualices una clase que ya es approved, debes seguir estableciendo este campo en underReview.

object (Review)

Los comentarios de revisión que establece la plataforma cuando una clase se marca como approved o rejected

object (InfoModuleData)

Obsoleta. En su lugar, usa textModulesData.

object (ImageModuleData)

Datos del módulo de imagen. La cantidad máxima de estos campos que se muestra es 1 a nivel del objeto y 1 a nivel del objeto de clase.

object (TextModuleData)

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

object (LinksModuleData)

Vincula los datos del módulo. Si los datos del módulo de vínculos también se definen en el objeto, se mostrarán ambos.

string (int64 format)

Identifica qué entidades emisoras de canje pueden canjear el pase con Smart Tap. Las entidades emisoras de canjes se identifican por su ID de emisor. Los emisores de canje deben tener configurada al menos una clave de Smart Tap.

Los campos enableSmartTap y smartTapRedemptionLevel de nivel de objeto también deben configurarse correctamente para que un pase admita el Toque inteligente.

string

Es el código de país que se usa para mostrar el país de la tarjeta (cuando el usuario no está en ese país) y para mostrar contenido localizado cuando no está disponible en la configuración regional del usuario.

object (Image)

Es la imagen de banner opcional que se muestra en la parte frontal de la tarjeta. Si no hay ninguno, no se mostrará nada. La imagen se mostrará al 100% de ancho.

object (Image)

Obsoleta.

boolean

Identifica si esta clase es compatible con el Toque inteligente. Los campos redemptionIssuers y smartTapRedemptionLevel de nivel de objeto también deben configurarse correctamente para que un pase admita el Toque inteligente.

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 ninguna imagen hero, se usa 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 #rgb, como #fc0.

object (LocalizedString)

Cadenas traducidas para issuerName. La longitud máxima recomendada es de 20 caracteres para garantizar que la cadena completa se muestre en las pantallas más pequeñas.

enum (MultipleDevicesAndHoldersAllowedStatus)

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

object (CallbackOptions)

Opciones de devolución de llamada que se usarán 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.

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.

enum (ViewUnlockRequirement)

Consulta las opciones de requisitos de desbloqueo de la tarjeta de regalo.

object (Image)

El logotipo ancho de la empresa o el programa de tarjetas de regalo. Si se proporciona, se usará en lugar del logotipo del programa en la parte superior izquierda de la vista de la tarjeta.

enum (NotificationSettingsForUpdates)

Si las actualizaciones de campo de esta clase deben activar notificaciones o no. Cuando se establece en NOTIFY, intentaremos activar una notificación de actualización de campo para los usuarios. Estas notificaciones solo se enviarán a los usuarios si el campo forma parte de una lista de entidades permitidas. Si no se especifica, no se activará ninguna notificación. Este parámetro de configuración es efímero y se debe establecer con cada solicitud PATCH o UPDATE. De lo contrario, no se activará una notificación.

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 el objeto correspondiente, se usará en su lugar.

object (ValueAddedModuleData)

Datos opcionales del módulo de valor agregado. Se permite un máximo de diez personas en la clase. Para un pase, solo se mostrarán diez, priorizando las del objeto.