REST Resource: loyaltyobject

Recurso: trustObject

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

string

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

object (LoyaltyClass)

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

string

Es 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 se muestre toda la cadena en 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 por lealtad
linkedOfferIds[]

string

Una lista de objetos de ofertas vinculados a esta tarjeta de lealtad. Los objetos de oferta ya deben existir.

Los IDs de objeto de la oferta deben seguir el formato issuer ID.identifier donde la primera es emitida por Google y la última es la tuya.
secondaryLoyaltyPoints

object (LoyaltyPoints)

Es la etiqueta, el saldo y el tipo de puntos de recompensa secundarios. Se muestra junto con los puntos de lealtad principales.
id

string

Obligatorio. El identificador único de un objeto. Este ID debe ser único en todos los objetos de una entidad emisora. Este valor debe seguir el formato issuer ID.identifier donde la primera es emitida por Google y la última es la tuya. 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 aprobarse.

Los IDs de clase deben seguir el formato issuer ID.identifier donde la primera es emitida por Google y la última es la tuya.
version
(deprecated)

string (int64 format)

Obsoleto
state

enum (State)

Obligatorio. Es 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 de código de barras y el valor.
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.
validTimeInterval

object (TimeInterval)

El período del objeto será active y se podrá usar el objeto. El estado de un objeto cambiará a expired una vez transcurrido este período.
locations[]

object (LatLongPoint)

Nota: Actualmente, este campo no es compatible con la activación de notificaciones geográficas.
hasUsers

boolean

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

string

El valor que se transmitirá a una terminal certificada por Smart Tap a través de NFC para este objeto. Los campos enableSmartTap y redemptionIssuers a nivel de la clase 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 de nivel de clase enableSmartTap y redemptionIssuers 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 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 lo usen socios seleccionados. Comunícate con el equipo de Asistencia para obtener más información.
disableExpirationNotification

boolean

Indica si las notificaciones deben suprimirse explícitamente. Si estableces este campo como verdadero, independientemente del campo messages, se suprimirán las notificaciones de vencimiento para el usuario. De forma predeterminada, este campo se establece en falso.

Actualmente, solo se puede configurar para ofertas.
infoModuleData

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 para el nivel de objeto y 1 para el nivel de objeto de clase.
textModulesData[]

object (TextModuleData)

Datos del módulo de texto. Si en la clase también se definen los datos del módulo de texto, se mostrarán ambos. La cantidad máxima de campos que se muestran es 10 para el objeto y 10 para la clase.
rotatingBarcode

object (RotatingBarcode)

El tipo y valor de código de barras rotativos.
heroImage

object (Image)

Imagen opcional del banner que se muestra en el frente de la tarjeta. Si no hay ninguno, se mostrará la imagen principal de la clase. Si tampoco hay una hero image de la clase, no se mostrará nada.
groupingInfo

object (GroupingInfo)

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

object (PassConstraints)

Pasa restricciones para el objeto. Incluye limitar los comportamientos de NFC y capturas de pantalla.

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 saldo. Solo se debe propagar uno de estos subtipos (string, int, double, currency).
int

integer

Número entero de un saldo Solo se debe propagar uno de estos subtipos (string, int, double, currency).
double

number

Forma doble de una balanza. Solo se debe propagar uno de estos subtipos (string, int, double, currency).
money

object (Money)

Es la forma monetaria de un saldo. Solo se debe propagar uno de estos subtipos (string, int, double, currency).

Métodos

addmessage

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

get

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

insert

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

list

 Devuelve una lista de todos los objetos de lealtad de un ID de entidad emisora determinado.

modifylinkedofferobjects

 Modifica los objetos de la oferta vinculada del objeto de lealtad con el ID determinado.

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.