Class OfferClass

Inheritance
object
OfferClass
Implements
Inherited Members
Namespace: Google.Apis.Walletobjects.v1.Data
Assembly: Google.Apis.Walletobjects.v1.dll
Syntax
public class OfferClass : IDirectResponseSchema

Properties

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

Details

The details of the offer.

Declaration
[JsonProperty("details")]
public virtual string Details { get; set; }
Property Value
Type Description
string

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 object level smartTapRedemptionLevel 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?

FinePrint

The fine print or terms of the offer, such as "20% off any t-shirt at Adam's Apparel."

Declaration
[JsonProperty("finePrint")]
public virtual string FinePrint { get; set; }
Property Value
Type Description
string

HelpUri

The help link for the offer, such as http://myownpersonaldomain.com/help

Declaration
[JsonProperty("helpUri")]
public virtual Uri HelpUri { get; set; }
Property Value
Type Description
Uri

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#offerClass".

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

LocalizedDetails

Translated strings for the details.

Declaration
[JsonProperty("localizedDetails")]
public virtual LocalizedString LocalizedDetails { get; set; }
Property Value
Type Description
LocalizedString

LocalizedFinePrint

Translated strings for the fine_print.

Declaration
[JsonProperty("localizedFinePrint")]
public virtual LocalizedString LocalizedFinePrint { 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

LocalizedProvider

Translated strings for the provider. Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens.

Declaration
[JsonProperty("localizedProvider")]
public virtual LocalizedString LocalizedProvider { get; set; }
Property Value
Type Description
LocalizedString

LocalizedShortTitle

Translated strings for the short title. Recommended maximum length is 20 characters.

Declaration
[JsonProperty("localizedShortTitle")]
public virtual LocalizedString LocalizedShortTitle { get; set; }
Property Value
Type Description
LocalizedString

LocalizedTitle

Translated strings for the title. Recommended maximum length is 60 characters to ensure full string is displayed on smaller screens.

Declaration
[JsonProperty("localizedTitle")]
public virtual LocalizedString LocalizedTitle { 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>

MerchantLocations

Merchant locations. There is a maximum of ten on the class. Any additional MerchantLocations added beyond the 10 will be rejected. These locations will trigger a notification when a user enters within a Google-set radius of the point. This field replaces the deprecated LatLongPoints.

Declaration
[JsonProperty("merchantLocations")]
public virtual IList<MerchantLocation> MerchantLocations { get; set; }
Property Value
Type Description
IList<MerchantLocation>

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

Provider

Required. The offer provider (either the aggregator name or merchant name). Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens.

Declaration
[JsonProperty("provider")]
public virtual string Provider { get; set; }
Property Value
Type Description
string

RedemptionChannel

Required. The redemption channels applicable to this offer.

Declaration
[JsonProperty("redemptionChannel")]
public virtual string RedemptionChannel { 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 object level smartTapRedemptionLevel 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 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

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

ShortTitle

A shortened version of the title of the offer, such as "20% off," shown to users as a quick reference to the offer contents. Recommended maximum length is 20 characters.

Declaration
[JsonProperty("shortTitle")]
public virtual string ShortTitle { get; set; }
Property Value
Type Description
string

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>

Title

Required. The title of the offer, such as "20% off any t-shirt." Recommended maximum length is 60 characters to ensure full string is displayed on smaller screens.

Declaration
[JsonProperty("title")]
public virtual string Title { get; set; }
Property Value
Type Description
string

TitleImage

The title image of the offer. This image is displayed in both the details and list views of the app.

Declaration
[JsonProperty("titleImage")]
public virtual Image TitleImage { get; set; }
Property Value
Type Description
Image

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

Declaration
[JsonProperty("viewUnlockRequirement")]
public virtual string ViewUnlockRequirement { get; set; }
Property Value
Type Description
string

WideTitleImage

The wide title image of the offer. When provided, this will be used in place of the title image in the top left of the card view.

Declaration
[JsonProperty("wideTitleImage")]
public virtual Image WideTitleImage { get; set; }
Property Value
Type Description
Image

WordMark

Deprecated.

Declaration
[JsonProperty("wordMark")]
public virtual Image WordMark { get; set; }
Property Value
Type Description
Image

Implements