Class LoyaltyClass
Implements
Inherited Members
Namespace: Google.Apis.Walletobjects.v1.Data
Assembly: Google.Apis.Walletobjects.v1.dll
Syntax
public class LoyaltyClass : IDirectResponseSchema
Properties
AccountIdLabel
The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
Declaration
[JsonProperty("accountIdLabel")]
public virtual string AccountIdLabel { get; set; }
Property Value
Type | Description |
---|---|
string |
AccountNameLabel
The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
Declaration
[JsonProperty("accountNameLabel")]
public virtual string AccountNameLabel { get; set; }
Property Value
Type | Description |
---|---|
string |
AllowMultipleUsersPerObject
Deprecated. Use multipleDevicesAndHoldersAllowedStatus
instead.
Declaration
[JsonProperty("allowMultipleUsersPerObject")]
public virtual bool? AllowMultipleUsersPerObject { get; set; }
Property Value
Type | Description |
---|---|
bool? |
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 object that will be used instead.
Declaration
[JsonProperty("appLinkData")]
public virtual AppLinkData AppLinkData { get; set; }
Property Value
Type | Description |
---|---|
AppLinkData |
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.
Declaration
[JsonProperty("callbackOptions")]
public virtual CallbackOptions CallbackOptions { get; set; }
Property Value
Type | Description |
---|---|
CallbackOptions |
ClassTemplateInfo
Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
Declaration
[JsonProperty("classTemplateInfo")]
public virtual ClassTemplateInfo ClassTemplateInfo { get; set; }
Property Value
Type | Description |
---|---|
ClassTemplateInfo |
CountryCode
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.
Declaration
[JsonProperty("countryCode")]
public virtual string CountryCode { get; set; }
Property Value
Type | Description |
---|---|
string |
DiscoverableProgram
Information about how the class may be discovered and instantiated from within the Google Pay app.
Declaration
[JsonProperty("discoverableProgram")]
public virtual DiscoverableProgram DiscoverableProgram { get; set; }
Property Value
Type | Description |
---|---|
DiscoverableProgram |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
EnableSmartTap
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.
Declaration
[JsonProperty("enableSmartTap")]
public virtual bool? EnableSmartTap { get; set; }
Property Value
Type | Description |
---|---|
bool? |
HeroImage
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.
Declaration
[JsonProperty("heroImage")]
public virtual Image HeroImage { get; set; }
Property Value
Type | Description |
---|---|
Image |
HexBackgroundColor
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
.
Declaration
[JsonProperty("hexBackgroundColor")]
public virtual string HexBackgroundColor { get; set; }
Property Value
Type | Description |
---|---|
string |
HomepageUri
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).
Declaration
[JsonProperty("homepageUri")]
public virtual Uri HomepageUri { get; set; }
Property Value
Type | Description |
---|---|
Uri |
Id
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 '-'.
Declaration
[JsonProperty("id")]
public virtual string Id { get; set; }
Property Value
Type | Description |
---|---|
string |
ImageModulesData
Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
Declaration
[JsonProperty("imageModulesData")]
public virtual IList<ImageModuleData> ImageModulesData { get; set; }
Property Value
Type | Description |
---|---|
IList<ImageModuleData> |
InfoModuleData
Deprecated. Use textModulesData instead.
Declaration
[JsonProperty("infoModuleData")]
public virtual InfoModuleData InfoModuleData { get; set; }
Property Value
Type | Description |
---|---|
InfoModuleData |
IssuerName
Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
Declaration
[JsonProperty("issuerName")]
public virtual string IssuerName { get; set; }
Property Value
Type | Description |
---|---|
string |
Kind
Identifies what kind of resource this is. Value: the fixed string "walletobjects#loyaltyClass"
.
Declaration
[JsonProperty("kind")]
public virtual string Kind { get; set; }
Property Value
Type | Description |
---|---|
string |
LinksModuleData
Links module data. If links module data is also defined on the object, both will be displayed.
Declaration
[JsonProperty("linksModuleData")]
public virtual LinksModuleData LinksModuleData { get; set; }
Property Value
Type | Description |
---|---|
LinksModuleData |
LocalizedAccountIdLabel
Translated strings for the account_id_label. Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
Declaration
[JsonProperty("localizedAccountIdLabel")]
public virtual LocalizedString LocalizedAccountIdLabel { get; set; }
Property Value
Type | Description |
---|---|
LocalizedString |
LocalizedAccountNameLabel
Translated strings for the account_name_label. Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
Declaration
[JsonProperty("localizedAccountNameLabel")]
public virtual LocalizedString LocalizedAccountNameLabel { get; set; }
Property Value
Type | Description |
---|---|
LocalizedString |
LocalizedIssuerName
Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
Declaration
[JsonProperty("localizedIssuerName")]
public virtual LocalizedString LocalizedIssuerName { get; set; }
Property Value
Type | Description |
---|---|
LocalizedString |
LocalizedProgramName
Translated strings for the program_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
Declaration
[JsonProperty("localizedProgramName")]
public virtual LocalizedString LocalizedProgramName { get; set; }
Property Value
Type | Description |
---|---|
LocalizedString |
LocalizedRewardsTier
Translated strings for the rewards_tier. Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens.
Declaration
[JsonProperty("localizedRewardsTier")]
public virtual LocalizedString LocalizedRewardsTier { get; set; }
Property Value
Type | Description |
---|---|
LocalizedString |
LocalizedRewardsTierLabel
Translated strings for the rewards_tier_label. Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens.
Declaration
[JsonProperty("localizedRewardsTierLabel")]
public virtual LocalizedString LocalizedRewardsTierLabel { get; set; }
Property Value
Type | Description |
---|---|
LocalizedString |
LocalizedSecondaryRewardsTier
Translated strings for the secondary_rewards_tier.
Declaration
[JsonProperty("localizedSecondaryRewardsTier")]
public virtual LocalizedString LocalizedSecondaryRewardsTier { get; set; }
Property Value
Type | Description |
---|---|
LocalizedString |
LocalizedSecondaryRewardsTierLabel
Translated strings for the secondary_rewards_tier_label.
Declaration
[JsonProperty("localizedSecondaryRewardsTierLabel")]
public virtual LocalizedString LocalizedSecondaryRewardsTierLabel { get; set; }
Property Value
Type | Description |
---|---|
LocalizedString |
Locations
Note: This field is currently not supported to trigger geo notifications.
Declaration
[JsonProperty("locations")]
public virtual IList<LatLongPoint> Locations { get; set; }
Property Value
Type | Description |
---|---|
IList<LatLongPoint> |
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.
Declaration
[JsonProperty("messages")]
public virtual IList<Message> Messages { get; set; }
Property Value
Type | Description |
---|---|
IList<Message> |
MultipleDevicesAndHoldersAllowedStatus
Identifies whether multiple users and devices will save the same object referencing this class.
Declaration
[JsonProperty("multipleDevicesAndHoldersAllowedStatus")]
public virtual string MultipleDevicesAndHoldersAllowedStatus { get; set; }
Property Value
Type | Description |
---|---|
string |
NotifyPreference
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.
Declaration
[JsonProperty("notifyPreference")]
public virtual string NotifyPreference { get; set; }
Property Value
Type | Description |
---|---|
string |
ProgramLogo
Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app.
Declaration
[JsonProperty("programLogo")]
public virtual Image ProgramLogo { get; set; }
Property Value
Type | Description |
---|---|
Image |
ProgramName
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.
Declaration
[JsonProperty("programName")]
public virtual string ProgramName { get; set; }
Property Value
Type | Description |
---|---|
string |
RedemptionIssuers
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, or
accountId` fields must also be set up
correctly in order for a pass to support Smart Tap.
Declaration
[JsonProperty("redemptionIssuers")]
public virtual IList<long?> RedemptionIssuers { get; set; }
Property Value
Type | Description |
---|---|
IList<long?> |
Review
The review comments set by the platform when a class is marked approved
or rejected
.
Declaration
[JsonProperty("review")]
public virtual Review Review { get; set; }
Property Value
Type | Description |
---|---|
Review |
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
.
Declaration
[JsonProperty("reviewStatus")]
public virtual string ReviewStatus { get; set; }
Property Value
Type | Description |
---|---|
string |
RewardsTier
The rewards tier, such as "Gold" or "Platinum." Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens.
Declaration
[JsonProperty("rewardsTier")]
public virtual string RewardsTier { get; set; }
Property Value
Type | Description |
---|---|
string |
RewardsTierLabel
The rewards tier label, such as "Rewards Tier." Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens.
Declaration
[JsonProperty("rewardsTierLabel")]
public virtual string RewardsTierLabel { get; set; }
Property Value
Type | Description |
---|---|
string |
SecondaryRewardsTier
The secondary rewards tier, such as "Gold" or "Platinum."
Declaration
[JsonProperty("secondaryRewardsTier")]
public virtual string SecondaryRewardsTier { get; set; }
Property Value
Type | Description |
---|---|
string |
SecondaryRewardsTierLabel
The secondary rewards tier label, such as "Rewards Tier."
Declaration
[JsonProperty("secondaryRewardsTierLabel")]
public virtual string SecondaryRewardsTierLabel { get; set; }
Property Value
Type | Description |
---|---|
string |
SecurityAnimation
Optional information about the security animation. If this is set a security animation will be rendered on pass details.
Declaration
[JsonProperty("securityAnimation")]
public virtual SecurityAnimation SecurityAnimation { get; set; }
Property Value
Type | Description |
---|---|
SecurityAnimation |
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.
Declaration
[JsonProperty("textModulesData")]
public virtual IList<TextModuleData> TextModulesData { get; set; }
Property Value
Type | Description |
---|---|
IList<TextModuleData> |
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.
Declaration
[JsonProperty("valueAddedModuleData")]
public virtual IList<ValueAddedModuleData> ValueAddedModuleData { get; set; }
Property Value
Type | Description |
---|---|
IList<ValueAddedModuleData> |
Version
Deprecated
Declaration
[JsonProperty("version")]
public virtual long? Version { get; set; }
Property Value
Type | Description |
---|---|
long? |
ViewUnlockRequirement
View Unlock Requirement options for the loyalty card.
Declaration
[JsonProperty("viewUnlockRequirement")]
public virtual string ViewUnlockRequirement { get; set; }
Property Value
Type | Description |
---|---|
string |
WideProgramLogo
The wide logo of the loyalty program or company. When provided, this will be used in place of the program logo in the top left of the card view.
Declaration
[JsonProperty("wideProgramLogo")]
public virtual Image WideProgramLogo { get; set; }
Property Value
Type | Description |
---|---|
Image |
WordMark
Deprecated.
Declaration
[JsonProperty("wordMark")]
public virtual Image WordMark { get; set; }
Property Value
Type | Description |
---|---|
Image |