REST Resource: offerclass

Risorsa: OfferClass

Rappresentazione 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)
  }
}
Campi
kind
(deprecated)

string

Identifica di che tipo di risorsa si tratta. Valore: la stringa fissa "walletobjects#offerClass".
title

string

Obbligatorio. Il titolo dell'offerta, ad esempio "20% di sconto su qualsiasi t-shirt". La lunghezza massima consigliata è di 60 caratteri per garantire che la stringa completa venga visualizzata su schermi più piccoli.
redemptionChannel

enum (RedemptionChannel)

Obbligatorio. I canali di utilizzo applicabili a questa offerta.
provider

string

Obbligatorio. Il fornitore dell'offerta (il nome dell'aggregatore o il nome del commerciante). La lunghezza massima consigliata è di 12 caratteri per garantire che la stringa completa venga visualizzata su schermi più piccoli.
titleImage

object (Image)

L'immagine del titolo dell'offerta. Questa immagine viene mostrata sia nella visualizzazione dei dettagli sia nella visualizzazione elenco dell'app.
details

string

I dettagli dell'offerta.
finePrint

string

Le clausole o i termini dell'offerta, ad esempio "20% di sconto su qualsiasi t-shirt da Adam's Apparel".
helpUri

object (Uri)

Il link di assistenza per l'offerta, ad esempio http://myownpersonaldomain.com/help
localizedTitle

object (LocalizedString)

Stringhe tradotte per il titolo. La lunghezza massima consigliata è di 60 caratteri per garantire che la stringa completa venga visualizzata su schermi più piccoli.
localizedProvider

object (LocalizedString)

Stringhe tradotte per il provider. La lunghezza massima consigliata è di 12 caratteri per garantire che la stringa completa venga visualizzata su schermi più piccoli.
localizedDetails

object (LocalizedString)

Stringhe tradotte per i dettagli.
localizedFinePrint

object (LocalizedString)

Stringhe tradotte per finePrint.
shortTitle

string

Una versione abbreviata del titolo dell'offerta, ad esempio "20% di sconto", mostrati agli utenti come riferimento rapido ai contenuti dell'offerta. La lunghezza massima consigliata è di 20 caratteri.
localizedShortTitle

object (LocalizedString)

Stringhe tradotte per il titolo breve. La lunghezza massima consigliata è di 20 caratteri.
classTemplateInfo

object (ClassTemplateInfo)

Modello di informazioni su come deve essere visualizzata la classe. Se il criterio non viene configurato, Google utilizzerà un insieme predefinito di campi da visualizzare.
id

string

Obbligatorio. L'identificatore univoco di una classe. Questo ID deve essere univoco in tutte le classi di un emittente. Questo valore deve essere nel formato issuer ID.identifier: il primo viene emesso da Google, mentre il secondo è scelto da te. Il tuo identificatore univoco deve includere solo caratteri alfanumerici, ".", "_" o "-".
version
(deprecated)

string (int64 format)

Deprecato
issuerName

string

Obbligatorio. Il nome dell'emittente. La lunghezza massima consigliata è di 20 caratteri per garantire che la stringa completa venga visualizzata su schermi più piccoli.
messages[]

object (Message)

Un array di messaggi visualizzati nell'app. Tutti gli utenti di questo oggetto riceveranno i messaggi associati. Il numero massimo di questi campi è 10.
allowMultipleUsersPerObject
(deprecated)

boolean

Deprecato. Usa invece il criterio multipleDevicesAndHoldersAllowedStatus.
homepageUri

object (Uri)

