/walletobjects/v1/eventTicketClass/{resourceId}

GET

eventticketclass

Returns the event ticket class with the given class ID.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://walletobjects.googleapis.com//walletobjects/v1/eventTicketClass/'

Response Example

{
  "allowMultipleUsersPerObject": true,
  "callbackOptions": {
    "updateRequestUrl": "string",
    "url": "string"
  },
  "classTemplateInfo": {
    "cardBarcodeSectionDetails": {
      "firstBottomDetail": {
        "fieldSelector": {
          "fields": [
            {
              "dateFormat": "DATE_FORMAT_UNSPECIFIED",
              "fieldPath": "string"
            }
          ]
        }
      },
      "firstTopDetail": {
        "fieldSelector": {
          "fields": [
            {
              "dateFormat": "DATE_FORMAT_UNSPECIFIED",
              "fieldPath": "string"
            }
          ]
        }
      },
      "secondTopDetail": {
        "fieldSelector": {
          "fields": [
            {
              "dateFormat": "DATE_FORMAT_UNSPECIFIED",
              "fieldPath": "string"
            }
          ]
        }
      }
    },
    "cardTemplateOverride": {
      "cardRowTemplateInfos": [
        {
          "oneItem": {
            "item": {
              "firstValue": {
                "fields": [
                  {
                    "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                    "fieldPath": "string"
                  }
                ]
              },
              "predefinedItem": "PREDEFINED_ITEM_UNSPECIFIED",
              "secondValue": {
                "fields": [
                  {
                    "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                    "fieldPath": "string"
                  }
                ]
              }
            }
          },
          "threeItems": {
            "endItem": {
              "firstValue": {
                "fields": [
                  {
                    "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                    "fieldPath": "string"
                  }
                ]
              },
              "predefinedItem": "PREDEFINED_ITEM_UNSPECIFIED",
              "secondValue": {
                "fields": [
                  {
                    "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                    "fieldPath": "string"
                  }
                ]
              }
            },
            "middleItem": {
              "firstValue": {
                "fields": [
                  {
                    "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                    "fieldPath": "string"
                  }
                ]
              },
              "predefinedItem": "PREDEFINED_ITEM_UNSPECIFIED",
              "secondValue": {
                "fields": [
                  {
                    "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                    "fieldPath": "string"
                  }
                ]
              }
            },
            "startItem": {
              "firstValue": {
                "fields": [
                  {
                    "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                    "fieldPath": "string"
                  }
                ]
              },
              "predefinedItem": "PREDEFINED_ITEM_UNSPECIFIED",
              "secondValue": {
                "fields": [
                  {
                    "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                    "fieldPath": "string"
                  }
                ]
              }
            }
          },
          "twoItems": {
            "endItem": {
              "firstValue": {
                "fields": [
                  {
                    "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                    "fieldPath": "string"
                  }
                ]
              },
              "predefinedItem": "PREDEFINED_ITEM_UNSPECIFIED",
              "secondValue": {
                "fields": [
                  {
                    "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                    "fieldPath": "string"
                  }
                ]
              }
            },
            "startItem": {
              "firstValue": {
                "fields": [
                  {
                    "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                    "fieldPath": "string"
                  }
                ]
              },
              "predefinedItem": "PREDEFINED_ITEM_UNSPECIFIED",
              "secondValue": {
                "fields": [
                  {
                    "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                    "fieldPath": "string"
                  }
                ]
              }
            }
          }
        }
      ]
    },
    "detailsTemplateOverride": {
      "detailsItemInfos": [
        {
          "item": {
            "firstValue": {
              "fields": [
                {
                  "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                  "fieldPath": "string"
                }
              ]
            },
            "predefinedItem": "PREDEFINED_ITEM_UNSPECIFIED",
            "secondValue": {
              "fields": [
                {
                  "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                  "fieldPath": "string"
                }
              ]
            }
          }
        }
      ]
    },
    "listTemplateOverride": {
      "firstRowOption": {
        "fieldOption": {
          "fields": [
            {
              "dateFormat": "DATE_FORMAT_UNSPECIFIED",
              "fieldPath": "string"
            }
          ]
        },
        "transitOption": "TRANSIT_OPTION_UNSPECIFIED"
      },
      "secondRowOption": {
        "fields": [
          {
            "dateFormat": "DATE_FORMAT_UNSPECIFIED",
            "fieldPath": "string"
          }
        ]
      },
      "thirdRowOption": {
        "fields": [
          {
            "dateFormat": "DATE_FORMAT_UNSPECIFIED",
            "fieldPath": "string"
          }
        ]
      }
    }
  },
  "confirmationCodeLabel": "CONFIRMATION_CODE_LABEL_UNSPECIFIED",
  "countryCode": "string",
  "customConfirmationCodeLabel": {
    "defaultValue": {
      "kind": "string",
      "language": "string",
      "value": "string"
    },
    "kind": "string",
    "translatedValues": [
      {
        "kind": "string",
        "language": "string",
        "value": "string"
      }
    ]
  },
  "customGateLabel": {
    "defaultValue": {
      "kind": "string",
      "language": "string",
      "value": "string"
    },
    "kind": "string",
    "translatedValues": [
      {
        "kind": "string",
        "language": "string",
        "value": "string"
      }
    ]
  },
  "customRowLabel": {
    "defaultValue": {
      "kind": "string",
      "language": "string",
      "value": "string"
    },
    "kind": "string",
    "translatedValues": [
      {
        "kind": "string",
        "language": "string",
        "value": "string"
      }
    ]
  },
  "customSeatLabel": {
    "defaultValue": {
      "kind": "string",
      "language": "string",
      "value": "string"
    },
    "kind": "string",
    "translatedValues": [
      {
        "kind": "string",
        "language": "string",
        "value": "string"
      }
    ]
  },
  "customSectionLabel": {
    "defaultValue": {
      "kind": "string",
      "language": "string",
      "value": "string"
    },
    "kind": "string",
    "translatedValues": [
      {
        "kind": "string",
        "language": "string",
        "value": "string"
      }
    ]
  },
  "dateTime": {
    "customDoorsOpenLabel": {
      "defaultValue": {
        "kind": "string",
        "language": "string",
        "value": "string"
      },
      "kind": "string",
      "translatedValues": [
        {
          "kind": "string",
          "language": "string",
          "value": "string"
        }
      ]
    },
    "doorsOpen": "string",
    "doorsOpenLabel": "DOORS_OPEN_LABEL_UNSPECIFIED",
    "end": "string",
    "kind": "string",
    "start": "string"
  },
  "enableSmartTap": true,
  "eventId": "string",
  "eventName": {
    "defaultValue": {
      "kind": "string",
      "language": "string",
      "value": "string"
    },
    "kind": "string",
    "translatedValues": [
      {
        "kind": "string",
        "language": "string",
        "value": "string"
      }
    ]
  },
  "finePrint": {
    "defaultValue": {
      "kind": "string",
      "language": "string",
      "value": "string"
    },
    "kind": "string",
    "translatedValues": [
      {
        "kind": "string",
        "language": "string",
        "value": "string"
      }
    ]
  },
  "gateLabel": "GATE_LABEL_UNSPECIFIED",
  "heroImage": {
    "kind": "string",
    "sourceUri": {
      "description": "string",
      "localizedDescription": {
        "defaultValue": {
          "kind": "string",
          "language": "string",
          "value": "string"
        },
        "kind": "string",
        "translatedValues": [
          {
            "kind": "string",
            "language": "string",
            "value": "string"
          }
        ]
      },
      "uri": "string"
    }
  },
  "hexBackgroundColor": "string",
  "homepageUri": {
    "description": "string",
    "id": "string",
    "kind": "string",
    "localizedDescription": {
      "defaultValue": {
        "kind": "string",
        "language": "string",
        "value": "string"
      },
      "kind": "string",
      "translatedValues": [
        {
          "kind": "string",
          "language": "string",
          "value": "string"
        }
      ]
    },
    "uri": "string"
  },
  "id": "string",
  "imageModulesData": [
    {
      "id": "string",
      "mainImage": {
        "kind": "string",
        "sourceUri": {
          "description": "string",
          "localizedDescription": {
            "defaultValue": {
              "kind": "string",
              "language": "string",
              "value": "string"
            },
            "kind": "string",
            "translatedValues": [
              {
                "kind": "string",
                "language": "string",
                "value": "string"
              }
            ]
          },
          "uri": "string"
        }
      }
    }
  ],
  "infoModuleData": {
    "labelValueRows": [
      {
        "columns": [
          {
            "label": "string",
            "localizedLabel": {
              "defaultValue": {
                "kind": "string",
                "language": "string",
                "value": "string"
              },
              "kind": "string",
              "translatedValues": [
                {
                  "kind": "string",
                  "language": "string",
                  "value": "string"
                }
              ]
            },
            "localizedValue": {
              "defaultValue": {
                "kind": "string",
                "language": "string",
                "value": "string"
              },
              "kind": "string",
              "translatedValues": [
                {
                  "kind": "string",
                  "language": "string",
                  "value": "string"
                }
              ]
            },
            "value": "string"
          }
        ]
      }
    ],
    "showLastUpdateTime": true
  },
  "issuerName": "string",
  "kind": "string",
  "linksModuleData": {
    "uris": [
      {
        "description": "string",
        "id": "string",
        "kind": "string",
        "localizedDescription": {
          "defaultValue": {
            "kind": "string",
            "language": "string",
            "value": "string"
          },
          "kind": "string",
          "translatedValues": [
            {
              "kind": "string",
              "language": "string",
              "value": "string"
            }
          ]
        },
        "uri": "string"
      }
    ]
  },
  "localizedIssuerName": {
    "defaultValue": {
      "kind": "string",
      "language": "string",
      "value": "string"
    },
    "kind": "string",
    "translatedValues": [
      {
        "kind": "string",
        "language": "string",
        "value": "string"
      }
    ]
  },
  "locations": [
    {
      "kind": "string",
      "latitude": 0,
      "longitude": 0
    }
  ],
  "logo": {
    "kind": "string",
    "sourceUri": {
      "description": "string",
      "localizedDescription": {
        "defaultValue": {
          "kind": "string",
          "language": "string",
          "value": "string"
        },
        "kind": "string",
        "translatedValues": [
          {
            "kind": "string",
            "language": "string",
            "value": "string"
          }
        ]
      },
      "uri": "string"
    }
  },
  "messages": [
    {
      "body": "string",
      "displayInterval": {
        "end": {
          "date": "string"
        },
        "kind": "string",
        "start": {
          "date": "string"
        }
      },
      "header": "string",
      "id": "string",
      "kind": "string",
      "localizedBody": {
        "defaultValue": {
          "kind": "string",
          "language": "string",
          "value": "string"
        },
        "kind": "string",
        "translatedValues": [
          {
            "kind": "string",
            "language": "string",
            "value": "string"
          }
        ]
      },
      "localizedHeader": {
        "defaultValue": {
          "kind": "string",
          "language": "string",
          "value": "string"
        },
        "kind": "string",
        "translatedValues": [
          {
            "kind": "string",
            "language": "string",
            "value": "string"
          }
        ]
      },
      "messageType": "MESSAGE_TYPE_UNSPECIFIED"
    }
  ],
  "multipleDevicesAndHoldersAllowedStatus": "STATUS_UNSPECIFIED",
  "redemptionIssuers": [
    "string"
  ],
  "review": {
    "comments": "string"
  },
  "reviewStatus": "REVIEW_STATUS_UNSPECIFIED",
  "rowLabel": "ROW_LABEL_UNSPECIFIED",
  "seatLabel": "SEAT_LABEL_UNSPECIFIED",
  "sectionLabel": "SECTION_LABEL_UNSPECIFIED",
  "securityAnimation": {
    "animationType": "ANIMATION_UNSPECIFIED"
  },
  "textModulesData": [
    {
      "body": "string",
      "header": "string",
      "id": "string",
      "localizedBody": {
        "defaultValue": {
          "kind": "string",
          "language": "string",
          "value": "string"
        },
        "kind": "string",
        "translatedValues": [
          {
            "kind": "string",
            "language": "string",
            "value": "string"
          }
        ]
      },
      "localizedHeader": {
        "defaultValue": {
          "kind": "string",
          "language": "string",
          "value": "string"
        },
        "kind": "string",
        "translatedValues": [
          {
            "kind": "string",
            "language": "string",
            "value": "string"
          }
        ]
      }
    }
  ],
  "venue": {
    "address": {
      "defaultValue": {
        "kind": "string",
        "language": "string",
        "value": "string"
      },
      "kind": "string",
      "translatedValues": [
        {
          "kind": "string",
          "language": "string",
          "value": "string"
        }
      ]
    },
    "kind": "string",
    "name": {
      "defaultValue": {
        "kind": "string",
        "language": "string",
        "value": "string"
      },
      "kind": "string",
      "translatedValues": [
        {
          "kind": "string",
          "language": "string",
          "value": "string"
        }
      ]
    }
  },
  "version": "string",
  "wordMark": {
    "kind": "string",
    "sourceUri": {
      "description": "string",
      "localizedDescription": {
        "defaultValue": {
          "kind": "string",
          "language": "string",
          "value": "string"
        },
        "kind": "string",
        "translatedValues": [
          {
            "kind": "string",
            "language": "string",
            "value": "string"
          }
        ]
      },
      "uri": "string"
    }
  }
}

