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)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
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 opération 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'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 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, où 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, des points, des traits d'union ou des tirets.
classId

string

Obligatoire. Classe associée à cet objet. La classe doit être du même type que cet objet, doit déjà exister 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.
version
(deprecated)

string (int64 format)

Obsolète
state

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é dans la section "Cartes expirées".
barcode

object (Barcode)

Type et valeur du code-barres.
messages[]

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 de 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 ce délai écoulé.
locations[]
(deprecated)

object (LatLongPoint)

Remarque : Il n'est actuellement pas possible d'utiliser ce champ pour déclencher des notifications géo.
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 de niveau de classe enableSmartTap et redemptionIssuers sont configurés correctement, les champs barcode.value ou accountId sont utilisés en remplacement, le cas échéant.
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, en l'associant à son appareil. Destiné à certains partenaires. Pour en savoir plus, contactez l'assistance.
disableExpirationNotification

boolean

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

Pour le moment, 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 du module d'image. Le nombre maximal de ces champs affichés est de 1 au niveau de l'objet et de 1 au niveau de l'objet de classe.
textModulesData[]

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. Le nombre maximal de ces champs affichés est de 10 pour l'objet et de 10 pour la classe.
rotatingBarcode

object (RotatingBarcode)

Type et valeur du code-barres rotatif.
heroImage

object (Image)

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

object (GroupingInfo)

Information qui gère le regroupement des cartes.
passConstraints

object (PassConstraints)

Transmettez des contraintes pour l'objet. Inclut la limitation des comportements NFC et des captures d'écran.
saveRestrictions

object (SaveRestrictions)

Restrictions concernant l'objet qui doivent être validées avant que l'utilisateur ne tente d'enregistrer la carte. Notez que ces restrictions ne s'appliquent qu'au moment de l'enregistrement. Si les restrictions ont changé après qu'un utilisateur a enregistré la carte, les nouvelles restrictions ne s'appliquent pas à une carte déjà enregistrée.
linkedObjectIds[]

string

Les linkedObjectIds sont une liste d'autres objets tels que des billets pour des événements, des cartes de fidélité, des offres, des cartes génériques, des cartes cadeaux, des titres de transport et des cartes d'embarquement qui doivent être automatiquement associés à cet objet de fidélité. Si un utilisateur avait enregistré cette carte de fidélité, ces identifiants linkedObjectId seront automatiquement transférés vers le portefeuille de l'utilisateur (sauf s'il a désactivé le paramètre permettant de recevoir ces cartes associées).

Assurez-vous que les objets présents dans linkedObjectIds sont déjà insérés. Sinon, les appels échoueront. Une fois associés, les objets ne peuvent plus être dissociés. Vous ne pouvez pas associer des objets appartenant à un autre émetteur. Le nombre d'objets pouvant être associés à un même objet est limité. Une fois la limite atteinte, les nouveaux objets associés de l'appel sont ignorés sans notification.

Les ID d'objet doivent respecter le format issuer ID.identifier, où le premier est émis par Google et le second est choisi par vous.
notifyPreference

enum (NotificationSettingsForUpdates)

Indique si les mises à jour de champ de cet objet doivent déclencher des notifications. Si cet indicateur est défini sur NOTIFY, nous essayons de déclencher une notification de mise à jour des champs pour les utilisateurs. Ces notifications ne sont envoyées aux utilisateurs que si le champ figure sur une liste d'autorisation. Si la valeur est DO_NOT_NOTIFY ou NOTIFICATION_SETTINGS_UNSPECIFIED, aucune notification ne sera déclenchée. Ce paramètre est éphémère et doit être défini avec chaque requête PATCH ou UPDATE, sinon aucune notification ne sera déclenchée.
valueAddedModuleData[]

object (ValueAddedModuleData)

Données facultatives du module à valeur ajoutée. Dix au maximum sur l'objet.

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 de points de fidélité du titulaire du compte, par exemple "500" ou "10,00 $". La longueur maximale recommandée est de sept 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 neuf caractères.

LoyaltyPointsBalance

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

string

Forme 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 (chaîne, int, double, money) doit être renseigné.
double

number

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

object (Money)

Représentation monétaire d'un solde. Un seul de ces sous-types (chaîne, 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

 Affiche l'objet de fidélité avec l'ID d'objet donné.

insert

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

list

 Affiche la liste de tous les objets fidélité pour un ID d'émetteur donné.

modifylinkedofferobjects

 Modifie les objets d'offre associés à l'objet de fidélité associé à l'ID donné.

patch

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

update

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