OfferClass (Google Wallet API v1-rev20250506-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.walletobjects.model.OfferClass

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class OfferClass
extends com.google.api.client.json.GenericJson
```
Model definition for OfferClass.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Wallet API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

OfferClass()

Constructors
Constructor and Description
`OfferClass()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OfferClass`	`clone()`
`Boolean`	`getAllowMultipleUsersPerObject()` Deprecated.
`AppLinkData`	`getAppLinkData()` Optional app or website link that will be displayed as a button on the front of the pass.
`CallbackOptions`	`getCallbackOptions()` Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user.
`ClassTemplateInfo`	`getClassTemplateInfo()` Template information about how the class should be displayed.
`String`	`getCountryCode()` Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
`String`	`getDetails()` The details of the offer.
`Boolean`	`getEnableSmartTap()` Identifies whether this class supports Smart Tap.
`String`	`getFinePrint()` The fine print or terms of the offer, such as "20% off any t-shirt at Adam's Apparel."
`Uri`	`getHelpUri()` The help link for the offer, such as `http://myownpersonaldomain.com/help`
`Image`	`getHeroImage()` Optional banner image displayed on the front of the card.
`String`	`getHexBackgroundColor()` The background color for the card.
`Uri`	`getHomepageUri()` The URI of your application's home page.
`String`	`getId()` Required.
`List<ImageModuleData>`	`getImageModulesData()` Image module data.
`InfoModuleData`	`getInfoModuleData()` Deprecated.
`String`	`getIssuerName()` Required.
`String`	`getKind()` Identifies what kind of resource this is.
`LinksModuleData`	`getLinksModuleData()` Links module data.
`LocalizedString`	`getLocalizedDetails()` Translated strings for the details.
`LocalizedString`	`getLocalizedFinePrint()` Translated strings for the fine_print.
`LocalizedString`	`getLocalizedIssuerName()` Translated strings for the issuer_name.
`LocalizedString`	`getLocalizedProvider()` Translated strings for the provider.
`LocalizedString`	`getLocalizedShortTitle()` Translated strings for the short title.
`LocalizedString`	`getLocalizedTitle()` Translated strings for the title.
`List<LatLongPoint>`	`getLocations()` Note: This field is currently not supported to trigger geo notifications.
`List<MerchantLocation>`	`getMerchantLocations()` Merchant locations.
`List<Message>`	`getMessages()` An array of messages displayed in the app.
`String`	`getMultipleDevicesAndHoldersAllowedStatus()` Identifies whether multiple users and devices will save the same object referencing this class.
`String`	`getNotifyPreference()` Whether or not field updates to this class should trigger notifications.
`String`	`getProvider()` Required.
`String`	`getRedemptionChannel()` Required.
`List<Long>`	`getRedemptionIssuers()` Identifies which redemption issuers can redeem the pass over Smart Tap.
`Review`	`getReview()` The review comments set by the platform when a class is marked `approved` or `rejected`.
`String`	`getReviewStatus()` Required.
`SecurityAnimation`	`getSecurityAnimation()` Optional information about the security animation.
`String`	`getShortTitle()` A shortened version of the title of the offer, such as "20% off," shown to users as a quick reference to the offer contents.
`List<TextModuleData>`	`getTextModulesData()` Text module data.
`String`	`getTitle()` Required.
`Image`	`getTitleImage()` The title image of the offer.
`List<ValueAddedModuleData>`	`getValueAddedModuleData()` Optional value added module data.
`Long`	`getVersion()` Deprecated
`String`	`getViewUnlockRequirement()` View Unlock Requirement options for the offer.
`Image`	`getWideTitleImage()` The wide title image of the offer.
`Image`	`getWordMark()` Deprecated.
`OfferClass`	`set(String fieldName, Object value)`
`OfferClass`	`setAllowMultipleUsersPerObject(Boolean allowMultipleUsersPerObject)` Deprecated.
`OfferClass`	`setAppLinkData(AppLinkData appLinkData)` Optional app or website link that will be displayed as a button on the front of the pass.
`OfferClass`	`setCallbackOptions(CallbackOptions callbackOptions)` Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user.
`OfferClass`	`setClassTemplateInfo(ClassTemplateInfo classTemplateInfo)` Template information about how the class should be displayed.
`OfferClass`	`setCountryCode(String countryCode)` Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
`OfferClass`	`setDetails(String details)` The details of the offer.
`OfferClass`	`setEnableSmartTap(Boolean enableSmartTap)` Identifies whether this class supports Smart Tap.
`OfferClass`	`setFinePrint(String finePrint)` The fine print or terms of the offer, such as "20% off any t-shirt at Adam's Apparel."
`OfferClass`	`setHelpUri(Uri helpUri)` The help link for the offer, such as `http://myownpersonaldomain.com/help`
`OfferClass`	`setHeroImage(Image heroImage)` Optional banner image displayed on the front of the card.
`OfferClass`	`setHexBackgroundColor(String hexBackgroundColor)` The background color for the card.
`OfferClass`	`setHomepageUri(Uri homepageUri)` The URI of your application's home page.
`OfferClass`	`setId(String id)` Required.
`OfferClass`	`setImageModulesData(List<ImageModuleData> imageModulesData)` Image module data.
`OfferClass`	`setInfoModuleData(InfoModuleData infoModuleData)` Deprecated.
`OfferClass`	`setIssuerName(String issuerName)` Required.
`OfferClass`	`setKind(String kind)` Identifies what kind of resource this is.
`OfferClass`	`setLinksModuleData(LinksModuleData linksModuleData)` Links module data.
`OfferClass`	`setLocalizedDetails(LocalizedString localizedDetails)` Translated strings for the details.
`OfferClass`	`setLocalizedFinePrint(LocalizedString localizedFinePrint)` Translated strings for the fine_print.
`OfferClass`	`setLocalizedIssuerName(LocalizedString localizedIssuerName)` Translated strings for the issuer_name.
`OfferClass`	`setLocalizedProvider(LocalizedString localizedProvider)` Translated strings for the provider.
`OfferClass`	`setLocalizedShortTitle(LocalizedString localizedShortTitle)` Translated strings for the short title.
`OfferClass`	`setLocalizedTitle(LocalizedString localizedTitle)` Translated strings for the title.
`OfferClass`	`setLocations(List<LatLongPoint> locations)` Note: This field is currently not supported to trigger geo notifications.
`OfferClass`	`setMerchantLocations(List<MerchantLocation> merchantLocations)` Merchant locations.
`OfferClass`	`setMessages(List<Message> messages)` An array of messages displayed in the app.
`OfferClass`	`setMultipleDevicesAndHoldersAllowedStatus(String multipleDevicesAndHoldersAllowedStatus)` Identifies whether multiple users and devices will save the same object referencing this class.
`OfferClass`	`setNotifyPreference(String notifyPreference)` Whether or not field updates to this class should trigger notifications.
`OfferClass`	`setProvider(String provider)` Required.
`OfferClass`	`setRedemptionChannel(String redemptionChannel)` Required.
`OfferClass`	`setRedemptionIssuers(List<Long> redemptionIssuers)` Identifies which redemption issuers can redeem the pass over Smart Tap.
`OfferClass`	`setReview(Review review)` The review comments set by the platform when a class is marked `approved` or `rejected`.
`OfferClass`	`setReviewStatus(String reviewStatus)` Required.
`OfferClass`	`setSecurityAnimation(SecurityAnimation securityAnimation)` Optional information about the security animation.
`OfferClass`	`setShortTitle(String shortTitle)` A shortened version of the title of the offer, such as "20% off," shown to users as a quick reference to the offer contents.
`OfferClass`	`setTextModulesData(List<TextModuleData> textModulesData)` Text module data.
`OfferClass`	`setTitle(String title)` Required.
`OfferClass`	`setTitleImage(Image titleImage)` The title image of the offer.
`OfferClass`	`setValueAddedModuleData(List<ValueAddedModuleData> valueAddedModuleData)` Optional value added module data.
`OfferClass`	`setVersion(Long version)` Deprecated
`OfferClass`	`setViewUnlockRequirement(String viewUnlockRequirement)` View Unlock Requirement options for the offer.
`OfferClass`	`setWideTitleImage(Image wideTitleImage)` The wide title image of the offer.
`OfferClass`	`setWordMark(Image wordMark)` Deprecated.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - OfferClass
```
public OfferClass()
```
- Method Detail
  - getAllowMultipleUsersPerObject
```
public Boolean getAllowMultipleUsersPerObject()
```
    Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
    
    Returns:
    
    value or null for none
  - setAllowMultipleUsersPerObject
```
public OfferClass setAllowMultipleUsersPerObject(Boolean allowMultipleUsersPerObject)
```
    Deprecated. Use `multipleDevicesAndHoldersAllowedStatus` instead.
    
    Parameters:
    
    allowMultipleUsersPerObject - allowMultipleUsersPerObject or null for none
  - getAppLinkData
```
public AppLinkData getAppLinkData()
```
    Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
    
    Returns:
    
    value or null for none
  - setAppLinkData
```
public OfferClass setAppLinkData(AppLinkData appLinkData)
```
    Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding object that will be used instead.
    
    Parameters:
    
    appLinkData - appLinkData or null for none
  - getCallbackOptions
```
public CallbackOptions getCallbackOptions()
```
    Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
    
    Returns:
    
    value or null for none
  - setCallbackOptions
```
public OfferClass setCallbackOptions(CallbackOptions callbackOptions)
```
    Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.
    
    Parameters:
    
    callbackOptions - callbackOptions or null for none
  - getClassTemplateInfo
```
public ClassTemplateInfo getClassTemplateInfo()
```
    Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
    
    Returns:
    
    value or null for none
  - setClassTemplateInfo
```
public OfferClass setClassTemplateInfo(ClassTemplateInfo classTemplateInfo)
```
    Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
    
    Parameters:
    
    classTemplateInfo - classTemplateInfo or null for none
  - getCountryCode
```
public String getCountryCode()
```
    Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
    
    Returns:
    
    value or null for none
  - setCountryCode
```
public OfferClass setCountryCode(String countryCode)
```
    Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.
    
    Parameters:
    
    countryCode - countryCode or null for none
  - getDetails
```
public String getDetails()
```
    The details of the offer.
    
    Returns:
    
    value or null for none
  - setDetails
```
public OfferClass setDetails(String details)
```
    The details of the offer.
    
    Parameters:
    
    details - details or null for none
  - getEnableSmartTap
```
public Boolean getEnableSmartTap()
```
    Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
    
    Returns:
    
    value or null for none
  - setEnableSmartTap
```
public OfferClass setEnableSmartTap(Boolean enableSmartTap)
```
    Identifies whether this class supports Smart Tap. The `redemptionIssuers` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
    
    Parameters:
    
    enableSmartTap - enableSmartTap or null for none
  - getFinePrint
```
public String getFinePrint()
```
    The fine print or terms of the offer, such as "20% off any t-shirt at Adam's Apparel."
    
    Returns:
    
    value or null for none
  - setFinePrint
```
public OfferClass setFinePrint(String finePrint)
```
    The fine print or terms of the offer, such as "20% off any t-shirt at Adam's Apparel."
    
    Parameters:
    
    finePrint - finePrint or null for none
  - getHelpUri
```
public Uri getHelpUri()
```
    The help link for the offer, such as `http://myownpersonaldomain.com/help`
    
    Returns:
    
    value or null for none
  - setHelpUri
```
public OfferClass setHelpUri(Uri helpUri)
```
    The help link for the offer, such as `http://myownpersonaldomain.com/help`
    
    Parameters:
    
    helpUri - helpUri or null for none
  - getHeroImage
```
public Image getHeroImage()
```
    Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
    
    Returns:
    
    value or null for none
  - setHeroImage
```
public OfferClass setHeroImage(Image heroImage)
```
    Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.
    
    Parameters:
    
    heroImage - heroImage or null for none
  - getHexBackgroundColor
```
public String getHexBackgroundColor()
```
    The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
    
    Returns:
    
    value or null for none
  - setHexBackgroundColor
```
public OfferClass setHexBackgroundColor(String hexBackgroundColor)
```
    The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
    
    Parameters:
    
    hexBackgroundColor - hexBackgroundColor or null for none
  - getHomepageUri
```
public Uri getHomepageUri()
```
    The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
    
    Returns:
    
    value or null for none
  - setHomepageUri
```
public OfferClass setHomepageUri(Uri homepageUri)
```
    The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).
    
    Parameters:
    
    homepageUri - homepageUri or null for none
  - getId
