REST Resource: giftcardclass

Ressource: GiftCardClass

Représentation JSON
{
  "kind": string,
  "merchantName": string,
  "programLogo": {
    object (Image)
  },
  "pinLabel": string,
  "eventNumberLabel": string,
  "allowBarcodeRedemption": boolean,
  "localizedMerchantName": {
    object (LocalizedString)
  },
  "localizedPinLabel": {
    object (LocalizedString)
  },
  "localizedEventNumberLabel": {
    object (LocalizedString)
  },
  "cardNumberLabel": string,
  "localizedCardNumberLabel": {
    object (LocalizedString)
  },
  "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#giftCardClass".

merchantName

string

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.

pinLabel

string

Libellé à afficher pour le code PIN (par exemple, "Code PIN à 4 chiffres").

eventNumberLabel

string

Libellé à afficher pour le numéro d'événement, par exemple "Numéro de l'événement cible".

allowBarcodeRedemption

boolean

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

localizedMerchantName

object (LocalizedString)

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.

localizedPinLabel

object (LocalizedString)

Chaînes traduites pour le pinLabel.

localizedEventNumberLabel

object (LocalizedString)

Chaînes traduites pour eventNumberLabel.

cardNumberLabel

string

Libellé à afficher pour le numéro de carte, tel que "Numéro de carte".

localizedCardNumberLabel

object (LocalizedString)

Chaînes traduites pour le cardNumberLabel.

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 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
(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 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[]
(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 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 a été modifié 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 d'offres doivent avoir configuré au moins une clé Smart Tap.

Les champs enableSmartTap et smartTapRedemptionLevel au niveau de l'objet doivent également être configurés correctement pour qu'une carte soit compatible avec le sans contact avancé.

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 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 smartTapRedemptionLevel au niveau de l'objet doivent également être configurés correctement pour qu'une carte soit compatible avec le sans contact avancé.

hexBackgroundColor

string

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 #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 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)

Afficher les options de conditions de déverrouillage pour la carte

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 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

addmessage

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

get

Renvoie la classe de carte de fidélité avec l'ID de classe donné.

insert

Insère une classe de bons d'achat avec l'ID et les propriétés donnés.

list

Affiche la liste de toutes les classes de cartes cadeaux pour un ID d'émetteur donné.

patch

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

update

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