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)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
Champs
kind
(deprecated)

string

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

string

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

string

Libellé du nom du compte (par exemple, "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, par exemple "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écompense, par exemple "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.
rewardsTier

string

Niveau de récompense, 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 le nom du programme. L'application peut afficher des points de suspension après les 20 premiers caractères pour que la chaîne s'affiche entièrement sur les écrans de petite taille.
localizedAccountNameLabel

object (LocalizedString)

Chaînes traduites pour le compteNameLabel. 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 le compteIdLabel. 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 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 rewardsTier. 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 secondaire de récompense, par exemple "Niveau de récompense".
localizedSecondaryRewardsTierLabel

object (LocalizedString)

Chaînes traduites pour secondaryRewardsTierLabel.
secondaryRewardsTier

string

Niveau secondaire de récompense, par exemple "Or" ou "Platine".
localizedSecondaryRewardsTier

object (LocalizedString)

Chaînes traduites pour le secondaryRewardsTier.
discoverableProgram

object (DiscoverableProgram)

Informations sur la façon dont la classe peut être découverte et instanciée depuis l'application Google Pay.
classTemplateInfo

object (ClassTemplateInfo)

Informations du modèle sur la façon dont le cours doit s'afficher. Si ce paramètre n'est pas défini, Google utilisera un ensemble de champs par défaut à afficher.
id

string

Obligatoire. Identifiant unique d'un cours. Cet ID doit être unique pour toutes les classes 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. Votre identifiant unique ne doit contenir que des caractères alphanumériques, des points, des traits de soulignement ou des tirets.
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 qui lui sont associés. Le nombre maximal de ces champs est de 10.
allowMultipleUsersPerObject
(deprecated)

boolean

Obsolète. Utilisez multipleDevicesAndHoldersAllowedStatus à la place.
homepageUri

object (Uri)

URI de la page d'accueil de votre application. Renseigner l'URI dans ce champ produit 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 qui est généralement considéré comme la section linksModuleData de l'objet).
locations[]
(deprecated)

object (LatLongPoint)

Remarque: Il n'est actuellement pas possible d'utiliser ce champ pour déclencher des notifications géo.
reviewStatus

enum (ReviewStatus)

Obligatoire. État de la classe. Ce champ peut être défini sur draft ou underReview à l'aide des appels d'API insert, patch ou update. Une fois que l'état de l'examen est passé de draft, il ne peut plus être rétabli à draft.

Laissez ce champ 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 à être utilisée. La plate-forme définira automatiquement ce champ sur approved, et vous pourrez immédiatement l'utiliser pour créer ou migrer des objets.

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

object (Review)

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

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 le cours, les deux sont affichées. Le nombre maximal de ces champs affichés est de 10 pour l'objet et de 10 pour la classe.
redemptionIssuers[]

string (int64 format)

Indique les émetteurs d'offres qui peuvent utiliser la carte via le sans contact avancé. Les émetteurs d'offres sont identifiés par leur ID d'émetteur. Les émetteurs de bons doivent avoir au moins une clé Smart Tap configurée.

Les champs 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 fiche (lorsque l'utilisateur ne se trouve pas dans ce pays), ainsi que pour afficher du contenu localisé lorsque celui-ci n'est pas disponible dans la langue de l'utilisateur.
heroImage

object (Image)

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

object (Image)

Obsolète.
enableSmartTap

boolean

Indique si cette classe est compatible avec le Sans contact avancé. Les champs 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 fiche. Si cette couleur d'arrière-plan 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 au format hexadécimal, tel que #ffcc00. Vous pouvez également utiliser la version abrégée du triplet RVB (#rgb), telle que #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 enregistrent le même objet faisant 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 peuvent utiliser 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 informations de la carte.
viewUnlockRequirement

enum (ViewUnlockRequirement)

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

enum (NotificationSettingsForUpdates)

Indique si les mises à jour de champ de cette classe doivent déclencher des notifications. Si la valeur est NOTIFY, nous tenterons de déclencher une notification de mise à jour de champ auprès des utilisateurs. Ces notifications ne sont envoyées aux utilisateurs que si le champ figure sur une liste d'autorisation. Si aucune valeur n'est spécifiée, aucune notification n'est 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 du module avec valeur ajoutée facultative. Maximum de 10 pour le cours. Pour une carte, seules dix cartes s'affichent, en privilégiant celles de l'objet.

DiscoverableProgram

Informations sur la façon dont une classe peut être découverte et instanciée depuis l'application Android Pay. Pour ce faire, recherchez un programme de fidélité ou une carte cadeau, puis scannez-la ou saisissez-la 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 une valeur pour ce programme via le site d'un marchand. Utilisé lorsque MERCHANT_HOSTED_SIGNUP est activé.
merchantSigninInfo

object (DiscoverableProgramMerchantSigninInfo)

Informations sur la possibilité de se connecter et d'ajouter une valeur pour ce programme via le site d'un marchand. Utilisé lorsque MERCHANT_HOSTED_SIGNIN est activé.
state

enum (State)

État de visibilité du programme visible.

DiscoverableProgramMerchantSignupInfo

Informations sur la procédure d'inscription hébergée par le marchand pour un programme.

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

object (Uri)

URL vers laquelle rediriger l'utilisateur pour accéder au site d'inscription du marchand.
signupSharedDatas[]

enum (SharedDataType)

Données utilisateur envoyées dans une requête 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 de visibilité.

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 la procédure de connexion hébergée par le marchand pour un programme.

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

object (Uri)

URL redirigeant l'utilisateur vers 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

 Renvoie la classe de fidélité associée à l'ID de classe donné.

insert

 Insère une classe de fidélité avec l'ID et les propriétés donné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é.