REST Resource: loyaltyclass

Ressource: LoyaltyClass

Représentation JSON 
{
  "kind": string,
  "programName": string,
  "programLogo": {
    object (Image)
  },
  "accountNameLabel": string,
  "accountIdLabel": string,
  "rewardsTierLabel": string,
  "rewardsTier": string,
  "localizedProgramName": {
    object (LocalizedString)
  },
  "localizedAccountNameLabel": {
    object (LocalizedString)
  },
  "localizedAccountIdLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTierLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTier": {
    object (LocalizedString)
  },
  "secondaryRewardsTierLabel": string,
  "localizedSecondaryRewardsTierLabel": {
    object (LocalizedString)
  },
  "secondaryRewardsTier": string,
  "localizedSecondaryRewardsTier": {
    object (LocalizedString)
  },
  "discoverableProgram": {
    object (DiscoverableProgram)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideProgramLogo": {
    object (Image)
  }
}
Champs
kind
(deprecated)

string

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

string

Obligatoire. Nom du programme, tel que "Vêtements d'Adam". L'application peut afficher des points de suspension après les 20 premiers caractères pour s'assurer que la chaîne s'affiche entièrement sur des écrans de petite taille.
accountNameLabel

string

Libellé du nom de compte, tel que "Nom du membre". La longueur maximale recommandée est de 15 caractères, afin de garantir que la chaîne s'affiche entièrement sur des écrans de petite taille.
accountIdLabel

string

Libellé du numéro de compte, tel que "Référence membre". La longueur maximale recommandée est de 15 caractères, afin de garantir que la chaîne s'affiche entièrement sur des écrans de petite taille.
rewardsTierLabel

string

Libellé du niveau de récompense, tel que "Niveau de récompenses". La longueur maximale recommandée est de 9 caractères, afin de garantir que la chaîne s'affiche entièrement sur des écrans de petite taille.
rewardsTier

string

Niveau de récompenses, par exemple "Or" ou "Platine". La longueur maximale recommandée est de 7 caractères, afin de garantir que la chaîne s'affiche entièrement sur des écrans de petite taille.
localizedProgramName

object (LocalizedString)

Chaînes traduites pour programName. L'application peut afficher des points de suspension après les 20 premiers caractères pour s'assurer que la chaîne s'affiche entièrement sur des écrans de petite taille.
localizedAccountNameLabel

object (LocalizedString)

Chaînes traduites pour accountNameLabel. La longueur maximale recommandée est de 15 caractères, afin de garantir que la chaîne s'affiche entièrement sur des écrans de petite taille.
localizedAccountIdLabel

object (LocalizedString)

Chaînes traduites pour accountIdLabel. La longueur maximale recommandée est de 15 caractères, afin de garantir que la chaîne s'affiche entièrement sur des écrans de petite taille.
localizedRewardsTierLabel

object (LocalizedString)

Chaînes traduites pour le RewardsTierLabel. La longueur maximale recommandée est de 9 caractères, afin de garantir que la chaîne s'affiche entièrement sur des écrans de petite taille.
localizedRewardsTier

object (LocalizedString)

Chaînes traduites pour le niveau de récompenses. La longueur maximale recommandée est de 7 caractères, afin de garantir que la chaîne s'affiche entièrement sur des écrans de petite taille.
secondaryRewardsTierLabel

string

Libellé du niveau de récompense secondaire, tel que "Niveau de récompenses".
localizedSecondaryRewardsTierLabel

object (LocalizedString)

Chaînes traduites pour le secondaireRewardsTierLabel.
secondaryRewardsTier

string

Il s'agit du niveau de récompense secondaire, tel que "Or" ou "Platine".
localizedSecondaryRewardsTier

object (LocalizedString)

Chaînes traduites pour le secondaireRewardsTier.
discoverableProgram

object (DiscoverableProgram)

Informations sur la manière dont la classe peut être découverte et instanciée depuis l'application Google Pay.
classTemplateInfo

object (ClassTemplateInfo)

