REST Resource: loyaltyclass

Recurso: LoyaltyClass

Representación JSON 
{
  "kind": string,
  "programName": string,
  "programLogo": {
    object (Image)
  },
  "accountNameLabel": string,
  "accountIdLabel": string,
  "rewardsTierLabel": string,
  "rewardsTier": string,
  "localizedProgramName": {
    object (LocalizedString)
  },
  "localizedAccountNameLabel": {
    object (LocalizedString)
  },
  "localizedAccountIdLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTierLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTier": {
    object (LocalizedString)
  },
  "secondaryRewardsTierLabel": string,
  "localizedSecondaryRewardsTierLabel": {
    object (LocalizedString)
  },
  "secondaryRewardsTier": string,
  "localizedSecondaryRewardsTier": {
    object (LocalizedString)
  },
  "discoverableProgram": {
    object (DiscoverableProgram)
  },
  "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#loyaltyClass".
programName

string

Obligatorio. Es el nombre del programa, 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.
accountNameLabel

string

La etiqueta del nombre de la cuenta, como “Nombre del miembro” La longitud máxima recomendada es de 15 caracteres para garantizar que se muestre la cadena completa en pantallas más pequeñas.
accountIdLabel

string

La etiqueta del ID de la cuenta, como "ID de miembro" La longitud máxima recomendada es de 15 caracteres para garantizar que se muestre la cadena completa en pantallas más pequeñas.
rewardsTierLabel

string

La etiqueta del nivel de recompensas, como "Nivel de recompensas" La longitud máxima recomendada es de 9 caracteres para garantizar que se muestre la cadena completa en pantallas más pequeñas.
rewardsTier

string

El nivel de recompensas, como "Oro" o "Platino" La longitud máxima recomendada es de 7 caracteres para garantizar que la cadena completa se muestre en las pantallas más pequeñas.
localizedProgramName

object (LocalizedString)

Cadenas traducidas para programName. 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.
localizedAccountNameLabel

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

Se tradujeron las cadenas para recompensasTierLabel. La longitud máxima recomendada es de 9 caracteres para garantizar que se muestre la cadena completa en pantallas más pequeñas.
localizedRewardsTier

object (LocalizedString)

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

string

La etiqueta del nivel de recompensas secundario, como “Nivel de recompensas”.
localizedSecondaryRewardsTierLabel

object (LocalizedString)

Cadenas traducidas para secondaryRewardsTierLabel.
secondaryRewardsTier

string

El nivel de recompensas secundario, como “Oro” o “Platino”.
localizedSecondaryRewardsTier

object (LocalizedString)

Cadenas traducidas para secondaryRewardsTier.
discoverableProgram

object (DiscoverableProgram)

Información sobre cómo se puede descubrir la clase y crear una instancia desde la app de Google Pay
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 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 '-'.
version
(deprecated)

string (int64 format)

Obsoleto
issuerName

string

Obligatorio. Es el 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)

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

boolean

Obsoleta. Usa multipleDevicesAndHoldersAllowedStatus en su lugar.
homepageUri

object (Uri)

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).
locations[]
(deprecated)

object (LatLongPoint)

Nota: Por el momento, este campo no se admite 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 puede usar de inmediato para crear o migrar objetos.

Cuando actualices 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 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 muestra es 1 a nivel del objeto y 1 a nivel del 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 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. Los emisores de canje deben tener configurada al menos una clave de Smart Tap.

El campo enableSmartTap y uno de los campos smartTapRedemptionValue a nivel del objeto, barcode.value, oraccountId` 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 contenido localizado cuando el contenido no está disponible en la configuración regional del usuario.
heroImage

object (Image)

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

object (Image)

Obsoleta.
enableSmartTap

boolean

Identifica si esta clase admite el Presionar con el dedo inteligente. El campo redemptionIssuers y uno de los campos smartTapRedemptionLevel a nivel del objeto, barcode.value, or accountId` 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 emisorName 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 configura, se renderizará una animación de seguridad en los detalles del pase.
viewUnlockRequirement

enum (ViewUnlockRequirement)

Consulta las opciones de requisitos de desbloqueo para la tarjeta de lealtad.
notifyPreference

enum (NotificationSettingsForUpdates)

Si las actualizaciones de campo de esta clase deben activar notificaciones o no. Cuando se configura como 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, dando prioridad a los del objeto.

DiscoverableProgram

Información sobre cómo se puede descubrir una clase y crear una instancia desde la app de Android Pay. Para ello, se busca un programa de lealtad o una tarjeta de regalo, y se escanea o ingresa manualmente.

Representación JSON 
{
  "merchantSignupInfo": {
    object (DiscoverableProgramMerchantSignupInfo)
  },
  "merchantSigninInfo": {
    object (DiscoverableProgramMerchantSigninInfo)
  },
  "state": enum (State)
}
Campos
merchantSignupInfo

object (DiscoverableProgramMerchantSignupInfo)

Información sobre la capacidad de registrarse y agregar un elemento valioso a este programa a través del sitio de un comercio. Se utiliza cuando está habilitado MERCHANT_HOSTED_SIGNUP.
merchantSigninInfo

object (DiscoverableProgramMerchantSigninInfo)

Información sobre la capacidad de acceder y agregar un elemento valioso para este programa a través del sitio de un comercio Se utiliza cuando está habilitado MERCHANT_HOSTED_SIGNIN.
state

enum (State)

Es el estado de visibilidad del programa detectable.

DiscoverableProgramMerchantSignupInfo

Es la información sobre el flujo de registro alojado por el comercio para un programa.

Representación JSON 
{
  "signupWebsite": {
    object (Uri)
  },
  "signupSharedDatas": [
    enum (SharedDataType)
  ]
}
Campos
signupWebsite

object (Uri)

Es la URL a la que se debe dirigir al usuario para que acceda al sitio de registro del comercio.
signupSharedDatas[]

enum (SharedDataType)

Datos del usuario que se envían en una solicitud POST a la URL del sitio web de registro Esta información se codifica y, luego, se comparte para que el sitio web del comercio pueda completar previamente los campos que se usan para inscribir al usuario en el programa detectable.

SharedDataType

Enumeraciones
SHARED_DATA_TYPE_UNSPECIFIED
FIRST_NAME
LAST_NAME
STREET_ADDRESS campo de dirección de una sola línea
ADDRESS_LINE_1 campos de dirección de varias líneas
ADDRESS_LINE_2
ADDRESS_LINE_3
CITY
STATE
ZIPCODE
COUNTRY
EMAIL
PHONE

DiscoverableProgramMerchantSigninInfo

Es la información sobre el flujo de acceso al programa alojado por el comercio.

Representación JSON 
{
  "signinWebsite": {
    object (Uri)
  }
}
Campos
signinWebsite

object (Uri)

Es la URL a la que se dirige al usuario para que acceda al sitio de acceso del comercio.

Estado

Enumeraciones
STATE_UNSPECIFIED
TRUSTED_TESTERS Solo los verificadores que tengan acceso a la cuenta del emisor pueden verlos.
trustedTesters

Es el alias heredado de TRUSTED_TESTERS. Obsoleta.
LIVE Visible para todos.
live

Es el alias heredado de LIVE. Obsoleta.
DISABLED No es visible.
disabled

Es el alias heredado de DISABLED. Obsoleta.

Métodos

addmessage

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

get

 Muestra la clase de lealtad con el ID de clase determinado.

insert

 Inserta una clase de lealtad con el ID y las propiedades determinados.

list

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

patch

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

update

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