Cette page a été traduite par l'API Cloud Translation.

REST Resource: offerclass

Ressource: OfferClass
- Représentation JSON
- RedemptionChannel
Méthodes

Ressource: OfferClass

Représentation JSON

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`) }, "notifyPreference": enum (`NotificationSettingsForUpdates`), "appLinkData": { object (`AppLinkData`) }, "valueAddedModuleData": [ { object (`ValueAddedModuleData`) } ] }

{
  "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)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}

Champs
`kind (deprecated)`	`string` Cet élément est obsolète. Identifie le type de ressource. Valeur : chaîne fixe `"walletobjects#offerClass"`.
`title`	`string` Obligatoire. Titre de l'offre (par exemple, "20% de remise sur tout 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. Canaux de distribution 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étaillée et Liste de l'application.
`details`	`string` Détails de l'offre.
`finePrint`	`string` Les conditions de l'offre, par exemple "20% de remise sur tous les t-shirts chez Adam's Apparel".
`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 les détails.
`localizedFinePrint`	`object (LocalizedString)` Chaînes traduites pour les conditions d'utilisation.
`shortTitle`	`string` Version abrégée du titre de l'offre (par exemple, "20% de remise"), présentée aux utilisateurs pour leur permettre 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 du modèle sur la façon dont le cours doit s'afficher. Si ce paramètre n'est pas défini, Google utilisera un ensemble de champs par défaut à afficher.
`id`	`string` Obligatoire. Identifiant unique d'un cours. Cet ID doit être unique parmi toutes les classes 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. Votre identifiant unique ne doit contenir que des caractères alphanumériques, des points, des traits de soulignement ou des tirets.
`version (deprecated)`	`string (int64 format)` Cet élément est obsolète. 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 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 de 10.
`allowMultipleUsersPerObject (deprecated)`	`boolean` Cet élément est obsolète. Obsolète. Utilisez `multipleDevicesAndHoldersAllowedStatus` à la place.
`homepageUri`	`object (Uri)` URI de la page d'accueil de votre application. Renseigner l'URI dans ce champ entraîne 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 qui est généralement considéré comme la section linksModuleData de l'objet).
`locations[] (deprecated)`	`object (LatLongPoint)` Cet élément est obsolète. Remarque : Il n'est actuellement pas possible d'utiliser ce champ pour déclencher des notifications géo.
`reviewStatus`	`enum (ReviewStatus)` Obligatoire. État de la classe. Ce champ peut être défini sur `draft` ou sur l'état du cours. Ce champ peut être défini sur `draft` ou `underReview` à l'aide des appels d'API insert, patch ou update. Une fois que l'état de l'examen est passé de `draft`, vous ne pouvez plus le repasser à l'état `draft`. Laissez ce champ 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éfinira automatiquement ce champ sur `approved`, et vous pourrez immédiatement l'utiliser pour créer ou migrer des objets. Lorsque vous mettez à jour une classe `approved`, vous devez continuer à définir ce champ sur `underReview`.
`review`	`object (Review)` Commentaires d'évaluation définis par la plate-forme lorsqu'un cours est marqué `approved` ou `rejected`.
`infoModuleData (deprecated)`	`object (InfoModuleData)` Cet élément est obsolète. 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. Ces champs affichés sont limités à 10 pour l'objet et 10 à partir de la classe.
`linksModuleData`	`object (LinksModuleData)` Données du module de liens. Si des données du module de liens sont également définies sur l'objet, les deux sont affichées.
`redemptionIssuers[]`	`string (int64 format)` Indique les émetteurs d'offres qui peuvent utiliser la carte via le sans contact avancé. Les émetteurs d'offres sont identifiés par leur ID d'émetteur. 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 configurés correctement pour qu'une carte soit compatible avec le sans contact avancé.
`countryCode`	`string` Code pays utilisé pour afficher le pays de la fiche (lorsque l'utilisateur ne se trouve pas dans ce pays), ainsi que pour afficher du contenu localisé lorsque celui-ci n'est pas disponible dans la langue de l'utilisateur.
`heroImage`	`object (Image)` Image de bannière facultative affichée sur le recto de la fiche. Si aucun n'est présent, rien ne s'affiche. L'image s'affichera sur 100 % de la largeur.
`wordMark (deprecated)`	`object (Image)` Cet élément est obsolète. Obsolète.
`enableSmartTap`	`boolean` Indique si cette classe est compatible avec le Sans contact avancé. 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 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. 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`), telle que `#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 enregistrent le même objet faisant référence à cette classe.
`callbackOptions`	`object (CallbackOptions)` Options de rappel à utiliser pour rappeler l'émetteur à chaque enregistrement/suppression d'un objet de cette classe par l'utilisateur final. Tous les objets de cette classe peuvent utiliser le 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 sur les informations de la carte.
`viewUnlockRequirement`	`enum (ViewUnlockRequirement)` Affichez les options "Exigences de déverrouillage" pour l'offre.
`wideTitleImage`	`object (Image)` Image du titre de l'offre en grand format. Lorsqu'elle est fournie, elle est utilisée à la place de l'image de titre en haut à gauche de la vue Fiche.
`notifyPreference`	`enum (NotificationSettingsForUpdates)` Indique si les mises à jour de champ de cette classe doivent déclencher 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 seront envoyées aux utilisateurs que si le champ fait partie d'une liste d'autorisation. Si aucune valeur n'est spécifiée, aucune notification n'est 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.
`appLinkData`	`object (AppLinkData)` Lien vers une application ou un site Web facultatif qui s'affiche sous forme de bouton sur le recto de la carte. Si AppLinkData est fourni pour l'objet correspondant, il est utilisé à la place.
`valueAddedModuleData[]`	`object (ValueAddedModuleData)` Données du module avec valeur ajoutée facultative. Maximum de 10 pour le cours. Pour une carte, seules dix cartes s'affichent, en privilégiant celles de l'objet.

RedemptionChannel

Enums
`REDEMPTION_CHANNEL_UNSPECIFIED`
`INSTORE`
`instore`	Ancien alias de `INSTORE`. Obsolète. Cet élément est obsolète.
`ONLINE`
`online`	Ancien alias de `ONLINE`. Obsolète. Cet élément est obsolète.
`BOTH`
`both`	Ancien alias pour `BOTH`. Obsolète. Cet élément est obsolète.
`TEMPORARY_PRICE_REDUCTION`
`temporaryPriceReduction`	Ancien alias de `TEMPORARY_PRICE_REDUCTION`. Obsolète. Cet élément est 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 associée à l'ID de classe donné.
`insert`	Insère une classe d'offre avec l'ID et les propriétés donnés.
`list`	Renvoie 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é.

REST Resource: offerclass

Ressource: OfferClass

RedemptionChannel

Méthodes

`addmessage`

`get`

`insert`

`list`

`patch`

`update`