GiftCardObject (Google Wallet API v1-rev20240109-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.GiftCardObject

All Implemented Interfaces:

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

GiftCardObject()

Constructors
Constructor and Description
`GiftCardObject()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GiftCardObject`	`clone()`
`AppLinkData`	`getAppLinkData()` Optional information about the partner app link.
`Money`	`getBalance()` The card's monetary balance.
`DateTime`	`getBalanceUpdateTime()` The date and time when the balance was last updated.
`Barcode`	`getBarcode()` The barcode type and value.
`String`	`getCardNumber()` Required.
`String`	`getClassId()` Required.
`GiftCardClass`	`getClassReference()` A copy of the inherited fields of the parent class.
`Boolean`	`getDisableExpirationNotification()` Indicates if notifications should explicitly be suppressed.
`String`	`getEventNumber()` The card's event number, an optional field used by some gift cards.
`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.
`LinksModuleData`	`getLinksModuleData()` Links module data.
`List<LatLongPoint>`	`getLocations()` Note: This field is currently not supported to trigger geo notifications.
`List<Message>`	`getMessages()` An array of messages displayed in the app.
`PassConstraints`	`getPassConstraints()` Pass constraints for the object.
`String`	`getPin()` The card's PIN.
`RotatingBarcode`	`getRotatingBarcode()` The rotating barcode type and value.
`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.
`Long`	`getVersion()` Deprecated
`GiftCardObject`	`set(String fieldName, Object value)`
`GiftCardObject`	`setAppLinkData(AppLinkData appLinkData)` Optional information about the partner app link.
`GiftCardObject`	`setBalance(Money balance)` The card's monetary balance.
`GiftCardObject`	`setBalanceUpdateTime(DateTime balanceUpdateTime)` The date and time when the balance was last updated.
`GiftCardObject`	`setBarcode(Barcode barcode)` The barcode type and value.
`GiftCardObject`	`setCardNumber(String cardNumber)` Required.
`GiftCardObject`	`setClassId(String classId)` Required.
`GiftCardObject`	`setClassReference(GiftCardClass classReference)` A copy of the inherited fields of the parent class.
`GiftCardObject`	`setDisableExpirationNotification(Boolean disableExpirationNotification)` Indicates if notifications should explicitly be suppressed.
`GiftCardObject`	`setEventNumber(String eventNumber)` The card's event number, an optional field used by some gift cards.
`GiftCardObject`	`setGroupingInfo(GroupingInfo groupingInfo)` Information that controls how passes are grouped together.
`GiftCardObject`	`setHasLinkedDevice(Boolean hasLinkedDevice)` Whether this object is currently linked to a single device.
`GiftCardObject`	`setHasUsers(Boolean hasUsers)` Indicates if the object has users.
`GiftCardObject`	`setHeroImage(Image heroImage)` Optional banner image displayed on the front of the card.
`GiftCardObject`	`setId(String id)` Required.
`GiftCardObject`	`setImageModulesData(List<ImageModuleData> imageModulesData)` Image module data.
`GiftCardObject`	`setInfoModuleData(InfoModuleData infoModuleData)` Deprecated.
`GiftCardObject`	`setKind(String kind)` Identifies what kind of resource this is.
`GiftCardObject`	`setLinksModuleData(LinksModuleData linksModuleData)` Links module data.
`GiftCardObject`	`setLocations(List<LatLongPoint> locations)` Note: This field is currently not supported to trigger geo notifications.
`GiftCardObject`	`setMessages(List<Message> messages)` An array of messages displayed in the app.
`GiftCardObject`	`setPassConstraints(PassConstraints passConstraints)` Pass constraints for the object.
`GiftCardObject`	`setPin(String pin)` The card's PIN.
`GiftCardObject`	`setRotatingBarcode(RotatingBarcode rotatingBarcode)` The rotating barcode type and value.
`GiftCardObject`	`setSmartTapRedemptionValue(String smartTapRedemptionValue)` The value that will be transmitted to a Smart Tap certified terminal over NFC for this object.
`GiftCardObject`	`setState(String state)` Required.
`GiftCardObject`	`setTextModulesData(List<TextModuleData> textModulesData)` Text module data.
`GiftCardObject`	`setValidTimeInterval(TimeInterval validTimeInterval)` The time period this object will be `active` and object can be used.
`GiftCardObject`	`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
  - GiftCardObject
```
public GiftCardObject()
```
- Method Detail
  - getAppLinkData
```
public AppLinkData getAppLinkData()
```
    Optional information about the partner app link.
    
    Returns:
    
    value or null for none
  - setAppLinkData
```
public GiftCardObject setAppLinkData(AppLinkData appLinkData)
```
    Optional information about the partner app link.
    
    Parameters:
    
    appLinkData - appLinkData or null for none
  - getBalance
```
public Money getBalance()
```
    The card's monetary balance.
    
    Returns:
    
    value or null for none
  - setBalance
```
public GiftCardObject setBalance(Money balance)
```
    The card's monetary balance.
    
    Parameters:
    
    balance - balance or null for none
  - getBalanceUpdateTime
```
public DateTime getBalanceUpdateTime()
```
    The date and time when the balance was last updated. Offset is required. If balance is updated and this property is not provided, system will default to the current time.
    
    Returns:
    
    value or null for none
  - setBalanceUpdateTime
```
public GiftCardObject setBalanceUpdateTime(DateTime balanceUpdateTime)
```
    The date and time when the balance was last updated. Offset is required. If balance is updated and this property is not provided, system will default to the current time.
    
    Parameters:
    
    balanceUpdateTime - balanceUpdateTime or null for none
  - getBarcode
```
public Barcode getBarcode()
```
    The barcode type and value.
    
    Returns:
    
    value or null for none
  - setBarcode
```
public GiftCardObject setBarcode(Barcode barcode)
```
    The barcode type and value.
    
    Parameters:
    
    barcode - barcode or null for none
  - getCardNumber
```
public String getCardNumber()
```
    Required. The card's number.
    
    Returns:
    
    value or null for none
  - setCardNumber
```
public GiftCardObject setCardNumber(String cardNumber)
```
    Required. The card's number.
    
    Parameters:
    
    cardNumber - cardNumber 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 GiftCardObject 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 GiftCardClass 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 GiftCardObject setClassReference(GiftCardClass 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 GiftCardObject 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
  - getEventNumber
```
public String getEventNumber()
```
    The card's event number, an optional field used by some gift cards.
    
    Returns:
    
    value or null for none
  - setEventNumber
```
public GiftCardObject setEventNumber(String eventNumber)
```
    The card's event number, an optional field used by some gift cards.
    
    Parameters:
    
    eventNumber - eventNumber or null for none
  - getGroupingInfo
```
public GroupingInfo getGroupingInfo()
```
    Information that controls how passes are grouped together.
    
    Returns:
    
    value or null for none
  - setGroupingInfo
```
public GiftCardObject 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 GiftCardObject 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 GiftCardObject 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 GiftCardObject 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 GiftCardObject 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 GiftCardObject 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 GiftCardObject 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#giftCardObject"`.
    
    Returns:
    
    value or null for none
  - setKind
```
public GiftCardObject setKind(String kind)
```
    Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardObject"`.
    
    Parameters:
    
    kind - kind 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 GiftCardObject 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 GiftCardObject setLocations(List<LatLongPoint> locations)
```
    Note: This field is currently not supported to trigger geo notifications.
    
    Parameters:
    
    locations - locations 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 GiftCardObject 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
  - getPassConstraints
```
public PassConstraints getPassConstraints()
```
    Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
    
    Returns:
    
    value or null for none
  - setPassConstraints
```
public GiftCardObject setPassConstraints(PassConstraints passConstraints)
```
    Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
    
    Parameters:
    
    passConstraints - passConstraints or null for none
  - getPin
```
public String getPin()
```
    The card's PIN.
    
    Returns:
    
    value or null for none
  - setPin
```
public GiftCardObject setPin(String pin)
```
    The card's PIN.
    
    Parameters:
    
    pin - pin or null for none
  - getRotatingBarcode
```
public RotatingBarcode getRotatingBarcode()
```
    The rotating barcode type and value.
    
    Returns:
    
    value or null for none
  - setRotatingBarcode
```
public GiftCardObject setRotatingBarcode(RotatingBarcode rotatingBarcode)
```
    The rotating barcode type and value.
    
    Parameters:
    
    rotatingBarcode - rotatingBarcode 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.
    
    Returns:
    
    value or null for none
  - setSmartTapRedemptionValue
```
public GiftCardObject 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.
    
    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 GiftCardObject 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 GiftCardObject 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 GiftCardObject 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
  - getVersion
```
public Long getVersion()
```
    Deprecated
    
    Returns:
    
    value or null for none
  - setVersion
```
public GiftCardObject setVersion(Long version)
```
    Deprecated
    
    Parameters:
    
    version - version or null for none
  - set
```
public GiftCardObject set(String fieldName,
                          Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GiftCardObject clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GiftCardObject

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

GiftCardObject

Method Detail

getAppLinkData

setAppLinkData

getBalance

setBalance

getBalanceUpdateTime

setBalanceUpdateTime

getBarcode

setBarcode

getCardNumber

setCardNumber

getClassId

setClassId

getClassReference

setClassReference

getDisableExpirationNotification

setDisableExpirationNotification

getEventNumber

setEventNumber

getGroupingInfo

setGroupingInfo

getHasLinkedDevice

setHasLinkedDevice

getHasUsers

setHasUsers

getHeroImage

setHeroImage

getId

setId

getImageModulesData

setImageModulesData

getInfoModuleData

setInfoModuleData

getKind

setKind

getLinksModuleData

setLinksModuleData

getLocations

setLocations

getMessages

setMessages

getPassConstraints

setPassConstraints

getPin

setPin

getRotatingBarcode

setRotatingBarcode

getSmartTapRedemptionValue

setSmartTapRedemptionValue

getState

setState

getTextModulesData

setTextModulesData

getValidTimeInterval

setValidTimeInterval

getVersion

setVersion

set

clone