Request

Path Params

resourceId

string

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

Responses

🟢200Successful response

application/json

Body

allowMultipleUsersPerObject

boolean

optional

Deprecated. Use multipleDevicesAndHoldersAllowedStatus instead.

callbackOptions

object (CallbackOptions)

optional

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.

updateRequestUrl

string

optional

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:Google-Valuables. Please contact Google support before using this field.

url

string

optional

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:Google-Valuables.

classTemplateInfo

object (ClassTemplateInfo)

optional

Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.

cardBarcodeSectionDetails

object (CardBarcodeSectionDetails)

optional

Specifies extra information to be displayed above and below the barcode.

cardTemplateOverride

object (CardTemplateOverride)

optional

Override for the card view.

detailsTemplateOverride

object (DetailsTemplateOverride)

optional

Override for the details view (beneath the card view).

listTemplateOverride

object (ListTemplateOverride)

optional

Override for the passes list view.

confirmationCodeLabel

enum<string>

optional

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.

Allowed values:

CONFIRMATION_CODE_LABEL_UNSPECIFIEDCONFIRMATION_CODEconfirmationCodeCONFIRMATION_NUMBERconfirmationNumberORDER_NUMBERorderNumberRESERVATION_NUMBERreservationNumber

countryCode

string

optional

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.

