REST Resource: loyaltyclass

Resource: LoyaltyClass

JSON representation 
{
  "kind": string,
  "programName": string,
  "programLogo": {
    object (Image)
  },
  "accountNameLabel": string,
  "accountIdLabel": string,
  "rewardsTierLabel": string,
  "rewardsTier": string,
  "localizedProgramName": {
    object (LocalizedString)
  },
  "localizedAccountNameLabel": {
    object (LocalizedString)
  },
  "localizedAccountIdLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTierLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTier": {
    object (LocalizedString)
  },
  "secondaryRewardsTierLabel": string,
  "localizedSecondaryRewardsTierLabel": {
    object (LocalizedString)
  },
  "secondaryRewardsTier": string,
  "localizedSecondaryRewardsTier": {
    object (LocalizedString)
  },
  "discoverableProgram": {
    object (DiscoverableProgram)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideProgramLogo": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
Fields
kind
(deprecated)

string

Identifies what kind of resource this is. Value: the fixed string "walletobjects#loyaltyClass".
programName

string

Required. The program name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
accountNameLabel

string

The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
accountIdLabel

string

The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
rewardsTierLabel

string

The rewards tier label, such as "Rewards Tier." Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens.
rewardsTier

string

The rewards tier, such as "Gold" or "Platinum." Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens.
localizedProgramName

object (LocalizedString)

Translated strings for the programName. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
localizedAccountNameLabel

object (LocalizedString)

Translated strings for the accountNameLabel. Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
localizedAccountIdLabel

object (LocalizedString)

Translated strings for the accountIdLabel. Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
localizedRewardsTierLabel

object (LocalizedString)

Translated strings for the rewardsTierLabel. Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens.
localizedRewardsTier

object (LocalizedString)

Translated strings for the rewardsTier. Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens.
secondaryRewardsTierLabel

string

The secondary rewards tier label, such as "Rewards Tier."
localizedSecondaryRewardsTierLabel

object (LocalizedString)

Translated strings for the secondaryRewardsTierLabel.
secondaryRewardsTier

string

The secondary rewards tier, such as "Gold" or "Platinum."
localizedSecondaryRewardsTier

object (LocalizedString)

Translated strings for the secondaryRewardsTier.
discoverableProgram

object (DiscoverableProgram)

Information about how the class may be discovered and instantiated from within the Google Pay app.
classTemplateInfo

object (ClassTemplateInfo)

Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
id

string

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 '-'.
version
(deprecated)

string (int64 format)

Deprecated
issuerName

string

Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
messages[]

object (Message)

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.
allowMultipleUsersPerObject
(deprecated)

boolean

Deprecated. Use multipleDevicesAndHoldersAllowedStatus instead.
homepageUri

object (Uri)

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).
locations[]
(deprecated)

object (LatLongPoint)

Note: This field is currently not supported to trigger geo notifications.
reviewStatus

enum (ReviewStatus)

Required. 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.
review

object (Review)

The review comments set by the platform when a class is marked approved or rejected.
infoModuleData
(deprecated)

object (InfoModuleData)

Deprecated. Use textModulesData instead.
imageModulesData[]

object (ImageModuleData)

Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
textModulesData[]

object (TextModuleData)

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.
redemptionIssuers[]

string (int64 format)

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 one of object level smartTapRedemptionValue, barcode.value, oraccountId` fields must also be set up correctly in order for a pass to support Smart Tap.
countryCode

string

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.
heroImage

object (Image)

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.
wordMark
(deprecated)

object (Image)

Deprecated.
enableSmartTap

boolean

Identifies whether this class supports Smart Tap. The redemptionIssuers and one of object level smartTapRedemptionLevel, barcode.value, or accountId` fields must also be set up correctly in order for a pass to support Smart Tap.
hexBackgroundColor

string

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.
localizedIssuerName

object (LocalizedString)

Translated strings for the issuerName. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

Identifies whether multiple users and devices will save the same object referencing this class.
callbackOptions

object (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.
securityAnimation

object (SecurityAnimation)

Optional information about the security animation. If this is set a security animation will be rendered on pass details.
viewUnlockRequirement

enum (ViewUnlockRequirement)

View Unlock Requirement options for the loyalty card.
notifyPreference

enum (NotificationSettingsForUpdates)

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.
valueAddedModuleData[]

object (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.

DiscoverableProgram

Information about how a class may be discovered and instantiated from within the Android Pay app. This is done by searching for a loyalty or gift card program and scanning or manually entering.

JSON representation 
{
  "merchantSignupInfo": {
    object (DiscoverableProgramMerchantSignupInfo)
  },
  "merchantSigninInfo": {
    object (DiscoverableProgramMerchantSigninInfo)
  },
  "state": enum (State)
}
Fields
merchantSignupInfo

object (DiscoverableProgramMerchantSignupInfo)

Information about the ability to signup and add a valuable for this program through a merchant site. Used when MERCHANT_HOSTED_SIGNUP is enabled.
merchantSigninInfo

object (DiscoverableProgramMerchantSigninInfo)

Information about the ability to signin and add a valuable for this program through a merchant site. Used when MERCHANT_HOSTED_SIGNIN is enabled.
state

enum (State)

Visibility state of the discoverable program.

DiscoverableProgramMerchantSignupInfo

Information about the merchant hosted signup flow for a program.

JSON representation 
{
  "signupWebsite": {
    object (Uri)
  },
  "signupSharedDatas": [
    enum (SharedDataType)
  ]
}
Fields
signupWebsite

object (Uri)

The URL to direct the user to for the merchant's signup site.
signupSharedDatas[]

enum (SharedDataType)

User data that is sent in a POST request to the signup website URL. This information is encoded and then shared so that the merchant's website can prefill fields used to enroll the user for the discoverable program.

SharedDataType

Enums
SHARED_DATA_TYPE_UNSPECIFIED
FIRST_NAME
LAST_NAME
STREET_ADDRESS single line address field
ADDRESS_LINE_1 multi line address fields
ADDRESS_LINE_2
ADDRESS_LINE_3
CITY
STATE
ZIPCODE
COUNTRY
EMAIL
PHONE

DiscoverableProgramMerchantSigninInfo

Information about the merchant hosted signin flow for a program.

JSON representation 
{
  "signinWebsite": {
    object (Uri)
  }
}
Fields
signinWebsite

object (Uri)

The URL to direct the user to for the merchant's signin site.

State

Enums
STATE_UNSPECIFIED
TRUSTED_TESTERS Visible only to testers that have access to issuer account.
trustedTesters

Legacy alias for TRUSTED_TESTERS. Deprecated.
LIVE Visible to all.
live

Legacy alias for LIVE. Deprecated.
DISABLED Not visible.
disabled

Legacy alias for DISABLED. Deprecated.

Methods

addmessage

 Adds a message to the loyalty class referenced by the given class ID.

get

 Returns the loyalty class with the given class ID.

insert

 Inserts an loyalty class with the given ID and properties.

list

 Returns a list of all loyalty classes for a given issuer ID.

patch

 Updates the loyalty class referenced by the given class ID.

update

 Updates the loyalty class referenced by the given class ID.