Class GenericObject

Generic Object

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

Properties

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.

Declaration
[JsonProperty("appLinkData")]
public virtual AppLinkData AppLinkData { get; set; }
Property Value
Type Description
AppLinkData

Barcode

The barcode type and value. If pass does not have a barcode, we can allow the issuer to set Barcode.alternate_text and display just that.

Declaration
[JsonProperty("barcode")]
public virtual Barcode Barcode { get; set; }
Property Value
Type Description
Barcode

CardTitle

Required. The header of the pass. This is usually the Business name such as "XXX Gym", "AAA Insurance". This field is required and appears in the header row at the very top of the pass.

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

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 issuerID.identifier where issuerID is issued by Google and identifier is chosen by you.

Declaration
[JsonProperty("classId")]
public virtual string ClassId { 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

GenericType

Specify which GenericType the card belongs to.

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

GroupingInfo

Information that controls how passes are grouped together.

Declaration
[JsonProperty("groupingInfo")]
public virtual GroupingInfo GroupingInfo { get; set; }
Property Value
Type Description
GroupingInfo

HasUsers

Indicates if the object has users. This field is set by the platform.

Declaration
[JsonProperty("hasUsers")]
public virtual bool? HasUsers { get; set; }
Property Value
Type Description
bool?

Header

Required. The title of the pass, such as "50% off coupon" or "Library card" or "Voucher". This field is required and appears in the title row of the pass detail view.

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

HeroImage

Banner image displayed on the front of the card if present. The image will be displayed 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 and if logo is not set, a color would be chosen by Google.

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

Id

Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value needs to follow the format issuerID.identifier where issuerID is issued by Google and identifier is chosen by you. The unique identifier can only include alphanumeric characters, ., _, or -.

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

ImageModulesData

Image module data. Only one of the image from class and one from object level will be rendered when both set.

Declaration
[JsonProperty("imageModulesData")]
public virtual IList<ImageModuleData> ImageModulesData { get; set; }
Property Value
Type Description
IList<ImageModuleData>

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 generic object. If a user had saved this generic card, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you.

Declaration
[JsonProperty("linkedObjectIds")]
public virtual IList<string> LinkedObjectIds { get; set; }
Property Value
Type Description
IList<string>

LinksModuleData

Links module data. If linksModuleData is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.

Declaration
[JsonProperty("linksModuleData")]
public virtual LinksModuleData LinksModuleData { get; set; }
Property Value
Type Description
LinksModuleData

The logo image of the pass. This image is displayed in the card detail view in upper left, and also on the list/thumbnail view. If the logo is not present, the first letter of cardTitle would be shown as logo.

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

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>

Notifications

The notification settings that are enabled for this object.

Declaration
[JsonProperty("notifications")]
public virtual Notifications Notifications { get; set; }
Property Value
Type Description
Notifications

PassConstraints

Pass constraints for the object. Includes limiting NFC and screenshot behaviors.

Declaration
[JsonProperty("passConstraints")]
public virtual PassConstraints PassConstraints { get; set; }
Property Value
Type Description
PassConstraints

RotatingBarcode

The rotating barcode settings/details.

Declaration
[JsonProperty("rotatingBarcode")]
public virtual RotatingBarcode RotatingBarcode { get; set; }
Property Value
Type Description
RotatingBarcode

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.

Declaration
[JsonProperty("saveRestrictions")]
public virtual SaveRestrictions SaveRestrictions { get; set; }
Property Value
Type Description
SaveRestrictions

SmartTapRedemptionValue

The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields enableSmartTap and redemptionIssuers must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.

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

State

The state of the object. This field is used to determine how an object is displayed in the app. For example, an inactive object is moved to the "Expired passes" section. If this is not provided, the object would be considered ACTIVE.

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

Subheader

The title label of the pass, such as location where this pass can be used. Appears right above the title in the title row in the pass detail view.

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

TextModulesData

Text module data. If textModulesData is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.

Declaration
[JsonProperty("textModulesData")]
public virtual IList<TextModuleData> TextModulesData { get; set; }
Property Value
Type Description
IList<TextModuleData>

ValidTimeInterval

The time period this object will be considered valid or usable. When the time period is passed, the object will be considered expired, which will affect the rendering on user's devices.

Declaration
[JsonProperty("validTimeInterval")]
public virtual TimeInterval ValidTimeInterval { get; set; }
Property Value
Type Description
TimeInterval

ValueAddedModuleData

Optional value added module data. Maximum of ten on the object.

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

The wide logo of the pass. When provided, this will be used in place of the logo in the top left of the card view.

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

Implements