API Reference google_api_wallet_objects v0.12.0

API client metadata for GoogleApi.WalletObjects.V1.

API calls for all endpoints tagged Eventticketclass.

API calls for all endpoints tagged Eventticketobject.

API calls for all endpoints tagged Flightclass.

API calls for all endpoints tagged Flightobject.

API calls for all endpoints tagged Genericclass.

API calls for all endpoints tagged Genericobject.

API calls for all endpoints tagged Giftcardclass.

API calls for all endpoints tagged Giftcardobject.

API calls for all endpoints tagged Issuer.

API calls for all endpoints tagged Jwt.

API calls for all endpoints tagged Loyaltyclass.

API calls for all endpoints tagged Loyaltyobject.

API calls for all endpoints tagged Media.

API calls for all endpoints tagged Offerclass.

API calls for all endpoints tagged Offerobject.

API calls for all endpoints tagged Permissions.

API calls for all endpoints tagged Smarttap.

API calls for all endpoints tagged Transitclass.

API calls for all endpoints tagged Transitobject.

API calls for all endpoints tagged Walletobjects.

Handle Tesla connections for GoogleApi.WalletObjects.V1.

ActivationOptions for the class

The activation status of the object. This field includes activation status if valuable supports activation.

Resource used when the AddMessage endpoints are called.

Attributes