Informations du modèle sur la manière dont la classe doit s'afficher. Si cette règle n'est pas configurée, Google utilise alors un ensemble de champs par défaut à afficher.
id

string

Obligatoire. Identifiant unique d'une classe. Cet ID doit être unique parmi toutes les classes 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. Votre identifiant unique ne doit contenir que des caractères alphanumériques, ainsi que les caractères ".", "_" ou "-".
version
(deprecated)

string (int64 format)

Obsolète
issuerName

string

Obligatoire. Nom de l'émetteur. 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.
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.
allowMultipleUsersPerObject
(deprecated)

boolean

Obsolète. Utilisez multipleDevicesAndHoldersAllowedStatus à la place.
homepageUri

object (Uri)

URI de la page d'accueil de votre application. Le fait de renseigner l'URI dans ce champ produit exactement le même comportement que le remplissage d'un URI dans linksModuleData (lorsqu'un objet est affiché, un lien vers la page d'accueil s'affiche dans ce qui serait généralement considéré comme la section linksModuleData de l'objet).
locations[]

object (LatLongPoint)

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

enum (ReviewStatus)

Obligatoire. État du cours. Ce champ peut être défini sur draft ou underReview à l'aide des appels d'API d'insertion, de correctif ou de mise à jour. Une fois que l'état de l'examen est passé de "draft", il ne peut plus être redéfini sur "draft".

Vous devez conserver la valeur draft pour ce champ lorsque la classe est en cours de développement. Une classe draft ne peut pas être utilisée pour créer un objet.

Vous devez définir ce champ sur underReview lorsque vous pensez que la classe est prête à l'emploi. La plate-forme définit automatiquement ce champ sur approved. Il peut être immédiatement utilisé pour créer ou migrer des objets.

Lorsque vous mettez à jour une classe déjà approved, continuez à définir ce champ sur underReview.
review

object (Review)

Commentaires définis par la plate-forme lorsqu'une classe est marquée comme approved ou rejected.
infoModuleData
(deprecated)

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.
redemptionIssuers[]

string (int64 format)

Identifie les émetteurs d'offres qui peuvent utiliser la carte via Smart Tap. Les émetteurs d'offres sont identifiés par leur ID. Les émetteurs d'offres doivent avoir configuré au moins une clé Smart Tap.

Les champs enableSmartTap et smartTapRedemptionValue au niveau de l'objet, barcode.value, oraccountId` doivent également être correctement configurés pour qu'une carte soit compatible avec Smart Tap.
countryCode

string

