REST Resource: loyaltyobject

Ressource: LoyaltyObject

Représentation 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)
  }
}
Champs
kind
(deprecated)

string

Identifie le type de ressource. Valeur: chaîne fixe "walletobjects#loyaltyObject".
classReference

object (LoyaltyClass)

Copie des champs hérités de la classe parente. Ces champs sont récupérés lors d'une requête GET.
accountName

string

Nom du titulaire du compte de fidélité (par exemple, "Jean Dupont"). La longueur maximale recommandée est de 20 caractères, afin de garantir que la chaîne s'affiche entièrement sur des écrans de petite taille.
accountId

string

Identifiant du compte de fidélité. La longueur maximale recommandée est de 20 caractères.
loyaltyPoints

object (LoyaltyPoints)

Libellé, solde et type des points de fidélité.
linkedOfferIds[]

string

Liste des objets d'offre associés à cette carte de fidélité. Les objets d'offre doivent déjà exister.

Les ID d'objet d'offre doivent respecter le format issuer ID.identifier, lorsque le premier est émis par Google et le second est choisi par vous.
secondaryLoyaltyPoints

object (LoyaltyPoints)

Libellé, solde et type des points de fidélité secondaires. S'affiche en plus des points de fidélité principaux.
id

string

Obligatoire. Identifiant unique d'un objet. Cet ID doit être unique parmi tous les objets d'un émetteur. Cette valeur doit respecter le format issuer ID.identifier, lorsque le premier est émis par Google et le second est choisi par vous. L'identifiant unique ne doit contenir que des caractères alphanumériques, ainsi que les caractères ".", "_" ou "-".
classId

string

Obligatoire. Classe associée à cet objet. La classe doit être du même type que cet objet, doit déjà exister et être approuvée.

Les ID de classe doivent respecter le format issuer ID.identifier, lorsque le premier est émis par Google et le second est choisi par vous.
version
(deprecated)

string (int64 format)

Obsolète
state

enum (State)

Obligatoire. État de l'objet. Ce champ permet de déterminer la façon dont un objet s'affiche dans l'application. Par exemple, un objet inactive est déplacé vers la section "Cartes expirées".
barcode

object (Barcode)

Type et valeur du code-barres.
messages[]

object (Message)

Tableau de messages affichés dans l'application. Tous les utilisateurs de cet objet recevront les messages associés. Le nombre maximal de ces champs est 10.
validTimeInterval

object (TimeInterval)

Période pendant laquelle cet objet sera active et pourra être utilisé. L'état d'un objet passe à expired une fois cette période écoulée.
locations[]

object (LatLongPoint)

Remarque: Pour le moment, ce champ ne permet pas de déclencher des notifications géographiques.
hasUsers

boolean

Indique si l'objet a des utilisateurs. Ce champ est défini par la plate-forme.
smartTapRedemptionValue

string

Valeur qui sera transmise à un terminal certifié Smart Tap via NFC pour cet objet. Les champs enableSmartTap et redemptionIssuers au niveau de la classe doivent également être correctement configurés pour que la carte soit compatible avec Smart Tap. Seuls les caractères ASCII sont acceptés.

Si cette valeur n'est pas définie, mais que les champs enableSmartTap et redemptionIssuers au niveau de la classe sont correctement configurés, les champs barcode.value ou accountId sont utilisés en remplacement s'ils sont présents.
hasLinkedDevice

boolean

Indique si cet objet est actuellement associé à un seul appareil. Ce champ est défini par la plate-forme lorsqu'un utilisateur enregistre l'objet pour l'associer à son appareil. Destiné à certains partenaires. Pour plus d'informations, contactez l'assistance.
disableExpirationNotification

boolean

Indique si les notifications doivent être explicitement supprimées. Si ce champ est défini sur "true", quel que soit le champ messages, les notifications d'expiration envoyées à l'utilisateur seront supprimées. Par défaut, ce champ est défini sur "false".

Actuellement, cette option ne peut être définie que pour les offres.
infoModuleData

object (InfoModuleData)

Obsolète. Utilisez plutôt textModulesData.
imageModulesData[]

object (ImageModuleData)

Données de module d'image. Le nombre maximal de champs affichés pour l'objet de classe est limité à un pour le niveau de l'objet et un au niveau de l'objet de classe.
textModulesData[]

object (TextModuleData)

Données des modules de texte. Si des données de module de texte sont également définies sur la classe, les deux seront affichées. Le nombre maximal de ces champs affichés est de 10 pour l'objet et 10 pour la classe.
rotatingBarcode

object (RotatingBarcode)

Type et valeur du code-barres rotatif.
heroImage

object (Image)

Image de bannière facultative affichée au recto de la fiche. Si aucun n'est présent, l'image héros du cours s'affiche, le cas échéant. Si l'image héros de la classe n'est pas non plus présente, rien ne s'affichera.
groupingInfo

object (GroupingInfo)

Informations qui contrôlent la façon dont les cartes sont regroupées.
passConstraints

object (PassConstraints)

Transmettez des contraintes pour l'objet. Cela inclut la limitation des comportements liés à la technologie NFC et aux captures d'écran.

LoyaltyPoints

Représentation JSON 
{
  "label": string,
  "balance": {
    object (LoyaltyPointsBalance)
  },
  "localizedLabel": {
    object (LocalizedString)
  }
}
Champs
label

string

Libellé des points de fidélité, par exemple "Points". La longueur maximale recommandée est de 9 caractères.
balance

object (LoyaltyPointsBalance)

Solde en points de fidélité du titulaire du compte (par exemple, "500" ou "10,00 €"). La longueur maximale recommandée est de 7 caractères. Ce champ est obligatoire pour loyaltyPoints et secondaryLoyaltyPoints.
localizedLabel

object (LocalizedString)

Chaînes traduites pour le libellé. La longueur maximale recommandée est de 9 caractères.

LoyaltyPointsBalance

Représentation JSON 
{
  "string": string,
  "int": integer,
  "double": number,
  "money": {
    object (Money)
  }
}
Champs
string

string

Forme de chaîne d'un solde. Un seul de ces sous-types (string, int, double, money) doit être renseigné.
int

integer

Forme entière d'un solde. Un seul de ces sous-types (string, int, double, money) doit être renseigné.
double

number

La forme double d'un solde. Un seul de ces sous-types (string, int, double, money) doit être renseigné.
money

object (Money)

La forme monétaire d'un solde. Un seul de ces sous-types (string, int, double, money) doit être renseigné.

Méthodes

addmessage

 Ajoute un message à l'objet fidélité référencé par l'ID d'objet donné.

get

 Renvoie l'objet fidélité avec l'ID d'objet donné.

insert

 Insère un objet fidélité avec l'identifiant et les propriétés indiqués.

list

 Renvoie la liste de tous les objets liés aux cartes de fidélité pour un ID d'émetteur donné.

modifylinkedofferobjects

 Modifie les objets d'offres associés pour l'objet fidélité avec l'identifiant donné.

patch

 Met à jour l'objet fidélité référencé par l'ID d'objet donné.

update

 Met à jour l'objet fidélité référencé par l'ID d'objet donné.