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

string

Identifica il tipo di risorsa. Valore: 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 (nome dell'aggregatore o 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 visualizzata sia nella visualizzazione dettagliata che in quella 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 all'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 il finePrint.

shortTitle

string

Una versione abbreviata del titolo dell'offerta, ad esempio "20% di sconto", mostrata 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)

Informazioni sul modello relative alla visualizzazione del corso. Se non viene impostato, Google utilizzerà un insieme predefinito di campi da visualizzare.

id

string

Obbligatorio. L'identificatore univoco di un corso. Questo ID deve essere univoco per tutte le classi di un emittente. Questo valore deve seguire il formato issuer ID.identifier, dove il primo è emesso da Google e il secondo è scelto da te. L'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. Se compili l'URI in questo campo, il comportamento è esattamente lo stesso di quello che si ottiene compilando un URI in linksModuleData (quando viene visualizzato un oggetto, un link alla home page viene mostrato nella sezione linksModuleData dell'oggetto).

locations[]
(deprecated)

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 insert, patch o update. Una volta cambiato lo stato della revisione da draft, non è possibile tornare a draft.

Quando il corso è in fase di sviluppo, devi mantenere questo campo su draft. Non è possibile utilizzare una classe draft per creare alcun oggetto.

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 recensione impostati dalla piattaforma quando un corso è contrassegnato come approved o rejected.

infoModuleData
(deprecated)

object (InfoModuleData)

Deprecato. Utilizza 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 nel corso sono definiti anche i dati del modulo di testo, verranno visualizzati entrambi. Il numero massimo di questi campi visualizzati è 10 dall'oggetto e 10 dalla classe.

redemptionIssuers[]

string (int64 format)

Identifica gli emittenti di coupon che possono utilizzare la tessera tramite Smart Tap. Gli emittenti che hanno emesso i rimborsi sono identificati tramite l'ID emittente. Gli emittenti di coupon devono avere configurato almeno una chiave Smart Tap.

Anche i campi enableSmartTap e smartTapRedemptionLevel a livello di oggetto devono essere configurati correttamente affinché una tessera supporti il tocco intelligente.

countryCode

string

Codice paese utilizzato per visualizzare il paese della scheda (se l'utente non si trova in quel paese) e per visualizzare i contenuti localizzati quando 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 al 100% della larghezza.

wordMark
(deprecated)

object (Image)

Deprecato.

enableSmartTap

boolean

Indica se questa classe supporta il tocco intelligente. Anche i campi redemptionIssuers e smartTapRedemptionLevel a livello di oggetto devono essere configurati correttamente affinché una tessera supporti il tocco intelligente.

hexBackgroundColor

string

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

localizedIssuerName

object (LocalizedString)

Stringhe tradotte per 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 per 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 opzione è impostata, verrà visualizzata un'animazione di sicurezza nei dettagli della tessera.

viewUnlockRequirement

enum (ViewUnlockRequirement)

Visualizza le opzioni dei requisiti di sblocco per l'offerta.

wideTitleImage

object (Image)

L'immagine del titolo larga dell'offerta. Se specificato, verrà utilizzato al posto dell'immagine del titolo in alto a sinistra nella visualizzazione della scheda.

notifyPreference

enum (NotificationSettingsForUpdates)

Indica se gli aggiornamenti dei campi di questa classe devono attivare o meno le notifiche. Se impostato su NOTIFY, tenteremo di attivare una notifica di aggiornamento del campo per gli utenti. Queste notifiche verranno inviate agli utenti solo se il campo fa parte di una lista consentita. Se non specificato, non verrà attivata alcuna notifica. Questa impostazione è temporanea e deve essere impostata con ogni richiesta PATCH o UPDATE, altrimenti non verrà attivata una notifica.

valueAddedModuleData[]

object (ValueAddedModuleData)

Dati facoltativi del modulo a valore aggiunto. Massimo dieci per corso. Per un passaggio ne verranno visualizzati solo dieci, dando la priorità a quelli dell'oggetto.

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

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

update

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