L'URI della home page della tua applicazione. Il completamento dell'URI in questo campo ha lo stesso comportamento della compilazione di un URI in linksModuleData (quando viene eseguito il rendering di un oggetto, viene mostrato un link alla home page in quella che di solito viene considerata la sezione linksModuleData dell'oggetto).
locations[]

object (LatLongPoint)

Nota: al momento questo campo non è supportato per attivare le notifiche geografiche.
reviewStatus

enum (ReviewStatus)

Obbligatorio. Lo stato del corso. Questo campo può essere impostato su draft o sullo stato del corso. Questo campo può essere impostato su draft o underReview utilizzando le chiamate API di inserimento, patch o aggiornamento. Una volta cambiato lo stato della revisione da draft, non è possibile tornare a draft.

Devi mantenere questo campo su draft quando il corso è in fase di sviluppo. Non è possibile utilizzare una classe draft per creare oggetti.

Devi impostare questo campo su underReview quando ritieni che il corso sia pronto per l'uso. La piattaforma imposterà automaticamente questo campo su approved e potrà essere utilizzato immediatamente per creare o eseguire la migrazione di oggetti.

Quando aggiorni un corso già approved, devi continuare a impostare questo campo su underReview.
review

object (Review)

I commenti della revisione impostati dalla piattaforma quando un corso è contrassegnato come approved o rejected.
infoModuleData
(deprecated)

object (InfoModuleData)

Deprecato. Usa invece textModulesData.
imageModulesData[]

object (ImageModuleData)

Dati del modulo immagine. Il numero massimo di questi campi visualizzati è 1 a livello di oggetto e 1 a livello di oggetto di classe.
textModulesData[]

object (TextModuleData)

Dati del modulo di testo. Se i dati dei moduli di testo sono definiti anche per il corso, verranno visualizzati entrambi. Il numero massimo di questi campi visualizzati è 10 dall'oggetto e 10 dalla classe.
redemptionIssuers[]

string (int64 format)

Identifica quali emittenti possono riscattare la tessera tramite Smart Tap. Gli emittenti che hanno emesso i rimborsi sono identificati tramite l'ID emittente. Gli emittenti dell'utilizzo devono avere configurato almeno un tasto Smart Tap.

Anche i campi enableSmartTap e smartTapRedemptionLevel a livello di oggetto devono essere configurati correttamente affinché una tessera supporti Smart Tap.
countryCode

string

Codice paese utilizzato per mostrare il paese della carta (quando l'utente non si trova in quel paese) e per mostrare contenuti localizzati quando i contenuti non sono disponibili nella lingua dell'utente.
heroImage

object (Image)

Immagine del banner facoltativa visualizzata sulla parte anteriore della scheda. Se non è presente, non verrà visualizzato nulla. L'immagine verrà visualizzata con una larghezza al 100%.
wordMark
(deprecated)

object (Image)

Deprecato.
enableSmartTap

boolean

Indica se il corso supporta Smart Tap. Anche i campi redemptionIssuers e smartTapRedemptionLevel a livello di oggetto devono essere configurati correttamente affinché una tessera supporti Smart Tap.
hexBackgroundColor

string

Il colore di sfondo della scheda. Se non viene impostato il colore dominante dell'immagine hero, se non viene impostata alcuna immagine hero, viene utilizzato il colore dominante del logo. Il formato è #rrggbb, dove rrggbb è una terzina RGB esadecimale, ad esempio #ffcc00. Puoi anche utilizzare la versione abbreviata della terzina RGB che è il numero rgb, ad esempio #fc0.
localizedIssuerName

object (LocalizedString)

Stringhe tradotte per il valore IssuerName. La lunghezza massima consigliata è di 20 caratteri per garantire che la stringa completa venga visualizzata su schermi più piccoli.
multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

Indica se più utenti e dispositivi salveranno lo stesso oggetto facendo riferimento a questa classe.
callbackOptions

object (CallbackOptions)

Opzioni di callback da utilizzare per richiamare l'emittente a ogni salvataggio/eliminazione di un oggetto per questa classe da parte dell'utente finale. Tutti gli oggetti di questa classe sono idonei per il callback.
securityAnimation

object (SecurityAnimation)

Informazioni facoltative sull'animazione di sicurezza. Se questa impostazione è impostata, ai dettagli della tessera verrà visualizzata un'animazione di sicurezza.
viewUnlockRequirement

enum (ViewUnlockRequirement)

Visualizza le opzioni per i requisiti di sblocco per l'offerta.
wideTitleImage

object (Image)

L'immagine del titolo larga dell'offerta. Se fornita, verrà utilizzata al posto dell'immagine del titolo nell'angolo in alto a sinistra della visualizzazione schede.

RedemptionChannel

Enum
REDEMPTION_CHANNEL_UNSPECIFIED
INSTORE
instore

Alias precedente per INSTORE. Deprecato.
ONLINE
online

Alias precedente per ONLINE. Deprecato.
BOTH
both

Alias precedente per BOTH. Deprecato.
TEMPORARY_PRICE_REDUCTION
temporaryPriceReduction

Alias precedente per TEMPORARY_PRICE_REDUCTION. Deprecato.

Metodi

addmessage

 Aggiunge un messaggio alla classe di offerta a cui fa riferimento l'ID classe specificato.

get

 Restituisce la classe di offerta con l'ID classe specificato.

insert

 Inserisce una classe di offerta con l'ID e le proprietà specificati.

list

 Restituisce un elenco di tutte le classi di offerta per un determinato ID emittente.

patch

 Consente di aggiornare la classe di offerta a cui fa riferimento l'ID classe specificato.

update

 Consente di aggiornare la classe di offerta a cui fa riferimento l'ID classe specificato.