Resource: LoyaltyObject
JSON representation |
---|
{ "kind": string, "classReference": { object ( |
Fields | |
---|---|
kind |
Identifies what kind of resource this is. Value: the fixed string |
classReference |
A copy of the inherited fields of the parent class. These fields are retrieved during a GET. |
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. |
accountId |
The loyalty account identifier. Recommended maximum length is 20 characters. |
loyaltyPoints |
The loyalty reward points label, balance, and type. |
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. |
secondaryLoyaltyPoints |
The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points. |
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 '-'. |
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. |
version |
Deprecated |
state |
Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an |
barcode |
The barcode type and value. |
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. |
validTimeInterval |
The time period this object will be |
locations[] |
Note: This field is currently not supported to trigger geo notifications. |
hasUsers |
Indicates if the object has users. This field is set by the platform. |
smartTapRedemptionValue |
The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields If this value is not set but the class level fields |
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. |
disableExpirationNotification |
Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the Currently, this can only be set for offers. |
infoModuleData |
Deprecated. Use textModulesData instead. |
imageModulesData[] |
Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level. |
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. |
linksModuleData |
Links module data. If links module data is also defined on the class, both will be displayed. |
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. |
rotatingBarcode |
The rotating barcode type and value. |
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. |
groupingInfo |
Information that controls how passes are grouped together. |
passConstraints |
Pass constraints for the object. Includes limiting NFC and screenshot behaviors. |
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. |
LoyaltyPoints
JSON representation |
---|
{ "label": string, "balance": { object ( |
Fields | |
---|---|
label |
The loyalty points label, such as "Points". Recommended maximum length is 9 characters. |
balance |
The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of |
localizedLabel |
Translated strings for the label. Recommended maximum length is 9 characters. |
LoyaltyPointsBalance
JSON representation |
---|
{
"string": string,
"int": integer,
"double": number,
"money": {
object ( |
Fields | |
---|---|
string |
The string form of a balance. Only one of these subtypes (string, int, double, money) should be populated. |
int |
The integer form of a balance. Only one of these subtypes (string, int, double, money) should be populated. |
double |
The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated. |
money |
The money form of a balance. Only one of these subtypes (string, int, double, money) should be populated. |
Methods |
|
---|---|
|
Adds a message to the loyalty object referenced by the given object ID. |
|
Returns the loyalty object with the given object ID. |
|
Inserts an loyalty object with the given ID and properties. |
|
Returns a list of all loyalty objects for a given issuer ID. |
|
Modifies linked offer objects for the loyalty object with the given ID. |
|
Updates the loyalty object referenced by the given object ID. |
|
Updates the loyalty object referenced by the given object ID. |