Questa pagina è stata tradotta dall'API Cloud Translation.

REST Resource: giftcardclass

Risorsa: GiftCardClass
- Rappresentazione JSON
Metodi

Risorsa: GiftCardClass

Rappresentazione JSON

Rappresentazione JSON
{ "kind": string, "merchantName": string, "programLogo": { object (`Image`) }, "pinLabel": string, "eventNumberLabel": string, "allowBarcodeRedemption": boolean, "localizedMerchantName": { object (`LocalizedString`) }, "localizedPinLabel": { object (`LocalizedString`) }, "localizedEventNumberLabel": { object (`LocalizedString`) }, "cardNumberLabel": string, "localizedCardNumberLabel": { 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`), "wideProgramLogo": { object (`Image`) }, "notifyPreference": enum (`NotificationSettingsForUpdates`), "appLinkData": { object (`AppLinkData`) }, "valueAddedModuleData": [ { object (`ValueAddedModuleData`) } ] }

{
  "kind": string,
  "merchantName": string,
  "programLogo": {
    object (Image)
  },
  "pinLabel": string,
  "eventNumberLabel": string,
  "allowBarcodeRedemption": boolean,
  "localizedMerchantName": {
    object (LocalizedString)
  },
  "localizedPinLabel": {
    object (LocalizedString)
  },
  "localizedEventNumberLabel": {
    object (LocalizedString)
  },
  "cardNumberLabel": string,
  "localizedCardNumberLabel": {
    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),
  "wideProgramLogo": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}

Campi
`kind (deprecated)`	`string` Questo elemento è deprecato. Identifica il tipo di risorsa. Valore: la stringa fissa `"walletobjects#giftCardClass"`.
`merchantName`	`string` Nome del commerciante, ad esempio "Abbigliamento Adam". L'app potrebbe mostrare tre puntini dopo i primi 20 caratteri per assicurarsi che la stringa completa venga visualizzata su schermi più piccoli.
`programLogo`	`object (Image)` Il logo della società o del programma della carta regalo. Questo logo viene mostrato sia nella visualizzazione dei dettagli sia in quella elenco dell'app.
`pinLabel`	`string` L'etichetta da visualizzare per il PIN, ad esempio "PIN di 4 cifre".
`eventNumberLabel`	`string` L'etichetta da visualizzare per il numero di eventi, ad esempio "Evento target n.".
`allowBarcodeRedemption`	`boolean` Determina se il commerciante supporta l'utilizzo del codice a barre per l'utilizzo delle carte regalo. Se true, l'app mostra un codice a barre per la carta regalo nella schermata Dettagli carta regalo. Se è false, il codice a barre non viene visualizzato.
`localizedMerchantName`	`object (LocalizedString)` Stringhe tradotte per il nome del commerciante. L'app potrebbe mostrare dei puntini di sospensione dopo i primi 20 caratteri per garantire che l'intera stringa venga visualizzata su schermi più piccoli.
`localizedPinLabel`	`object (LocalizedString)` Stringhe tradotte per il pinLabel.
`localizedEventNumberLabel`	`object (LocalizedString)` Stringhe tradotte per eventNumberLabel.
`cardNumberLabel`	`string` L'etichetta da visualizzare per il numero della carta, ad esempio "Numero carta".
`localizedCardNumberLabel`	`object (LocalizedString)` Stringhe tradotte per l'etichetta cardNumberLabel.
`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)` Questo elemento è deprecato. 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` Questo elemento è deprecato. Deprecato. Utilizza invece `multipleDevicesAndHoldersAllowedStatus`.
`homepageUri`	`object (Uri)` L'URI della home page dell'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 in genere verrebbe considerata la sezione linksModuleData dell'oggetto).
`locations[] (deprecated)`	`object (LatLongPoint)` Questo elemento è deprecato. 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 `underReview` utilizzando le chiamate API insert, patch o update. Una volta modificato lo stato della revisione da `draft`, non è possibile ripristinare `draft`. Quando il corso è in fase di sviluppo, devi mantenere questo campo su `draft`. 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 recensione impostati dalla piattaforma quando un corso è contrassegnato come `approved` o `rejected`.
`infoModuleData (deprecated)`	`object (InfoModuleData)` Questo elemento è deprecato. 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 nell'oggetto, verranno visualizzati entrambi.
`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 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 il tocco intelligente.
`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)` Questo elemento è deprecato. 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 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)` Identifica se più utenti e dispositivi salveranno lo stesso oggetto che fa 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 per i requisiti di sblocco della carta regalo.
`wideProgramLogo`	`object (Image)` Il logo ampio della società o del programma della carta regalo. Se fornito, verrà utilizzato al posto del logo del programma in alto a sinistra nella visualizzazione della scheda.
`notifyPreference`	`enum (NotificationSettingsForUpdates)` Indica se gli aggiornamenti dei campi per questa classe devono attivare 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 viene specificato, non verrà attivata alcuna notifica. Questa impostazione è temporanea e deve essere configurata con ogni richiesta PATCH o UPDATE, altrimenti non verrà attivata alcuna notifica.
`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 corrispondente, verrà utilizzato al suo posto.
`valueAddedModuleData[]`	`object (ValueAddedModuleData)` Dati facoltativi del modulo sul valore aggiunto. Massimo dieci per corso. Per una tessera ne verranno visualizzate solo dieci, dando la priorità a quelle dell'oggetto.

Metodi
`addmessage`	Aggiunge un messaggio alla classe della carta regalo a cui fa riferimento l'ID classe specificato.
`get`	Restituisce la classe delle carte regalo con l'ID classe specificato.
`insert`	Inserisce una classe di carte regalo con l'ID e le proprietà specificati.
`list`	Restituisce un elenco di tutte le classi di carte regalo per un determinato ID emittente.
`patch`	Consente di aggiornare la classe delle carte regalo a cui fa riferimento l'ID classe specificato.
`update`	Consente di aggiornare la classe delle carte regalo a cui fa riferimento l'ID classe specificato.

REST Resource: giftcardclass

Risorsa: GiftCardClass

Metodi

`addmessage`

`get`

`insert`

`list`

`patch`

`update`