Resource: EventTicketClass
JSON representation |
---|
{ "kind": string, "eventName": { object ( |
Fields | |
---|---|
kind |
Identifies what kind of resource this is. Value: the fixed string |
event |
Required. The name of the event, such as "LA Dodgers at SF Giants". |
event |
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 If not provided, the platform will attempt to use other data to group tickets (potentially unstable). |
logo |
The logo image of the ticket. This image is displayed in the card detail view of the app. |
venue |
Event venue details. |
date |
The date & time information of the event. |
confirmation |
The label to use for the confirmation code value ( Both |
custom |
A custom label to use for the confirmation code value ( Both |
seat |
The label to use for the seat value ( Both |
custom |
A custom label to use for the seat value ( Both |
row |
The label to use for the row value ( Both |
custom |
A custom label to use for the row value ( Both |
section |
The label to use for the section value ( Both |
custom |
A custom label to use for the section value ( Both |
gate |
The label to use for the gate value ( Both |
custom |
A custom label to use for the gate value ( Both |
fine |
The fine print, terms, or conditions of the ticket. |
class |
Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display. |
id |
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 '-'. |
version |
Deprecated |
issuer |
Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. |
messages[] |
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. |
allowMultipleUsersPerObject |
Deprecated. Use |
homepage |
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). |
locations[] |
Note: This field is currently not supported to trigger geo notifications. |
review |
Required. The status of the class. This field can be set to You should keep this field to You should set this field to When updating an already |
review |
The review comments set by the platform when a class is marked |
infoModuleData |
Deprecated. Use textModulesData instead. |
image |
Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level. |
text |
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. |
links |
Links module data. If links module data is also defined on the object, both will be displayed. |
redemption |
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 |
country |
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. |
hero |
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. |
wordMark |
Deprecated. |
enable |
Identifies whether this class supports Smart Tap. The |
hex |
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 |
localized |
Translated strings for the issuerName. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. |
multiple |
Identifies whether multiple users and devices will save the same object referencing this class. |
callback |
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. |
security |
Optional information about the security animation. If this is set a security animation will be rendered on pass details. |
view |
View Unlock Requirement options for the event ticket. |
wide |
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. |
notify |
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. |
app |
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. |
value |
Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object. |
EventVenue
JSON representation |
---|
{ "kind": string, "name": { object ( |
Fields | |
---|---|
kind |
Identifies what kind of resource this is. Value: the fixed string |
name |
The name of the venue, such as "AT&T Park". This is required. |
address |
The address of the venue, such as "24 Willie Mays Plaza\nSan Francisco, CA 94107". Address lines are separated by line feed ( This is required. |
EventDateTime
JSON representation |
---|
{ "kind": string, "doorsOpen": string, "start": string, "end": string, "doorsOpenLabel": enum ( |
Fields | |
---|---|
kind |
Identifies what kind of resource this is. Value: the fixed string |
doors |
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:
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 Without offset information, some rich features may not be available. |
start |
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:
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 Without offset information, some rich features may not be available. |
end |
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:
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 Without offset information, some rich features may not be available. |
doors |
The label to use for the doors open value ( Both |
custom |
A custom label to use for the doors open value ( Both |
DoorsOpenLabel
Enums | |
---|---|
DOORS_OPEN_LABEL_UNSPECIFIED |
|
DOORS_OPEN |
|
doorsOpen |
Legacy alias for |
GATES_OPEN |
|
gatesOpen |
Legacy alias for |
ConfirmationCodeLabel
Enums | |
---|---|
CONFIRMATION_CODE_LABEL_UNSPECIFIED |
|
CONFIRMATION_CODE |
|
confirmationCode |
Legacy alias for |
CONFIRMATION_NUMBER |
|
confirmationNumber |
Legacy alias for |
ORDER_NUMBER |
|
orderNumber |
Legacy alias for |
RESERVATION_NUMBER |
|
reservationNumber |
Legacy alias for |
SeatLabel
Enums | |
---|---|
SEAT_LABEL_UNSPECIFIED |
|
SEAT |
|
seat |
Legacy alias for |
RowLabel
Enums | |
---|---|
ROW_LABEL_UNSPECIFIED |
|
ROW |
|
row |
Legacy alias for |
SectionLabel
Enums | |
---|---|
SECTION_LABEL_UNSPECIFIED |
|
SECTION |
|
section |
Legacy alias for |
THEATER |
|
theater |
Legacy alias for |
GateLabel
Enums | |
---|---|
GATE_LABEL_UNSPECIFIED |
|
GATE |
|
gate |
Legacy alias for |
DOOR |
|
door |
Legacy alias for |
ENTRANCE |
|
entrance |
Legacy alias for |
Methods |
|
---|---|
|
Adds a message to the event ticket class referenced by the given class ID. |
|
Returns the event ticket class with the given class ID. |
|
Inserts an event ticket class with the given ID and properties. |
|
Returns a list of all event ticket classes for a given issuer ID. |
|
Updates the event ticket class referenced by the given class ID. |
|
Updates the event ticket class referenced by the given class ID. |