v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1398152302.3 KB
eventticketclass

Updates the event ticket class referenced by the given class ID. This method supports patch semantics.

patch/walletobjects/v1/eventTicketClass/{resourceId}

Path parameters

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

Request body

seatLabel'SEAT_LABEL_UNSPECIFIED' | 'SEAT' | 'seat'

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.

issuerNamestring

Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.

gateLabel'GATE_LABEL_UNSPECIFIED' | 'GATE' | 'gate' | 'DOOR' | 'door' | 'ENTRANCE' | 'entrance'

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.

versionstring int64

Deprecated

enableSmartTapboolean

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.

eventIdstring

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

reviewStatus'REVIEW_STATUS_UNSPECIFIED' | 'UNDER_REVIEW' | 'underReview' | 'APPROVED' | 'approved' | 'REJECTED' | 'rejected' | 'DRAFT' | 'draft'

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.

kindstring

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

allowMultipleUsersPerObjectboolean

Deprecated. Use multipleDevicesAndHoldersAllowedStatus instead.

notifyPreference'NOTIFICATION_SETTINGS_FOR_UPDATES_UNSPECIFIED' | 'NOTIFY_ON_UPDATE'

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.

multipleDevicesAndHoldersAllowedStatus'STATUS_UNSPECIFIED' | 'MULTIPLE_HOLDERS' | 'ONE_USER_ALL_DEVICES' | 'ONE_USER_ONE_DEVICE' | 'multipleHolders' | 'oneUserAllDevices' | 'oneUserOneDevice'

Identifies whether multiple users and devices will save the same object referencing this class.

confirmationCodeLabel'CONFIRMATION_CODE_LABEL_UNSPECIFIED' | 'CONFIRMATION_CODE' | 'confirmationCode' | 'CONFIRMATION_NUMBER' | 'confirmationNumber' | 'ORDER_NUMBER' | 'orderNumber' | 'RESERVATION_NUMBER' | 'reservationNumber'

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.

idstring

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

rowLabel'ROW_LABEL_UNSPECIFIED' | 'ROW' | 'row'

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.

redemptionIssuersstring[]

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.

sectionLabel'SECTION_LABEL_UNSPECIFIED' | 'SECTION' | 'section' | 'THEATER' | 'theater'

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.

countryCodestring

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.

hexBackgroundColorstring

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.

viewUnlockRequirement'VIEW_UNLOCK_REQUIREMENT_UNSPECIFIED' | 'UNLOCK_NOT_REQUIRED' | 'UNLOCK_REQUIRED_TO_VIEW'

View Unlock Requirement options for the event ticket.

Response

Successful response