Cette page a été traduite par l'API Cloud Translation.

REST Resource: giftcardobject

Ressource: OfferCardObject
- Représentation JSON
Méthodes

Ressource: GiftCardObject

Représentation JSON

Représentation JSON
{ "kind": string, "classReference": { object (`GiftCardClass`) }, "cardNumber": string, "pin": string, "balance": { object (`Money`) }, "balanceUpdateTime": { object (`DateTime`) }, "eventNumber": string, "id": string, "classId": string, "version": string, "state": enum (`State`), "barcode": { object (`Barcode`) }, "messages": [ { object (`Message`) } ], "validTimeInterval": { object (`TimeInterval`) }, "locations": [ { object (`LatLongPoint`) } ], "hasUsers": boolean, "smartTapRedemptionValue": string, "hasLinkedDevice": boolean, "disableExpirationNotification": boolean, "infoModuleData": { object (`InfoModuleData`) }, "imageModulesData": [ { object (`ImageModuleData`) } ], "textModulesData": [ { object (`TextModuleData`) } ], "linksModuleData": { object (`LinksModuleData`) }, "appLinkData": { object (`AppLinkData`) }, "rotatingBarcode": { object (`RotatingBarcode`) }, "heroImage": { object (`Image`) }, "groupingInfo": { object (`GroupingInfo`) }, "passConstraints": { object (`PassConstraints`) }, "saveRestrictions": { object (`SaveRestrictions`) }, "linkedObjectIds": [ string ], "notifyPreference": enum (`NotificationSettingsForUpdates`), "valueAddedModuleData": [ { object (`ValueAddedModuleData`) } ] }

{
  "kind": string,
  "classReference": {
    object (GiftCardClass)
  },
  "cardNumber": string,
  "pin": string,
  "balance": {
    object (Money)
  },
  "balanceUpdateTime": {
    object (DateTime)
  },
  "eventNumber": string,
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}

