REST Resource: eventticketobject

Resource: EventTicketObject

JSON representation
{
  "kind": string,
  "classReference": {
    object (EventTicketClass)
  },
  "seatInfo": {
    object (EventSeat)
  },
  "reservationInfo": {
    object (EventReservationInfo)
  },
  "ticketHolderName": string,
  "ticketNumber": string,
  "ticketType": {
    object (LocalizedString)
  },
  "faceValue": {
    object (Money)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "linkedOfferIds": [
    string
  ],
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  }
}
Fields
kind
(deprecated)

string

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

classReference

object (EventTicketClass)

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

seatInfo

object (EventSeat)

Seating details for this ticket.

reservationInfo

object (EventReservationInfo)

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

ticketHolderName

string

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

ticketNumber

string

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

ticketType

object (LocalizedString)

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

faceValue

object (Money)

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

groupingInfo

object (GroupingInfo)

Grouping info for event tickets.

linkedOfferIds[]

string

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.

id

string

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

classId

string

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.

version
(deprecated)

string (int64 format)

Deprecated

state

enum (State)

Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an inactive object is no longer displayed in the Google Pay app.

barcode

object (Barcode)

The barcode type and value.

messages[]

object (Message)

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.

validTimeInterval

object (TimeInterval)

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.

locations[]

object (LatLongPoint)

The list of locations where the object can be used. The platform uses this information to trigger geolocated notifications to users. Note that locations in the object override locations in the class which override locations in the Google Places ID.

hasUsers

boolean

Indicates if the object has users. This field is set by the platform.

smartTapRedemptionValue

string

Available only to Smart Tap enabled partners. Contact support for additional guidance.

hasLinkedDevice

boolean

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.

disableExpirationNotification

boolean

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.

infoModuleData

object (InfoModuleData)

Deprecated. Use textModulesData instead.

imageModulesData[]

object (ImageModuleData)

Image module data. If image modules data is also defined on the class, those will be merged with the image data defined on the object. The maximum number of these fields (combined with the class) is 1.

textModulesData[]

object (TextModuleData)

Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields (combined with the class) is 10.

EventSeat

JSON representation
{
  "kind": string,
  "seat": {
    object (LocalizedString)
  },
  "row": {
    object (LocalizedString)
  },
  "section": {
    object (LocalizedString)
  },
  "gate": {
    object (LocalizedString)
  }
}
Fields
kind
(deprecated)

string

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

seat

object (LocalizedString)

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.

row

object (LocalizedString)

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.

section

object (LocalizedString)

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.

gate

object (LocalizedString)

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.

EventReservationInfo

JSON representation
{
  "kind": string,
  "confirmationCode": string
}
Fields
kind
(deprecated)

string

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

confirmationCode

string

The confirmation code of the event reservation. This may also take the form of an "order number", "confirmation number", "reservation number", or other equivalent.

GroupingInfo

NEXT_ID: 2

JSON representation
{
  "sortIndex": number
}
Fields
sortIndex

number

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 same sort index, the sorting behavior is undefined.

Methods

addmessage

Adds a message to the event ticket object referenced by the given object ID.

get

Returns the event ticket object with the given object ID.

insert

Inserts an event ticket object with the given ID and properties.

list

Returns a list of all event ticket objects for a given issuer ID.

modifylinkedofferobjects

Modifies linked offer objects for the event ticket object with the given ID.

patch

Updates the event ticket object referenced by the given object ID.

update

Updates the event ticket object referenced by the given object ID.