REST Resource: offerclass

Ressource: OfferClass

Représentation JSON 
{
  "kind": string,
  "title": string,
  "redemptionChannel": enum (RedemptionChannel),
  "provider": string,
  "titleImage": {
    object (Image)
  },
  "details": string,
  "finePrint": string,
  "helpUri": {
    object (Uri)
  },
  "localizedTitle": {
    object (LocalizedString)
  },
  "localizedProvider": {
    object (LocalizedString)
  },
  "localizedDetails": {
    object (LocalizedString)
  },
  "localizedFinePrint": {
    object (LocalizedString)
  },
  "shortTitle": string,
  "localizedShortTitle": {
    object (LocalizedString)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideTitleImage": {
    object (Image)
  },
  "appLinkData": {
    object (AppLinkData)
  }
}
Champs
kind
(deprecated)

string

Identifie le type de ressource. Valeur: chaîne fixe "walletobjects#offerClass".
title

string

Obligatoire. Titre de l'offre, par exemple "20% de remise sur n'importe quel t-shirt". La longueur maximale recommandée est de 60 caractères, afin de garantir que la chaîne s'affiche entièrement sur des écrans de petite taille.
redemptionChannel

enum (RedemptionChannel)

Obligatoire. Les canaux d'utilisation applicables à cette offre
provider

string

Obligatoire. Le fournisseur de l'offre (nom de l'agrégateur ou du marchand). La longueur maximale recommandée est de 12 caractères, afin de garantir que la chaîne s'affiche entièrement sur des écrans de petite taille.
titleImage

object (Image)

Image du titre de l'offre. Cette image s'affiche à la fois dans les vues "Détails" et "Liste" de l'application.
details

string

Détails de l'offre.
finePrint

string

Les conditions d'utilisation ou les conditions d'utilisation de l'offre, telles que "20% de réduction sur n'importe quel t-shirt chez Vêtements d'Adam".
helpUri

object (Uri)

Lien d'aide de l'offre, par exemple http://myownpersonaldomain.com/help
localizedTitle

object (LocalizedString)

Chaînes traduites pour le titre. La longueur maximale recommandée est de 60 caractères, afin de garantir que la chaîne s'affiche entièrement sur des écrans de petite taille.
localizedProvider

object (LocalizedString)

Chaînes traduites pour le fournisseur. La longueur maximale recommandée est de 12 caractères, afin de garantir que la chaîne s'affiche entièrement sur des écrans de petite taille.
localizedDetails

object (LocalizedString)

Chaînes traduites pour plus de détails.
localizedFinePrint

object (LocalizedString)

Chaînes traduites pour finePrint.
shortTitle

string

Une version abrégée du titre de l'offre, par exemple "20% de remise", s'affiche pour permettre aux utilisateurs de se référer rapidement au contenu de l'offre. La longueur maximale recommandée est de 20 caractères.
localizedShortTitle

object (LocalizedString)

Chaînes traduites pour le titre court. La longueur maximale recommandée est de 20 caractères.
classTemplateInfo

object (ClassTemplateInfo)

Informations de modèle sur la manière dont la classe doit s'afficher. Si cette règle n'est pas configurée, Google utilise un ensemble de champs par défaut à afficher.
id

string

Obligatoire. Identifiant unique d'une classe. Cet ID doit être unique dans toutes les classes d'un émetteur. Cette valeur doit respecter le format issuer ID.identifier, où le premier est émis par Google et le deuxième est choisi par vous. Votre identifiant unique ne doit contenir que des caractères alphanumériques, ainsi que des symboles ".", "_" et "-".
version
(deprecated)

string (int64 format)

Obsolète
issuerName

string

Obligatoire. Nom de l'émetteur. La longueur maximale recommandée est de 20 caractères, afin de garantir que la chaîne s'affiche entièrement sur des écrans de petite taille.
messages[]

object (Message)

Tableau des messages affichés dans l'application. Tous les utilisateurs de cet objet recevront les messages associés. Le nombre maximal de ces champs est 10.
allowMultipleUsersPerObject
(deprecated)

boolean

Obsolète. Utilisez multipleDevicesAndHoldersAllowedStatus à la place.
homepageUri

object (Uri)

