Recurso: LoyaltyObject
Representación JSON |
---|
{ "kind": string, "classReference": { object ( |
Campos | |
---|---|
kind |
Identifica qué tipo de recurso es. Valor: la cadena fija |
classReference |
Una copia de los campos heredados de la clase superior. Estos campos se recuperan durante un GET. |
accountName |
El nombre del titular de la cuenta de lealtad, como “Juan Pérez”. La longitud máxima recomendada es de 20 caracteres para garantizar que la cadena completa se muestre en las pantallas más pequeñas. |
accountId |
Es el identificador de la cuenta de lealtad. La longitud máxima recomendada es de 20 caracteres. |
loyaltyPoints |
La etiqueta, el saldo y el tipo de puntos de recompensa de lealtad. |
linkedOfferIds[] |
Es una lista de objetos de oferta vinculados a esta tarjeta de lealtad. Los objetos de oferta ya deben existir. Los IDs de objeto de oferta deben seguir el formato issuer ID.identifier, en el que Google emite el primero y tú eliges el segundo. |
secondaryLoyaltyPoints |
La etiqueta, el saldo y el tipo de puntos de recompensa secundarios por lealtad. Se muestra además de los puntos de lealtad principales. |
id |
Obligatorio. Es el identificador único de un objeto. Este ID debe ser único entre todos los objetos 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 “-”. |
classId |
Obligatorio. La clase asociada con este objeto. La clase debe ser del mismo tipo que este objeto, ya debe existir y debe aprobarse. Los IDs de clase deben seguir el formato issuer ID.identifier, en el que Google emite el primero y tú eliges el segundo. |
version |
Obsoleto |
state |
Obligatorio. El estado del objeto. Este campo se usa para determinar cómo se muestra un objeto en la app. Por ejemplo, un objeto |
barcode |
El tipo y valor del código de barras. |
messages[] |
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. |
validTimeInterval |
El período en el que será |
locations[] |
Nota: Por el momento, este campo no se admite para activar notificaciones geográficas. |
hasUsers |
Indica si el objeto tiene usuarios. La plataforma establece este campo. |
smartTapRedemptionValue |
El valor que se transmitirá a un terminal certificado para Smart Tap mediante NFC para este objeto. Los campos de nivel de clase Si no se establece este valor, pero los campos de nivel de clase |
hasLinkedDevice |
Indica si este objeto está vinculado actualmente a un solo dispositivo. La plataforma establece este campo cuando un usuario guarda el objeto y lo vincula a su dispositivo. Está diseñada para que la usen socios seleccionados. Comunícate con el equipo de asistencia para obtener más información. |
disableExpirationNotification |
Indica si se deben suprimir explícitamente las notificaciones. Si se establece este campo como verdadero, independientemente del campo Por el momento, esta opción solo se puede configurar para las ofertas. |
infoModuleData |
Obsoleta. En su lugar, usa textModulesData. |
imageModulesData[] |
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[] |
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. |
linksModuleData |
Vincula los datos del módulo. Si los datos del módulo de vínculos también se definen en la clase, se mostrarán ambos. |
appLinkData |
Vínculo opcional a la app o al sitio web que se mostrará como un botón en la parte frontal del pase. Si se proporciona AppLinkData para la clase correspondiente, solo se mostrará el objeto AppLinkData. |
rotatingBarcode |
El tipo y el valor del código de barras rotativo. |
heroImage |
Imagen del banner opcional que se muestra en el frente de la tarjeta. Si no hay ninguno, se mostrará la imagen principal de la clase, si está presente. Si la imagen principal de la clase tampoco está presente, no se mostrará nada. |
groupingInfo |
Información que controla cómo se agrupan los pases. |
passConstraints |
Pasa las restricciones del objeto. Incluye la limitación de los comportamientos de NFC y capturas de pantalla. |
saveRestrictions |
Son las restricciones en el objeto que se debe verificar antes de que el usuario intente guardar el pase. Ten en cuenta que estas restricciones solo se aplicarán durante el tiempo de guardado. Si las restricciones cambian después de que un usuario guarda un pase, las restricciones nuevas no se aplicarán a un pase ya guardado. |
LoyaltyPoints
Representación JSON |
---|
{ "label": string, "balance": { object ( |
Campos | |
---|---|
label |
La etiqueta de puntos de lealtad, como "Puntos". La longitud máxima recomendada es de 9 caracteres. |
balance |
El saldo de puntos de lealtad del titular de la cuenta, como "500" o “USD 10.00”. La longitud máxima recomendada es de 7 caracteres. Este es un campo obligatorio de |
localizedLabel |
Las cadenas traducidas para la etiqueta. La longitud máxima recomendada es de 9 caracteres. |
LoyaltyPointsBalance
Representación JSON |
---|
{
"string": string,
"int": integer,
"double": number,
"money": {
object ( |
Campos | |
---|---|
string |
Es la forma de cadena de un saldo. Solo se debe propagar uno de estos subtipos (string, int, double, currency). |
int |
Número entero de un saldo. Solo se debe propagar uno de estos subtipos (string, int, double, currency). |
double |
La forma doble de un saldo. Solo se debe propagar uno de estos subtipos (string, int, double, currency). |
money |
Es la forma de dinero de un saldo. Solo se debe propagar uno de estos subtipos (string, int, double, currency). |
Métodos |
|
---|---|
|
Agrega un mensaje al objeto de lealtad al que hace referencia el ID de objeto determinado. |
|
Devuelve el objeto de lealtad con el ID de objeto especificado. |
|
Inserta un objeto de lealtad con el ID y las propiedades especificados. |
|
Devuelve una lista de todos los objetos de lealtad de un ID de entidad emisora determinado. |
|
Modifica los objetos de oferta vinculados del objeto de lealtad con el ID proporcionado. |
|
Actualiza el objeto de lealtad al que hace referencia el ID de objeto determinado. |
|
Actualiza el objeto de lealtad al que hace referencia el ID de objeto determinado. |