REST Resource: loyaltyclass

Recurso: TrustClass

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

string

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

string

Obligatorio. El nombre del programa, como "Indumentaria de Adán". La app puede mostrar 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 la cadena completa se muestre 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 la cadena completa se muestre 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 pantallas más pequeñas.
localizedProgramName

object (LocalizedString)

Cadenas traducidas de programName La app puede mostrar 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 la cadena completa se muestre 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 la cadena completa se muestre en pantallas más pequeñas.
localizedRewardsTierLabel

object (LocalizedString)

Se tradujeron las cadenas de RewardsTierLabel. 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)

Se tradujeron las cadenas para el nivel de recompensa. La longitud máxima recomendada es de 7 caracteres para garantizar que la cadena completa se muestre en 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 la secondaryRewardsTierLabel.
secondaryRewardsTier

string

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

object (LocalizedString)

Se tradujeron las cadenas para el nivel secondaryRewardsTier.
discoverableProgram

object (DiscoverableProgram)

Información sobre cómo se pueden descubrir y crear instancias de la clase desde la app de Google Pay.
classTemplateInfo

object (ClassTemplateInfo)

Información de plantilla sobre cómo debe mostrarse 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 el primero lo emite Google y tú eliges el último. Tu identificador único solo debe incluir caracteres alfanuméricos, “.”, “_” o “-”.
version
(deprecated)

string (int64 format)

Funciones obsoletas
issuerName

string

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

object (Message)

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

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 la propagación de un URI en linksModuleData (cuando se renderiza un objeto, se muestra un vínculo a la página principal en lo que normalmente se denominaría la sección linksModuleData del objeto).
locations[]

object (LatLongPoint)

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

enum (ReviewStatus)

Obligatorio. Es el estado de la clase. Este campo se puede configurar como draft o underReview mediante las llamadas a la API para insertar, aplicar parches o actualizar. 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 actualices una clase approved que ya existe, debes seguir configurando 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)

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 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 los 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 del objeto y 10 de la clase.
redemptionIssuers[]

string (int64 format)

Identifica las entidades emisoras de los canjes que pueden canjear el pase con el Toque inteligente. Las entidades emisoras de los canjes se identifican con sus ID. Las entidades emisoras de los canjes deben tener al menos una clave de Toque inteligente configurada.

Los campos enableSmartTap y uno de los campos smartTapRedemptionValue, code.value, oraccountId` de nivel de 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 se encuentra en ese país) y contenido localizado cuando el contenido no está disponible en la configuración regional del usuario.
heroImage

object (Image)

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

object (Image)

Ya no está disponible.
enableSmartTap

boolean

Identifica si esta clase admite el Toque inteligente. Los campos redemptionIssuers y uno de los campos smartTapRedemptionLevel, code.value, or accountId` de nivel de 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 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 hexadecimal RGB, como #ffcc00. También puedes usar la versión abreviada del triplete RGB, que es #rgb, como #fc0.
localizedIssuerName

object (LocalizedString)

Cadenas traducidas del nombre emisor del nombre. La longitud máxima recomendada es de 20 caracteres para garantizar que la cadena completa se muestre 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)

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 esta opción, 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.

DiscoverableProgram

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

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

object (DiscoverableProgramMerchantSignupInfo)

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

object (DiscoverableProgramMerchantSigninInfo)

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

enum (State)

Estado de visibilidad del programa detectable.

DiscoverableProgramMerchantSignupInfo

Es la 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 el 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

Enumeradores
SHARED_DATA_TYPE_UNSPECIFIED
FIRST_NAME
LAST_NAME
STREET_ADDRESS campo de dirección de una sola línea
ADDRESS_LINE_1 campos de direcciones 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 alojado por el comerciante para un programa.

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

object (Uri)

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

Estado

Enumeradores
STATE_UNSPECIFIED
TRUSTED_TESTERS Visible solo para los verificadores que tienen acceso a la cuenta de la entidad emisora.
trustedTesters

Alias heredado de TRUSTED_TESTERS. Ya no está disponible.
LIVE Visible para todos
live

Alias heredado de LIVE. Ya no está disponible.
DISABLED No visible
disabled

Alias heredado de DISABLED. Ya no está disponible.

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

insert

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

list

 Muestra 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 determinado.

update

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