Champs
`kind (deprecated)`	`string` Cet élément est obsolète. Identifie le type de ressource. Valeur : chaîne fixe `"walletobjects#giftCardObject"`.
`classReference`	`object (GiftCardClass)` Copie des champs hérités de la classe parente. Ces champs sont récupérés lors d'une requête GET.
`cardNumber`	`string` Obligatoire. Numéro de la carte.
`pin`	`string` Code de la carte
`balance`	`object (Money)` Solde de la carte en devise.
`balanceUpdateTime`	`object (DateTime)` Date et heure de la dernière mise à jour du solde. Veuillez indiquer un décalage. Si le solde est mis à jour et que cette propriété n'est pas fournie, le système utilise l'heure actuelle par défaut.
`eventNumber`	`string` Numéro d'événement de la carte, champ facultatif utilisé par certaines cartes cadeaux.
`id`	`string` Obligatoire. Identifiant unique d'un objet Cet ID doit être unique parmi tous les objets 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. L'identifiant unique ne doit contenir que des caractères alphanumériques, des points, des traits d'union ou des tirets.
`classId`	`string` Obligatoire. Classe associée à cet objet. La classe doit être du même type que cet objet, doit déjà exister et doit être approuvée. Les ID de classe doivent respecter le format `issuer ID`.`identifier`, où le premier est émis par Google et le second est choisi par vous.
`version (deprecated)`	`string (int64 format)` Cet élément est obsolète. Obsolète
`state`	`enum (State)` Obligatoire. État de l'objet. Ce champ permet de déterminer la manière dont un objet s'affiche dans l'application. Par exemple, un objet `inactive` est déplacé dans la section "Cartes expirées".
`barcode`	`object (Barcode)` Type et valeur du code-barres.
`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.
`validTimeInterval`	`object (TimeInterval)` Période pendant laquelle cet objet sera `active` et pourra être utilisé. L'état d'un objet passe à `expired` une fois ce délai écoulé.
`locations[] (deprecated)`	`object (LatLongPoint)` Cet élément est obsolète. Remarque : Il n'est actuellement pas possible d'utiliser ce champ pour déclencher des notifications géo.
`hasUsers`	`boolean` Indique si l'objet a des utilisateurs. Ce champ est défini par la plate-forme.
`smartTapRedemptionValue`	`string` Valeur qui sera transmise à un terminal certifié Smart Tap via NFC pour cet objet. Les champs `enableSmartTap` et `redemptionIssuers` au niveau de la classe doivent également être correctement configurés pour que la carte soit compatible avec Smart Tap. Seuls les caractères ASCII sont acceptés.
`hasLinkedDevice`	`boolean` Indique si cet objet est actuellement associé à un seul appareil. Ce champ est défini par la plate-forme lorsqu'un utilisateur enregistre l'objet et l'associe à son appareil. Destiné à certains partenaires. Pour en savoir plus, contactez l'assistance.
`disableExpirationNotification`	`boolean` Indique si les notifications doivent être supprimées explicitement. Si ce champ est défini sur "True", les notifications d'expiration envoyées à l'utilisateur sont supprimées, quel que soit le champ `messages`. Par défaut, ce champ est défini sur "false". Pour le moment, cette option ne peut être définie que pour les offres.
`infoModuleData`	`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 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 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.
`linksModuleData`	`object (LinksModuleData)` Données du module de liens. Si les données du module de liens sont également définies sur la classe, les deux s'affichent.
`appLinkData`	`object (AppLinkData)` 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 la classe correspondante, seul l'objet AppLinkData sera affiché.
`rotatingBarcode`	`object (RotatingBarcode)` Type et valeur du code-barres rotatif.
`heroImage`	`object (Image)` Image de bannière facultative affichée sur le recto de la fiche. Si aucune image n'est présente, l'image héros de la classe, le cas échéant, s'affiche. Si l'image héros du cours n'est pas non plus présente, rien ne s'affiche.
`groupingInfo`	`object (GroupingInfo)` Information qui gère le regroupement des cartes.
`passConstraints`	`object (PassConstraints)` Transmettez les contraintes de l'objet. Inclut la limitation des comportements NFC et des captures d'écran.
`saveRestrictions`	`object (SaveRestrictions)` Restrictions sur l'objet qui doit être vérifié avant que l'utilisateur ne tente d'enregistrer la carte. Notez que ces restrictions ne s'appliquent qu'au moment de l'enregistrement. Si les restrictions ont changé après qu'un utilisateur a enregistré la carte, les nouvelles restrictions ne s'appliquent pas à une carte déjà enregistrée.
`linkedObjectIds[]`	`string` L'élément linkedObjectIds est une liste d'autres objets, tels que billet pour un événement, carte de fidélité, offre, générique, carte cadeau, carte de transport et carte d'embarquement, qui doit être automatiquement associé à cet objet carte cadeau. Si un utilisateur a enregistré cette carte, ces linkedObjectIds sont automatiquement transmis à son portefeuille (sauf s'il a désactivé le paramètre permettant de recevoir ces cartes associées). Assurez-vous que les objets présents dans linkedObjectIds sont déjà insérés. Sinon, les appels échoueront. Une fois associés, les objets ne peuvent plus être dissociés. Vous ne pouvez pas associer d'objets appartenant à un autre émetteur. Le nombre d'objets pouvant être associés à un même objet est limité. Une fois la limite atteinte, les nouveaux objets associés dans l'appel sont ignorés sans notification. Les ID d'objet doivent respecter le format `issuer ID`.`identifier`, où le premier est émis par Google et le second est choisi par vous.
`notifyPreference`	`enum (NotificationSettingsForUpdates)` Indique si les mises à jour de champ de cet objet doivent déclencher des notifications. Si cet indicateur est défini sur NOTIFY, nous essayons de déclencher une notification de mise à jour des champs pour les utilisateurs. Ces notifications ne sont envoyées aux utilisateurs que si le champ figure sur une liste d'autorisation. Si la valeur est DO_NOT_NOTIFY ou NOTIFICATION_SETTINGS_UNSPECIFIED, aucune notification ne sera 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. 10 maximum sur l'objet.

Méthodes
`addmessage`	Ajoute un message à l'objet Carte cadeau référencé par l'ID d'objet donné.
`get`	Renvoie l'objet de carte cadeau avec l'ID d'objet donné.
`insert`	Insère un objet carte-cadeau avec l'ID et les propriétés donnés.
`list`	Renvoie la liste de tous les objets de carte de cadeau pour un ID d'émetteur donné.
`patch`	Met à jour l'objet Carte cadeau référencé par l'ID d'objet donné.
`update`	Met à jour l'objet Carte cadeau référencé par l'ID d'objet donné.

REST Resource: giftcardobject

Ressource: GiftCardObject

Méthodes

`addmessage`

`get`

`insert`

`list`

`patch`

`update`