REST Resource: loyaltyobject

{
  "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)
  }
}

string

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

object (LoyaltyClass)

Copie des champs hérités de la classe parente. Ces champs sont récupérés lors d'une opération GET.

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.

string

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

object (LoyaltyPoints)

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

string

Liste des objets d'offres 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, où le premier est émis par Google et le deuxième est choisi par vous.

object (LoyaltyPoints)

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

string

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

string

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

Les ID de classe doivent respecter le format issuer ID.identifier, où le premier est émis par Google et le deuxième est choisi par vous.

string (int64 format)

Obsolète

enum (State)

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

object (Barcode)

Type et valeur du code-barres.

object (Message)

Tableau des 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.

object (TimeInterval)

Période pendant laquelle cet objet sera active. L'objet peut être utilisé. L'état d'un objet passera à expired une fois cette période écoulée.

object (LatLongPoint)

Remarque: Actuellement, ce champ ne permet pas de déclencher des notifications géographiques.

boolean

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

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 comme valeurs de remplacement, le cas échéant.

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 et l'associe à son appareil. Destiné à certains partenaires. Contactez l'assistance pour en savoir plus.

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, cela ne peut être défini que pour les offres.

object (InfoModuleData)

Obsolète. Utilisez textModulesData à la place.

object (ImageModuleData)

Données du module d'image. Le nombre maximal de ces champs affichés est 1 pour le niveau objet et 1 pour le niveau d'objet de classe.

object (TextModuleData)

Données du module de texte. Si des données de module de texte sont également définies sur la classe, les deux s'affichent. Ces champs affichés sont limités à 10 pour l'objet et 10 à partir de la classe.

object (LinksModuleData)

Données du module de liens. Si des données du module de liens sont également définies sur la classe, les deux s'affichent.

object (AppLinkData)

Lien facultatif vers l'application ou le site Web qui s'affichera sous la forme d'un bouton sur le devant de la carte. Si AppLinkData est fourni pour la classe correspondante, seul l'objet AppLinkData sera affiché.

object (RotatingBarcode)

Type et valeur du code-barres rotatif.

object (Image)

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

object (GroupingInfo)

Informations qui contrôlent la manière dont les cartes sont regroupées.

object (PassConstraints)

Transmettez des contraintes pour l'objet. y compris la limitation du NFC et les comportements des captures d'écran.

object (SaveRestrictions)

Restrictions sur l'objet qui doit être vérifié avant que l'utilisateur ne tente d'enregistrer la carte. Notez que ces restrictions ne seront appliquées que pendant la sauvegarde. Si les restrictions changent après qu'un utilisateur a enregistré la carte, les nouvelles restrictions ne s'appliquent pas à une carte déjà enregistrée.

{
  "label": string,
  "balance": {
    object (LoyaltyPointsBalance)
  },
  "localizedLabel": {
    object (LocalizedString)
  }
}

string

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

object (LoyaltyPointsBalance)

Solde des 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 dans les champs loyaltyPoints et secondaryLoyaltyPoints.

object (LocalizedString)

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

{
  "string": string,
  "int": integer,
  "double": number,
  "money": {
    object (Money)
  }
}

string

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

integer

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

number

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

object (Money)

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