REST Resource: offerobject

Ressource: OfferObject

Représentation JSON 
{
  "kind": string,
  "classReference": {
    object (OfferClass)
  },
  "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

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

object (OfferClass)

Copie des champs hérités de la classe parente. Ces champs sont récupérés lors d'une requête GET.
id

string

Obligatoire. Identifiant unique d'un objet Cet identifiant doit être unique pour 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, ainsi que des symboles ".", "_" ou "-".
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)

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 10.
validTimeInterval

object (TimeInterval)

Période pendant laquelle cet objet sera active et pourra être utilisé. L'état d'un objet passera à expired une fois cette période écoulée.
locations[]

object (LatLongPoint)

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 de niveau de classe enableSmartTap et redemptionIssuers doivent également être configurés correctement 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, en l'associant à 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".

Actuellement, cela ne peut être défini que pour les offres.
infoModuleData

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

object (RotatingBarcode)

Type et valeur du code-barres rotatif.
heroImage

object (Image)

Image de bannière facultative qui s'affiche au recto de la carte. 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)

Informations qui contrôlent la manière dont les cartes sont regroupées.
passConstraints

object (PassConstraints)

Transmettez des contraintes pour l'objet. Inclut la limitation des comportements NFC et des captures d'écran.
saveRestrictions

object (SaveRestrictions)

Restrictions concernant l'objet qui doivent être validées avant que l'utilisateur ne tente d'enregistrer la carte. Notez que ces restrictions ne seront appliquées que pendant la sauvegarde. 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

Les linkedObjectIds sont une liste d'autres objets tels que des billets pour des événements, des cartes de fidélité, des offres, des génériques, des cartes cadeaux, des titres de transport et des cartes d'embarquement qui doivent être automatiquement associés à cet objet d'offre. Si un utilisateur a enregistré cette offre, 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 seul objet est limité. Une fois la limite atteinte, les nouveaux objets associés de l'appel sont ignorés sans notification.

Les ID des objets 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 des champs de cet objet doivent déclencher ou non 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 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. Dix au maximum sur l'objet.

Méthodes

addmessage

 Ajoute un message à l'objet "offre" référencé par l'ID d'objet donné.

get

 Renvoie l'objet "offre" avec l'ID d'objet donné.

insert

 Insère un objet d'offre avec l'ID et les propriétés donnés.

list

 Renvoie la liste de tous les objets d'offre pour un ID d'émetteur donné.

patch

 Met à jour l'objet "offre" référencé par l'ID d'objet donné.

update

 Met à jour l'objet "offre" référencé par l'ID d'objet donné.