Code pays utilisé pour afficher le pays de la carte (lorsque l'utilisateur ne se trouve pas dans ce pays), ainsi que pour afficher le contenu localisé lorsqu'il n'est pas disponible dans les paramètres régionaux de l'utilisateur.
heroImage

object (Image)

Image de bannière facultative affichée au recto de la fiche. Si aucun n'est présent, rien ne s'affichera. L'image s'affiche à 100% de la largeur.
wordMark
(deprecated)

object (Image)

Obsolète.
enableSmartTap

boolean

Indique si cette classe est compatible avec Smart Tap. Les champs redemptionIssuers et smartTapRedemptionLevel au niveau de l'objet, barcode.value, or accountId` doivent également être correctement configurés pour qu'une carte soit compatible avec Smart Tap.
hexBackgroundColor

string

Couleur d'arrière-plan de la carte. Si cette couleur n'est pas définie, la couleur dominante de l'image héros est utilisée. En l'absence d'image héros, la couleur dominante du logo est utilisée. Le format est #rrggbb, où rrggbb est un triplet RVB hexadécimal, tel que #ffcc00. Vous pouvez également utiliser la version abrégée du triplet RVB (#rgb), par exemple #fc0.
localizedIssuerName

object (LocalizedString)

Chaînes traduites pour l'émetteurName. 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.
multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

Indique si plusieurs utilisateurs et appareils vont enregistrer le même objet en référence à cette classe.
callbackOptions

object (CallbackOptions)

Options de rappel à utiliser pour rappeler l'émetteur à chaque enregistrement/suppression d'un objet de cette classe par l'utilisateur final. Tous les objets de cette classe sont éligibles pour le rappel.
securityAnimation

object (SecurityAnimation)

Informations facultatives sur l'animation de sécurité. Si cette option est définie, une animation de sécurité s'affiche sur les détails de la carte.
viewUnlockRequirement

enum (ViewUnlockRequirement)

Afficher les options de déverrouillage requises pour la carte de fidélité

DiscoverableProgram

Informations sur la manière dont une classe peut être découverte et instanciée dans l'application Android Pay. Pour ce faire, recherchez un programme de fidélité ou de carte cadeau, puis scannez-le ou saisissez-le manuellement.

Représentation JSON 
{
  "merchantSignupInfo": {
    object (DiscoverableProgramMerchantSignupInfo)
  },
  "merchantSigninInfo": {
    object (DiscoverableProgramMerchantSigninInfo)
  },
  "state": enum (State)
}
Champs
merchantSignupInfo

object (DiscoverableProgramMerchantSignupInfo)

Informations sur la possibilité de s'inscrire à ce programme et d'y ajouter une valeur via le site d'un marchand. Utilisé lorsque MERCHANT_HOSTED_ID est activé.
merchantSigninInfo

object (DiscoverableProgramMerchantSigninInfo)

Informations sur la possibilité de se connecter et d'ajouter un élément utile à ce programme via un site marchand. Utilisé lorsque MERCHANT_HOSTED_SIGNIN est activé.
state

enum (State)

État de visibilité du programme visible.

DiscoverableProgramMerchantSignupInfo

Informations sur le processus d'inscription à un programme hébergé par le marchand.

Représentation JSON 
{
  "signupWebsite": {
    object (Uri)
  },
  "signupSharedDatas": [
    enum (SharedDataType)
  ]
}
Champs
signupWebsite

object (Uri)

URL vers laquelle rediriger l'utilisateur pour le site d'inscription du marchand.
signupSharedDatas[]

enum (SharedDataType)

Données utilisateur envoyées dans une demande POST à l'URL du site Web d'inscription. Ces informations sont encodées, puis partagées afin que le site Web du marchand puisse préremplir les champs utilisés pour inscrire l'utilisateur au programme visible.

SharedDataType

Enums
SHARED_DATA_TYPE_UNSPECIFIED
FIRST_NAME
LAST_NAME
STREET_ADDRESS champ d'adresse sur une seule ligne
ADDRESS_LINE_1 champs d'adresse multilignes
ADDRESS_LINE_2
ADDRESS_LINE_3
CITY
STATE
ZIPCODE
COUNTRY
EMAIL
PHONE

DiscoverableProgramMerchantSigninInfo

Informations sur le processus de connexion hébergé par le marchand pour un programme.

Représentation JSON 
{
  "signinWebsite": {
    object (Uri)
  }
}
Champs
signinWebsite

object (Uri)

URL vers laquelle rediriger l'utilisateur pour le site de connexion du marchand.

État

Enums
STATE_UNSPECIFIED
TRUSTED_TESTERS Visible uniquement par les testeurs ayant accès au compte de l'émetteur.
trustedTesters

Ancien alias de TRUSTED_TESTERS. Obsolète.
LIVE Visible par tous
live

Ancien alias de LIVE. Obsolète.
DISABLED Non visible.
disabled

Ancien alias de DISABLED. Obsolète.

Méthodes

addmessage

 Ajoute un message à la classe de fidélité référencée par l'ID de classe donné.

get

 Affiche la classe de fidélité avec l'identifiant de classe donné.

insert

 Insère une classe de fidélité avec l'identifiant et les propriétés indiqués.

list

 Renvoie la liste de toutes les classes de fidélité pour un ID d'émetteur donné.

patch

 Met à jour la classe de fidélité référencée par l'ID de classe donné.

update

 Met à jour la classe de fidélité référencée par l'ID de classe donné.