LoyaltyObject (Google Wallet API v1-rev20250312-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.LoyaltyObject

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class LoyaltyObject
extends com.google.api.client.json.GenericJson
```
Model definition for LoyaltyObject.
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

LoyaltyObject()

Constructors
Constructor and Description
`LoyaltyObject()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LoyaltyObject`	`clone()`
`String`	`getAccountId()` The loyalty account identifier.
`String`	`getAccountName()` The loyalty account holder name, such as "John Smith." Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
`AppLinkData`	`getAppLinkData()` Optional app or website link that will be displayed as a button on the front of the pass.
`Barcode`	`getBarcode()` The barcode type and value.
`String`	`getClassId()` Required.
`LoyaltyClass`	`getClassReference()` A copy of the inherited fields of the parent class.
`Boolean`	`getDisableExpirationNotification()` Indicates if notifications should explicitly be suppressed.
`GroupingInfo`	`getGroupingInfo()` Information that controls how passes are grouped together.
`Boolean`	`getHasLinkedDevice()` Whether this object is currently linked to a single device.
`Boolean`	`getHasUsers()` Indicates if the object has users.
`Image`	`getHeroImage()` Optional banner image displayed on the front of the card.
`String`	`getId()` Required.
`List<ImageModuleData>`	`getImageModulesData()` Image module data.
`InfoModuleData`	`getInfoModuleData()` Deprecated.
`String`	`getKind()` Identifies what kind of resource this is.
`List<String>`	`getLinkedObjectIds()` linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this loyalty object.
`List<String>`	`getLinkedOfferIds()` A list of offer objects linked to this loyalty card.
`LinksModuleData`	`getLinksModuleData()` Links module data.
`List<LatLongPoint>`	`getLocations()` Note: This field is currently not supported to trigger geo notifications.
`LoyaltyPoints`	`getLoyaltyPoints()` The loyalty reward points label, balance, and type.
`List<MerchantLocation>`	`getMerchantLocations()` Merchant locations.
`List<Message>`	`getMessages()` An array of messages displayed in the app.
`String`	`getNotifyPreference()` Whether or not field updates to this object should trigger notifications.
`PassConstraints`	`getPassConstraints()` Pass constraints for the object.
`RotatingBarcode`	`getRotatingBarcode()` The rotating barcode type and value.
`SaveRestrictions`	`getSaveRestrictions()` Restrictions on the object that needs to be verified before the user tries to save the pass.
`LoyaltyPoints`	`getSecondaryLoyaltyPoints()` The secondary loyalty reward points label, balance, and type.
`String`	`getSmartTapRedemptionValue()` The value that will be transmitted to a Smart Tap certified terminal over NFC for this object.
`String`	`getState()` Required.
`List<TextModuleData>`	`getTextModulesData()` Text module data.
`TimeInterval`	`getValidTimeInterval()` The time period this object will be `active` and object can be used.
`List<ValueAddedModuleData>`	`getValueAddedModuleData()` Optional value added module data.
`Long`	`getVersion()` Deprecated
`LoyaltyObject`	`set(String fieldName, Object value)`
`LoyaltyObject`	`setAccountId(String accountId)` The loyalty account identifier.
`LoyaltyObject`	`setAccountName(String accountName)` The loyalty account holder name, such as "John Smith." Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
`LoyaltyObject`	`setAppLinkData(AppLinkData appLinkData)` Optional app or website link that will be displayed as a button on the front of the pass.
`LoyaltyObject`	`setBarcode(Barcode barcode)` The barcode type and value.
`LoyaltyObject`	`setClassId(String classId)` Required.
`LoyaltyObject`	`setClassReference(LoyaltyClass classReference)` A copy of the inherited fields of the parent class.
`LoyaltyObject`	`setDisableExpirationNotification(Boolean disableExpirationNotification)` Indicates if notifications should explicitly be suppressed.
`LoyaltyObject`	`setGroupingInfo(GroupingInfo groupingInfo)` Information that controls how passes are grouped together.
`LoyaltyObject`	`setHasLinkedDevice(Boolean hasLinkedDevice)` Whether this object is currently linked to a single device.
`LoyaltyObject`	`setHasUsers(Boolean hasUsers)` Indicates if the object has users.
`LoyaltyObject`	`setHeroImage(Image heroImage)` Optional banner image displayed on the front of the card.
`LoyaltyObject`	`setId(String id)` Required.
`LoyaltyObject`	`setImageModulesData(List<ImageModuleData> imageModulesData)` Image module data.
`LoyaltyObject`	`setInfoModuleData(InfoModuleData infoModuleData)` Deprecated.
`LoyaltyObject`	`setKind(String kind)` Identifies what kind of resource this is.
`LoyaltyObject`	`setLinkedObjectIds(List<String> linkedObjectIds)` linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this loyalty object.
`LoyaltyObject`	`setLinkedOfferIds(List<String> linkedOfferIds)` A list of offer objects linked to this loyalty card.
`LoyaltyObject`	`setLinksModuleData(LinksModuleData linksModuleData)` Links module data.
`LoyaltyObject`	`setLocations(List<LatLongPoint> locations)` Note: This field is currently not supported to trigger geo notifications.
`LoyaltyObject`	`setLoyaltyPoints(LoyaltyPoints loyaltyPoints)` The loyalty reward points label, balance, and type.
`LoyaltyObject`	`setMerchantLocations(List<MerchantLocation> merchantLocations)` Merchant locations.
`LoyaltyObject`	`setMessages(List<Message> messages)` An array of messages displayed in the app.
`LoyaltyObject`	`setNotifyPreference(String notifyPreference)` Whether or not field updates to this object should trigger notifications.
`LoyaltyObject`	`setPassConstraints(PassConstraints passConstraints)` Pass constraints for the object.
`LoyaltyObject`	`setRotatingBarcode(RotatingBarcode rotatingBarcode)` The rotating barcode type and value.
`LoyaltyObject`	`setSaveRestrictions(SaveRestrictions saveRestrictions)` Restrictions on the object that needs to be verified before the user tries to save the pass.
`LoyaltyObject`	`setSecondaryLoyaltyPoints(LoyaltyPoints secondaryLoyaltyPoints)` The secondary loyalty reward points label, balance, and type.
`LoyaltyObject`	`setSmartTapRedemptionValue(String smartTapRedemptionValue)` The value that will be transmitted to a Smart Tap certified terminal over NFC for this object.
`LoyaltyObject`	`setState(String state)` Required.
`LoyaltyObject`	`setTextModulesData(List<TextModuleData> textModulesData)` Text module data.
`LoyaltyObject`	`setValidTimeInterval(TimeInterval validTimeInterval)` The time period this object will be `active` and object can be used.
`LoyaltyObject`	`setValueAddedModuleData(List<ValueAddedModuleData> valueAddedModuleData)` Optional value added module data.
`LoyaltyObject`	`setVersion(Long version)` 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
  - LoyaltyObject
```
public LoyaltyObject()
```
- Method Detail
  - getAccountId
```
public String getAccountId()
```
    The loyalty account identifier. Recommended maximum length is 20 characters.
    
    Returns:
    
    value or null for none
  - setAccountId
```
public LoyaltyObject setAccountId(String accountId)
```
    The loyalty account identifier. Recommended maximum length is 20 characters.
    
    Parameters:
    
    accountId - accountId or null for none
  - getAccountName
```
public String getAccountName()
```
    The loyalty account holder name, such as "John Smith." Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
    
    Returns:
    
    value or null for none
  - setAccountName
```
public LoyaltyObject setAccountName(String accountName)
```
    The loyalty account holder name, such as "John Smith." Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
    
    Parameters:
    
    accountName - accountName 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 class only object AppLinkData will be displayed.
    
    Returns:
    
    value or null for none
  - setAppLinkData
```
public LoyaltyObject 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 class only object AppLinkData will be displayed.
    
    Parameters:
    
    appLinkData - appLinkData or null for none
  - getBarcode
```
public Barcode getBarcode()
```
    The barcode type and value.
    
    Returns:
    
    value or null for none
  - setBarcode
```
public LoyaltyObject setBarcode(Barcode barcode)
```
    The barcode type and value.
    
    Parameters:
    
    barcode - barcode or null for none
  - getClassId
```
public String getClassId()
```
    Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
    
    Returns:
    
    value or null for none
  - setClassId
```
public LoyaltyObject setClassId(String classId)
```
    Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.
    
    Parameters:
    
    classId - classId or null for none
  - getClassReference
```
public LoyaltyClass getClassReference()
```
    A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
    
    Returns:
    
    value or null for none
  - setClassReference
```
public LoyaltyObject setClassReference(LoyaltyClass classReference)
```
    A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
    
    Parameters:
    
    classReference - classReference or null for none
  - getDisableExpirationNotification
```
public Boolean getDisableExpirationNotification()
```
    Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for offers.
    
    Returns:
    
    value or null for none
  - setDisableExpirationNotification
```
public LoyaltyObject setDisableExpirationNotification(Boolean disableExpirationNotification)
```
    Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for offers.
    
    Parameters:
    
    disableExpirationNotification - disableExpirationNotification or null for none
  - getGroupingInfo
```
public GroupingInfo getGroupingInfo()
```
    Information that controls how passes are grouped together.
    
    Returns:
    
    value or null for none
  - setGroupingInfo
```
public LoyaltyObject setGroupingInfo(GroupingInfo groupingInfo)
```
    Information that controls how passes are grouped together.
    
    Parameters:
    
    groupingInfo - groupingInfo or null for none
  - getHasLinkedDevice
```
public Boolean getHasLinkedDevice()
```
    Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
    
    Returns:
    
    value or null for none
  - setHasLinkedDevice
```
public LoyaltyObject setHasLinkedDevice(Boolean hasLinkedDevice)
```
    Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
    
    Parameters:
    
    hasLinkedDevice - hasLinkedDevice or null for none
  - getHasUsers
```
public Boolean getHasUsers()
```
    Indicates if the object has users. This field is set by the platform.
    
    Returns:
    
    value or null for none
  - setHasUsers
```
public LoyaltyObject setHasUsers(Boolean hasUsers)
```
    Indicates if the object has users. This field is set by the platform.
    
    Parameters:
    
    hasUsers - hasUsers or null for none
  - getHeroImage
```
public Image getHeroImage()
```
    Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
    
    Returns:
    
    value or null for none
  - setHeroImage
```
public LoyaltyObject setHeroImage(Image heroImage)
```
    Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
    
    Parameters:
    
    heroImage - heroImage or null for none
  - getId
```
public String getId()
```
    Required. The unique identifier for an object. This ID must be unique across all objects 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. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
    
    Returns:
    
    value or null for none
  - setId
```
public LoyaltyObject setId(String id)
```
    Required. The unique identifier for an object. This ID must be unique across all objects 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. The 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 LoyaltyObject 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 LoyaltyObject setInfoModuleData(InfoModuleData infoModuleData)
```
    Deprecated. Use textModulesData instead.
    
    Parameters:
    
    infoModuleData - infoModuleData or null for none
  - getKind
```
public String getKind()
```
    Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyObject"`.
    
    Returns:
    
    value or null for none
  - setKind
```
public LoyaltyObject setKind(String kind)
```
    Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyObject"`.
    
    Parameters:
    
    kind - kind or null for none
  - getLinkedObjectIds
```
public List<String> getLinkedObjectIds()
```
    linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this loyalty object. If a user had saved this loyalty card, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you.
    
    Returns:
    
    value or null for none
  - setLinkedObjectIds
```
public LoyaltyObject setLinkedObjectIds(List<String> linkedObjectIds)
```
    linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this loyalty object. If a user had saved this loyalty card, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you.
    
    Parameters:
    
    linkedObjectIds - linkedObjectIds or null for none
  - getLinkedOfferIds
```
public List<String> getLinkedOfferIds()
```
    A list of offer objects linked to this loyalty card. The offer objects must already exist. Offer object IDs should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you.
    
    Returns:
    
    value or null for none
  - setLinkedOfferIds
```
public LoyaltyObject setLinkedOfferIds(List<String> linkedOfferIds)
```
    A list of offer objects linked to this loyalty card. The offer objects must already exist. Offer object IDs should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you.
    
    Parameters:
    
    linkedOfferIds - linkedOfferIds or null for none
  - getLinksModuleData
```
public LinksModuleData getLinksModuleData()
```
    Links module data. If links module data is also defined on the class, both will be displayed.
    
    Returns:
    
    value or null for none
  - setLinksModuleData
```
public LoyaltyObject setLinksModuleData(LinksModuleData linksModuleData)
```
    Links module data. If links module data is also defined on the class, both will be displayed.
    
    Parameters:
    
    linksModuleData - linksModuleData 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 LoyaltyObject setLocations(List<LatLongPoint> locations)
```
    Note: This field is currently not supported to trigger geo notifications.
    
    Parameters:
    
    locations - locations or null for none
  - getLoyaltyPoints
```
public LoyaltyPoints getLoyaltyPoints()
```
    The loyalty reward points label, balance, and type.
    
    Returns:
    
    value or null for none
  - setLoyaltyPoints
```
public LoyaltyObject setLoyaltyPoints(LoyaltyPoints loyaltyPoints)
```
    The loyalty reward points label, balance, and type.
    
    Parameters:
    
    loyaltyPoints - loyaltyPoints or null for none
  - getMerchantLocations
```
public List<MerchantLocation> getMerchantLocations()
```
    Merchant locations. There is a maximum of ten on the object. 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 LoyaltyObject setMerchantLocations(List<MerchantLocation> merchantLocations)
```
    Merchant locations. There is a maximum of ten on the object. 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 LoyaltyObject 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
  - getNotifyPreference
```
public String getNotifyPreference()
```
    Whether or not field updates to this object 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 set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, 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 LoyaltyObject setNotifyPreference(String notifyPreference)
```
    Whether or not field updates to this object 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 set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, 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
  - getPassConstraints
```
public PassConstraints getPassConstraints()
```
    Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
    
    Returns:
    
    value or null for none
  - setPassConstraints
```
public LoyaltyObject setPassConstraints(PassConstraints passConstraints)
```
    Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
    
    Parameters:
    
    passConstraints - passConstraints or null for none
  - getRotatingBarcode
```
public RotatingBarcode getRotatingBarcode()
```
    The rotating barcode type and value.
    
    Returns:
    
    value or null for none
  - setRotatingBarcode
```
public LoyaltyObject setRotatingBarcode(RotatingBarcode rotatingBarcode)
```
    The rotating barcode type and value.
    
    Parameters:
    
    rotatingBarcode - rotatingBarcode or null for none
  - getSaveRestrictions
```
public SaveRestrictions getSaveRestrictions()
```
    Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass.
    
    Returns:
    
    value or null for none
  - setSaveRestrictions
```
public LoyaltyObject setSaveRestrictions(SaveRestrictions saveRestrictions)
```
    Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass.
    
    Parameters:
    
    saveRestrictions - saveRestrictions or null for none
  - getSecondaryLoyaltyPoints
```
public LoyaltyPoints getSecondaryLoyaltyPoints()
```
    The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points.
    
    Returns:
    
    value or null for none
  - setSecondaryLoyaltyPoints
```
public LoyaltyObject setSecondaryLoyaltyPoints(LoyaltyPoints secondaryLoyaltyPoints)
```
    The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points.
    
    Parameters:
    
    secondaryLoyaltyPoints - secondaryLoyaltyPoints or null for none
  - getSmartTapRedemptionValue
```
public String getSmartTapRedemptionValue()
```
    The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. If this value is not set but the class level fields `enableSmartTap` and `redemptionIssuers` are set up correctly, the `barcode.value` or the `accountId` fields are used as fallback if present.
    
    Returns:
    
    value or null for none
  - setSmartTapRedemptionValue
```
public LoyaltyObject setSmartTapRedemptionValue(String smartTapRedemptionValue)
```
    The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. If this value is not set but the class level fields `enableSmartTap` and `redemptionIssuers` are set up correctly, the `barcode.value` or the `accountId` fields are used as fallback if present.
    
    Parameters:
    
    smartTapRedemptionValue - smartTapRedemptionValue or null for none
  - getState
```
public String getState()
```
    Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
    
    Returns:
    
    value or null for none
  - setState
```
public LoyaltyObject setState(String state)
```
    Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section.
    
    Parameters:
    
    state - state 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 LoyaltyObject 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
  - getValidTimeInterval
```
public TimeInterval getValidTimeInterval()
```
    The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
    
    Returns:
    
    value or null for none
  - setValidTimeInterval
```
public LoyaltyObject setValidTimeInterval(TimeInterval validTimeInterval)
```
    The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
    
    Parameters:
    
    validTimeInterval - validTimeInterval or null for none
  - getValueAddedModuleData
```
public List<ValueAddedModuleData> getValueAddedModuleData()
```
    Optional value added module data. Maximum of ten on the object.
    
    Returns:
    
    value or null for none
  - setValueAddedModuleData
```
public LoyaltyObject setValueAddedModuleData(List<ValueAddedModuleData> valueAddedModuleData)
```
    Optional value added module data. Maximum of ten on the object.
    
    Parameters:
    
    valueAddedModuleData - valueAddedModuleData or null for none
  - getVersion
```
public Long getVersion()
```
    Deprecated
    
    Returns:
    
    value or null for none
  - setVersion
```
public LoyaltyObject setVersion(Long version)
```
    Deprecated
    
    Parameters:
    
    version - version or null for none
  - set
```
public LoyaltyObject set(String fieldName,
                         Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public LoyaltyObject clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class LoyaltyObject

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

LoyaltyObject

Method Detail

getAccountId

setAccountId

getAccountName

setAccountName

getAppLinkData

setAppLinkData

getBarcode

setBarcode

getClassId

setClassId

getClassReference

setClassReference

getDisableExpirationNotification

setDisableExpirationNotification

getGroupingInfo

setGroupingInfo

getHasLinkedDevice

setHasLinkedDevice

getHasUsers

setHasUsers

getHeroImage

setHeroImage

getId

setId

getImageModulesData

setImageModulesData

getInfoModuleData

setInfoModuleData

getKind

setKind

getLinkedObjectIds

setLinkedObjectIds

getLinkedOfferIds

setLinkedOfferIds

getLinksModuleData

setLinksModuleData

getLocations

setLocations

getLoyaltyPoints

setLoyaltyPoints

getMerchantLocations

setMerchantLocations

getMessages

setMessages

getNotifyPreference

setNotifyPreference

getPassConstraints

setPassConstraints

getRotatingBarcode

setRotatingBarcode

getSaveRestrictions

setSaveRestrictions

getSecondaryLoyaltyPoints

setSecondaryLoyaltyPoints

getSmartTapRedemptionValue

setSmartTapRedemptionValue

getState

setState

getTextModulesData

setTextModulesData

getValidTimeInterval

setValidTimeInterval

getValueAddedModuleData

setValueAddedModuleData

getVersion