REST Resource: offerobject

Risorsa: OfferObject

Rappresentazione JSON 
{
  "kind": string,
  "classReference": {
    object (OfferClass)
  },
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
Campi
kind
(deprecated)

string

Identifica il tipo di risorsa. Valore: la stringa fissa "walletobjects#offerObject".
classReference

object (OfferClass)

Una copia dei campi ereditati della classe principale. Questi campi vengono recuperati durante una richiesta GET.
id

string

Obbligatorio. L'identificatore univoco di un oggetto. Questo ID deve essere univoco in tutti gli oggetti 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 '-'.
classId

string

Obbligatorio. La classe associata a questo oggetto. Il corso deve essere dello stesso tipo di questo oggetto, deve già esistere e deve essere approvato.

Gli ID classe devono seguire il formato issuer ID.identifier, dove il primo è emesso da Google e il secondo è scelto da te.
version
(deprecated)

string (int64 format)

Deprecato
state

enum (State)

Obbligatorio. Lo stato dell'oggetto. Questo campo viene utilizzato per determinare la modalità di visualizzazione di un oggetto nell'app. Ad esempio, un oggetto inactive viene spostato nella sezione "Tessere scadute".
barcode

object (Barcode)

Il tipo e il valore del codice a barre.
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.
validTimeInterval

object (TimeInterval)

Il periodo di tempo in cui questo oggetto sarà active e l'oggetto può essere utilizzato. Al termine di questo periodo di tempo, lo stato di un oggetto verrà modificato in expired.
locations[]

object (LatLongPoint)

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

boolean

Indica se l'oggetto ha utenti. Questo campo è impostato dalla piattaforma.
smartTapRedemptionValue

string

Il valore che verrà trasmesso a un terminale certificato Smart Tap tramite NFC per questo oggetto. Affinché la tessera supporti Smart Tap, anche i campi a livello di corso enableSmartTap e redemptionIssuers devono essere configurati correttamente. Sono supportati solo i caratteri ASCII.
hasLinkedDevice

boolean

Indica se questo oggetto è attualmente collegato a un singolo dispositivo. Questo campo viene impostato dalla piattaforma quando un utente salva l'oggetto collegandolo al proprio dispositivo. Destinato all'utilizzo da parte di partner selezionati. Contatta l'assistenza per ulteriori informazioni.
disableExpirationNotification

boolean

Indica se le notifiche devono essere soppressate esplicitamente. Se questo campo è impostato su true, indipendentemente dal campo messages, le notifiche di scadenza all'utente verranno eliminate. Per impostazione predefinita, questo campo è impostato su false.

Al momento, questa opzione può essere impostata solo per le offerte.
infoModuleData

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 della 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.
rotatingBarcode

object (RotatingBarcode)

Il tipo e il valore del codice a barre rotante.
heroImage

object (Image)

Immagine del banner facoltativa visualizzata sulla parte anteriore della scheda. Se non è presente, verrà visualizzata l'immagine hero del corso, se presente. Se non è presente nemmeno l'immagine hero del corso, non verrà visualizzata alcuna immagine.
groupingInfo

object (GroupingInfo)

Informazioni che controllano il modo in cui le tessere vengono raggruppate.
passConstraints

object (PassConstraints)

Passa i vincoli per l'oggetto. Include la limitazione dei comportamenti dell'NFC e degli screenshot.
saveRestrictions

object (SaveRestrictions)

Restrizioni relative all'oggetto che devono essere verificate prima che l'utente provi a salvare la tessera. Tieni presente che queste limitazioni verranno applicate solo durante il tempo di salvataggio. Se le limitazioni cambiano dopo che un utente salva la tessera, le nuove limitazioni non verranno applicate a una tessera già salvata.
linkedObjectIds[]

string

Gli oggetti LinkedObjectId sono un elenco di altri oggetti, quali biglietti per un evento, fedeltà, offerte, generici, carte regalo, carte di trasporto pubblico e carte d'imbarco, che devono essere automaticamente collegati all'oggetto dell'offerta. Se un utente avesse salvato questa offerta, questi LinkedObjectId verranno inviati automaticamente al suo wallet (a meno che non abbia disattivato l'impostazione per ricevere i documenti collegati).

Assicurati che gli oggetti presenti in linkedObjectIds siano già inseriti. In caso contrario, le chiamate non andranno a buon fine. Una volta collegati, gli oggetti collegati non possono essere scollegati. Non puoi collegare oggetti appartenenti a un altro emittente. Esiste un limite al numero di oggetti che possono essere collegati a un singolo oggetto. Una volta raggiunto il limite, i nuovi oggetti collegati nella chiamata verranno ignorati automaticamente.

Gli ID oggetto devono seguire il formato issuer ID.identifier, dove il primo è emesso da Google e il secondo è scelto da te.
notifyPreference

enum (NotificationSettingsForUpdates)

Indica se gli aggiornamenti dei campi per questo oggetto devono attivare o meno le notifiche. Se impostato su NOTIFY, si proverà ad attivare una notifica di aggiornamento dei campi per gli utenti. Queste notifiche verranno inviate agli utenti solo se il campo fa parte di una lista consentita. Se impostato su DO_NOT_NOTIFY o NOTIFICATION_SETTINGS_UNSPECIFIED, 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 sul valore aggiunto. Massimo dieci nell'oggetto.

Metodi

addmessage

 Aggiunge un messaggio all'oggetto dell'offerta a cui fa riferimento l'ID oggetto specificato.

get

 Restituisce l'oggetto offerta con l'ID oggetto specificato.

insert

 Inserisce un oggetto offerta con l'ID e le proprietà specificati.

list

 Restituisce un elenco di tutti gli oggetti offer per un determinato ID emittente.

patch

 Aggiorna l'oggetto offerta a cui fa riferimento l'ID oggetto specificato.

update

 Aggiorna l'oggetto offerta a cui fa riferimento l'ID oggetto specificato.