- Ressource: OfferCardClass
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Méthodes
Ressource: OfferCardClass
Représentation JSON |
---|
{ "kind": string, "merchantName": string, "programLogo": { object ( |
Champs | |
---|---|
kind |
Identifie le type de ressource. Valeur: chaîne fixe |
merchantName |
Nom du marchand, 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. |
programLogo |
Logo du programme de cartes cadeaux ou de l'entreprise. Ce logo s'affiche à la fois dans les détails et dans la liste de l'application. |
pinLabel |
Libellé à afficher pour le code, par exemple "Code PIN à 4 chiffres". |
eventNumberLabel |
Libellé à afficher pour le numéro d'événement (par exemple, "Numéro d'événement cible"). |
allowBarcodeRedemption |
Détermine si le marchand accepte l'utilisation de cartes cadeaux à l'aide d'un code-barres. Si la valeur est "true", l'application affiche le code-barres de la carte sur l'écran "Détails de la carte". Si la valeur est "false", aucun code-barres ne s'affiche. |
localizedMerchantName |
Chaînes traduites pour merchantName. 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. |
localizedPinLabel |
Chaînes traduites pour pinLabel. |
localizedEventNumberLabel |
Chaînes traduites pour eventNumberLabel. |
cardNumberLabel |
Libellé à afficher pour le numéro de carte, tel que "Numéro de carte". |
localizedCardNumberLabel |
Chaînes traduites pour cardNumberLabel. |
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 |
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 |
Obsolète |
issuerName |
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[] |
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 |
Obsolète. Utilisez |
homepageUri |
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[] |
Remarque: Actuellement, ce champ ne permet pas de déclencher des notifications géographiques. |
reviewStatus |
Obligatoire. État du cours. Ce champ peut être défini sur Ce champ doit rester défini sur Vous devez définir ce champ sur Lorsque vous mettez à jour une classe déjà |
review |
Commentaires sur l'avis définis par la plate-forme lorsqu'un cours est marqué comme |
infoModuleData |
Obsolète. Utilisez textModulesData à la place. |
imageModulesData[] |
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[] |
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. |
linksModuleData |
Données du module de liens. Si les données du module de liens sont également définies sur l'objet, les deux s'affichent. |
redemptionIssuers[] |
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 |
countryCode |
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 |
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 |
Obsolète. |
enableSmartTap |
Indique si cette classe est compatible avec Smart Tap. Les champs |
hexBackgroundColor |
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 |
localizedIssuerName |
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 |
Indique si plusieurs utilisateurs et appareils enregistreront le même objet faisant référence à cette classe. |
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 |
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 |
Affichez les conditions de déverrouillage pour la carte cadeau. |
wideProgramLogo |
Logo large du programme de cartes cadeaux ou de l'entreprise. Lorsqu'il est fourni, il sera utilisé à la place du logo du programme en haut à gauche de la vue Fiche. |
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 l'objet correspondant, il est utilisé à la place. |
Méthodes |
|
---|---|
|
Ajoute un message à la classe de carte cadeau référencée par l'ID de classe donné. |
|
Affiche la classe de carte cadeau avec l'ID de classe donné. |
|
Insère une classe de carte cadeau avec l'identifiant et les propriétés indiqués. |
|
Affiche la liste de toutes les classes de cartes cadeaux pour un ID d'émetteur donné. |
|
Met à jour la classe de carte cadeau référencée par l'ID de classe donné. |
|
Met à jour la classe de carte cadeau référencée par l'ID de classe donné. |