Class EventTicketObject

Inheritance

object

EventTicketObject

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Walletobjects.v1.Data

Assembly: Google.Apis.Walletobjects.v1.dll

Syntax

public class EventTicketObject : 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.

Declaration

[JsonProperty("barcode")]
public virtual Barcode Barcode { get; set; }

Property Value

Type	Description
Barcode

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.

Declaration

[JsonProperty("classId")]
public virtual string ClassId { get; set; }

Property Value

Type	Description
string

ClassReference

A copy of the inherited fields of the parent class. These fields are retrieved during a GET.

Declaration

[JsonProperty("classReference")]
public virtual EventTicketClass ClassReference { get; set; }

Property Value

Type	Description
EventTicketClass

DisableExpirationNotification

Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the messages field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for offers.

Declaration

[JsonProperty("disableExpirationNotification")]
public virtual bool? DisableExpirationNotification { get; set; }

Property Value

Type	Description
bool?

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

FaceValue

The face value of the ticket, matching what would be printed on a physical version of the ticket.

Declaration

[JsonProperty("faceValue")]
public virtual Money FaceValue { get; set; }

Property Value

Type	Description
Money

GroupingInfo

Information that controls how passes are grouped together.

Declaration

[JsonProperty("groupingInfo")]
public virtual GroupingInfo GroupingInfo { get; set; }

Property Value

Type	Description
GroupingInfo

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.

Declaration

[JsonProperty("hasLinkedDevice")]
public virtual bool? HasLinkedDevice { get; set; }

Property Value

Type	Description
bool?

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?

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.

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

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

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

Kind

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

Declaration

[JsonProperty("kind")]
public virtual string Kind { get; set; }

Property Value

Type	Description
string

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 event ticket object. If a user had saved this event ticket, 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>

LinkedOfferIds

A list of offer objects linked to this event ticket. 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.

Declaration

[JsonProperty("linkedOfferIds")]
public virtual IList<string> LinkedOfferIds { get; set; }

Property Value

Type	Description
IList<string>

LinksModuleData

Links module data. If links module data is also defined on the class, both will be displayed.

Declaration

[JsonProperty("linksModuleData")]
public virtual LinksModuleData LinksModuleData { get; set; }

Property Value

Type	Description
LinksModuleData

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>

NotifyPreference

Whether or not field updates to this object 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 set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, 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

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

ReservationInfo

Reservation details for this ticket. This is expected to be shared amongst all tickets that were purchased in the same order.

Declaration

[JsonProperty("reservationInfo")]
public virtual EventReservationInfo ReservationInfo { get; set; }

Property Value

Type	Description
EventReservationInfo

RotatingBarcode

The rotating barcode type and value.

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

SeatInfo

Seating details for this ticket.

Declaration

[JsonProperty("seatInfo")]
public virtual EventSeat SeatInfo { get; set; }

Property Value

Type	Description
EventSeat

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

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

Declaration

[JsonProperty("state")]
public virtual string State { 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>

TicketHolderName

Name of the ticket holder, if the ticket is assigned to a person. E.g. "John Doe" or "Jane Doe".

Declaration

[JsonProperty("ticketHolderName")]
public virtual string TicketHolderName { get; set; }

Property Value

Type	Description
string

TicketNumber

The number of the ticket. This can be a unique identifier across all tickets in an issuer's system, all tickets for the event (e.g. XYZ1234512345), or all tickets in the order (1, 2, 3, etc.).

Declaration

[JsonProperty("ticketNumber")]
public virtual string TicketNumber { get; set; }

Property Value

Type	Description
string

TicketType

The type of the ticket, such as "Adult" or "Child", or "VIP" or "Standard".

Declaration

[JsonProperty("ticketType")]
public virtual LocalizedString TicketType { get; set; }

Property Value

Type	Description
LocalizedString

ValidTimeInterval

The time period this object will be active and object can be used. An object's state will be changed to expired when this time period has passed.

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>

Version

Deprecated

Declaration

[JsonProperty("version")]
public virtual long? Version { get; set; }

Property Value

Type	Description
long?

Implements

IDirectResponseSchema