customConfirmationCodeLabel

object (LocalizedString)

optional

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.

defaultValue

object (TranslatedString)

optional

Contains the string to be displayed if no appropriate translation is available.

kind

string

optional

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

translatedValues

array[object (TranslatedString) {3}]

optional

Contains the translations for the string.

customGateLabel

object (LocalizedString)

optional

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.

customRowLabel

object (LocalizedString)

optional

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.

customSeatLabel

object (LocalizedString)

optional

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.

customSectionLabel

object (LocalizedString)

optional

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.

dateTime

object (EventDateTime)

optional

The date & time information of the event.

customDoorsOpenLabel

object (LocalizedString)

optional

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

string

optional

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

enum<string>

optional

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.

Allowed values:

DOORS_OPEN_LABEL_UNSPECIFIEDDOORS_OPENdoorsOpenGATES_OPENgatesOpen

end

string

optional

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

string

optional

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

start

string

optional

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.

enableSmartTap

boolean

optional

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

eventId

string

optional

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

eventName

object (LocalizedString)

optional

Required. The name of the event, such as "LA Dodgers at SF Giants".

finePrint

object (LocalizedString)

optional

The fine print, terms, or conditions of the ticket.

gateLabel

enum<string>

optional

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.

Allowed values:

GATE_LABEL_UNSPECIFIEDGATEgateDOORdoorENTRANCEentrance