```
public String getId()
```
    Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
    
    Returns:
    
    value or null for none
  - setId
```
public OfferClass setId(String id)
```
    Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
    
    Parameters:
    
    id - id or null for none
  - getImageModulesData
```
public List<ImageModuleData> getImageModulesData()
```
    Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
    
    Returns:
    
    value or null for none
  - setImageModulesData
```
public OfferClass setImageModulesData(List<ImageModuleData> imageModulesData)
```
    Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
    
    Parameters:
    
    imageModulesData - imageModulesData or null for none
  - getInfoModuleData
```
public InfoModuleData getInfoModuleData()
```
    Deprecated. Use textModulesData instead.
    
    Returns:
    
    value or null for none
  - setInfoModuleData
```
public OfferClass setInfoModuleData(InfoModuleData infoModuleData)
```
    Deprecated. Use textModulesData instead.
    
    Parameters:
    
    infoModuleData - infoModuleData or null for none
  - getIssuerName
```
public String getIssuerName()
```
    Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
    
    Returns:
    
    value or null for none
  - setIssuerName
```
public OfferClass setIssuerName(String issuerName)
```
    Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
    
    Parameters:
    
    issuerName - issuerName or null for none
  - getKind
```
public String getKind()
```
    Identifies what kind of resource this is. Value: the fixed string `"walletobjects#offerClass"`.
    
    Returns:
    
    value or null for none
  - setKind
