EventTicketClass
import type { EventTicketClass } from "https://googleapis.deno.dev/v1/walletobjects:v1.ts";§Properties
Deprecated. Use multipleDevicesAndHoldersAllowedStatus instead.
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.
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.
Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
The label to use for the confirmation code value
(eventTicketObject.reservationInfo.confirmationCode) on the card detail
view. Each available option maps to a set of localized strings, so that
translations are shown to the user based on their locale. Both
confirmationCodeLabel and customConfirmationCodeLabel may not be set.
If neither is set, the label will default to "Confirmation Code",
localized. If the confirmation code field is unset, this label will not be
used.
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.
A custom label to use for the confirmation code value
(eventTicketObject.reservationInfo.confirmationCode) on the card detail
view. This should only be used if the default "Confirmation Code" label or
one of the confirmationCodeLabel options is not sufficient. Both
confirmationCodeLabel and customConfirmationCodeLabel may not be set.
If neither is set, the label will default to "Confirmation Code",
localized. If the confirmation code field is unset, this label will not be
used.
A custom label to use for the gate value
(eventTicketObject.seatInfo.gate) on the card detail view. This should
only be used if the default "Gate" label or one of the gateLabel options
is not sufficient. Both gateLabel and customGateLabel may not be set.
If neither is set, the label will default to "Gate", localized. If the gate
field is unset, this label will not be used.
A custom label to use for the row value (eventTicketObject.seatInfo.row)
on the card detail view. This should only be used if the default "Row"
label or one of the rowLabel options is not sufficient. Both rowLabel
and customRowLabel may not be set. If neither is set, the label will
default to "Row", localized. If the row field is unset, this label will not
be used.
A custom label to use for the seat value
(eventTicketObject.seatInfo.seat) on the card detail view. This should
only be used if the default "Seat" label or one of the seatLabel options
is not sufficient. Both seatLabel and customSeatLabel may not be set.
If neither is set, the label will default to "Seat", localized. If the seat
field is unset, this label will not be used.
A custom label to use for the section value
(eventTicketObject.seatInfo.section) on the card detail view. This should
only be used if the default "Section" label or one of the sectionLabel
options is not sufficient. Both sectionLabel and customSectionLabel may
not be set. If neither is set, the label will default to "Section",
localized. If the section field is unset, this label will not be used.
The date & time information of the event.
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.
The ID of the event. This ID should be unique for every event in an
account. It is used to group tickets together if the user has saved
multiple tickets for the same event. It can be at most 64 characters. If
provided, the grouping will be stable. Be wary of unintentional collision
to avoid grouping tickets that should not be grouped. If you use only one
class per event, you can simply set this to the classId (with or without
the issuer ID portion). If not provided, the platform will attempt to use
other data to group tickets (potentially unstable).
Required. The name of the event, such as "LA Dodgers at SF Giants".
The fine print, terms, or conditions of the ticket.
The label to use for the gate value (eventTicketObject.seatInfo.gate) on
the card detail view. Each available option maps to a set of localized
strings, so that translations are shown to the user based on their locale.
Both gateLabel and customGateLabel may not be set. If neither is set,
the label will default to "Gate", localized. If the gate field is unset,
this label will not be used.
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.
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).
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 '-'.
Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
Deprecated. Use textModulesData instead.
Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
Identifies what kind of resource this is. Value: the fixed string
"walletobjects#eventTicketClass".
Links module data. If links module data is also defined on the object, both will be displayed.
Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
Note: This field is currently not supported to trigger geo notifications.
Identifies whether multiple users and devices will save the same object referencing this class.
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.
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.
The label to use for the row value (eventTicketObject.seatInfo.row) on
the card detail view. Each available option maps to a set of localized
strings, so that translations are shown to the user based on their locale.
Both rowLabel and customRowLabel may not be set. If neither is set, the
label will default to "Row", localized. If the row field is unset, this
label will not be used.
The label to use for the seat value (eventTicketObject.seatInfo.seat) on
the card detail view. Each available option maps to a set of localized
strings, so that translations are shown to the user based on their locale.
Both seatLabel and customSeatLabel may not be set. If neither is set,
the label will default to "Seat", localized. If the seat field is unset,
this label will not be used.
The label to use for the section value
(eventTicketObject.seatInfo.section) on the card detail view. Each
available option maps to a set of localized strings, so that translations
are shown to the user based on their locale. Both sectionLabel and
customSectionLabel may not be set. If neither is set, the label will
default to "Section", localized. If the section field is unset, this label
will not be used.
Optional information about the security animation. If this is set a security animation will be rendered on pass details.
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.
Event venue details.
View Unlock Requirement options for the event ticket.