REST Resource: loyaltyobject

Recurso: LoyaltyObject

Representación JSON 
{
  "kind": string,
  "classReference": {
    object (LoyaltyClass)
  },
  "accountName": string,
  "accountId": string,
  "loyaltyPoints": {
    object (LoyaltyPoints)
  },
  "linkedOfferIds": [
    string
  ],
  "secondaryLoyaltyPoints": {
    object (LoyaltyPoints)
  },
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
Campos
kind
(deprecated)

string

Identifica qué tipo de recurso es. Valor: la cadena fija "walletobjects#loyaltyObject".
classReference

object (LoyaltyClass)

Una copia de los campos heredados de la clase superior. Estos campos se recuperan durante una solicitud GET.
accountName

string

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

string

Es el identificador de la cuenta de lealtad. La longitud máxima recomendada es de 20 caracteres.
loyaltyPoints

object (LoyaltyPoints)

La etiqueta, el saldo y el tipo de puntos de recompensa de lealtad
linkedOfferIds[]

string

Es una lista de objetos de oferta vinculados a esta tarjeta de lealtad. Los objetos de oferta ya deben existir.

Los IDs de los objetos de oferta deben seguir el formato issuer ID.identifier, donde Google emite el primero y tú eliges el segundo.
secondaryLoyaltyPoints

object (LoyaltyPoints)

La etiqueta, el saldo y el tipo de puntos de recompensa de lealtad secundarios Se muestran además de los puntos de lealtad principales.
id

string

Obligatorio. Es el identificador único de un objeto. Este ID debe ser único para todos los objetos de un emisor. Este valor debe seguir el formato issuer ID.identifier, donde Google emite el primero y tú eliges el segundo. El identificador único solo debe incluir caracteres alfanuméricos, “.”, “_” o “-”.
classId

string

Obligatorio. La clase asociada con este objeto. La clase debe ser del mismo tipo que este objeto, ya debe existir y debe estar aprobada.

Los IDs de clase deben seguir el formato issuer ID.identifier, donde Google emite el primero y tú eliges el segundo.
version
(deprecated)

string (int64 format)

Obsoleto
state

enum (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 inactive se mueve a la sección "Pases vencidos".
barcode

object (Barcode)

El tipo y el valor del código de barras.
messages[]

object (Message)

Una matriz 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

object (TimeInterval)

Es el período durante el cual este objeto será active y se puede usar. El estado de un objeto cambiará a expired cuando finalice este período.
locations[]
(deprecated)

object (LatLongPoint)

Nota: Por el momento, este campo no es compatible para activar notificaciones geográficas.
hasUsers

boolean

Indica si el objeto tiene usuarios. La plataforma establece este campo.
smartTapRedemptionValue

string

Es el valor que se transmitirá a una terminal certificada de Smart Tap a través de NFC para este objeto. Los campos a nivel de la clase enableSmartTap y redemptionIssuers también deben configurarse correctamente para que el pase admita el Toque inteligente. Solo se admiten caracteres ASCII.

Si no se establece este valor, pero los campos enableSmartTap y redemptionIssuers a nivel de la clase están configurados correctamente, los campos barcode.value o accountId se usan como resguardo si están presentes.
hasLinkedDevice

boolean

Indica si este objeto está vinculado a un solo dispositivo. La plataforma establece este campo cuando un usuario guarda el objeto y lo vincula a su dispositivo. Está destinado a socios seleccionados. Comunícate con el equipo de asistencia para obtener más información.
disableExpirationNotification

boolean

Indica si se deben suprimir las notificaciones de forma explícita. Si este campo se establece como verdadero, independientemente del campo messages, se suprimirán las notificaciones de vencimiento para el usuario. De forma predeterminada, este campo se establece como "false".

Por el momento, solo se puede configurar para las ofertas.
infoModuleData

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 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 de 10 del objeto y 10 de la clase.
rotatingBarcode

object (RotatingBarcode)

El tipo y el valor del código de barras rotativo.
heroImage

object (Image)

Es la imagen de banner opcional que se muestra en la parte frontal de la tarjeta. Si no hay ninguna, se mostrará la imagen hero de la clase, si está presente. Si la imagen principal de la clase tampoco está presente, no se mostrará nada.
groupingInfo

object (GroupingInfo)

Información que controla cómo se agrupan los pases.
passConstraints

object (PassConstraints)

Pasa las restricciones del objeto. Incluye la limitación de los comportamientos de NFC y capturas de pantalla.
saveRestrictions

object (SaveRestrictions)

Son restricciones sobre el objeto que se deben verificar antes de que el usuario intente guardar el pase. Ten en cuenta que estas restricciones solo se aplicarán durante el tiempo de ahorro. Si las restricciones cambiaron después de que un usuario guardó el pase, las nuevas restricciones no se aplicarán a un pase que ya se haya guardado.
linkedObjectIds[]

string

linkedObjectIds es una lista de otros objetos, como entradas para eventos, programas de lealtad, ofertas, genéricos, tarjetas de regalo, pases de transporte público y tarjetas de embarque, que se deben adjuntar automáticamente a este objeto de lealtad. Si un usuario hubiera guardado esta tarjeta de lealtad, estos linkedObjectIds se enviarían automáticamente a su billetera (a menos que haya desactivado el parámetro de configuración para recibir esos pases vinculados).

Asegúrate de que ya se hayan insertado los objetos presentes en linkedObjectIds. De lo contrario, las llamadas fallarán. Una vez vinculados, los objetos vinculados no se pueden desvincular. No puedes vincular objetos que pertenezcan a otro emisor. Existe un límite para la cantidad de objetos que se pueden vincular a un solo objeto. Una vez que se alcance el límite, se ignorarán en silencio los objetos vinculados nuevos en la llamada.

Los IDs de objetos deben seguir el formato issuer ID.identifier, donde Google emite el primero y tú eliges el segundo.
notifyPreference

enum (NotificationSettingsForUpdates)

Indica si las actualizaciones de campos de este objeto deben activar notificaciones. Cuando se establece en 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 la estableces en DO_NOT_NOTIFY o NOTIFICATION_CONFIG_UNSPECIFIED, no se activará ninguna notificación. Este parámetro de configuración es efímero y debe establecerse 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. Se aplica un máximo de diez en el objeto.

LoyaltyPoints

Representación JSON 
{
  "label": string,
  "balance": {
    object (LoyaltyPointsBalance)
  },
  "localizedLabel": {
    object (LocalizedString)
  }
}
Campos
label

string

La etiqueta de puntos de lealtad, como "Puntos". La longitud máxima recomendada es de 9 caracteres.
balance

object (LoyaltyPointsBalance)

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 loyaltyPoints y secondaryLoyaltyPoints.
localizedLabel

object (LocalizedString)

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 (Money)
  }
}
Campos
string

string

Es la forma de cadena de un balance. Solo se debe propagar uno de estos subtipos (cadena, int, doble, dinero).
int

integer

Es la forma de número entero de un saldo. Solo se debe propagar a uno de estos subtipos (string, int, double, currency).
double

number

La forma doble de un saldo. Solo se debe propagar uno de estos subtipos (cadena, int, doble, dinero).
money

object (Money)

Es la forma monetaria de un saldo. Solo se debe propagar uno de estos subtipos (cadena, int, doble, dinero).

Métodos

addmessage

 Agrega un mensaje al objeto de lealtad al que hace referencia el ID de objeto determinado.

get

 Devuelve el objeto de lealtad con el ID de objeto especificado.

insert

 Inserta un objeto de lealtad con el ID y las propiedades especificados.

list

 Muestra una lista de todos los objetos de lealtad para un ID de emisor determinado.

modifylinkedofferobjects

 Modifica los objetos de oferta vinculados del objeto de lealtad con el ID proporcionado.

patch

 Actualiza el objeto de lealtad al que hace referencia el ID de objeto determinado.

update

 Actualiza el objeto de lealtad al que hace referencia el ID de objeto determinado.