heroImage

object (Image)

optional

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.

kind

string

optional

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

sourceUri

object (ImageUri)

optional

The URI for the image.

hexBackgroundColor

string

optional

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.

homepageUri

object (Uri)

optional

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

description

string

optional

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.

string

optional

The ID associated with a uri. This field is here to enable ease of management of uris.

kind

string

optional

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

localizedDescription

object (LocalizedString)

optional

Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.

uri

string

optional

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.

string

optional

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

imageModulesData

array[object (ImageModuleData) {2}]

optional

Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.

string

optional

The ID associated with an image module. This field is here to enable ease of management of image modules.

mainImage

object (Image)

optional

A 100% width image.

infoModuleData

object (InfoModuleData)

optional

Deprecated. Use textModulesData instead.

labelValueRows

array[object (LabelValueRow) {1}]

optional

A list of collections of labels and values. These will be displayed one after the other in a singular column.

showLastUpdateTime

boolean

optional

issuerName

string

optional

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

kind

string

optional

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

linksModuleData

object (LinksModuleData)

optional

Links module data. If links module data is also defined on the object, both will be displayed.

uris

array[object (Uri) {5}]

optional

The list of URIs.

localizedIssuerName

object (LocalizedString)

optional

Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.

locations

array[object (LatLongPoint) {3}]

