REST Resource: genericobject

Ressource: GenericObject

ID suivant de l'objet générique: 121

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)
  }
}
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 "XXX Gym" ou "AAA Insurance". Ce champ est obligatoire et apparaît dans la ligne d'en-tête tout en haut de la carte.
subheader

object (LocalizedString)

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

object (LocalizedString)

Obligatoire. Titre de la carte, tel que "50% de réduction" ou "Carte 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 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. Si le logo n'est pas défini, 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 peut contenir que des caractères alphanumériques, ainsi que des caractères ., _ 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 ê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 bannière affichée au recto de la carte, le cas échéant. L'image sera affichée à 100% de la largeur.
validTimeInterval

object (TimeInterval)

Durée pendant laquelle cet objet est considéré comme valide ou utilisable. Une fois cette période écoulée, l'objet sera considéré comme expiré, ce qui aura une incidence sur l'affichage sur les appareils des utilisateurs.
imageModulesData[]

object (ImageModuleData)

Données de module d'image. Une seule image de la classe et une autre au niveau de l'objet seront affichées lorsque les deux seront définies.
textModulesData[]

object (TextModuleData)

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

object (GroupingInfo)

Informations qui contrôlent la façon 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 façon dont un objet s'affiche dans l'application. Par exemple, un objet inactive est déplacé vers la section "Cartes expirées". Si cet attribut n'est pas fourni, l'objet sera considéré comme ACTIVE.
hasUsers

boolean

Indique si l'objet a des utilisateurs. Ce champ est défini par la plate-forme.
passConstraints

object (PassConstraints)

Transmettez des contraintes pour l'objet. Cela inclut la limitation des comportements liés à la technologie NFC et aux captures d'écran.

GenericType

Type de fiche générique.

Enums
GENERIC_TYPE_UNSPECIFIED Type générique non spécifié.
GENERIC_SEASON_PASS Pass saisonnier
GENERIC_UTILITY_BILLS Factures émanant de services publics
GENERIC_PARKING_PASS Titre 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'une seule des notifications ExpiryNotification/FutureNotification. 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)

Vous recevrez une notification à 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 concernant la validité de la carte un jour avant qu'elle ne soit valide/utilisable.

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

boolean

Indique si la notification des événements à venir doit être activée 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 indiqué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é.