public final class OfferObject
extends com.google.api.client.json.GenericJson
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
com.google.api.client.util.GenericData.FlagsAbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>| Constructor and Description |
|---|
OfferObject() |
| Modifier and Type | Method and Description |
|---|---|
OfferObject |
clone() |
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.
|
OfferClass |
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 offer object.
|
LinksModuleData |
getLinksModuleData()
Links module data.
|
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 |
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.
|
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
|
OfferObject |
set(String fieldName,
Object value) |
OfferObject |
setAppLinkData(AppLinkData appLinkData)
Optional app or website link that will be displayed as a button on the front of the pass.
|
OfferObject |
setBarcode(Barcode barcode)
The barcode type and value.
|
OfferObject |
setClassId(String classId)
Required.
|
OfferObject |
setClassReference(OfferClass classReference)
A copy of the inherited fields of the parent class.
|
OfferObject |
setDisableExpirationNotification(Boolean disableExpirationNotification)
Indicates if notifications should explicitly be suppressed.
|
OfferObject |
setGroupingInfo(GroupingInfo groupingInfo)
Information that controls how passes are grouped together.
|
OfferObject |
setHasLinkedDevice(Boolean hasLinkedDevice)
Whether this object is currently linked to a single device.
|
OfferObject |
setHasUsers(Boolean hasUsers)
Indicates if the object has users.
|
OfferObject |
setHeroImage(Image heroImage)
Optional banner image displayed on the front of the card.
|
OfferObject |
setId(String id)
Required.
|
OfferObject |
setImageModulesData(List<ImageModuleData> imageModulesData)
Image module data.
|
OfferObject |
setInfoModuleData(InfoModuleData infoModuleData)
Deprecated.
|
OfferObject |
setKind(String kind)
Identifies what kind of resource this is.
|
OfferObject |
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 offer object.
|
OfferObject |
setLinksModuleData(LinksModuleData linksModuleData)
Links module data.
|
OfferObject |
setLocations(List<LatLongPoint> locations)
Note: This field is currently not supported to trigger geo notifications.
|
OfferObject |
setMerchantLocations(List<MerchantLocation> merchantLocations)
Merchant locations.
|
OfferObject |
setMessages(List<Message> messages)
An array of messages displayed in the app.
|
OfferObject |
setNotifyPreference(String notifyPreference)
Whether or not field updates to this object should trigger notifications.
|
OfferObject |
setPassConstraints(PassConstraints passConstraints)
Pass constraints for the object.
|
OfferObject |
setRotatingBarcode(RotatingBarcode rotatingBarcode)
The rotating barcode type and value.
|
OfferObject |
setSaveRestrictions(SaveRestrictions saveRestrictions)
Restrictions on the object that needs to be verified before the user tries to save the pass.
|
OfferObject |
setSmartTapRedemptionValue(String smartTapRedemptionValue)
The value that will be transmitted to a Smart Tap certified terminal over NFC for this object.
|
OfferObject |
setState(String state)
Required.
|
OfferObject |
setTextModulesData(List<TextModuleData> textModulesData)
Text module data.
|
OfferObject |
setValidTimeInterval(TimeInterval validTimeInterval)
The time period this object will be `active` and object can be used.
|
OfferObject |
setValueAddedModuleData(List<ValueAddedModuleData> valueAddedModuleData)
Optional value added module data.
|
OfferObject |
setVersion(Long version)
Deprecated
|
getFactory, setFactory, toPrettyString, toStringentrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeysclear, containsKey, containsValue, isEmpty, keySet, size, valuesfinalize, getClass, notify, notifyAll, wait, wait, waitcompute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAllpublic AppLinkData getAppLinkData()
null for nonepublic OfferObject setAppLinkData(AppLinkData appLinkData)
appLinkData - appLinkData or null for nonepublic Barcode getBarcode()
null for nonepublic OfferObject setBarcode(Barcode barcode)
barcode - barcode or null for nonepublic String getClassId()
null for nonepublic OfferObject setClassId(String classId)
classId - classId or null for nonepublic OfferClass getClassReference()
null for nonepublic OfferObject setClassReference(OfferClass classReference)
classReference - classReference or null for nonepublic Boolean getDisableExpirationNotification()
null for nonepublic OfferObject setDisableExpirationNotification(Boolean disableExpirationNotification)
disableExpirationNotification - disableExpirationNotification or null for nonepublic GroupingInfo getGroupingInfo()
null for nonepublic OfferObject setGroupingInfo(GroupingInfo groupingInfo)
groupingInfo - groupingInfo or null for nonepublic Boolean getHasLinkedDevice()
null for nonepublic OfferObject setHasLinkedDevice(Boolean hasLinkedDevice)
hasLinkedDevice - hasLinkedDevice or null for nonepublic Boolean getHasUsers()
null for nonepublic OfferObject setHasUsers(Boolean hasUsers)
hasUsers - hasUsers or null for nonepublic Image getHeroImage()
null for nonepublic OfferObject setHeroImage(Image heroImage)
heroImage - heroImage or null for nonepublic String getId()
null for nonepublic OfferObject setId(String id)
id - id or null for nonepublic List<ImageModuleData> getImageModulesData()
null for nonepublic OfferObject setImageModulesData(List<ImageModuleData> imageModulesData)
imageModulesData - imageModulesData or null for nonepublic InfoModuleData getInfoModuleData()
null for nonepublic OfferObject setInfoModuleData(InfoModuleData infoModuleData)
infoModuleData - infoModuleData or null for nonepublic String getKind()
null for nonepublic OfferObject setKind(String kind)
kind - kind or null for nonepublic List<String> getLinkedObjectIds()
null for nonepublic OfferObject setLinkedObjectIds(List<String> linkedObjectIds)
linkedObjectIds - linkedObjectIds or null for nonepublic LinksModuleData getLinksModuleData()
null for nonepublic OfferObject setLinksModuleData(LinksModuleData linksModuleData)
linksModuleData - linksModuleData or null for nonepublic List<LatLongPoint> getLocations()
null for nonepublic OfferObject setLocations(List<LatLongPoint> locations)
locations - locations or null for nonepublic List<MerchantLocation> getMerchantLocations()
null for nonepublic OfferObject setMerchantLocations(List<MerchantLocation> merchantLocations)
merchantLocations - merchantLocations or null for nonepublic List<Message> getMessages()
null for nonepublic OfferObject setMessages(List<Message> messages)
messages - messages or null for nonepublic String getNotifyPreference()
null for nonepublic OfferObject setNotifyPreference(String notifyPreference)
notifyPreference - notifyPreference or null for nonepublic PassConstraints getPassConstraints()
null for nonepublic OfferObject setPassConstraints(PassConstraints passConstraints)
passConstraints - passConstraints or null for nonepublic RotatingBarcode getRotatingBarcode()
null for nonepublic OfferObject setRotatingBarcode(RotatingBarcode rotatingBarcode)
rotatingBarcode - rotatingBarcode or null for nonepublic SaveRestrictions getSaveRestrictions()
null for nonepublic OfferObject setSaveRestrictions(SaveRestrictions saveRestrictions)
saveRestrictions - saveRestrictions or null for nonepublic String getSmartTapRedemptionValue()
null for nonepublic OfferObject setSmartTapRedemptionValue(String smartTapRedemptionValue)
smartTapRedemptionValue - smartTapRedemptionValue or null for nonepublic String getState()
null for nonepublic OfferObject setState(String state)
state - state or null for nonepublic List<TextModuleData> getTextModulesData()
null for nonepublic OfferObject setTextModulesData(List<TextModuleData> textModulesData)
textModulesData - textModulesData or null for nonepublic TimeInterval getValidTimeInterval()
null for nonepublic OfferObject setValidTimeInterval(TimeInterval validTimeInterval)
validTimeInterval - validTimeInterval or null for nonepublic List<ValueAddedModuleData> getValueAddedModuleData()
null for nonepublic OfferObject setValueAddedModuleData(List<ValueAddedModuleData> valueAddedModuleData)
valueAddedModuleData - valueAddedModuleData or null for nonepublic Long getVersion()
null for nonepublic OfferObject setVersion(Long version)
version - version or null for nonepublic OfferObject set(String fieldName, Object value)
set in class com.google.api.client.json.GenericJsonpublic OfferObject clone()
clone in class com.google.api.client.json.GenericJsonCopyright © 2011–2025 Google. All rights reserved.