optional

kind

string

optional

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

latitude

number <double>

optional

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

number <double>

optional

The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.

logo

object (Image)

optional

The logo image of the ticket. This image is displayed in the card detail view of the app.

messages

array[object (Message) {8}]

optional

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.

body

string

optional

The message body.

displayInterval

object (TimeInterval)

optional

The period of time that the message will be displayed to users. You can define both a startTime and endTime for each message. A message is displayed immediately after a Wallet Object is inserted unless a startTime is set. The message will appear in a list of messages indefinitely if endTime is not provided.

header

string

optional

The message header.

string

optional

The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.

kind

string

optional

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

localizedBody

object (LocalizedString)

optional

Translated strings for the message body.

localizedHeader

object (LocalizedString)

optional

Translated strings for the message header.

messageType

enum<string>

optional

The type of the message. Currently, this can only be set for offers.

Allowed values:

MESSAGE_TYPE_UNSPECIFIEDTEXTtextEXPIRATION_NOTIFICATIONexpirationNotification

multipleDevicesAndHoldersAllowedStatus

enum<string>

optional

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

Allowed values:

STATUS_UNSPECIFIEDMULTIPLE_HOLDERSmultipleHoldersONE_USER_ALL_DEVICESoneUserAllDevicesONE_USER_ONE_DEVICEoneUserOneDevice

redemptionIssuers

array[string <int64>]

optional

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

review

object (Review)

optional

The review comments set by the platform when a class is marked approved or rejected.

comments

string

optional

reviewStatus

enum<string>

optional

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.

Allowed values:

REVIEW_STATUS_UNSPECIFIEDUNDER_REVIEWunderReviewAPPROVEDapprovedREJECTEDrejectedDRAFTdraft

rowLabel

enum<string>

optional

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.

Allowed values:

ROW_LABEL_UNSPECIFIEDROWrow

seatLabel

enum<string>

optional

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.

Allowed values:

SEAT_LABEL_UNSPECIFIEDSEATseat

sectionLabel

enum<string>

optional

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.

Allowed values:

SECTION_LABEL_UNSPECIFIEDSECTIONsectionTHEATERtheater

securityAnimation

object (SecurityAnimation)

optional

Optional information about the security animation. If this is set a security animation will be rendered on pass details.

animationType

enum<string>

optional

Type for animation, FOIL_SHIMMER will be used if not provided.

Allowed values:

ANIMATION_UNSPECIFIEDFOIL_SHIMMERfoilShimmer

textModulesData

array[object (TextModuleData) {5}]

optional

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.

body

string

optional

The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.

header

string

optional

The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.

string

optional

The ID associated with a text module. This field is here to enable ease of management of text modules.

localizedBody

object (LocalizedString)

optional

Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.

localizedHeader

object (LocalizedString)

optional

Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.

venue

object (EventVenue)

optional

Event venue details.

address

object (LocalizedString)

optional

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

string

optional

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

name

object (LocalizedString)

optional

The name of the venue, such as "AT&T Park". This is required.

version

string <int64>

optional

Deprecated

wordMark

object (Image)

optional

Deprecated.

Modified at 2022-09-10 16:56:46

/walletobjects/v1/eventTicketClass

/walletobjects/v1/eventTicketClass/{resourceId}