URI de la page d'accueil de votre application. Le fait de renseigner l'URI dans ce champ a exactement le même comportement que de renseigner un URI dans linksModuleData (lorsqu'un objet est affiché, un lien vers la page d'accueil s'affiche dans ce que l'on considère généralement comme la section linksModuleData de l'objet).
locations[]

object (LatLongPoint)

Remarque: Actuellement, ce champ ne permet pas de déclencher des notifications géographiques.
reviewStatus

enum (ReviewStatus)

Obligatoire. État du cours. Ce champ peut être défini sur draft ou sur l'état de la classe. Ce champ peut être défini sur draft ou underReview à l'aide des appels d'API d'insertion, de correctif ou de mise à jour. Une fois que l'état de l'examen est passé de draft, vous ne pouvez plus le repasser à l'état draft.

Ce champ doit rester défini sur draft lorsque la classe est en cours de développement. Une classe draft ne peut pas être utilisée pour créer un objet.

Vous devez définir ce champ sur underReview lorsque vous pensez que la classe est prête à l'emploi. La plate-forme définit automatiquement ce champ sur approved, et peut être utilisé immédiatement pour créer ou migrer des objets.

Lorsque vous mettez à jour une classe déjà approved, vous devez continuer à définir ce champ sur underReview.
review

object (Review)

Commentaires sur l'avis définis par la plate-forme lorsqu'un cours est marqué comme approved ou rejected.
infoModuleData
(deprecated)

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 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 la classe, les deux s'affichent. Ces champs affichés sont limités à 10 pour l'objet et 10 à partir de la classe.
redemptionIssuers[]

string (int64 format)

Identifie les émetteurs d'offres qui peuvent utiliser la carte via Smart Tap. Les émetteurs d'offres sont identifiés par leur ID. Les émetteurs d'offres doivent avoir configuré au moins une clé Smart Tap.

Les champs enableSmartTap et smartTapRedemptionLevel au niveau de l'objet doivent également être correctement configurés pour qu'une carte soit compatible avec Smart Tap.
countryCode

string

Code pays utilisé pour afficher le pays de la carte (lorsque l'utilisateur ne se trouve pas dans ce pays), ainsi que pour afficher le contenu localisé lorsque celui-ci n'est pas disponible dans les paramètres régionaux de l'utilisateur.
heroImage

object (Image)

Image de bannière facultative qui s'affiche au recto de la carte. En l'absence de code, rien ne s'affiche. L'image s'affiche avec une largeur de 100 %.
wordMark
(deprecated)

object (Image)

Obsolète.
enableSmartTap

boolean

Indique si cette classe est compatible avec Smart Tap. Les champs redemptionIssuers et smartTapRedemptionLevel au niveau de l'objet doivent également être correctement configurés pour qu'une carte soit compatible avec Smart Tap.
hexBackgroundColor

string

Couleur d'arrière-plan de la carte. Si cette option 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. Le format est #rrggbb, où rrggbb est un triplet RVB hexadécimal, comme #ffcc00. Vous pouvez également utiliser la version abrégée du triplet RVB (#rgb), comme #fc0.
localizedIssuerName

object (LocalizedString)

Chaînes traduites pour "IssuerName". La longueur maximale recommandée est de 20 caractères, afin de garantir que la chaîne s'affiche entièrement sur des écrans de petite taille.
multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

Indique si plusieurs utilisateurs et appareils enregistreront le même objet référençant cette classe.
callbackOptions

object (CallbackOptions)

Options de rappel à utiliser pour rappeler l'émetteur à chaque enregistrement ou suppression d'un objet de cette classe par l'utilisateur final. Tous les objets de cette classe sont éligibles au rappel.
securityAnimation

object (SecurityAnimation)

Informations facultatives sur l'animation de sécurité. Si cette option est définie, une animation de sécurité s'affiche dans les détails de la carte.
viewUnlockRequirement

enum (ViewUnlockRequirement)

Affichez les options "Exigences de déverrouillage" pour l'offre.
wideTitleImage

object (Image)

Image large du titre de l'offre. Lorsqu'elle est fournie, elle est utilisée à la place de l'image de titre en haut à gauche de la vue Fiche.

RedemptionChannel

Enums
REDEMPTION_CHANNEL_UNSPECIFIED
INSTORE
instore

Ancien alias pour INSTORE. Obsolète.
ONLINE
online

Ancien alias pour ONLINE. Obsolète.
BOTH
both

Ancien alias pour BOTH. Obsolète.
TEMPORARY_PRICE_REDUCTION
temporaryPriceReduction

Ancien alias pour TEMPORARY_PRICE_REDUCTION. Obsolète.

Méthodes

addmessage

 Ajoute un message à la classe d'offre référencée par l'ID de classe donné.

get

 Renvoie la classe d'offre avec l'ID de classe donné.

insert

 Insère une classe d'offre avec l'identifiant et les propriétés indiqués.

list

 Affiche la liste de toutes les classes d'offres pour un ID d'émetteur donné.

patch

 Met à jour la classe d'offre référencée par l'ID de classe donné.

update

 Met à jour la classe d'offre référencée par l'ID de classe donné.