Ressource: GiftCardClass
Représentation JSON |
---|
{ "kind": string, "merchantName": string, "programLogo": { object ( |
Champs | |
---|---|
kind |
Identifie le type de ressource. Valeur : chaîne fixe |
merchant |
Nom du marchand (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. |
program |
Logo du programme de cartes cadeaux ou de l'entreprise. Ce logo s'affiche dans les vues détaillée et Liste de l'application. |
pin |
Libellé à afficher pour le code PIN (par exemple, "Code PIN à 4 chiffres"). |
event |
Libellé à afficher pour le numéro d'événement, par exemple "Numéro de l'événement cible". |
allow |
Indique si le marchand accepte les cartes cadeaux avec code-barres. Si cette valeur est définie sur "true", l'application affiche un code-barres pour la carte sur l'écran "Informations sur la carte". Si la valeur est "false", aucun code-barres n'est affiché. |
localized |
Chaînes traduites pour merchantName. 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. |
localized |
Chaînes traduites pour le pinLabel. |
localized |
Chaînes traduites pour eventNumberLabel. |
card |
Libellé à afficher pour le numéro de carte, tel que "Numéro de carte". |
localized |
Chaînes traduites pour le cardNumberLabel. |
class |
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 |
Obligatoire. Identifiant unique d'un cours. Cet ID doit être unique parmi 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 |
Obsolète |
issuer |
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 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 |
Obsolète. Utilisez |
homepage |
URI de la page d'accueil de votre application. Renseigner l'URI dans ce champ entraîne 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[] |
Remarque : Il n'est actuellement pas possible d'utiliser ce champ pour déclencher des notifications géo. |
review |
Obligatoire. État du cours. Ce champ peut être défini sur Laissez ce champ défini sur Vous devez définir ce champ sur Lorsque vous mettez à jour une classe |
review |
Commentaires d'évaluation définis par la plate-forme lorsqu'un cours est marqué |
infoModuleData |
Obsolète. Utilisez plutôt textModulesData. |
image |
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. |
text |
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. |
links |
Données du module de liens. Si des données du module de liens sont également définies sur l'objet, les deux sont affichées. |
redemption |
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 d'offres doivent avoir configuré au moins une clé Smart Tap. Les champs |
country |
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 la langue de l'utilisateur. |
hero |
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 |
Obsolète. |
enable |
Indique si cette classe est compatible avec le Sans contact avancé. Les champs |
hex |
Couleur d'arrière-plan de la carte. 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 |
localized |
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. |
multiple |
Indique si plusieurs utilisateurs et appareils enregistrent le même objet faisant référence à cette classe. |
callback |
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 au rappel. |
security |
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. |
view |
Afficher les options de conditions de déverrouillage pour la carte |
wide |
Logo large du programme de fidélité ou de l'entreprise. Lorsqu'il est fourni, il sera utilisé à la place du logo du programme en haut à gauche de la vue Fiche. |
notify |
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. |
app |
Lien vers une application ou un site Web facultatif qui s'affiche sous forme de bouton sur le recto de la carte. Si AppLinkData est fourni pour l'objet correspondant, il sera utilisé à la place. |
value |
Données facultatives du module à valeur ajoutée. Dix maximum pour la classe. Pour une carte, seules dix cartes s'affichent, en privilégiant celles de l'objet. |
Méthodes |
|
---|---|
|
Ajoute un message à la classe de carte cadeau référencée par l'ID de classe donné. |
|
Renvoie la classe de carte de fidélité avec l'ID de classe donné. |
|
Insère une classe de bons d'achat avec l'ID et les propriétés donné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é. |