Questa pagina è stata tradotta dall'API Cloud Translation.

REST Resource: giftcardobject

Risorsa: GiftCardObject
- Rappresentazione JSON
Metodi

Risorsa: GiftCardObject

Rappresentazione JSON

Rappresentazione JSON
{ "kind": string, "classReference": { object (`GiftCardClass`) }, "cardNumber": string, "pin": string, "balance": { object (`Money`) }, "balanceUpdateTime": { object (`DateTime`) }, "eventNumber": string, "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`) } ] }

{
  "kind": string,
  "classReference": {
    object (GiftCardClass)
  },
  "cardNumber": string,
  "pin": string,
  "balance": {
    object (Money)
  },
  "balanceUpdateTime": {
    object (DateTime)
  },
  "eventNumber": string,
  "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` Questo elemento è deprecato. Identifica il tipo di risorsa. Valore: stringa fissa `"walletobjects#giftCardObject"`.
`classReference`	`object (GiftCardClass)` Una copia dei campi ereditati della classe principale. Questi campi vengono recuperati durante una richiesta GET.
`cardNumber`	`string` Obbligatorio. Il numero della carta.
`pin`	`string` Il PIN della carta.
`balance`	`object (Money)` Il saldo monetario della carta.
`balanceUpdateTime`	`object (DateTime)` La data e l'ora dell'ultimo aggiornamento del saldo. L'offset è obbligatorio. Se il saldo viene aggiornato e questa proprietà non viene fornita, il sistema utilizzerà per impostazione predefinita l'ora corrente.
`eventNumber`	`string` Il numero di evento della carta, un campo facoltativo utilizzato da alcune carte regalo.
`id`	`string` Obbligatorio. L'identificatore univoco di un oggetto. Questo ID deve essere univoco in tutti gli oggetti di un emittente. Questo valore deve essere nel formato `issuer ID`.`identifier`: il primo viene emesso da Google, mentre il secondo è scelto da te. L'identificatore univoco deve includere solo caratteri alfanumerici, '.', '_' o '-'.
`classId`	`string` Obbligatorio. La classe associata a questo oggetto. La classe deve essere dello stesso tipo dell'oggetto, deve esistere già e deve essere approvata. 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)` Questo elemento è deprecato. 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. Lo stato di un oggetto verrà modificato in `expired` al termine di questo periodo di tempo.
`locations[] (deprecated)`	`object (LatLongPoint)` Questo elemento è deprecato. 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. Anche i campi a livello di classe `enableSmartTap` e `redemptionIssuers` devono essere configurati correttamente affinché la tessera supporti la funzionalità Smart Tap. 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 viene impostato su true, indipendentemente dal campo `messages`, le notifiche di scadenza per l'utente verranno soppresse. 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 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.
`linksModuleData`	`object (LinksModuleData)` Collega i dati del modulo. Se i dati del modulo dei link sono definiti anche nel corso, verranno visualizzati entrambi.
`appLinkData`	`object (AppLinkData)` Link facoltativo all'app o al sito web che verrà mostrato sotto forma di pulsante sulla parte anteriore della tessera. Se viene fornito AppLinkData per l'oggetto della classe corrispondente, verrà visualizzato solo AppLinkData.
`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 della classe, 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. Sono inclusi i comportamenti di limitazione di NFC e 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 sono cambiate dopo che un utente ha salvato la tessera, le nuove limitazioni non verranno applicate a una tessera già salvata.
`linkedObjectIds[]`	`string` linkedObjectIds è un elenco di altri oggetti, come biglietti per eventi, fedeltà, offerte, generici, carte regalo, trasporto pubblico e carte d'imbarco, che devono essere collegati automaticamente a questo oggetto carta regalo. Se un utente avesse salvato questa carta regalo, questi linkedObjectId verrebbero inviati automaticamente al suo portafoglio (a meno che non abbia disattivato l'impostazione per ricevere queste tessere collegate). 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 silenziosamente. Gli ID oggetto devono seguire il formato `issuer ID`.`identifier`: il primo viene emesso da Google, mentre il secondo è scelto da te.
`notifyPreference`	`enum (NotificationSettingsForUpdates)` Indica se gli aggiornamenti dei campi di questo oggetto 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 impostato su DO_NOT_NOTIFY o NOTIFICATION_SETTINGS_UNSPECIFIED, non verrà attivata alcuna notifica. Questa impostazione è temporanea e deve essere configurata con ogni richiesta PATCH o UPDATE, altrimenti non verrà attivata alcuna notifica.
`valueAddedModuleData[]`	`object (ValueAddedModuleData)` Dati facoltativi del modulo sul valore aggiunto. Massimo dieci nell'oggetto.

Metodi
`addmessage`	Aggiunge un messaggio all'oggetto carta regalo a cui fa riferimento l'ID oggetto specificato.
`get`	Restituisce l'oggetto della carta regalo con l'ID oggetto specificato.
`insert`	Inserisce un oggetto carta regalo con l'ID e le proprietà specificati.
`list`	Restituisce un elenco di tutti gli oggetti carta regalo per un determinato ID emittente.
`patch`	Consente di aggiornare l'oggetto carta regalo a cui fa riferimento l'ID oggetto specificato.
`update`	Aggiorna l'oggetto carta regalo a cui fa riferimento l'ID oggetto specificato.

REST Resource: giftcardobject

Risorsa: GiftCardObject

Metodi

`addmessage`

`get`

`insert`

`list`

`patch`

`update`