REST Resource: genericobject

Ressource: GenericObject

Objet générique

Représentation JSON 
{
  "genericType": enum (GenericType),
  "cardTitle": {
    object (LocalizedString)
  },
  "subheader": {
    object (LocalizedString)
  },
  "header": {
    object (LocalizedString)
  },
  "logo": {
    object (Image)
  },
  "hexBackgroundColor": string,
  "notifications": {
    object (Notifications)
  },
  "id": string,
  "classId": string,
  "barcode": {
    object (Barcode)
  },
  "heroImage": {
    object (Image)
  },
  "validTimeInterval": {
    object (TimeInterval)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "smartTapRedemptionValue": string,
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "state": enum (State),
  "hasUsers": boolean,
  "messages": [
    {
      object (Message)
    }
  ],
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ],
  "linkedObjectIds": [
    string
  ]
}
Champs
genericType

enum (GenericType)

Indique le type GenericType de la carte.
cardTitle

object (LocalizedString)

Obligatoire. En-tête de la carte. Il s'agit généralement du nom de l'entreprise, tel que "Salle de sport XXX" ou "Assurance AAA". Ce champ est obligatoire et apparaît dans la ligne d'en-tête en haut de la carte.
subheader

object (LocalizedString)

Libellé du titre de la carte, par exemple le lieu où elle peut être utilisée. S'affiche juste au-dessus du titre dans la ligne de titre de la vue d'informations de la carte.
header

object (LocalizedString)

Obligatoire. Titre de la carte, par exemple "Bon de 50% de remise", "Carte de bibliothèque" ou "Bon". Ce champ est obligatoire et s'affiche dans la ligne de titre de la vue d'informations de la carte.
hexBackgroundColor

string

Couleur d'arrière-plan de la fiche. 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. En l'absence de logo, Google choisit une couleur.
notifications

object (Notifications)

Paramètres de notification activés pour cet objet.
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 issuerID.identifier où issuerID est émis par Google et identifier est choisi par vous. L'identifiant unique ne doit contenir que des caractères alphanumériques, des points (.), des traits de soulignement (_) 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 issuerID.identifier, où issuerID est émis par Google et identifier est choisi par vous.
barcode

object (Barcode)

Type et valeur du code-barres. Si la carte n'a pas de code-barres, nous pouvons autoriser l'émetteur à définir Barcode.alternate_text et à n'afficher que celui-ci.
heroImage

object (Image)

Image de la bannière affichée sur le recto de la carte, le cas échéant. L'image s'affichera sur 100% de la largeur.
validTimeInterval

object (TimeInterval)

Période pendant laquelle cet objet sera considéré comme valide ou utilisable. Une fois ce délai écoulé, l'objet est considéré comme expiré, ce qui affecte le rendu sur les appareils des utilisateurs.
imageModulesData[]

object (ImageModuleData)

Données du module d'image. Seule l'une des images au niveau de la classe et l'autre au niveau de l'objet seront affichées si les deux sont définies.
textModulesData[]

object (TextModuleData)

Données du module de texte. Si textModulesData est également défini sur la classe, les deux sont affichés. Le nombre maximal de ces champs affichés est de 10 pour la classe et de 10 pour l'objet.
groupingInfo

object (GroupingInfo)

Information qui gère le regroupement des cartes.
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.
rotatingBarcode

object (RotatingBarcode)

Paramètres/Détails du code-barres rotatif
state

enum (State)

É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". Si cette valeur n'est pas fournie, l'objet est considéré comme ACTIVE.
hasUsers

boolean

Indique si l'objet comporte des utilisateurs. Ce champ est défini par la plate-forme.
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.
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 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.
valueAddedModuleData[]

object (ValueAddedModuleData)

Données du module avec valeur ajoutée facultative. Dix au maximum sur l'objet.
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 générique. Si un utilisateur a enregistré cette carte générique, ces linkedObjectIds sont automatiquement transmis à son portefeuille (sauf s'il a désactivé le paramètre permettant de recevoir ces cartes associées).

Vérifiez que les objets présents dans linkedObjectIds sont déjà insérés. Dans le cas contraire, les appels échoueront. Une fois associés, les objets ne peuvent plus être dissociés. Vous ne pouvez pas associer des 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.

GenericType

Type de la fiche générique.

Enums
GENERIC_TYPE_UNSPECIFIED Type générique non spécifié.
GENERIC_SEASON_PASS Pass saisonnier
GENERIC_UTILITY_BILLS Factures de charge courante
GENERIC_PARKING_PASS Carte de stationnement
GENERIC_VOUCHER Coupon
GENERIC_GYM_MEMBERSHIP Abonnements de gym
GENERIC_LIBRARY_MEMBERSHIP Cartes de bibliothèque
GENERIC_RESERVATIONS Réservations
GENERIC_AUTO_INSURANCE Cartes d'assurance auto
GENERIC_HOME_INSURANCE Cartes d'assurance habitation
GENERIC_ENTRY_TICKET Billets d'entrée
GENERIC_RECEIPT Reçus
GENERIC_LOYALTY_CARD Cartes de fidélité Veuillez noter qu'il est recommandé d'utiliser un type de carte de fidélité dédié plutôt que ce type générique. Un type de carte de fidélité dédié offre plus de fonctionnalités qu'un type de carte générique.
GENERIC_OTHER Autre type

Notifications

Indique si les notifications doivent être activées pour l'objet. Nous n'acceptons qu'un seul des éléments ExpiryNotification/UpcomingNotification. expiryNotification est prioritaire sur upcomingNotification. En d'autres termes, si expiryNotification est défini, nous ignorons le champ upcomingNotification.

Représentation JSON 
{
  "expiryNotification": {
    object (ExpiryNotification)
  },
  "upcomingNotification": {
    object (UpcomingNotification)
  }
}
Champs
expiryNotification

object (ExpiryNotification)

Une notification est déclenchée à un moment spécifique avant l'expiration de la carte.
upcomingNotification

object (UpcomingNotification)

Une notification est déclenchée à un moment spécifique avant que la carte ne soit utilisable.

ExpiryNotification

Indique que l'émetteur souhaite que Google Wallet envoie des notifications d'expiration deux jours avant l'expiration de la carte.

Représentation JSON 
{
  "enableNotification": boolean
}
Champs
enableNotification

boolean

Indique si la notification d'expiration doit être activée pour l'objet.

UpcomingNotification

Indique que l'émetteur souhaite que Google Wallet envoie une notification de validité de la carte un jour avant que la carte ne soit valide/utilisable.

Représentation JSON 
{
  "enableNotification": boolean
}
Champs
enableNotification

boolean

Indique si les notifications de disponibilité doivent être activées pour l'objet.

Méthodes

addmessage

 Ajoute un message à l'objet générique référencé par l'ID d'objet donné.

get

 Renvoie l'objet générique avec l'ID d'objet donné.

insert

 Insère un objet générique avec l'ID et les propriétés donnés.

list

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

patch

 Met à jour l'objet générique référencé par l'ID d'objet donné.

update

 Met à jour l'objet générique référencé par l'ID d'objet donné.