```
public OfferClass setKind(String kind)
```
    Identifies what kind of resource this is. Value: the fixed string `"walletobjects#offerClass"`.
    
    Parameters:
    
    kind - kind or null for none
  - getLinksModuleData
```
public LinksModuleData getLinksModuleData()
```
    Links module data. If links module data is also defined on the object, both will be displayed.
    
    Returns:
    
    value or null for none
  - setLinksModuleData
```
public OfferClass setLinksModuleData(LinksModuleData linksModuleData)
```
    Links module data. If links module data is also defined on the object, both will be displayed.
    
    Parameters:
    
    linksModuleData - linksModuleData or null for none
  - getLocalizedDetails
```
public LocalizedString getLocalizedDetails()
```
    Translated strings for the details.
    
    Returns:
    
    value or null for none
  - setLocalizedDetails
```
public OfferClass setLocalizedDetails(LocalizedString localizedDetails)
```
    Translated strings for the details.
    
    Parameters:
    
    localizedDetails - localizedDetails or null for none
  - getLocalizedFinePrint
```
public LocalizedString getLocalizedFinePrint()
```
    Translated strings for the fine_print.
    
    Returns:
    
    value or null for none
  - setLocalizedFinePrint
```
public OfferClass setLocalizedFinePrint(LocalizedString localizedFinePrint)
```
    Translated strings for the fine_print.
    
    Parameters:
    
    localizedFinePrint - localizedFinePrint or null for none
  - getLocalizedIssuerName
