GoogleApi.WalletObjects.V1.Model.EventTicketClass (google_api_wallet_objects v0.12.0)
View SourceAttributes
-
appLinkData
(type:GoogleApi.WalletObjects.V1.Model.AppLinkData.t
, default:nil
) - 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. -
gateLabel
(type:String.t
, default:nil
) - 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. BothgateLabel
andcustomGateLabel
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. -
redemptionIssuers
(type:list(String.t)
, default:nil
) - 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. TheenableSmartTap
and object levelsmartTapRedemptionLevel
fields must also be set up correctly in order for a pass to support Smart Tap. -
securityAnimation
(type:GoogleApi.WalletObjects.V1.Model.SecurityAnimation.t
, default:nil
) - Optional information about the security animation. If this is set a security animation will be rendered on pass details. -
finePrint
(type:GoogleApi.WalletObjects.V1.Model.LocalizedString.t
, default:nil
) - The fine print, terms, or conditions of the ticket. -
venue
(type:GoogleApi.WalletObjects.V1.Model.EventVenue.t
, default:nil
) - Event venue details. -
logo
(type:GoogleApi.WalletObjects.V1.Model.Image.t
, default:nil
) - The logo image of the ticket. This image is displayed in the card detail view of the app. -
kind
(type:String.t
, default:nil
) - Identifies what kind of resource this is. Value: the fixed string"walletobjects#eventTicketClass"
. -
hexBackgroundColor
(type:String.t
, default:nil
) - 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
. -
infoModuleData
(type:GoogleApi.WalletObjects.V1.Model.InfoModuleData.t
, default:nil
) - Deprecated. Use textModulesData instead. -
rowLabel
(type:String.t
, default:nil
) - 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. BothrowLabel
andcustomRowLabel
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. -
customSectionLabel
(type:GoogleApi.WalletObjects.V1.Model.LocalizedString.t
, default:nil
) - 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 thesectionLabel
options is not sufficient. BothsectionLabel
andcustomSectionLabel
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. -
confirmationCodeLabel
(type:String.t
, default:nil
) - 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. BothconfirmationCodeLabel
andcustomConfirmationCodeLabel
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. -
review
(type:GoogleApi.WalletObjects.V1.Model.Review.t
, default:nil
) - The review comments set by the platform when a class is markedapproved
orrejected
. -
dateTime
(type:GoogleApi.WalletObjects.V1.Model.EventDateTime.t
, default:nil
) - The date & time information of the event. -
localizedIssuerName
(type:GoogleApi.WalletObjects.V1.Model.LocalizedString.t
, default:nil
) - Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. -
wordMark
(type:GoogleApi.WalletObjects.V1.Model.Image.t
, default:nil
) - Deprecated. -
seatLabel
(type:String.t
, default:nil
) - 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. BothseatLabel
andcustomSeatLabel
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. -
customConfirmationCodeLabel
(type:GoogleApi.WalletObjects.V1.Model.LocalizedString.t
, default:nil
) - 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 theconfirmationCodeLabel
options is not sufficient. BothconfirmationCodeLabel
andcustomConfirmationCodeLabel
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. -
eventId
(type:String.t
, default:nil
) - 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 theclassId
(with or without the issuer ID portion). If not provided, the platform will attempt to use other data to group tickets (potentially unstable). -
issuerName
(type:String.t
, default:nil
) - Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. -
allowMultipleUsersPerObject
(type:boolean()
, default:nil
) - Deprecated. UsemultipleDevicesAndHoldersAllowedStatus
instead. -
customGateLabel
(type:GoogleApi.WalletObjects.V1.Model.LocalizedString.t
, default:nil
) - 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 thegateLabel
options is not sufficient. BothgateLabel
andcustomGateLabel
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. -
imageModulesData
(type:list(GoogleApi.WalletObjects.V1.Model.ImageModuleData.t)
, default:nil
) - Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level. -
merchantLocations
(type:list(GoogleApi.WalletObjects.V1.Model.MerchantLocation.t)
, default:nil
) - 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. -
version
(type:String.t
, default:nil
) - Deprecated -
locations
(type:list(GoogleApi.WalletObjects.V1.Model.LatLongPoint.t)
, default:nil
) - Note: This field is currently not supported to trigger geo notifications. -
sectionLabel
(type:String.t
, default:nil
) - 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. BothsectionLabel
andcustomSectionLabel
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. -
notifyPreference
(type:String.t
, default:nil
) - 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. -
homepageUri
(type:GoogleApi.WalletObjects.V1.Model.Uri.t
, default:nil
) - 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). -
textModulesData
(type:list(GoogleApi.WalletObjects.V1.Model.TextModuleData.t)
, default:nil
) - 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. -
linksModuleData
(type:GoogleApi.WalletObjects.V1.Model.LinksModuleData.t
, default:nil
) - Links module data. If links module data is also defined on the object, both will be displayed. -
messages
(type:list(GoogleApi.WalletObjects.V1.Model.Message.t)
, default:nil
) - 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. -
reviewStatus
(type:String.t
, default:nil
) - Required. The status of the class. This field can be set todraft
orunderReview
using the insert, patch, or update API calls. Once the review state is changed fromdraft
it may not be changed back todraft
. You should keep this field todraft
when the class is under development. Adraft
class cannot be used to create any object. You should set this field tounderReview
when you believe the class is ready for use. The platform will automatically set this field toapproved
and it can be immediately used to create or migrate objects. When updating an alreadyapproved
class you should keep setting this field tounderReview
. -
multipleDevicesAndHoldersAllowedStatus
(type:String.t
, default:nil
) - Identifies whether multiple users and devices will save the same object referencing this class. -
heroImage
(type:GoogleApi.WalletObjects.V1.Model.Image.t
, default:nil
) - 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. -
classTemplateInfo
(type:GoogleApi.WalletObjects.V1.Model.ClassTemplateInfo.t
, default:nil
) - Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display. -
callbackOptions
(type:GoogleApi.WalletObjects.V1.Model.CallbackOptions.t
, default:nil
) - 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. -
enableSmartTap
(type:boolean()
, default:nil
) - Identifies whether this class supports Smart Tap. TheredemptionIssuers
and object levelsmartTapRedemptionLevel
fields must also be set up correctly in order for a pass to support Smart Tap. -
valueAddedModuleData
(type:list(GoogleApi.WalletObjects.V1.Model.ValueAddedModuleData.t)
, default:nil
) - Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object. -
countryCode
(type:String.t
, default:nil
) - 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. -
viewUnlockRequirement
(type:String.t
, default:nil
) - View Unlock Requirement options for the event ticket. -
customSeatLabel
(type:GoogleApi.WalletObjects.V1.Model.LocalizedString.t
, default:nil
) - 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 theseatLabel
options is not sufficient. BothseatLabel
andcustomSeatLabel
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. -
wideLogo
(type:GoogleApi.WalletObjects.V1.Model.Image.t
, default:nil
) - The wide logo of the ticket. When provided, this will be used in place of the logo in the top left of the card view. -
id
(type:String.t
, default:nil
) - 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 '-'. -
customRowLabel
(type:GoogleApi.WalletObjects.V1.Model.LocalizedString.t
, default:nil
) - 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 therowLabel
options is not sufficient. BothrowLabel
andcustomRowLabel
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. -
eventName
(type:GoogleApi.WalletObjects.V1.Model.LocalizedString.t
, default:nil
) - Required. The name of the event, such as "LA Dodgers at SF Giants".
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.WalletObjects.V1.Model.EventTicketClass{ allowMultipleUsersPerObject: boolean() | nil, appLinkData: GoogleApi.WalletObjects.V1.Model.AppLinkData.t() | nil, callbackOptions: GoogleApi.WalletObjects.V1.Model.CallbackOptions.t() | nil, classTemplateInfo: GoogleApi.WalletObjects.V1.Model.ClassTemplateInfo.t() | nil, confirmationCodeLabel: String.t() | nil, countryCode: String.t() | nil, customConfirmationCodeLabel: GoogleApi.WalletObjects.V1.Model.LocalizedString.t() | nil, customGateLabel: GoogleApi.WalletObjects.V1.Model.LocalizedString.t() | nil, customRowLabel: GoogleApi.WalletObjects.V1.Model.LocalizedString.t() | nil, customSeatLabel: GoogleApi.WalletObjects.V1.Model.LocalizedString.t() | nil, customSectionLabel: GoogleApi.WalletObjects.V1.Model.LocalizedString.t() | nil, dateTime: GoogleApi.WalletObjects.V1.Model.EventDateTime.t() | nil, enableSmartTap: boolean() | nil, eventId: String.t() | nil, eventName: GoogleApi.WalletObjects.V1.Model.LocalizedString.t() | nil, finePrint: GoogleApi.WalletObjects.V1.Model.LocalizedString.t() | nil, gateLabel: String.t() | nil, heroImage: GoogleApi.WalletObjects.V1.Model.Image.t() | nil, hexBackgroundColor: String.t() | nil, homepageUri: GoogleApi.WalletObjects.V1.Model.Uri.t() | nil, id: String.t() | nil, imageModulesData: [GoogleApi.WalletObjects.V1.Model.ImageModuleData.t()] | nil, infoModuleData: GoogleApi.WalletObjects.V1.Model.InfoModuleData.t() | nil, issuerName: String.t() | nil, kind: String.t() | nil, linksModuleData: GoogleApi.WalletObjects.V1.Model.LinksModuleData.t() | nil, localizedIssuerName: GoogleApi.WalletObjects.V1.Model.LocalizedString.t() | nil, locations: [GoogleApi.WalletObjects.V1.Model.LatLongPoint.t()] | nil, logo: GoogleApi.WalletObjects.V1.Model.Image.t() | nil, merchantLocations: [GoogleApi.WalletObjects.V1.Model.MerchantLocation.t()] | nil, messages: [GoogleApi.WalletObjects.V1.Model.Message.t()] | nil, multipleDevicesAndHoldersAllowedStatus: String.t() | nil, notifyPreference: String.t() | nil, redemptionIssuers: [String.t()] | nil, review: GoogleApi.WalletObjects.V1.Model.Review.t() | nil, reviewStatus: String.t() | nil, rowLabel: String.t() | nil, seatLabel: String.t() | nil, sectionLabel: String.t() | nil, securityAnimation: GoogleApi.WalletObjects.V1.Model.SecurityAnimation.t() | nil, textModulesData: [GoogleApi.WalletObjects.V1.Model.TextModuleData.t()] | nil, valueAddedModuleData: [GoogleApi.WalletObjects.V1.Model.ValueAddedModuleData.t()] | nil, venue: GoogleApi.WalletObjects.V1.Model.EventVenue.t() | nil, version: String.t() | nil, viewUnlockRequirement: String.t() | nil, wideLogo: GoogleApi.WalletObjects.V1.Model.Image.t() | nil, wordMark: GoogleApi.WalletObjects.V1.Model.Image.t() | nil }