REST Resource: giftcardclass

Ressource: OfferCardClass

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

string

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

merchantName

string

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.

pinLabel

string

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

eventNumberLabel

string

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

allowBarcodeRedemption

boolean

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

object (LocalizedString)

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

object (LocalizedString)

Chaînes traduites pour 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 cardNumberLabel.

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.

Les champs enableSmartTap et smartTapRedemptionLevel au niveau de l'objet doivent également être correctement configurés 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 la langue 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. Les champs redemptionIssuers et smartTapRedemptionLevel au niveau de l'objet doivent également être correctement configurés 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 cadeau.

Méthodes

addmessage

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

get

Affiche la classe de carte cadeau avec l'ID de classe donné.

insert

Insère une classe de carte cadeau avec l'identifiant et les propriétés indiqué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é.