```
public LocalizedString getLocalizedIssuerName()
```
    Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
    
    Returns:
    
    value or null for none
  - setLocalizedIssuerName
```
public OfferClass setLocalizedIssuerName(LocalizedString localizedIssuerName)
```
    Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
    
    Parameters:
    
    localizedIssuerName - localizedIssuerName or null for none
  - getLocalizedProvider
```
public LocalizedString getLocalizedProvider()
```
    Translated strings for the provider. Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens.
    
    Returns:
    
    value or null for none
  - setLocalizedProvider
```
public OfferClass setLocalizedProvider(LocalizedString localizedProvider)
```
    Translated strings for the provider. Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens.
    
    Parameters:
    
    localizedProvider - localizedProvider or null for none
  - getLocalizedShortTitle
```
public LocalizedString getLocalizedShortTitle()
```
    Translated strings for the short title. Recommended maximum length is 20 characters.
    
    Returns:
    
    value or null for none
  - setLocalizedShortTitle
```
public OfferClass setLocalizedShortTitle(LocalizedString localizedShortTitle)
```
    Translated strings for the short title. Recommended maximum length is 20 characters.
    
    Parameters:
    
    localizedShortTitle - localizedShortTitle or null for none
  - getLocalizedTitle
```
public LocalizedString getLocalizedTitle()
```
    Translated strings for the title. Recommended maximum length is 60 characters to ensure full string is displayed on smaller screens.
    
    Returns:
    
    value or null for none
  - setLocalizedTitle
