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)
  },
  "appLinkData": {
    object (AppLinkData)
  }
}
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". La app puede mostrar puntos suspensivos después de los primeros 20 caracteres para garantizar que la cadena completa se muestre 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 la cadena completa se muestre en las pantallas más pequeñas.
accountIdLabel

string

La etiqueta de ID de la cuenta, como “ID de miembro” La longitud máxima recomendada es de 15 caracteres para garantizar que la cadena completa se muestre en las 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 la cadena completa se muestre en las 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)

Se tradujeron las cadenas para el programName. La app puede mostrar puntos suspensivos después de los primeros 20 caracteres para garantizar que la cadena completa se muestre en pantallas más pequeñas.
localizedAccountNameLabel

object (LocalizedString)

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

object (LocalizedString)

Se tradujeron las strings traducidas para accountIdLabel. La longitud máxima recomendada es de 15 caracteres para garantizar que la cadena completa se muestre en las 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 la cadena completa se muestre en las pantallas más pequeñas.
localizedRewardsTier

object (LocalizedString)

Se tradujeron las cadenas para el nivel de recompensas. 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)

Se tradujeron las cadenas para lasecondaryRewardsTierLabel.
secondaryRewardsTier

string

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

object (LocalizedString)

Se tradujeron las cadenas para el elementosecondaryRewardsTier.
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 plantilla sobre cómo se debe mostrar la clase. Si no la estableces, Google recurrirá a 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, en el que Google emite el primero y tú eliges el segundo. El 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 la cadena completa se muestre en las 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

Obsoleta. Usa multipleDevicesAndHoldersAllowedStatus en su lugar.
homepageUri

object (Uri)

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

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 mediante las llamadas a la API de insertar, aplicar parches o actualizar. Una vez que se cambie el estado de revisión de draft, no se puede 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 configurar este campo como 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 las opiniones que establece la plataforma cuando se marca una clase 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 también se definen datos del módulo de texto 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. Las entidades emisoras de canje deben tener configurada al menos una clave de Toque inteligente.

Los campos enableSmartTap y uno de los niveles de objeto smartTapRedemptionValue, indican.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á con un ancho del 100%.
wordMark
(deprecated)

object (Image)

Obsoleta.
enableSmartTap

boolean

Identifica si esta clase es compatible con el Toque inteligente. Los campos redemptionIssuers y uno de los niveles de objeto smartTapRedemptionLevel, indican.value, or accountId, 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 principal, 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 encryptionName. La longitud máxima recomendada es de 20 caracteres para garantizar que la cadena completa se muestre en las 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)

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.
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 los requisitos de desbloqueo de la tarjeta de lealtad.

DiscoverableProgram

Información sobre cómo se puede descubrir una clase y crear una instancia desde la app de Android Pay. Para ello, se debe buscar un programa de tarjetas de regalo o de lealtad y escanearlo o ingresarlo de forma manual.

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)

Estado de visibilidad del programa detectable.

DiscoverableProgramMerchantSignupInfo

Información sobre el flujo de registro alojado por el comerciante 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 acceder 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 precompletar 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

Información sobre el flujo de acceso alojado por el comerciante para un programa.

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

object (Uri)

La URL a la que se debe dirigir al usuario para acceder al sitio de acceso del comercio.

Estado

Enumeraciones
STATE_UNSPECIFIED
TRUSTED_TESTERS Visible solo para los verificadores con acceso a la cuenta de la entidad emisora
trustedTesters

Alias heredado de TRUSTED_TESTERS. Obsoleta.
LIVE Visible para todos
live

Alias heredado de LIVE. Obsoleta.
DISABLED No visible
disabled

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

get

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

insert

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

list

 Devuelve una lista de todas las clases de lealtad de un ID de entidad emisora determinado.

patch

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

update

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