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)
  }
}
Campos
kind
(deprecated)

string

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

string

Nombre del comercio, como “Ropa de Adán” La app puede mostrar puntos suspensivos después de los primeros 20 caracteres para garantizar que se muestre toda la cadena en pantallas más pequeñas.
pinLabel

string

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úmero de evento de destino".
allowBarcodeRedemption

boolean

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

object (LocalizedString)

Cadenas traducidas de merchantName La app puede mostrar puntos suspensivos después de los primeros 20 caracteres para garantizar que se muestre toda la cadena en pantallas más pequeñas.
localizedPinLabel

object (LocalizedString)

Cadenas traducidas para pinLabel.
localizedEventNumberLabel

object (LocalizedString)

Cadenas traducidas para eventNumberLabel
cardNumberLabel

string

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 la estableces, Google recurrirá a un conjunto de campos predeterminado 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 la primera es emitida por Google y la última es la tuya. Tu identificador único solo debe incluir caracteres alfanuméricos, “.”, “_” o “-”.
version
(deprecated)

string (int64 format)

Obsoleto
issuerName

string

Obligatorio. El nombre de la entidad emisora. La longitud máxima recomendada es de 20 caracteres para garantizar que se muestre toda la cadena en pantallas más pequeñas.
messages[]

object (Message)

Un array 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

Ya no está disponible. Usa multipleDevicesAndHoldersAllowedStatus en su lugar.
homepageUri

object (Uri)

El URI de la página principal de tu aplicación. La propagación del URI en este campo da como resultado el mismo comportamiento que si se propaga un URI en linksModuleData (cuando se renderiza un objeto, se muestra un vínculo a la página principal en lo que generalmente se consideraría la sección linksModuleData del objeto).
locations[]

object (LatLongPoint)

Nota: Actualmente, este campo no es compatible con la activación de notificaciones geográficas.
reviewStatus

enum (ReviewStatus)

Obligatorio. Estado de la clase. Este campo se puede configurar como draft o underReview mediante las llamadas a la API de inserción, parche o actualización. Una vez que el estado de revisión cambie de draft, no se podrá 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 actualizas una clase que ya es approved, debes seguir estableciendo este campo en underReview.
review

object (Review)

Los comentarios de revisión que establece la plataforma cuando una clase está marcada como approved o rejected.
infoModuleData
(deprecated)

object (InfoModuleData)

Ya no está disponible. 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 para el nivel de objeto y 1 para el nivel de objeto de clase.
textModulesData[]

object (TextModuleData)

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

string (int64 format)

Identifica qué entidades emisoras de canje pueden canjear el pase con Smart Tap. Las entidades emisoras de canje se identifican con su ID de entidad emisora. Las entidades emisoras de canje deben tener al menos una clave de Toque inteligente configurada.

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 (si el usuario no se encuentra en ese país) y contenido localizado cuando no está disponible en la configuración regional del usuario.
heroImage

object (Image)

Imagen opcional del banner que se muestra en el frente de la tarjeta. Si no hay ninguno, no se mostrará nada. La imagen se mostrará con un ancho del 100%.
wordMark
(deprecated)

object (Image)

Ya no está disponible.
enableSmartTap

boolean

Identifica si esta clase es compatible con el Toque 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

El color de fondo de la tarjeta. Si no se establece el color dominante de la imagen de héroe, se utiliza 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 el número rgb, como #fc0.
localizedIssuerName

object (LocalizedString)

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

enum (MultipleDevicesAndHoldersAllowedStatus)

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

object (CallbackOptions)

Opciones de devolución de llamada que el usuario final usará 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.
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 Requisito de desbloqueo para la tarjeta de regalo.

Métodos

addmessage

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

get

 Devuelve la clase de la tarjeta de regalo con el ID de clase especificado.

insert

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

list

 Devuelve una lista de todas las clases de tarjetas de regalo para un ID de entidad emisora determinado.

patch

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

update

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