```
public OfferClass setLocalizedTitle(LocalizedString localizedTitle)
```
    Translated strings for the title. Recommended maximum length is 60 characters to ensure full string is displayed on smaller screens.
    
    Parameters:
    
    localizedTitle - localizedTitle or null for none
  - getLocations
```
public List<LatLongPoint> getLocations()
```
    Note: This field is currently not supported to trigger geo notifications.
    
    Returns:
    
    value or null for none
  - setLocations
```
public OfferClass setLocations(List<LatLongPoint> locations)
```
    Note: This field is currently not supported to trigger geo notifications.
    
    Parameters:
    
    locations - locations or null for none
  - getMerchantLocations
```
public List<MerchantLocation> getMerchantLocations()
```
    Merchant locations. There is a maximum of ten on the class. Any additional MerchantLocations added beyond the 10 will be rejected. These locations will trigger a notification when a user enters within a Google-set radius of the point. This field replaces the deprecated LatLongPoints.
    
    Returns:
    
    value or null for none
  - setMerchantLocations
```
public OfferClass setMerchantLocations(List<MerchantLocation> merchantLocations)
```
    Merchant locations. There is a maximum of ten on the class. Any additional MerchantLocations added beyond the 10 will be rejected. These locations will trigger a notification when a user enters within a Google-set radius of the point. This field replaces the deprecated LatLongPoints.
    
    Parameters:
    
    merchantLocations - merchantLocations or null for none
  - getMessages
```
public List<Message> getMessages()
```
    An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
    
    Returns:
    
    value or null for none
  - setMessages
```
public OfferClass setMessages(List<Message> messages)
```
    An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
    
    Parameters:
    
    messages - messages or null for none
  - getMultipleDevicesAndHoldersAllowedStatus
```
public String getMultipleDevicesAndHoldersAllowedStatus()
```
    Identifies whether multiple users and devices will save the same object referencing this class.
    
    Returns:
    
    value or null for none
  - setMultipleDevicesAndHoldersAllowedStatus
```
public OfferClass setMultipleDevicesAndHoldersAllowedStatus(String multipleDevicesAndHoldersAllowedStatus)
```
    Identifies whether multiple users and devices will save the same object referencing this class.
    
    Parameters:
    
    multipleDevicesAndHoldersAllowedStatus - multipleDevicesAndHoldersAllowedStatus or null for none
  - getNotifyPreference
```
public String getNotifyPreference()
```
    Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.
    
    Returns:
    
    value or null for none
  - setNotifyPreference
```
public OfferClass setNotifyPreference(String notifyPreference)
```
    Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If not specified, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.
    
    Parameters:
    
    notifyPreference - notifyPreference or null for none
  - getProvider