• airportIataCode (type: String.t, default: nil) - Three character IATA airport code. This is a required field for origin and destination. Eg: "SFO"
• airportNameOverride (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - Optional field that overrides the airport city name defined by IATA. By default, Google takes the airportIataCode provided and maps it to the official airport city name defined by IATA. Official IATA airport city names can be found at IATA airport city names website. For example, for the airport IATA code "LTN", IATA website tells us that the corresponding airport city is "London". If this field is not populated, Google would display "London". However, populating this field with a custom name (eg: "London Luton") would override it.
• gate (type: String.t, default: nil) - A name of the gate. Eg: "B59" or "59"
• kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "walletobjects#airportInfo".
• terminal (type: String.t, default: nil) - Terminal name. Eg: "INTL" or "I"

Attributes

• androidAppLinkInfo (type: GoogleApi.WalletObjects.V1.Model.AppLinkDataAppLinkInfo.t, default: nil) - Optional information about the partner app link.
• displayText (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - Optional display text for the app link button. Character limit is 30.
• iosAppLinkInfo (type: GoogleApi.WalletObjects.V1.Model.AppLinkDataAppLinkInfo.t, default: nil) - Deprecated. Links to open iOS apps are not supported.
• webAppLinkInfo (type: GoogleApi.WalletObjects.V1.Model.AppLinkDataAppLinkInfo.t, default: nil) - Optional information about the partner web link.

Attributes

• appLogoImage (type: GoogleApi.WalletObjects.V1.Model.Image.t, default: nil) - Deprecated. Image isn't supported in the app link module.
• appTarget (type: GoogleApi.WalletObjects.V1.Model.AppLinkDataAppLinkInfoAppTarget.t, default: nil) - Target to follow when opening the app link on clients. It will be used by partners to open their app or webpage.
• description (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - Deprecated. Description isn't supported in the app link module.
• title (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - Deprecated. Title isn't supported in the app link module.

Attributes

• packageName (type: String.t, default: nil) - Package name for AppTarget. For example: com.google.android.gm
• targetUri (type: GoogleApi.WalletObjects.V1.Model.Uri.t, default: nil) - URI for AppTarget. The description on the URI must be set. Prefer setting package field instead, if this target is defined for your application.

Attributes

• id (type: integer(), default: nil) - Available only to Smart Tap enabled partners. Contact support for additional guidance.
• publicKeyPem (type: String.t, default: nil) - Available only to Smart Tap enabled partners. Contact support for additional guidance.

Attributes

• alternateText (type: String.t, default: nil) - An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
• kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "walletobjects#barcode".
• renderEncoding (type: String.t, default: nil) - The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
• showCodeText (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
• type (type: String.t, default: nil) - The type of barcode.
• value (type: String.t, default: nil) - The value encoded in the barcode.

Attributes

• fieldSelector (type: GoogleApi.WalletObjects.V1.Model.FieldSelector.t, default: nil) - A reference to an existing text-based or image field to display.

Information to read/write to blobstore2.

Attributes

• boardingDoor (type: String.t, default: nil) - Set this field only if this flight boards through more than one door or bridge and you want to explicitly print the door location on the boarding pass. Most airlines route their passengers to the right door or bridge by refering to doors/bridges by the seatClass. In those cases boardingDoor should not be set.
• boardingGroup (type: String.t, default: nil) - The value of boarding group (or zone) this passenger shall board with. eg: "B" The label for this value will be determined by the boardingPolicy field in the flightClass referenced by this object.
• boardingPosition (type: String.t, default: nil) - The value of boarding position. eg: "76"
• boardingPrivilegeImage (type: GoogleApi.WalletObjects.V1.Model.Image.t, default: nil) - A small image shown above the boarding barcode. Airlines can use it to communicate any special boarding privileges. In the event the security program logo is also set, this image might be rendered alongside the logo for that security program.
• kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "walletobjects#boardingAndSeatingInfo".
• seatAssignment (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - The passenger's seat assignment. To be used when there is no specific identifier to use in seatNumber. eg: "assigned at gate"
• seatClass (type: String.t, default: nil) - The value of the seat class. eg: "Economy" or "Economy Plus"
• seatNumber (type: String.t, default: nil) - The value of passenger seat. If there is no specific identifier, use seatAssignment instead. eg: "25A"
• sequenceNumber (type: String.t, default: nil) - The sequence number on the boarding pass. This usually matches the sequence in which the passengers checked in. Airline might use the number for manual boarding and bag tags. eg: "49"

Attributes

• boardingPolicy (type: String.t, default: nil) - Indicates the policy the airline uses for boarding. If unset, Google will default to zoneBased.
• kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "walletobjects#boardingAndSeatingPolicy".
• seatClassPolicy (type: String.t, default: nil) - Seating policy which dictates how we display the seat class. If unset, Google will default to cabinBased.

Attributes

• updateRequestUrl (type: String.t, default: nil) - URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot. Deprecated.
• url (type: String.t, default: nil) - The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Googlebot.

Attributes

• firstBottomDetail (type: GoogleApi.WalletObjects.V1.Model.BarcodeSectionDetail.t, default: nil) - Optional information to display below the barcode.
• firstTopDetail (type: GoogleApi.WalletObjects.V1.Model.BarcodeSectionDetail.t, default: nil) - Optional information to display above the barcode. If secondTopDetail is defined, this will be displayed to the start side of this detail section.
• secondTopDetail (type: GoogleApi.WalletObjects.V1.Model.BarcodeSectionDetail.t, default: nil) - Optional second piece of information to display above the barcode. If firstTopDetail is defined, this will be displayed to the end side of this detail section.

Attributes

• item (type: GoogleApi.WalletObjects.V1.Model.TemplateItem.t, default: nil) - The item to be displayed in the row. This item will be automatically centered.

Attributes

• oneItem (type: GoogleApi.WalletObjects.V1.Model.CardRowOneItem.t, default: nil) - Template for a row containing one item. Exactly one of "one_item", "two_items", "three_items" must be set.
• threeItems (type: GoogleApi.WalletObjects.V1.Model.CardRowThreeItems.t, default: nil) - Template for a row containing three items. Exactly one of "one_item", "two_items", "three_items" must be set.
• twoItems (type: GoogleApi.WalletObjects.V1.Model.CardRowTwoItems.t, default: nil) - Template for a row containing two items. Exactly one of "one_item", "two_items", "three_items" must be set.

Attributes

• endItem (type: GoogleApi.WalletObjects.V1.Model.TemplateItem.t, default: nil) - The item to be displayed at the end of the row. This item will be aligned to the right.
• middleItem (type: GoogleApi.WalletObjects.V1.Model.TemplateItem.t, default: nil) - The item to be displayed in the middle of the row. This item will be centered between the start and end items.
• startItem (type: GoogleApi.WalletObjects.V1.Model.TemplateItem.t, default: nil) - The item to be displayed at the start of the row. This item will be aligned to the left.

Attributes

• endItem (type: GoogleApi.WalletObjects.V1.Model.TemplateItem.t, default: nil) - The item to be displayed at the end of the row. This item will be aligned to the right.
• startItem (type: GoogleApi.WalletObjects.V1.Model.TemplateItem.t, default: nil) - The item to be displayed at the start of the row. This item will be aligned to the left.

Attributes

• cardRowTemplateInfos (type: list(GoogleApi.WalletObjects.V1.Model.CardRowTemplateInfo.t), default: nil) - Template information for rows in the card view. At most three rows are allowed to be specified.

Attributes

• cardBarcodeSectionDetails (type: GoogleApi.WalletObjects.V1.Model.CardBarcodeSectionDetails.t, default: nil) - Specifies extra information to be displayed above and below the barcode.
• cardTemplateOverride (type: GoogleApi.WalletObjects.V1.Model.CardTemplateOverride.t, default: nil) - Override for the card view.
• detailsTemplateOverride (type: GoogleApi.WalletObjects.V1.Model.DetailsTemplateOverride.t, default: nil) - Override for the details view (beneath the card view).
• listTemplateOverride (type: GoogleApi.WalletObjects.V1.Model.ListTemplateOverride.t, default: nil) - Override for the passes list view.

A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites.

Detailed Content-Type information from Scotty. The Content-Type of the media will typically be filled in by the header or Scotty's best_guess, but this extended information provides the backend with more information so that it can make a better decision if needed. This is only used on media upload requests from Scotty.

Attributes

• date (type: String.t, default: nil) - An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: 1985-04-12T23:20:50.52Z would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. 1985-04-12T19:20:50.52-04:00 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. 1985-04-12T19:20:50.52 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of 2018-06-19T18:30:00-04:00 will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of 2018-06-19T18:30:00 will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.

Attributes

• item (type: GoogleApi.WalletObjects.V1.Model.TemplateItem.t, default: nil) - The item to be displayed in the details list.

Attributes

• detailsItemInfos (type: list(GoogleApi.WalletObjects.V1.Model.DetailsItemInfo.t), default: nil) - Information for the "nth" item displayed in the details list.

Device context associated with the object.

Backend response for a Diff get checksums response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.

Backend response for a Diff download response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.

A Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.

Backend response for a Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.

Backend response for a Diff get version response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.

Information about how a class may be discovered and instantiated from within the Google Wallet app. This is done by searching for a loyalty or gift card program and scanning or manually entering.

Information about the merchant hosted signin flow for a program.

Information about the merchant hosted signup flow for a program.

Parameters specific to media downloads.

Attributes

• customDoorsOpenLabel (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - A custom label to use for the doors open value (doorsOpen) on the card detail view. This should only be used if the default "Doors Open" label or one of the doorsOpenLabel options is not sufficient. Both doorsOpenLabel and customDoorsOpenLabel may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
• doorsOpen (type: String.t, default: nil) - The date/time when the doors open at the venue. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: 1985-04-12T23:20:50.52Z would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. 1985-04-12T19:20:50.52-04:00 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. 1985-04-12T19:20:50.52 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be 2018-06-05T20:00:00. If the local date/time at the venue is 4 hours before UTC, an offset of -04:00 may be appended. Without offset information, some rich features may not be available.
• doorsOpenLabel (type: String.t, default: nil) - The label to use for the doors open value (doorsOpen) 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 doorsOpenLabel and customDoorsOpenLabel may not be set. If neither is set, the label will default to "Doors Open", localized. If the doors open field is unset, this label will not be used.
• end (type: String.t, default: nil) - The date/time when the event ends. If the event spans multiple days, it should be the end date/time on the last day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: 1985-04-12T23:20:50.52Z would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. 1985-04-12T19:20:50.52-04:00 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. 1985-04-12T19:20:50.52 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be 2018-06-05T20:00:00. If the local date/time at the venue is 4 hours before UTC, an offset of -04:00 may be appended. Without offset information, some rich features may not be available.
• kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "walletobjects#eventDateTime".
• start (type: String.t, default: nil) - The date/time when the event starts. If the event spans multiple days, it should be the start date/time on the first day. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: 1985-04-12T23:20:50.52Z would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. 1985-04-12T19:20:50.52-04:00 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. 1985-04-12T19:20:50.52 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the venue. For example, if the event occurs at the 20th hour of June 5th, 2018 at the venue, the local date/time portion should be 2018-06-05T20:00:00. If the local date/time at the venue is 4 hours before UTC, an offset of -04:00 may be appended. Without offset information, some rich features may not be available.

Attributes

• confirmationCode (type: String.t, default: nil) - The confirmation code of the event reservation. This may also take the form of an "order number", "confirmation number", "reservation number", or other equivalent.
• kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "walletobjects#eventReservationInfo".

Attributes

• gate (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - The gate the ticket holder should enter to get to their seat, such as "A" or "West". This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
• kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "walletobjects#eventSeat".
• row (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - The row of the seat, such as "1", E", "BB", or "A5". This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
• seat (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - The seat number, such as "1", "2", "3", or any other seat identifier. This field is localizable so you may translate words or use different alphabets for the characters in an identifier.
• section (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - The section of the seat, such as "121". This field is localizable so you may translate words or use different alphabets for the characters in an identifier.

Attributes

• 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. 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.
• 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. The enableSmartTap and object level smartTapRedemptionLevel 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. 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.
• 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 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.
• 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. 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.
• review (type: GoogleApi.WalletObjects.V1.Model.Review.t, default: nil) - The review comments set by the platform when a class is marked approved or rejected.
• 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. 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.
• 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 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.
• 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 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).
• 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. Use multipleDevicesAndHoldersAllowedStatus 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 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.
• 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. 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.
• 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 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.
• 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. The redemptionIssuers and object level smartTapRedemptionLevel 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 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.
• 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 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.
• eventName (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - Required. The name of the event, such as "LA Dodgers at SF Giants".

Attributes

• resource (type: GoogleApi.WalletObjects.V1.Model.EventTicketClass.t, default: nil) - The updated EventTicketClass resource.

Attributes

• pagination (type: GoogleApi.WalletObjects.V1.Model.Pagination.t, default: nil) - Pagination of the response.
• resources (type: list(GoogleApi.WalletObjects.V1.Model.EventTicketClass.t), default: nil) - Resources corresponding to the list request.

Attributes

• barcode (type: GoogleApi.WalletObjects.V1.Model.Barcode.t, default: nil) - The barcode type and value.
• 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 class only object AppLinkData will be displayed.
• ticketType (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - The type of the ticket, such as "Adult" or "Child", or "VIP" or "Standard".
• state (type: String.t, default: nil) - 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.
• groupingInfo (type: GoogleApi.WalletObjects.V1.Model.GroupingInfo.t, default: nil) - Information that controls how passes are grouped together.
• kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "walletobjects#eventTicketObject".
• 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.
• ticketHolderName (type: String.t, default: nil) - Name of the ticket holder, if the ticket is assigned to a person. E.g. "John Doe" or "Jane Doe".
• smartTapRedemptionValue (type: String.t, default: nil) - 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.
• classId (type: String.t, default: nil) - 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.
• 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 object. 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
• hasUsers (type: boolean(), default: nil) - Indicates if the object has users. This field is set by the platform.
• locations (type: list(GoogleApi.WalletObjects.V1.Model.LatLongPoint.t), default: nil) - Note: This field is currently not supported to trigger geo notifications.
• notifyPreference (type: String.t, default: nil) - 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.
• 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 class, both will be displayed.
• ticketNumber (type: String.t, default: nil) - 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.).
• 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.
• reservationInfo (type: GoogleApi.WalletObjects.V1.Model.EventReservationInfo.t, default: nil) - Reservation details for this ticket. This is expected to be shared amongst all tickets that were purchased in the same order.
• heroImage (type: GoogleApi.WalletObjects.V1.Model.Image.t, default: nil) - 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.
• seatInfo (type: GoogleApi.WalletObjects.V1.Model.EventSeat.t, default: nil) - Seating details for this ticket.
• hasLinkedDevice (type: boolean(), default: nil) - 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.
• linkedObjectIds (type: list(String.t), default: nil) - 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.
• disableExpirationNotification (type: boolean(), default: nil) - 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.
• passConstraints (type: GoogleApi.WalletObjects.V1.Model.PassConstraints.t, default: nil) - Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
• rotatingBarcode (type: GoogleApi.WalletObjects.V1.Model.RotatingBarcode.t, default: nil) - The rotating barcode type and value.
• classReference (type: GoogleApi.WalletObjects.V1.Model.EventTicketClass.t, default: nil) - A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
• valueAddedModuleData (type: list(GoogleApi.WalletObjects.V1.Model.ValueAddedModuleData.t), default: nil) - Optional value added module data. Maximum of ten on the object.
• linkedOfferIds (type: list(String.t), default: nil) - 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.
• validTimeInterval (type: GoogleApi.WalletObjects.V1.Model.TimeInterval.t, default: nil) - 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.
• id (type: String.t, default: nil) - 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 '-'.
• faceValue (type: GoogleApi.WalletObjects.V1.Model.Money.t, default: nil) - The face value of the ticket, matching what would be printed on a physical version of the ticket.
• saveRestrictions (type: GoogleApi.WalletObjects.V1.Model.SaveRestrictions.t, default: nil) - 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.

Attributes

• resource (type: GoogleApi.WalletObjects.V1.Model.EventTicketObject.t, default: nil) - The updated EventTicketObject resource.

Attributes

• pagination (type: GoogleApi.WalletObjects.V1.Model.Pagination.t, default: nil) - Pagination of the response.
• resources (type: list(GoogleApi.WalletObjects.V1.Model.EventTicketObject.t), default: nil) - Resources corresponding to the list request.

Attributes

• address (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - The address of the venue, such as "24 Willie Mays Plaza\nSan Francisco, CA 94107". Address lines are separated by line feed (\n) characters. This is required.
• kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "walletobjects#eventVenue".
• name (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - The name of the venue, such as "AT&T Park". This is required.

Indicates that the issuer would like Google Wallet to send expiry notifications 2 days prior to the card expiration.

Reference definition to use with field overrides.

Custom field selector to use with field overrides.

Attributes

• fieldOption (type: GoogleApi.WalletObjects.V1.Model.FieldSelector.t, default: nil) - A reference to the field to be displayed in the first row.
• transitOption (type: String.t, default: nil) -

Attributes

• airlineAllianceLogo (type: GoogleApi.WalletObjects.V1.Model.Image.t, default: nil) - A logo for the airline alliance, displayed below the QR code that the passenger scans to board.
• airlineLogo (type: GoogleApi.WalletObjects.V1.Model.Image.t, default: nil) - A logo for the airline described by carrierIataCode and localizedAirlineName. This logo will be rendered at the top of the detailed card view.
• airlineName (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - A localized name of the airline specified by carrierIataCode. If unset, issuer_name or localized_issuer_name from FlightClass will be used for display purposes. eg: "Swiss Air" for "LX"
• carrierIataCode (type: String.t, default: nil) - Two character IATA airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or carrierIcaoCode needs to be provided for carrier and operatingCarrier. eg: "LX" for Swiss Air
• carrierIcaoCode (type: String.t, default: nil) - Three character ICAO airline code of the marketing carrier (as opposed to operating carrier). Exactly one of this or carrierIataCode needs to be provided for carrier and operatingCarrier. eg: "EZY" for Easy Jet
• kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "walletobjects#flightCarrier".
• wideAirlineLogo (type: GoogleApi.WalletObjects.V1.Model.Image.t, default: nil) - The wide logo of the airline. When provided, this will be used in place of the airline logo in the top left of the card view.

Attributes

• 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.
• localEstimatedOrActualArrivalDateTime (type: String.t, default: nil) - The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 2027-03-05T06:30:00 This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport.
• languageOverride (type: String.t, default: nil) - If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
• 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. The enableSmartTap and object level smartTapRedemptionLevel 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.
• localScheduledDepartureDateTime (type: String.t, default: nil) - Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set localEstimatedOrActualDepartureDateTime. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 2027-03-05T06:30:00 This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
• kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "walletobjects#flightClass".
• 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.
• review (type: GoogleApi.WalletObjects.V1.Model.Review.t, default: nil) - The review comments set by the platform when a class is marked approved or rejected.
• 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.
• flightHeader (type: GoogleApi.WalletObjects.V1.Model.FlightHeader.t, default: nil) - Required. Information about the flight carrier and number.
• boardingAndSeatingPolicy (type: GoogleApi.WalletObjects.V1.Model.BoardingAndSeatingPolicy.t, default: nil) - Policies for boarding and seating. These will inform which labels will be shown to users.
• 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. Use multipleDevicesAndHoldersAllowedStatus instead.
• 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 by the validator. 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.
• 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).
• localBoardingDateTime (type: String.t, default: nil) - The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 2027-03-05T06:30:00 This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
• 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.
• localScheduledArrivalDateTime (type: String.t, default: nil) - The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set localEstimatedOrActualArrivalDateTime. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 2027-03-05T06:30:00 This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport.
• 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.
• flightStatus (type: String.t, default: nil) - Status of this flight. If unset, Google will compute status based on data from other sources, such as FlightStats, etc. Note: Google-computed status will not be returned in API responses.
• origin (type: GoogleApi.WalletObjects.V1.Model.AirportInfo.t, default: nil) - Required. Origin airport.
• reviewStatus (type: String.t, default: nil) - 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.
• 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.
• destination (type: GoogleApi.WalletObjects.V1.Model.AirportInfo.t, default: nil) - Required. Destination airport.
• 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. The redemptionIssuers and object level smartTapRedemptionLevel 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 boarding pass.
• localEstimatedOrActualDepartureDateTime (type: String.t, default: nil) - The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 2027-03-05T06:30:00 This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.
• 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 '-'.
• localGateClosingDateTime (type: String.t, default: nil) - The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: 2027-03-05T06:30:00 This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.

Attributes

• resource (type: GoogleApi.WalletObjects.V1.Model.FlightClass.t, default: nil) - The updated FlightClass resource.

Attributes

• pagination (type: GoogleApi.WalletObjects.V1.Model.Pagination.t, default: nil) - Pagination of the response.
• resources (type: list(GoogleApi.WalletObjects.V1.Model.FlightClass.t), default: nil) - Resources corresponding to the list request.

Attributes

• carrier (type: GoogleApi.WalletObjects.V1.Model.FlightCarrier.t, default: nil) - Information about airline carrier. This is a required property of flightHeader.
• flightNumber (type: String.t, default: nil) - The flight number without IATA carrier code. This field should contain only digits. This is a required property of flightHeader. eg: "123"
• flightNumberDisplayOverride (type: String.t, default: nil) - Override value to use for flight number. The default value used for display purposes is carrier + flight_number. If a different value needs to be shown to passengers, use this field to override the default behavior. eg: "XX1234 / YY576"
• kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "walletobjects#flightHeader".
• operatingCarrier (type: GoogleApi.WalletObjects.V1.Model.FlightCarrier.t, default: nil) - Information about operating airline carrier.
• operatingFlightNumber (type: String.t, default: nil) - The flight number used by the operating carrier without IATA carrier code. This field should contain only digits. eg: "234"

Attributes

• barcode (type: GoogleApi.WalletObjects.V1.Model.Barcode.t, default: nil) - The barcode type and value.
• 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 class only object AppLinkData will be displayed.
• state (type: String.t, default: nil) - 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.
• groupingInfo (type: GoogleApi.WalletObjects.V1.Model.GroupingInfo.t, default: nil) - Information that controls how passes are grouped together.
• kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "walletobjects#flightObject".
• 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.
• securityProgramLogo (type: GoogleApi.WalletObjects.V1.Model.Image.t, default: nil) - An image for the security program that applies to the passenger.
• infoModuleData (type: GoogleApi.WalletObjects.V1.Model.InfoModuleData.t, default: nil) - Deprecated. Use textModulesData instead.
• smartTapRedemptionValue (type: String.t, default: nil) - 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.
• classId (type: String.t, default: nil) - 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.
• 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 object. 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
• hasUsers (type: boolean(), default: nil) - Indicates if the object has users. This field is set by the platform.
• locations (type: list(GoogleApi.WalletObjects.V1.Model.LatLongPoint.t), default: nil) - Note: This field is currently not supported to trigger geo notifications.
• notifyPreference (type: String.t, default: nil) - 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.
• 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.
• boardingAndSeatingInfo (type: GoogleApi.WalletObjects.V1.Model.BoardingAndSeatingInfo.t, default: nil) - Passenger specific information about boarding and seating.
• linksModuleData (type: GoogleApi.WalletObjects.V1.Model.LinksModuleData.t, default: nil) - Links module data. If links module data is also defined on the class, 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.
• reservationInfo (type: GoogleApi.WalletObjects.V1.Model.ReservationInfo.t, default: nil) - Required. Information about flight reservation.
• heroImage (type: GoogleApi.WalletObjects.V1.Model.Image.t, default: nil) - 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.
• hasLinkedDevice (type: boolean(), default: nil) - 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.
• linkedObjectIds (type: list(String.t), default: nil) - 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 flight object. If a user had saved this boarding pass, 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.
• disableExpirationNotification (type: boolean(), default: nil) - 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 Flights.
• passConstraints (type: GoogleApi.WalletObjects.V1.Model.PassConstraints.t, default: nil) - Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
• rotatingBarcode (type: GoogleApi.WalletObjects.V1.Model.RotatingBarcode.t, default: nil) - The rotating barcode type and value.
• classReference (type: GoogleApi.WalletObjects.V1.Model.FlightClass.t, default: nil) - A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
• valueAddedModuleData (type: list(GoogleApi.WalletObjects.V1.Model.ValueAddedModuleData.t), default: nil) - Optional value added module data. Maximum of ten on the object.
• passengerName (type: String.t, default: nil) - Required. Passenger name as it would appear on the boarding pass. eg: "Dave M Gahan" or "Gahan/Dave" or "GAHAN/DAVEM"
• validTimeInterval (type: GoogleApi.WalletObjects.V1.Model.TimeInterval.t, default: nil) - 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.
• id (type: String.t, default: nil) - 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 '-'.
• saveRestrictions (type: GoogleApi.WalletObjects.V1.Model.SaveRestrictions.t, default: nil) - 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.

Attributes

• resource (type: GoogleApi.WalletObjects.V1.Model.FlightObject.t, default: nil) - The updated FlightObject resource.

Attributes

• pagination (type: GoogleApi.WalletObjects.V1.Model.Pagination.t, default: nil) - Pagination of the response.
• resources (type: list(GoogleApi.WalletObjects.V1.Model.FlightObject.t), default: nil) - Resources corresponding to the list request.

Attributes

• frequentFlyerNumber (type: String.t, default: nil) - Frequent flyer number. Required for each nested object of kind walletobjects#frequentFlyerInfo.
• frequentFlyerProgramName (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - Frequent flyer program name. eg: "Lufthansa Miles & More"
• kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "walletobjects#frequentFlyerInfo".

Generic Class

Response to adding a new issuer message to the class. This contains the entire updated GenericClass.

List response which contains the list of all generic classes for a given issuer ID.

Generic Object

Response to adding a new issuer message to the object. This contains the entire updated GenericObject.

List response which contains the list of all generic objects for a given issuer ID.

Attributes

• 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.
• 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. The enableSmartTap and object level smartTapRedemptionLevel 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.
• localizedMerchantName (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - Translated strings for the merchant_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
• kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "walletobjects#giftCardClass".
• 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.
• review (type: GoogleApi.WalletObjects.V1.Model.Review.t, default: nil) - The review comments set by the platform when a class is marked approved or rejected.
• 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.
• localizedPinLabel (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - Translated strings for the pin_label.
• wordMark (type: GoogleApi.WalletObjects.V1.Model.Image.t, default: nil) - Deprecated.
• pinLabel (type: String.t, default: nil) - The label to display for the PIN, such as "4-digit PIN".
• 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. Use multipleDevicesAndHoldersAllowedStatus instead.
• allowBarcodeRedemption (type: boolean(), default: nil) - Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.
• 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.
• 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.
• wideProgramLogo (type: GoogleApi.WalletObjects.V1.Model.Image.t, default: nil) - The wide logo of the gift card program or company. When provided, this will be used in place of the program logo in the top left of the card view.
• cardNumberLabel (type: String.t, default: nil) - The label to display for the card number, such as "Card Number".
• 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 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.
• 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.
• programLogo (type: GoogleApi.WalletObjects.V1.Model.Image.t, default: nil) - The logo of the gift card program or company. This logo is displayed in both the details and list views of the app.
• merchantName (type: String.t, default: nil) - Merchant name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.
• 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.
• eventNumberLabel (type: String.t, default: nil) - The label to display for event number, such as "Target Event #".
• enableSmartTap (type: boolean(), default: nil) - 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.
• 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.
• localizedCardNumberLabel (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - Translated strings for the card_number_label.
• viewUnlockRequirement (type: String.t, default: nil) - View Unlock Requirement options for the gift card.
• localizedEventNumberLabel (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - Translated strings for the event_number_label.
• 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 '-'.

Attributes

• resource (type: GoogleApi.WalletObjects.V1.Model.GiftCardClass.t, default: nil) - The updated GiftCardClass resource.

Attributes

• pagination (type: GoogleApi.WalletObjects.V1.Model.Pagination.t, default: nil) - Pagination of the response.
• resources (type: list(GoogleApi.WalletObjects.V1.Model.GiftCardClass.t), default: nil) - Resources corresponding to the list request.

Attributes

• barcode (type: GoogleApi.WalletObjects.V1.Model.Barcode.t, default: nil) - The barcode type and value.
• 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 class only object AppLinkData will be displayed.
• state (type: String.t, default: nil) - 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.
• groupingInfo (type: GoogleApi.WalletObjects.V1.Model.GroupingInfo.t, default: nil) - Information that controls how passes are grouped together.
• balanceUpdateTime (type: GoogleApi.WalletObjects.V1.Model.DateTime.t, default: nil) - The date and time when the balance was last updated. Offset is required. If balance is updated and this property is not provided, system will default to the current time.
• kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "walletobjects#giftCardObject".
• cardNumber (type: String.t, default: nil) - Required. The card's number.
• infoModuleData (type: GoogleApi.WalletObjects.V1.Model.InfoModuleData.t, default: nil) - Deprecated. Use textModulesData instead.
• balance (type: GoogleApi.WalletObjects.V1.Model.Money.t, default: nil) - The card's monetary balance.
• smartTapRedemptionValue (type: String.t, default: nil) - 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.
• classId (type: String.t, default: nil) - 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.
• 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 object. 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.
• pin (type: String.t, default: nil) - The card's PIN.
• version (type: String.t, default: nil) - Deprecated
• hasUsers (type: boolean(), default: nil) - Indicates if the object has users. This field is set by the platform.
• locations (type: list(GoogleApi.WalletObjects.V1.Model.LatLongPoint.t), default: nil) - Note: This field is currently not supported to trigger geo notifications.
• notifyPreference (type: String.t, default: nil) - 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.
• 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 class, 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.
• heroImage (type: GoogleApi.WalletObjects.V1.Model.Image.t, default: nil) - 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.
• hasLinkedDevice (type: boolean(), default: nil) - 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.
• linkedObjectIds (type: list(String.t), default: nil) - 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 giftcard object. If a user had saved this gift 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.
• disableExpirationNotification (type: boolean(), default: nil) - 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.
• passConstraints (type: GoogleApi.WalletObjects.V1.Model.PassConstraints.t, default: nil) - Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
• rotatingBarcode (type: GoogleApi.WalletObjects.V1.Model.RotatingBarcode.t, default: nil) - The rotating barcode type and value.
• classReference (type: GoogleApi.WalletObjects.V1.Model.GiftCardClass.t, default: nil) - A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
• eventNumber (type: String.t, default: nil) - The card's event number, an optional field used by some gift cards.
• valueAddedModuleData (type: list(GoogleApi.WalletObjects.V1.Model.ValueAddedModuleData.t), default: nil) - Optional value added module data. Maximum of ten on the object.
• validTimeInterval (type: GoogleApi.WalletObjects.V1.Model.TimeInterval.t, default: nil) - 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.
• id (type: String.t, default: nil) - 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 '-'.
• saveRestrictions (type: GoogleApi.WalletObjects.V1.Model.SaveRestrictions.t, default: nil) - 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.

Attributes

• resource (type: GoogleApi.WalletObjects.V1.Model.GiftCardObject.t, default: nil) - The updated GiftCardObject resource.

Attributes

• pagination (type: GoogleApi.WalletObjects.V1.Model.Pagination.t, default: nil) - Pagination of the response.
• resources (type: list(GoogleApi.WalletObjects.V1.Model.GiftCardObject.t), default: nil) - Resources corresponding to the list request.

Attributes

• groupingId (type: String.t, default: nil) - Optional grouping ID for grouping the passes with the same ID visually together. Grouping with different types of passes is allowed.
• sortIndex (type: integer(), default: nil) - Optional index for sorting the passes when they are grouped with other passes. Passes with lower sort index are shown before passes with higher sort index. If unspecified, the value is assumed to be INT_MAX. For two passes with the same sort index, the sorting behavior is undefined.

Wrapping type for Google hosted images.

Attributes

• id (type: String.t, default: nil) - The ID associated with an image module. This field is here to enable ease of management of image modules.
• mainImage (type: GoogleApi.WalletObjects.V1.Model.Image.t, default: nil) - A 100% width image.

Attributes

• description (type: String.t, default: nil) - Additional information about the image, which is unused and retained only for backward compatibility.
• localizedDescription (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - Translated strings for the description, which are unused and retained only for backward compatibility.
• uri (type: String.t, default: nil) - The location of the image. URIs must have a scheme.

Attributes

• labelValueRows (type: list(GoogleApi.WalletObjects.V1.Model.LabelValueRow.t), default: nil) - A list of collections of labels and values. These will be displayed one after the other in a singular column.
• showLastUpdateTime (type: boolean(), default: nil) -

Attributes

• callbackOptions (type: GoogleApi.WalletObjects.V1.Model.CallbackOptions.t, default: nil) - Allows the issuer to provide their callback settings.
• contactInfo (type: GoogleApi.WalletObjects.V1.Model.IssuerContactInfo.t, default: nil) - Issuer contact information.
• homepageUrl (type: String.t, default: nil) - URL for the issuer's home page.
• issuerId (type: String.t, default: nil) - The unique identifier for an issuer account. This is automatically generated when the issuer is inserted.
• name (type: String.t, default: nil) - The account name of the issuer.
• smartTapMerchantData (type: GoogleApi.WalletObjects.V1.Model.SmartTapMerchantData.t, default: nil) - Available only to Smart Tap enabled partners. Contact support for additional guidance.

Attributes

• alertsEmails (type: list(String.t), default: nil) - Email addresses which will receive alerts.
• email (type: String.t, default: nil) - The primary contact email address.
• name (type: String.t, default: nil) - The primary contact name.
• phone (type: String.t, default: nil) - The primary contact phone number.

Attributes

• resources (type: list(GoogleApi.WalletObjects.V1.Model.Issuer.t), default: nil) - Resources corresponding to the list request.

Attributes

• action (type: String.t, default: nil) -
• signUpInfo (type: GoogleApi.WalletObjects.V1.Model.SignUpInfo.t, default: nil) -
• url (type: String.t, default: nil) - Currently not used, consider deprecating.
• value (type: String.t, default: nil) - JSON web token for action S2AP.

Attributes

• resources (type: GoogleApi.WalletObjects.V1.Model.Resources.t, default: nil) - Data that corresponds to the ids of the provided classes and objects in the JWT. resources will only include the non-empty arrays (i.e. if the JWT only includes eventTicketObjects, then that is the only field that will be present in resources).
• saveUri (type: String.t, default: nil) - A URI that, when opened, will allow the end user to save the object(s) identified in the JWT to their Google account.

Attributes

• jwt (type: String.t, default: nil) - A string representing a JWT of the format described at https://developers.google.com/wallet/reference/rest/v1/Jwt

A pair of text strings to be displayed in the details view. Note we no longer display LabelValue/LabelValueRow as a table, instead a list of items.

Attributes

• columns (type: list(GoogleApi.WalletObjects.V1.Model.LabelValue.t), default: nil) - A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name.

Attributes

• kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "walletobjects#latLongPoint".
• latitude (type: float(), default: nil) - The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
• longitude (type: float(), default: nil) - The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.

Attributes

• uris (type: list(GoogleApi.WalletObjects.V1.Model.Uri.t), default: nil) - The list of URIs.

Attributes

• firstRowOption (type: GoogleApi.WalletObjects.V1.Model.FirstRowOption.t, default: nil) - Specifies from a predefined set of options or from a reference to the field what will be displayed in the first row. To set this override, set the FirstRowOption.fieldOption to the FieldSelector of your choice.
• secondRowOption (type: GoogleApi.WalletObjects.V1.Model.FieldSelector.t, default: nil) - A reference to the field to be displayed in the second row. This option is only displayed if there are not multiple user objects in a group. If there is a group, the second row will always display a field shared by all objects. To set this override, please set secondRowOption to the FieldSelector of you choice.
• thirdRowOption (type: GoogleApi.WalletObjects.V1.Model.FieldSelector.t, default: nil) - An unused/deprecated field. Setting it will have no effect on what the user sees.

Attributes

• defaultValue (type: GoogleApi.WalletObjects.V1.Model.TranslatedString.t, default: nil) - Contains the string to be displayed if no appropriate translation is available.
• kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
• translatedValues (type: list(GoogleApi.WalletObjects.V1.Model.TranslatedString.t), default: nil) - Contains the translations for the string.

Attributes

• 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.
• secondaryRewardsTierLabel (type: String.t, default: nil) - The secondary rewards tier label, such as "Rewards Tier."
• 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. The enableSmartTap and one of object level smartTapRedemptionValue, barcode.value, oraccountIdfields 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. *secondaryRewardsTier(*type:*String.t, *default:*nil) - The secondary rewards tier, such as "Gold" or "Platinum." *rewardsTierLabel(*type:*String.t, *default:*nil) - The rewards tier label, such as "Rewards Tier." Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens. *localizedProgramName(*type:*GoogleApi.WalletObjects.V1.Model.LocalizedString.t, *default:*nil) - Translated strings for the program_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens. *kind(*type:*String.t, *default:*nil) - Identifies what kind of resource this is. Value: the fixed string"walletobjects#loyaltyClass". *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. *localizedAccountNameLabel(*type:*GoogleApi.WalletObjects.V1.Model.LocalizedString.t, *default:*nil) - Translated strings for the account_name_label. Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens. *infoModuleData(*type:*GoogleApi.WalletObjects.V1.Model.InfoModuleData.t, *default:*nil) - Deprecated. Use textModulesData instead. *discoverableProgram(*type:*GoogleApi.WalletObjects.V1.Model.DiscoverableProgram.t, *default:*nil) - Information about how the class may be discovered and instantiated from within the Google Pay app. *review(*type:*GoogleApi.WalletObjects.V1.Model.Review.t, *default:*nil) - The review comments set by the platform when a class is markedapprovedorrejected. *rewardsTier(*type:*String.t, *default:*nil) - The rewards tier, such as "Gold" or "Platinum." Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens. *programName(*type:*String.t, *default:*nil) - Required. The program name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens. *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. *localizedSecondaryRewardsTier(*type:*GoogleApi.WalletObjects.V1.Model.LocalizedString.t, *default:*nil) - Translated strings for the secondary_rewards_tier. *wordMark(*type:*GoogleApi.WalletObjects.V1.Model.Image.t, *default:*nil) - Deprecated. *localizedAccountIdLabel(*type:*GoogleApi.WalletObjects.V1.Model.LocalizedString.t, *default:*nil) - Translated strings for the account_id_label. Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens. *accountNameLabel(*type:*String.t, *default:*nil) - The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens. *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. UsemultipleDevicesAndHoldersAllowedStatusinstead. *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. *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. *wideProgramLogo(*type:*GoogleApi.WalletObjects.V1.Model.Image.t, *default:*nil) - The wide logo of the loyalty program or company. When provided, this will be used in place of the program logo in the top left of the card view. *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 todraftorunderReviewusing the insert, patch, or update API calls. Once the review state is changed fromdraftit may not be changed back todraft. You should keep this field todraftwhen the class is under development. Adraftclass cannot be used to create any object. You should set this field tounderReviewwhen you believe the class is ready for use. The platform will automatically set this field toapprovedand it can be immediately used to create or migrate objects. When updating an alreadyapprovedclass 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. *localizedRewardsTierLabel(*type:*GoogleApi.WalletObjects.V1.Model.LocalizedString.t, *default:*nil) - Translated strings for the rewards_tier_label. Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens. *programLogo(*type:*GoogleApi.WalletObjects.V1.Model.Image.t, *default:*nil) - Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app. *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. TheredemptionIssuersand one of object levelsmartTapRedemptionLevel, barcode.value, or accountId fields must also be set up correctly in order for a pass to support Smart Tap.
• accountIdLabel (type: String.t, default: nil) - The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
• 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 loyalty card.
• 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 '-'.
• localizedRewardsTier (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - Translated strings for the rewards_tier. Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens.
• localizedSecondaryRewardsTierLabel (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - Translated strings for the secondary_rewards_tier_label.

Attributes

• resource (type: GoogleApi.WalletObjects.V1.Model.LoyaltyClass.t, default: nil) - The updated LoyaltyClass resource.

Attributes

• pagination (type: GoogleApi.WalletObjects.V1.Model.Pagination.t, default: nil) - Pagination of the response.
• resources (type: list(GoogleApi.WalletObjects.V1.Model.LoyaltyClass.t), default: nil) - Resources corresponding to the list request.

Attributes

• barcode (type: GoogleApi.WalletObjects.V1.Model.Barcode.t, default: nil) - The barcode type and value.
• 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 class only object AppLinkData will be displayed.
• state (type: String.t, default: nil) - 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.
• groupingInfo (type: GoogleApi.WalletObjects.V1.Model.GroupingInfo.t, default: nil) - Information that controls how passes are grouped together.
• kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "walletobjects#loyaltyObject".
• infoModuleData (type: GoogleApi.WalletObjects.V1.Model.InfoModuleData.t, default: nil) - Deprecated. Use textModulesData instead.
• loyaltyPoints (type: GoogleApi.WalletObjects.V1.Model.LoyaltyPoints.t, default: nil) - The loyalty reward points label, balance, and type.
• smartTapRedemptionValue (type: String.t, default: nil) - 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. If this value is not set but the class level fields enableSmartTap and redemptionIssuers are set up correctly, the barcode.value or the accountId fields are used as fallback if present.
• classId (type: String.t, default: nil) - 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.
• 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 object. 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
• hasUsers (type: boolean(), default: nil) - Indicates if the object has users. This field is set by the platform.
• locations (type: list(GoogleApi.WalletObjects.V1.Model.LatLongPoint.t), default: nil) - Note: This field is currently not supported to trigger geo notifications.
• notifyPreference (type: String.t, default: nil) - 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.
• 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 class, 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.
• heroImage (type: GoogleApi.WalletObjects.V1.Model.Image.t, default: nil) - 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.
• hasLinkedDevice (type: boolean(), default: nil) - 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.
• accountName (type: String.t, default: nil) - The loyalty account holder name, such as "John Smith." Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
• linkedObjectIds (type: list(String.t), default: nil) - 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 loyalty object. If a user had saved this loyalty 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.
• disableExpirationNotification (type: boolean(), default: nil) - 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.
• passConstraints (type: GoogleApi.WalletObjects.V1.Model.PassConstraints.t, default: nil) - Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
• rotatingBarcode (type: GoogleApi.WalletObjects.V1.Model.RotatingBarcode.t, default: nil) - The rotating barcode type and value.
• classReference (type: GoogleApi.WalletObjects.V1.Model.LoyaltyClass.t, default: nil) - A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
• secondaryLoyaltyPoints (type: GoogleApi.WalletObjects.V1.Model.LoyaltyPoints.t, default: nil) - The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points.
• valueAddedModuleData (type: list(GoogleApi.WalletObjects.V1.Model.ValueAddedModuleData.t), default: nil) - Optional value added module data. Maximum of ten on the object.
• linkedOfferIds (type: list(String.t), default: nil) - A list of offer objects linked to this loyalty card. 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.
• validTimeInterval (type: GoogleApi.WalletObjects.V1.Model.TimeInterval.t, default: nil) - 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.
• id (type: String.t, default: nil) - 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 '-'.
• accountId (type: String.t, default: nil) - The loyalty account identifier. Recommended maximum length is 20 characters.
• saveRestrictions (type: GoogleApi.WalletObjects.V1.Model.SaveRestrictions.t, default: nil) - 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.

Attributes

• resource (type: GoogleApi.WalletObjects.V1.Model.LoyaltyObject.t, default: nil) - The updated LoyaltyObject resource.

Attributes

• pagination (type: GoogleApi.WalletObjects.V1.Model.Pagination.t, default: nil) - Pagination of the response.
• resources (type: list(GoogleApi.WalletObjects.V1.Model.LoyaltyObject.t), default: nil) - Resources corresponding to the list request.

Attributes

• balance (type: GoogleApi.WalletObjects.V1.Model.LoyaltyPointsBalance.t, default: nil) - The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of loyaltyPoints and secondaryLoyaltyPoints.
• label (type: String.t, default: nil) - The loyalty points label, such as "Points". Recommended maximum length is 9 characters.
• localizedLabel (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - Translated strings for the label. Recommended maximum length is 9 characters.

Attributes

• double (type: float(), default: nil) - The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
• int (type: integer(), default: nil) - The integer form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
• money (type: GoogleApi.WalletObjects.V1.Model.Money.t, default: nil) - The money form of a balance. Only one of these subtypes (string, int, double, money) should be populated.
• string (type: String.t, default: nil) - The string form of a balance. Only one of these subtypes (string, int, double, money) should be populated.

A reference to data stored on the filesystem, on GFS or in blobstore.

Extra information added to operations that support Scotty media requests.

Locations of interest for this class or object. Currently, this location is used for geofenced notifications. When a user is within a set radius of this lat/long, and dwells there, Google will trigger a notification. When a user exits this radius, the notification will be hidden.

A message that will be displayed with a Valuable

Attributes

• addLinkedOfferObjectIds (type: list(String.t), default: nil) - The linked offer object ids to add to the object.
• removeLinkedOfferObjectIds (type: list(String.t), default: nil) - The linked offer object ids to remove from the object.

Attributes

• linkedOfferObjectIds (type: GoogleApi.WalletObjects.V1.Model.ModifyLinkedOfferObjects.t, default: nil) - The linked offer object ids to add or remove from the object.

Constraints that all must be met for the module to be shown.

Attributes

• currencyCode (type: String.t, default: nil) - The currency code, such as "USD" or "EUR."
• kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "walletobjects#money".
• micros (type: String.t, default: nil) - The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.

Indicates if the object needs to have notification enabled. We support only one of ExpiryNotification/UpcomingNotification. expiryNotification takes precedence over upcomingNotification. In other words if expiryNotification is set, we ignore the upcomingNotification field.

This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763.

Attributes

• 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.
• 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. The enableSmartTap and object level smartTapRedemptionLevel 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: String.t, default: nil) - The fine print or terms of the offer, such as "20% off any t-shirt at Adam's Apparel."
• redemptionChannel (type: String.t, default: nil) - Required. The redemption channels applicable to this offer.
• localizedTitle (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - Translated strings for the title. Recommended maximum length is 60 characters to ensure full string is displayed on smaller screens.
• kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "walletobjects#offerClass".
• 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.
• localizedDetails (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - Translated strings for the details.
• review (type: GoogleApi.WalletObjects.V1.Model.Review.t, default: nil) - The review comments set by the platform when a class is marked approved or rejected.
• localizedShortTitle (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - Translated strings for the short title. Recommended maximum length is 20 characters.
• 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.
• shortTitle (type: String.t, default: nil) - 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.
• wordMark (type: GoogleApi.WalletObjects.V1.Model.Image.t, default: nil) - Deprecated.
• provider (type: String.t, default: nil) - 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.
• localizedFinePrint (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - Translated strings for the fine_print.
• details (type: String.t, default: nil) - The details of the offer.
• 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. Use multipleDevicesAndHoldersAllowedStatus instead.
• 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
• helpUri (type: GoogleApi.WalletObjects.V1.Model.Uri.t, default: nil) - The help link for the offer, such as http://myownpersonaldomain.com/help
• locations (type: list(GoogleApi.WalletObjects.V1.Model.LatLongPoint.t), default: nil) - Note: This field is currently not supported to trigger geo notifications.
• 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.
• wideTitleImage (type: GoogleApi.WalletObjects.V1.Model.Image.t, default: nil) - 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.
• 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 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.
• 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. The redemptionIssuers and object level smartTapRedemptionLevel fields must also be set up correctly in order for a pass to support Smart Tap.
• localizedProvider (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - Translated strings for the provider. Recommended maximum length is 12 characters to ensure full string is displayed on smaller screens.
• 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.
• titleImage (type: GoogleApi.WalletObjects.V1.Model.Image.t, default: nil) - The title image of the offer. This image is displayed in both the details and list views of the app.
• viewUnlockRequirement (type: String.t, default: nil) - View Unlock Requirement options for the offer.
• 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 '-'.
• title (type: String.t, default: nil) - 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.

Attributes

• resource (type: GoogleApi.WalletObjects.V1.Model.OfferClass.t, default: nil) - The updated OfferClass resource.

Attributes

• pagination (type: GoogleApi.WalletObjects.V1.Model.Pagination.t, default: nil) - Pagination of the response.
• resources (type: list(GoogleApi.WalletObjects.V1.Model.OfferClass.t), default: nil) - Resources corresponding to the list request.

Attributes

• 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 class only object AppLinkData will be displayed.
• barcode (type: GoogleApi.WalletObjects.V1.Model.Barcode.t, default: nil) - The barcode type and value.
• classId (type: String.t, default: nil) - 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.
• classReference (type: GoogleApi.WalletObjects.V1.Model.OfferClass.t, default: nil) - A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
• disableExpirationNotification (type: boolean(), default: nil) - 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.
• groupingInfo (type: GoogleApi.WalletObjects.V1.Model.GroupingInfo.t, default: nil) - Information that controls how passes are grouped together.
• hasLinkedDevice (type: boolean(), default: nil) - 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.
• hasUsers (type: boolean(), default: nil) - Indicates if the object has users. This field is set by the platform.
• heroImage (type: GoogleApi.WalletObjects.V1.Model.Image.t, default: nil) - 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.
• id (type: String.t, default: nil) - 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 '-'.
• 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.
• infoModuleData (type: GoogleApi.WalletObjects.V1.Model.InfoModuleData.t, default: nil) - Deprecated. Use textModulesData instead.
• kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "walletobjects#offerObject".
• linkedObjectIds (type: list(String.t), default: nil) - 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 offer object. If a user had saved this offer, 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.
• linksModuleData (type: GoogleApi.WalletObjects.V1.Model.LinksModuleData.t, default: nil) - Links module data. If links module data is also defined on the class, both will be displayed.
• locations (type: list(GoogleApi.WalletObjects.V1.Model.LatLongPoint.t), default: nil) - Note: This field is currently not supported to trigger geo notifications.
• merchantLocations (type: list(GoogleApi.WalletObjects.V1.Model.MerchantLocation.t), default: nil) - Merchant locations. There is a maximum of ten on the object. 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.
• 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.
• notifyPreference (type: String.t, default: nil) - 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.
• passConstraints (type: GoogleApi.WalletObjects.V1.Model.PassConstraints.t, default: nil) - Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
• rotatingBarcode (type: GoogleApi.WalletObjects.V1.Model.RotatingBarcode.t, default: nil) - The rotating barcode type and value.
• saveRestrictions (type: GoogleApi.WalletObjects.V1.Model.SaveRestrictions.t, default: nil) - 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.
• smartTapRedemptionValue (type: String.t, default: nil) - 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.
• state (type: String.t, default: nil) - 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.
• 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.
• validTimeInterval (type: GoogleApi.WalletObjects.V1.Model.TimeInterval.t, default: nil) - 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.
• valueAddedModuleData (type: list(GoogleApi.WalletObjects.V1.Model.ValueAddedModuleData.t), default: nil) - Optional value added module data. Maximum of ten on the object.
• version (type: String.t, default: nil) - Deprecated

Attributes

• resource (type: GoogleApi.WalletObjects.V1.Model.OfferObject.t, default: nil) - The updated OfferObject resource.

Attributes

• pagination (type: GoogleApi.WalletObjects.V1.Model.Pagination.t, default: nil) - Pagination of the response.
• resources (type: list(GoogleApi.WalletObjects.V1.Model.OfferObject.t), default: nil) - Resources corresponding to the list request.

Attributes

• kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "walletobjects#pagination".
• nextPageToken (type: String.t, default: nil) - Page token to send to fetch the next page.
• resultsPerPage (type: integer(), default: nil) - Number of results returned in this page.

Container for any constraints that may be placed on passes.

Attributes

• emailAddress (type: String.t, default: nil) - The email address of the user, group, or service account to which this permission refers to.
• role (type: String.t, default: nil) - The role granted by this permission.

Attributes

• issuerId (type: String.t, default: nil) - ID of the issuer the list of permissions refer to.
• permissions (type: list(GoogleApi.WalletObjects.V1.Model.Permission.t), default: nil) - The complete list of permissions for the issuer account.

Attributes

• accountId (type: String.t, default: nil) - ID of the account used to purchase the ticket.
• confirmationCode (type: String.t, default: nil) - The confirmation code for the purchase. This may be the same for multiple different tickets and is used to group tickets together.
• purchaseDateTime (type: String.t, default: nil) - The purchase date/time of the ticket. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: 1985-04-12T23:20:50.52Z would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. 1985-04-12T19:20:50.52-04:00 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. 1985-04-12T19:20:50.52 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Without offset information, some rich features may not be available.
• purchaseReceiptNumber (type: String.t, default: nil) - Receipt number/identifier for tracking the ticket purchase via the body that sold the ticket.
• ticketCost (type: GoogleApi.WalletObjects.V1.Model.TicketCost.t, default: nil) - The cost of the ticket.

Attributes

• confirmationCode (type: String.t, default: nil) - Confirmation code needed to check into this flight. This is the number that the passenger would enter into a kiosk at the airport to look up the flight and print a boarding pass.
• eticketNumber (type: String.t, default: nil) - E-ticket number.
• frequentFlyerInfo (type: GoogleApi.WalletObjects.V1.Model.FrequentFlyerInfo.t, default: nil) - Frequent flyer membership information.
• kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "walletobjects#reservationInfo".

Attributes

• eventTicketClasses (type: list(GoogleApi.WalletObjects.V1.Model.EventTicketClass.t), default: nil) - A list of event ticket classes.
• eventTicketObjects (type: list(GoogleApi.WalletObjects.V1.Model.EventTicketObject.t), default: nil) - A list of event ticket objects.
• flightClasses (type: list(GoogleApi.WalletObjects.V1.Model.FlightClass.t), default: nil) - A list of flight classes.
• flightObjects (type: list(GoogleApi.WalletObjects.V1.Model.FlightObject.t), default: nil) - A list of flight objects.
• genericClasses (type: list(GoogleApi.WalletObjects.V1.Model.GenericClass.t), default: nil) - A list of generic classes.
• genericObjects (type: list(GoogleApi.WalletObjects.V1.Model.GenericObject.t), default: nil) - A list of generic objects.
• giftCardClasses (type: list(GoogleApi.WalletObjects.V1.Model.GiftCardClass.t), default: nil) - A list of gift card classes.
• giftCardObjects (type: list(GoogleApi.WalletObjects.V1.Model.GiftCardObject.t), default: nil) - A list of gift card objects.
• loyaltyClasses (type: list(GoogleApi.WalletObjects.V1.Model.LoyaltyClass.t), default: nil) - A list of loyalty classes.
• loyaltyObjects (type: list(GoogleApi.WalletObjects.V1.Model.LoyaltyObject.t), default: nil) - A list of loyalty objects.
• offerClasses (type: list(GoogleApi.WalletObjects.V1.Model.OfferClass.t), default: nil) - A list of offer classes.
• offerObjects (type: list(GoogleApi.WalletObjects.V1.Model.OfferObject.t), default: nil) - A list of offer objects.
• transitClasses (type: list(GoogleApi.WalletObjects.V1.Model.TransitClass.t), default: nil) - A list of transit classes.
• transitObjects (type: list(GoogleApi.WalletObjects.V1.Model.TransitObject.t), default: nil) - A list of transit objects.

Attributes

• comments (type: String.t, default: nil) -

Attributes

• alternateText (type: String.t, default: nil) - An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.
• initialRotatingBarcodeValues (type: GoogleApi.WalletObjects.V1.Model.RotatingBarcodeValues.t, default: nil) - Input only. NOTE: This feature is only available for the transit vertical. Optional set of initial rotating barcode values. This allows a small subset of barcodes to be included with the object. Further rotating barcode values must be uploaded with the UploadRotatingBarcodeValues endpoint.
• renderEncoding (type: String.t, default: nil) - The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.
• showCodeText (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.
• totpDetails (type: GoogleApi.WalletObjects.V1.Model.RotatingBarcodeTotpDetails.t, default: nil) - Details used to evaluate the {totp_value_n} substitutions.
• type (type: String.t, default: nil) - The type of this barcode.
• valuePattern (type: String.t, default: nil) - String encoded barcode value. This string supports the following substitutions: {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated.

Configuration for the time-based OTP substitutions. See https://tools.ietf.org/html/rfc6238

Configuration for the key and value length. See https://www.rfc-editor.org/rfc/rfc4226#section-5.3

A payload containing many barcode values and start date/time.

Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support.

Attributes

• animationType (type: String.t, default: nil) - Type of animation.

Request to send a private pass update notice information to Google, so that devices can then fetch the notice prompting the user to update a pass.

A response to a request to notify Google of an awaiting update to a private pass.

Attributes

• classId (type: String.t, default: nil) - ID of the class the user can sign up for.

Attributes

• id (type: String.t, default: nil) - The unique identifier for a smart tap. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is the Smart Tap id. The Smart Tap id is a Base64 encoded string which represents the id which was generated by the Google Pay app.
• infos (type: list(GoogleApi.WalletObjects.V1.Model.IssuerToUserInfo.t), default: nil) - Communication from merchant to user.
• kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "walletobjects#smartTap".
• merchantId (type: String.t, default: nil) - Smart Tap merchant ID of who engaged in the Smart Tap interaction.

Attributes

• authenticationKeys (type: list(GoogleApi.WalletObjects.V1.Model.AuthenticationKey.t), default: nil) - Available only to Smart Tap enabled partners. Contact support for additional guidance.
• smartTapMerchantId (type: String.t, default: nil) - Available only to Smart Tap enabled partners. Contact support for additional guidance.

Attributes

• firstValue (type: GoogleApi.WalletObjects.V1.Model.FieldSelector.t, default: nil) - A reference to a field to display. If both firstValue and secondValue are populated, they will both appear as one item with a slash between them. For example, values A and B would be shown as "A / B".
• predefinedItem (type: String.t, default: nil) - A predefined item to display. Only one of firstValue or predefinedItem may be set.
• secondValue (type: GoogleApi.WalletObjects.V1.Model.FieldSelector.t, default: nil) - A reference to a field to display. This may only be populated if the firstValue field is populated.

Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.

Attributes

• discountMessage (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - A message describing any kind of discount that was applied.
• faceValue (type: GoogleApi.WalletObjects.V1.Model.Money.t, default: nil) - The face value of the ticket.
• purchasePrice (type: GoogleApi.WalletObjects.V1.Model.Money.t, default: nil) - The actual purchase price of the ticket, after tax and/or discounts.

Attributes

• arrivalDateTime (type: String.t, default: nil) - The date/time of arrival. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: 1985-04-12T23:20:50.52Z would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. 1985-04-12T19:20:50.52-04:00 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. 1985-04-12T19:20:50.52 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the destination station. For example, if the event occurs at the 20th hour of June 5th, 2018 at the destination station, the local date/time portion should be 2018-06-05T20:00:00. If the local date/time at the destination station is 4 hours before UTC, an offset of -04:00 may be appended. Without offset information, some rich features may not be available.
• carriage (type: String.t, default: nil) - The train or ship name/number that the passsenger needs to board.
• departureDateTime (type: String.t, default: nil) - The date/time of departure. This is required if there is no validity time interval set on the transit object. This is an ISO 8601 extended format date/time, with or without an offset. Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: 1985-04-12T23:20:50.52Z would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. 1985-04-12T19:20:50.52-04:00 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the event were in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. 1985-04-12T19:20:50.52 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. The portion of the date/time without the offset is considered the "local date/time". This should be the local date/time at the origin station. For example, if the departure occurs at the 20th hour of June 5th, 2018 at the origin station, the local date/time portion should be 2018-06-05T20:00:00. If the local date/time at the origin station is 4 hours before UTC, an offset of -04:00 may be appended. Without offset information, some rich features may not be available.
• destinationName (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - The destination name.
• destinationStationCode (type: String.t, default: nil) - The destination station code.
• fareName (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - Short description/name of the fare for this leg of travel. Eg "Anytime Single Use".
• originName (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - The name of the origin station. This is required if desinationName is present or if originStationCode is not present.
• originStationCode (type: String.t, default: nil) - The origin station code. This is required if destinationStationCode is present or if originName is not present.
• platform (type: String.t, default: nil) - The platform or gate where the passenger can board the carriage.
• ticketSeat (type: GoogleApi.WalletObjects.V1.Model.TicketSeat.t, default: nil) - The reserved seat for the passenger(s). If more than one seat is to be specified then use the ticketSeats field instead. Both ticketSeat and ticketSeats may not be set.
• ticketSeats (type: list(GoogleApi.WalletObjects.V1.Model.TicketSeat.t), default: nil) - The reserved seat for the passenger(s). If only one seat is to be specified then use the ticketSeat field instead. Both ticketSeat and ticketSeats may not be set.
• transitOperatorName (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - The name of the transit operator that is operating this leg of a trip.
• transitTerminusName (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - Terminus station or destination of the train/bus/etc.
• zone (type: String.t, default: nil) - The zone of boarding within the platform.

Attributes

• otherRestrictions (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - Extra restrictions that don't fall under the "route" or "time" categories.
• routeRestrictions (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - Restrictions about routes that may be taken. For example, this may be the string "Reserved CrossCountry trains only".
• routeRestrictionsDetails (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - More details about the above routeRestrictions.
• timeRestrictions (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - Restrictions about times this ticket may be used.

Attributes

• coach (type: String.t, default: nil) - The identifier of the train car or coach in which the ticketed seat is located. Eg. "10"
• customFareClass (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - A custome fare class to be used if no fareClass applies. Both fareClass and customFareClass may not be set.
• fareClass (type: String.t, default: nil) - The fare class of the ticketed seat.
• seat (type: String.t, default: nil) - The identifier of where the ticketed seat is located. Eg. "42". If there is no specific identifier, use seatAssigment instead.
• seatAssignment (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - The passenger's seat assignment. Eg. "no specific seat". To be used when there is no specific identifier to use in seat.

Attributes

• end (type: GoogleApi.WalletObjects.V1.Model.DateTime.t, default: nil) - End time of the interval. Offset is not required. If an offset is provided and start time is set, start must also include an offset.
• kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "walletobjects#timeInterval".
• start (type: GoogleApi.WalletObjects.V1.Model.DateTime.t, default: nil) - Start time of the interval. Offset is not required. If an offset is provided and end time is set, end must also include an offset.

Attributes

• 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.
• languageOverride (type: String.t, default: nil) - If this field is present, transit tickets served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
• 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. The enableSmartTap and object level smartTapRedemptionLevel 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.
• customPurchaseFaceValueLabel (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - A custom label to use for the purchase face value (transitObject.purchaseDetails.ticketCost.faceValue).
• customConcessionCategoryLabel (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - A custom label to use for the transit concession category value (transitObject.concessionCategory).
• customCoachLabel (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - A custom label to use for the coach value (transitObject.ticketLeg.ticketSeat.coach).
• customRouteRestrictionsLabel (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - A custom label to use for the route restrictions value (transitObject.ticketRestrictions.routeRestrictions).
• transitType (type: String.t, default: nil) - Required. The type of transit this class represents, such as "bus".
• logo (type: GoogleApi.WalletObjects.V1.Model.Image.t, default: nil) - Required. The logo image of the ticket. This image is displayed in the card detail view of the app.
• 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.
• customFareNameLabel (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - A custom label to use for the transit fare name value (transitObject.ticketLeg.fareName).
• customCarriageLabel (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - A custom label to use for the carriage value (transitObject.ticketLeg.carriage).
• infoModuleData (type: GoogleApi.WalletObjects.V1.Model.InfoModuleData.t, default: nil) - Deprecated. Use textModulesData instead.
• customTimeRestrictionsLabel (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - A custom label to use for the time restrictions details value (transitObject.ticketRestrictions.timeRestrictions).
• review (type: GoogleApi.WalletObjects.V1.Model.Review.t, default: nil) - The review comments set by the platform when a class is marked approved or rejected.
• customPurchaseReceiptNumberLabel (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - A custom label to use for the purchase receipt number value (transitObject.purchaseDetails.purchaseReceiptNumber).
• customTicketNumberLabel (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - A custom label to use for the ticket number value (transitObject.ticketNumber).
• 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.
• customOtherRestrictionsLabel (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - A custom label to use for the other restrictions value (transitObject.ticketRestrictions.otherRestrictions).
• wordMark (type: GoogleApi.WalletObjects.V1.Model.Image.t, default: nil) - Deprecated.
• customPurchasePriceLabel (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - A custom label to use for the purchase price value (transitObject.purchaseDetails.ticketCost.purchasePrice).
• customConfirmationCodeLabel (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - A custom label to use for the confirmation code value (transitObject.purchaseDetails.confirmationCode).
• customPlatformLabel (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - A custom label to use for the boarding platform value (transitObject.ticketLeg.platform).
• 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. Use multipleDevicesAndHoldersAllowedStatus instead.
• customFareClassLabel (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - A custom label to use for the fare class value (transitObject.ticketLeg.ticketSeat.fareClass).
• 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.
• 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 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.
• 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.
• watermark (type: GoogleApi.WalletObjects.V1.Model.Image.t, default: nil) - Watermark image to display on the user's device.
• enableSingleLegItinerary (type: boolean(), default: nil) - Controls the display of the single-leg itinerary for this class. By default, an itinerary will only display for multi-leg trips.
• 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 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.
• 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.
• activationOptions (type: GoogleApi.WalletObjects.V1.Model.ActivationOptions.t, default: nil) - Activation options for an activatable ticket.
• customZoneLabel (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - A custom label to use for the boarding zone value (transitObject.ticketLeg.zone).
• 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.
• customTransitTerminusNameLabel (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - A custom label to use for the transit terminus name value (transitObject.ticketLeg.transitTerminusName).
• enableSmartTap (type: boolean(), default: nil) - 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.
• customRouteRestrictionsDetailsLabel (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - A custom label to use for the route restrictions details value (transitObject.ticketRestrictions.routeRestrictionsDetails).
• transitOperatorName (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - The name of the transit operator.
• 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.
• customDiscountMessageLabel (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - A custom label to use for the transit discount message value (transitObject.purchaseDetails.ticketCost.discountMessage).
• viewUnlockRequirement (type: String.t, default: nil) - View Unlock Requirement options for the transit ticket.
• customSeatLabel (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - A custom label to use for the seat location value (transitObject.ticketLeg.ticketSeat.seat).
• 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 '-'.

Attributes

• resource (type: GoogleApi.WalletObjects.V1.Model.TransitClass.t, default: nil) - The updated TransitClass resource.

Attributes

• pagination (type: GoogleApi.WalletObjects.V1.Model.Pagination.t, default: nil) - Pagination of the response.
• resources (type: list(GoogleApi.WalletObjects.V1.Model.TransitClass.t), default: nil) - Resources corresponding to the list request.

Attributes

• barcode (type: GoogleApi.WalletObjects.V1.Model.Barcode.t, default: nil) - The barcode type and value.
• 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 class only object AppLinkData will be displayed.
• state (type: String.t, default: nil) - 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.
• tripType (type: String.t, default: nil) - Required. The type of trip this transit object represents. Used to determine the pass title and/or which symbol to use between the origin and destination.
• concessionCategory (type: String.t, default: nil) - The concession category for the ticket.
• groupingInfo (type: GoogleApi.WalletObjects.V1.Model.GroupingInfo.t, default: nil) - Information that controls how passes are grouped together.
• 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.
• deviceContext (type: GoogleApi.WalletObjects.V1.Model.DeviceContext.t, default: nil) - Device context associated with the object.
• ticketLegs (type: list(GoogleApi.WalletObjects.V1.Model.TicketLeg.t), default: nil) - Each ticket may contain one or more legs. Each leg contains departure and arrival information along with boarding and seating information. If only one leg is to be specified then use the ticketLeg field instead. Both ticketLeg and ticketLegs may not be set.
• passengerNames (type: String.t, default: nil) - The name(s) of the passengers the ticket is assigned to. The above passengerType field is meant to give Google context on this field.
• smartTapRedemptionValue (type: String.t, default: nil) - 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.
• purchaseDetails (type: GoogleApi.WalletObjects.V1.Model.PurchaseDetails.t, default: nil) - Purchase details for this ticket.
• ticketStatus (type: String.t, default: nil) - The status of the ticket. For states which affect display, use the state field instead.
• classId (type: String.t, default: nil) - 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.
• ticketRestrictions (type: GoogleApi.WalletObjects.V1.Model.TicketRestrictions.t, default: nil) - Information about what kind of restrictions there are on using this ticket. For example, which days of the week it must be used, or which routes are allowed to be taken.
• 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 object. 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.
• tripId (type: String.t, default: nil) - This id is used to group tickets together if the user has saved multiple tickets for the same trip.
• version (type: String.t, default: nil) - Deprecated
• activationStatus (type: GoogleApi.WalletObjects.V1.Model.ActivationStatus.t, default: nil) - The activation status for the object. Required if the class has activationOptions set.
• hasUsers (type: boolean(), default: nil) - Indicates if the object has users. This field is set by the platform.
• locations (type: list(GoogleApi.WalletObjects.V1.Model.LatLongPoint.t), default: nil) - Note: This field is currently not supported to trigger geo notifications.
• notifyPreference (type: String.t, default: nil) - 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.
• 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 class, both will be displayed.
• customConcessionCategory (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - A custom concession category to use when concessionCategory does not provide the right option. Both concessionCategory and customConcessionCategory may not be set.
• ticketNumber (type: String.t, default: nil) - The number of the ticket. This is a unique identifier for the ticket in the transit operator's system.
• 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.
• heroImage (type: GoogleApi.WalletObjects.V1.Model.Image.t, default: nil) - 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.
• hasLinkedDevice (type: boolean(), default: nil) - 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.
• customTicketStatus (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - A custom status to use for the ticket status value when ticketStatus does not provide the right option. Both ticketStatus and customTicketStatus may not be set.
• linkedObjectIds (type: list(String.t), default: nil) - 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 transit object. If a user had saved this transit 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.
• disableExpirationNotification (type: boolean(), default: nil) - 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.
• passConstraints (type: GoogleApi.WalletObjects.V1.Model.PassConstraints.t, default: nil) - Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
• rotatingBarcode (type: GoogleApi.WalletObjects.V1.Model.RotatingBarcode.t, default: nil) - The rotating barcode type and value.
• classReference (type: GoogleApi.WalletObjects.V1.Model.TransitClass.t, default: nil) - A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
• valueAddedModuleData (type: list(GoogleApi.WalletObjects.V1.Model.ValueAddedModuleData.t), default: nil) - Optional value added module data. Maximum of ten on the object.
• passengerType (type: String.t, default: nil) - The number of passengers.
• validTimeInterval (type: GoogleApi.WalletObjects.V1.Model.TimeInterval.t, default: nil) - 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.
• id (type: String.t, default: nil) - 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 '-'.
• ticketLeg (type: GoogleApi.WalletObjects.V1.Model.TicketLeg.t, default: nil) - A single ticket leg contains departure and arrival information along with boarding and seating information. If more than one leg is to be specified then use the ticketLegs field instead. Both ticketLeg and ticketLegs may not be set.
• saveRestrictions (type: GoogleApi.WalletObjects.V1.Model.SaveRestrictions.t, default: nil) - 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.

Attributes

• resource (type: GoogleApi.WalletObjects.V1.Model.TransitObject.t, default: nil) - The updated TransitObject resource.

Attributes

• pagination (type: GoogleApi.WalletObjects.V1.Model.Pagination.t, default: nil) - Pagination of the response.
• resources (type: list(GoogleApi.WalletObjects.V1.Model.TransitObject.t), default: nil) - Resources corresponding to the list request.

Request to upload rotating barcode values.

Response for uploading rotating barcode values.

Attributes

• kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
• language (type: String.t, default: nil) - Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
• value (type: String.t, default: nil) - The UTF-8 encoded translated string.

Indicates that the issuer would like Google Wallet to send an upcoming card validity notification 1 day before card becomes valid/usable.

Attributes

• description (type: String.t, default: nil) - The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. Note that in some contexts this text is not used, such as when description is part of an image.
• id (type: String.t, default: nil) - The ID associated with a uri. This field is here to enable ease of management of uris.
• kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "walletobjects#uri".
• localizedDescription (type: GoogleApi.WalletObjects.V1.Model.LocalizedString.t, default: nil) - Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.
• uri (type: String.t, default: nil) - The location of a web page, image, or other resource. URIs in the LinksModuleData module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme.

Data for Value Added module. Required fields are header and uri.