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,
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  }
}
Champs
genericType

enum (GenericType)

Spécifiez le GenericType auquel la carte appartient.

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 tout en haut de la carte.

subheader

object (LocalizedString)

Titre de la carte, comme l'emplacement où elle peut être utilisée. S'affiche juste au-dessus du titre dans la ligne de titre de la vue détaillée de la carte.

header

object (LocalizedString)

Obligatoire. Titre de la carte, par exemple "Bon de réduction de 50 %" ou "Fiche de bibliothèque" ou "Coupon". Ce champ est obligatoire et apparaît sur la ligne de titre de la vue détaillée de la carte.

hexBackgroundColor

string

Couleur d'arrière-plan de la carte. Si cette règle n'est pas configurée, 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. Si aucun logo n'est défini, Google en choisit une.

notifications

object (Notifications)

Paramètres de notification activés pour cet objet.

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 issuerID.identifier, où issuerID est émis par Google et identifier est choisi par vous. L'identifiant unique ne peut contenir que des caractères alphanumériques, ainsi que des ., _ ou -.

classId

string

Obligatoire. Classe associée à cet objet. La classe doit être du même type que cet objet, existe déjà 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 ne comporte pas de code-barres, nous pouvons autoriser l'émetteur à définir "Barcode.sub_text" et à n'afficher que ce code.

heroImage

object (Image)

Image de bannière affichée au recto de la carte, le cas échéant. L'image s'affiche avec une largeur de 100 %.

validTimeInterval

object (TimeInterval)

Période pendant laquelle cet objet sera considéré comme valide ou utilisable. Une fois le délai écoulé, l'objet est considéré comme expiré, ce qui affecte l'affichage sur les appareils de l'utilisateur.

imageModulesData[]

object (ImageModuleData)

Données du module d'image. Une seule image de la classe et une image issue de l'objet sont affichées lorsque les deux valeurs 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 10 pour la classe et 10 pour l'objet.

groupingInfo

object (GroupingInfo)

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

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.

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

passConstraints

object (PassConstraints)

Transmettez des contraintes pour l'objet. y compris la limitation du NFC et les comportements 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 changent après qu'un utilisateur a enregistré la carte, les nouvelles restrictions ne s'appliquent pas à une carte déjà enregistrée.

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_OTHER Autre type

Notifications

Indique si les notifications doivent être activées pour l'objet. Nous n'acceptons qu'un seul élément "ExpiryNotification/identifiant Notification". 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 précis avant l'expiration de la carte.

upcomingNotification

object (UpcomingNotification)

Une notification est déclenchée à un moment précis 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 associé à l'ID d'objet indiqué.

insert

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

list

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