```
public String getProvider()
```
    Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens.
    
    Returns:
    
    value or null for none
  - setProvider
```
public OfferClass setProvider(String provider)
```
    Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens.
    
    Parameters:
    
    provider - provider or null for none
  - getRedemptionChannel
```
public String getRedemptionChannel()
```
    Required. The redemption channels applicable to this offer.
    
    Returns:
    
    value or null for none
  - setRedemptionChannel
```
public OfferClass setRedemptionChannel(String redemptionChannel)
```
    Required. The redemption channels applicable to this offer.
    
    Parameters:
    
    redemptionChannel - redemptionChannel or null for none
  - getRedemptionIssuers
```
public List<Long> getRedemptionIssuers()
```
    Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
    
    Returns:
    
    value or null for none
  - setRedemptionIssuers
```
public OfferClass setRedemptionIssuers(List<Long> redemptionIssuers)
```
    Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The `enableSmartTap` and object level `smartTapRedemptionLevel` fields must also be set up correctly in order for a pass to support Smart Tap.
    
    Parameters:
    
    redemptionIssuers - redemptionIssuers or null for none
  - getReview
```
public Review getReview()
```
    The review comments set by the platform when a class is marked `approved` or `rejected`.
    
    Returns:
    
    value or null for none
  - setReview
```
public OfferClass setReview(Review review)
```
    The review comments set by the platform when a class is marked `approved` or `rejected`.
    
    Parameters:
    
    review - review or null for none
  - getReviewStatus
```
public String getReviewStatus()
```
    Required. The status of the class. This field can be set to `draft` or The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
    
    Returns:
    
    value or null for none
  - setReviewStatus
```
public OfferClass setReviewStatus(String reviewStatus)
```
    Required. The status of the class. This field can be set to `draft` or The status of the class. This field can be set to `draft` or `underReview` using the insert, patch, or update API calls. Once the review state is changed from `draft` it may not be changed back to `draft`. You should keep this field to `draft` when the class is under development. A `draft` class cannot be used to create any object. You should set this field to `underReview` when you believe the class is ready for use. The platform will automatically set this field to `approved` and it can be immediately used to create or migrate objects. When updating an already `approved` class you should keep setting this field to `underReview`.
    
    Parameters:
    
    reviewStatus - reviewStatus or null for none
  - getSecurityAnimation
```
public SecurityAnimation getSecurityAnimation()
```
    Optional information about the security animation. If this is set a security animation will be rendered on pass details.
    
    Returns:
    
    value or null for none
  - setSecurityAnimation
```
public OfferClass setSecurityAnimation(SecurityAnimation securityAnimation)
```
    Optional information about the security animation. If this is set a security animation will be rendered on pass details.
    
    Parameters:
    
    securityAnimation - securityAnimation or null for none
  - getShortTitle
```
public String getShortTitle()
```
    A shortened version of the title of the offer, such as "20% off," shown to users as a quick reference to the offer contents. Recommended maximum length is 20 characters.
    
    Returns:
    
    value or null for none
  - setShortTitle
```
public OfferClass setShortTitle(String shortTitle)
```
    A shortened version of the title of the offer, such as "20% off," shown to users as a quick reference to the offer contents. Recommended maximum length is 20 characters.
    
    Parameters:
    
    shortTitle - shortTitle or null for none
  - getTextModulesData
```
public List<TextModuleData> getTextModulesData()
```
    Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
    
    Returns:
    
    value or null for none
  - setTextModulesData
```
public OfferClass setTextModulesData(List<TextModuleData> textModulesData)
```
    Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
    
    Parameters:
    
    textModulesData - textModulesData or null for none
  - getTitle
```
public String getTitle()
```
    Required. The title of the offer, such as "20% off any t-shirt." Recommended maximum length is 60 characters to ensure full string is displayed on smaller screens.
    
    Returns:
    
    value or null for none
  - setTitle
