REST Resource: giftcardclass

Recurso: GiftCardClass

Representación JSON 
{
  "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)
    }
  ]
}
Campos
kind
(deprecated)

string

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

string

Nombre del comercio, como "Indumentaria de Juan" 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.
pinLabel

string

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

string

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

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

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

object (LocalizedString)

Cadenas traducidas para pinLabel.
localizedEventNumberLabel

object (LocalizedString)

Cadenas traducidas para eventNumberLabel.
cardNumberLabel

string

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

object (LocalizedString)

Cadenas traducidas para cardNumberLabel.
classTemplateInfo

object (ClassTemplateInfo)

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

string

Obligatorio. Es el identificador único de una clase. Este ID debe ser único en todas las clases de una entidad emisora. 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 '-'.
version
(deprecated)

string (int64 format)

Obsoleto
issuerName

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.
messages[]

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.
allowMultipleUsersPerObject
(deprecated)

boolean

Obsoleta. Usa multipleDevicesAndHoldersAllowedStatus en su lugar.
homepageUri

object (Uri)

Es el URI de la página principal de tu aplicación. Cuando se propaga el URI en este campo, se produce exactamente el mismo comportamiento que cuando se propaga un URI en linksModuleData (cuando se renderiza un objeto, se muestra un vínculo a la página principal en lo que normalmente se consideraría la sección linksModuleData del objeto).
locations[]
(deprecated)

object (LatLongPoint)

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

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 configurando este campo como underReview.
review

object (Review)

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

object (InfoModuleData)

Obsoleta. En su lugar, usa textModulesData.
imageModulesData[]

object (ImageModuleData)

Datos del módulo de imagen. La cantidad máxima de estos campos que se muestran es 1 desde el nivel de objeto y 1 para el nivel de objeto de clase.
textModulesData[]

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.
redemptionIssuers[]

string (int64 format)

Identifica qué emisores de canje pueden canjear el pase a través de 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 a nivel del objeto también deben configurarse correctamente para que un pase admita el Toque inteligente.
countryCode

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

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á con un ancho del 100%.
wordMark
(deprecated)

object (Image)

Obsoleta.
enableSmartTap

boolean

Identifica si esta clase admite el Presionar con el dedo inteligente. Los campos redemptionIssuers y smartTapRedemptionLevel a nivel del objeto también deben configurarse correctamente para que un pase admita el Toque inteligente.
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 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.
localizedIssuerName

object (LocalizedString)

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

enum (MultipleDevicesAndHoldersAllowedStatus)

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

object (CallbackOptions)

Son opciones de devolución de llamada que se usarán para llamar al emisor 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.
securityAnimation

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

enum (ViewUnlockRequirement)

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

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.
valueAddedModuleData[]

object (ValueAddedModuleData)

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

Métodos

addmessage

 Agrega un mensaje a la clase de tarjeta de regalo a la que hace referencia el ID de clase determinado.

get

 Muestra la clase de tarjeta de regalo con el ID de clase determinado.

insert

 Inserta una clase de tarjeta de regalo con el ID y las propiedades especificados.

list

 Muestra una lista de todas las clases de tarjetas de regalo para un ID de emisor determinado.

patch

 Actualiza la clase de tarjeta de regalo a la que hace referencia el ID de clase determinado.

update

 Actualiza la clase de tarjeta de regalo a la que hace referencia el ID de clase determinado.