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)
  },
  "appLinkData": {
    object (AppLinkData)
  }
}
Champs
kind
(deprecated)

string

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

string

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

string

Libellé du nom du 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é de l'ID de compte, tel que "ID de 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écompenses, 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 garantir 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 niveau de récompense. 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é secondaire du niveau de récompenses, tel que "Niveau de récompenses".
localizedSecondaryRewardsTierLabel

object (LocalizedString)

Chaînes traduites pour le niveau secondaireRewardsTierLabel.
secondaryRewardsTier

string

Niveau secondaire de récompenses, par exemple "Or" ou « Platine ».
localizedSecondaryRewardsTier

object (LocalizedString)

Chaînes traduites pour le niveau secondaireRewardsTier.
discoverableProgram

object (DiscoverableProgram)

Informations sur la manière dont le cours peut être découvert et instancié depuis l'application Google Pay.
classTemplateInfo

object (ClassTemplateInfo)

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

string

Obligatoire. Identifiant unique d'une classe. Cet ID doit être unique dans toutes les classes 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. Votre identifiant unique ne doit contenir que des caractères alphanumériques, ainsi que des symboles ".", "_" et "-".
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 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.
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 a exactement le même comportement que de renseigner un URI dans linksModuleData (lorsqu'un objet est affiché, un lien vers la page d'accueil s'affiche dans ce que l'on considère généralement comme la section linksModuleData de l'objet).
locations[]

object (LatLongPoint)

Remarque: Actuellement, 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, vous ne pouvez plus le repasser à l'état draft.

Ce champ doit rester défini sur draft 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, et peut être utilisé immédiatement pour créer ou migrer des objets.

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

object (Review)

Commentaires sur l'avis définis par la plate-forme lorsqu'un cours est marqué comme approved ou rejected.
infoModuleData
(deprecated)

object (InfoModuleData)

Obsolète. Utilisez textModulesData à la place.
imageModulesData[]

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.
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. Ces champs affichés sont limités à 10 pour l'objet et 10 à partir de 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.

Le champ enableSmartTap et l'un des champs smartTapRedemptionValue, barcode.value, oraccountId au niveau de l'objet, doivent également être configurés correctement 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é lorsque celui-ci n'est pas disponible dans les paramètres régionaux de l'utilisateur.
heroImage

object (Image)

Image de bannière facultative qui s'affiche au recto de la carte. En l'absence de code, rien ne s'affiche. L'image s'affiche avec une largeur de 100 %.
wordMark
(deprecated)

object (Image)

Obsolète.
enableSmartTap

boolean

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

string

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

object (LocalizedString)

Chaînes traduites pour "IssuerName". 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 enregistreront le même objet faisant référence à cette classe.
callbackOptions

object (CallbackOptions)

Options de rappel à utiliser pour rappeler l'émetteur à chaque enregistrement ou suppression d'un objet de cette classe par l'utilisateur final. Tous les objets de cette classe sont éligibles au 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 dans les détails de la carte.
viewUnlockRequirement

enum (ViewUnlockRequirement)

Affichez les conditions de déverrouillage pour la carte de fidélité.

DiscoverableProgram

Informations sur la manière dont une classe peut être découverte et instanciée depuis l'application Android Pay. Pour cela, il suffit de rechercher un programme de fidélité ou de carte cadeau, puis de le scanner ou de le saisir manuellement.

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

object (DiscoverableProgramMerchantSignupInfo)

Informations sur la possibilité de s'inscrire et d'ajouter un avantage à ce programme via un site marchand. Utilisé lorsque MERCHANT_HOSTED_ compagnie est activé.
merchantSigninInfo

object (DiscoverableProgramMerchantSigninInfo)

Informations sur la possibilité de se connecter et d'ajouter un avantage à 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 du site d'inscription du marchand vers lequel rediriger l'utilisateur.
signupSharedDatas[]

enum (SharedDataType)

Données utilisateur envoyées dans une requête POST à l'URL du site Web pour l'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 ligne
ADDRESS_LINE_1 champs d'adresse sur plusieurs lignes
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 (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 pour TRUSTED_TESTERS. Obsolète.
LIVE Visible par tous.
live

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

Ancien alias pour 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é associée à l'ID de classe donné.

insert

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

list

 Affiche 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é.