```
public OfferClass setTitle(String title)
```
    Required. The title of the offer, such as "20% off any t-shirt." Recommended maximum length is 60 characters to ensure full string is displayed on smaller screens.
    
    Parameters:
    
    title - title or null for none
  - getTitleImage
```
public Image getTitleImage()
```
    The title image of the offer. This image is displayed in both the details and list views of the app.
    
    Returns:
    
    value or null for none
  - setTitleImage
```
public OfferClass setTitleImage(Image titleImage)
```
    The title image of the offer. This image is displayed in both the details and list views of the app.
    
    Parameters:
    
    titleImage - titleImage or null for none
  - getValueAddedModuleData
```
public List<ValueAddedModuleData> getValueAddedModuleData()
```
    Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
    
    Returns:
    
    value or null for none
  - setValueAddedModuleData
```
public OfferClass setValueAddedModuleData(List<ValueAddedModuleData> valueAddedModuleData)
```
    Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
    
    Parameters:
    
    valueAddedModuleData - valueAddedModuleData or null for none
  - getVersion
```
public Long getVersion()
```
    Deprecated
    
    Returns:
    
    value or null for none
  - setVersion
```
public OfferClass setVersion(Long version)
```
    Deprecated
    
    Parameters:
    
    version - version or null for none
  - getViewUnlockRequirement
```
public String getViewUnlockRequirement()
```
    View Unlock Requirement options for the offer.
    
    Returns:
    
    value or null for none
  - setViewUnlockRequirement
```
public OfferClass setViewUnlockRequirement(String viewUnlockRequirement)
```
    View Unlock Requirement options for the offer.
    
    Parameters:
    
    viewUnlockRequirement - viewUnlockRequirement or null for none
  - getWideTitleImage
```
public Image getWideTitleImage()
```
    The wide title image of the offer. When provided, this will be used in place of the title image in the top left of the card view.
    
    Returns:
    
    value or null for none
  - setWideTitleImage
```
public OfferClass setWideTitleImage(Image wideTitleImage)
```
    The wide title image of the offer. When provided, this will be used in place of the title image in the top left of the card view.
    
    Parameters:
    
    wideTitleImage - wideTitleImage or null for none
  - getWordMark
```
public Image getWordMark()
```
    Deprecated.
    
    Returns:
    
    value or null for none
  - setWordMark
```
public OfferClass setWordMark(Image wordMark)
```
    Deprecated.
    
    Parameters:
    
    wordMark - wordMark or null for none
  - set
```
public OfferClass set(String fieldName,
                      Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public OfferClass clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class OfferClass

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

OfferClass

Method Detail

getAllowMultipleUsersPerObject

setAllowMultipleUsersPerObject

getAppLinkData

setAppLinkData

getCallbackOptions

setCallbackOptions

getClassTemplateInfo

setClassTemplateInfo

getCountryCode

setCountryCode

getDetails

setDetails

getEnableSmartTap

setEnableSmartTap

getFinePrint

setFinePrint

getHelpUri

setHelpUri

getHeroImage

setHeroImage

getHexBackgroundColor

setHexBackgroundColor

getHomepageUri

setHomepageUri

getId

setId

getImageModulesData

setImageModulesData

getInfoModuleData

setInfoModuleData

getIssuerName

setIssuerName

getKind

setKind

getLinksModuleData

setLinksModuleData

getLocalizedDetails

setLocalizedDetails

getLocalizedFinePrint

setLocalizedFinePrint

getLocalizedIssuerName

setLocalizedIssuerName

getLocalizedProvider

setLocalizedProvider

getLocalizedShortTitle

setLocalizedShortTitle

getLocalizedTitle

setLocalizedTitle

getLocations

setLocations

getMerchantLocations

setMerchantLocations

getMessages

setMessages

getMultipleDevicesAndHoldersAllowedStatus

setMultipleDevicesAndHoldersAllowedStatus

getNotifyPreference

setNotifyPreference

getProvider

setProvider

getRedemptionChannel

setRedemptionChannel

getRedemptionIssuers

setRedemptionIssuers

getReview