Eventticketclass

For a list of methods for this resource, see the end of this page.

Resource representations

{
  "kind": "walletobjects#eventTicketClass",
  "id": string,
  "version": long,
  "issuerName": string,
  "localizedIssuerName": {
    "kind": "walletobjects#localizedString",
    "translatedValues": [
      {
        "kind": "walletobjects#translatedString",
        "language": string,
        "value": string
      }
    ],
    "defaultValue": {
      "kind": "walletobjects#translatedString",
      "language": string,
      "value": string
    }
  },
  "messages": [
    {
      "kind": "walletobjects#walletObjectMessage",
      "header": string,
      "localizedHeader": {
        "kind": "walletobjects#localizedString",
        "translatedValues": [
          {
            "kind": "walletobjects#translatedString",
            "language": string,
            "value": string
          }
        ],
        "defaultValue": {
          "kind": "walletobjects#translatedString",
          "language": string,
          "value": string
        }
      },
      "body": string,
      "localizedBody": {
        "kind": "walletobjects#localizedString",
        "translatedValues": [
          {
            "kind": "walletobjects#translatedString",
            "language": string,
            "value": string
          }
        ],
        "defaultValue": {
          "kind": "walletobjects#translatedString",
          "language": string,
          "value": string
        }
      },
      "displayInterval": {
        "kind": "walletobjects#timeInterval",
        "start": {
          "date": string
        },
        "end": {
          "date": string
        }
      },
      "id": string,
      "messageType": string
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    "kind": "walletobjects#uri",
    "uri": string,
    "description": string,
    "localizedDescription": {
      "kind": "walletobjects#localizedString",
      "translatedValues": [
        {
          "kind": "walletobjects#translatedString",
          "language": string,
          "value": string
        }
      ],
      "defaultValue": {
        "kind": "walletobjects#translatedString",
        "language": string,
        "value": string
      }
    },
    "id": string
  },
  "locations": [
    {
      "kind": "walletobjects#latLongPoint",
      "latitude": double,
      "longitude": double
    }
  ],
  "reviewStatus": string,
  "review": {
    "comments": string
  },
  "infoModuleData": {
    "labelValueRows": [
      {
        "columns": [
          {
            "label": string,
            "localizedLabel": {
              "kind": "walletobjects#localizedString",
              "translatedValues": [
                {
                  "kind": "walletobjects#translatedString",
                  "language": string,
                  "value": string
                }
              ],
              "defaultValue": {
                "kind": "walletobjects#translatedString",
                "language": string,
                "value": string
              }
            },
            "value": string,
            "localizedValue": {
              "kind": "walletobjects#localizedString",
              "translatedValues": [
                {
                  "kind": "walletobjects#translatedString",
                  "language": string,
                  "value": string
                }
              ],
              "defaultValue": {
                "kind": "walletobjects#translatedString",
                "language": string,
                "value": string
              }
            }
          }
        ]
      }
    ],
    "showLastUpdateTime": boolean
  },
  "imageModulesData": [
    {
      "mainImage": {
        "kind": "walletobjects#image",
        "sourceUri": {
          "kind": "walletobjects#uri",
          "uri": string,
          "description": string,
          "localizedDescription": {
            "kind": "walletobjects#localizedString",
            "translatedValues": [
              {
                "kind": "walletobjects#translatedString",
                "language": string,
                "value": string
              }
            ],
            "defaultValue": {
              "kind": "walletobjects#translatedString",
              "language": string,
              "value": string
            }
          },
          "id": string
        }
      },
      "id": string
    }
  ],
  "textModulesData": [
    {
      "header": string,
      "body": string,
      "localizedHeader": {
        "kind": "walletobjects#localizedString",
        "translatedValues": [
          {
            "kind": "walletobjects#translatedString",
            "language": string,
            "value": string
          }
        ],
        "defaultValue": {
          "kind": "walletobjects#translatedString",
          "language": string,
          "value": string
        }
      },
      "localizedBody": {
        "kind": "walletobjects#localizedString",
        "translatedValues": [
          {
            "kind": "walletobjects#translatedString",
            "language": string,
            "value": string
          }
        ],
        "defaultValue": {
          "kind": "walletobjects#translatedString",
          "language": string,
          "value": string
        }
      },
      "id": string
    }
  ],
  "linksModuleData": {
    "uris": [
      {
        "kind": "walletobjects#uri",
        "uri": string,
        "description": string,
        "localizedDescription": {
          "kind": "walletobjects#localizedString",
          "translatedValues": [
            {
              "kind": "walletobjects#translatedString",
              "language": string,
              "value": string
            }
          ],
          "defaultValue": {
            "kind": "walletobjects#translatedString",
            "language": string,
            "value": string
          }
        },
        "id": string
      }
    ]
  },
  "redemptionIssuers": [
    long
  ],
  "countryCode": string,
  "heroImage": {
    "kind": "walletobjects#image",
    "sourceUri": {
      "kind": "walletobjects#uri",
      "uri": string,
      "description": string,
      "localizedDescription": {
        "kind": "walletobjects#localizedString",
        "translatedValues": [
          {
            "kind": "walletobjects#translatedString",
            "language": string,
            "value": string
          }
        ],
        "defaultValue": {
          "kind": "walletobjects#translatedString",
          "language": string,
          "value": string
        }
      },
      "id": string
    }
  },
  "wordMark": {
    "kind": "walletobjects#image",
    "sourceUri": {
      "kind": "walletobjects#uri",
      "uri": string,
      "description": string,
      "localizedDescription": {
        "kind": "walletobjects#localizedString",
        "translatedValues": [
          {
            "kind": "walletobjects#translatedString",
            "language": string,
            "value": string
          }
        ],
        "defaultValue": {
          "kind": "walletobjects#translatedString",
          "language": string,
          "value": string
        }
      },
      "id": string
    }
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "multipleDevicesAndHoldersAllowedStatus": string,
  "callbackOptions": {
    "url": string
  },
  "eventName": {
    "kind": "walletobjects#localizedString",
    "translatedValues": [
      {
        "kind": "walletobjects#translatedString",
        "language": string,
        "value": string
      }
    ],
    "defaultValue": {
      "kind": "walletobjects#translatedString",
      "language": string,
      "value": string
    }
  },
  "eventId": string,
  "logo": {
    "kind": "walletobjects#image",
    "sourceUri": {
      "kind": "walletobjects#uri",
      "uri": string,
      "description": string,
      "localizedDescription": {
        "kind": "walletobjects#localizedString",
        "translatedValues": [
          {
            "kind": "walletobjects#translatedString",
            "language": string,
            "value": string
          }
        ],
        "defaultValue": {
          "kind": "walletobjects#translatedString",
          "language": string,
          "value": string
        }
      },
      "id": string
    }
  },
  "venue": {
    "kind": "walletobjects#eventVenue",
    "name": {
      "kind": "walletobjects#localizedString",
      "translatedValues": [
        {
          "kind": "walletobjects#translatedString",
          "language": string,
          "value": string
        }
      ],
      "defaultValue": {
        "kind": "walletobjects#translatedString",
        "language": string,
        "value": string
      }
    },
    "address": {
      "kind": "walletobjects#localizedString",
      "translatedValues": [
        {
          "kind": "walletobjects#translatedString",
          "language": string,
          "value": string
        }
      ],
      "defaultValue": {
        "kind": "walletobjects#translatedString",
        "language": string,
        "value": string
      }
    }
  },
  "dateTime": {
    "kind": "walletobjects#eventDateTime",
    "doorsOpenLabel": string,
    "customDoorsOpenLabel": {
      "kind": "walletobjects#localizedString",
      "translatedValues": [
        {
          "kind": "walletobjects#translatedString",
          "language": string,
          "value": string
        }
      ],
      "defaultValue": {
        "kind": "walletobjects#translatedString",
        "language": string,
        "value": string
      }
    },
    "doorsOpen": string,
    "start": string,
    "end": string
  },
  "finePrint": {
    "kind": "walletobjects#localizedString",
    "translatedValues": [
      {
        "kind": "walletobjects#translatedString",
        "language": string,
        "value": string
      }
    ],
    "defaultValue": {
      "kind": "walletobjects#translatedString",
      "language": string,
      "value": string
    }
  },
  "confirmationCodeLabel": string,
  "customConfirmationCodeLabel": {
    "kind": "walletobjects#localizedString",
    "translatedValues": [
      {
        "kind": "walletobjects#translatedString",
        "language": string,
        "value": string
      }
    ],
    "defaultValue": {
      "kind": "walletobjects#translatedString",
      "language": string,
      "value": string
    }
  },
  "seatLabel": string,
  "customSeatLabel": {
    "kind": "walletobjects#localizedString",
    "translatedValues": [
      {
        "kind": "walletobjects#translatedString",
        "language": string,
        "value": string
      }
    ],
    "defaultValue": {
      "kind": "walletobjects#translatedString",
      "language": string,
      "value": string
    }
  },
  "rowLabel": string,
  "customRowLabel": {
    "kind": "walletobjects#localizedString",
    "translatedValues": [
      {
        "kind": "walletobjects#translatedString",
        "language": string,
        "value": string
      }
    ],
    "defaultValue": {
      "kind": "walletobjects#translatedString",
      "language": string,
      "value": string
    }
  },
  "sectionLabel": string,
  "customSectionLabel": {
    "kind": "walletobjects#localizedString",
    "translatedValues": [
      {
        "kind": "walletobjects#translatedString",
        "language": string,
        "value": string
      }
    ],
    "defaultValue": {
      "kind": "walletobjects#translatedString",
      "language": string,
      "value": string
    }
  },
  "gateLabel": string,
  "customGateLabel": {
    "kind": "walletobjects#localizedString",
    "translatedValues": [
      {
        "kind": "walletobjects#translatedString",
        "language": string,
        "value": string
      }
    ],
    "defaultValue": {
      "kind": "walletobjects#translatedString",
      "language": string,
      "value": string
    }
  }
}
Property name Value Description Notes
allowMultipleUsersPerObject boolean Deprecated. Use multipleDevicesAndHoldersAllowedStatus instead. writable
callbackOptions nested object 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. writable
callbackOptions.url string URL for the merchant endpoint that would be called for all user saves and deletes. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Google-Valuables. writable
confirmationCodeLabel string 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.

Acceptable values are:
  • "confirmationCode"
  • "confirmationNumber"
  • "orderNumber"
  • "reservationNumber"
writable
countryCode string 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. writable
customConfirmationCodeLabel nested object 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.
writable
customConfirmationCodeLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
customConfirmationCodeLabel.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
customConfirmationCodeLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customConfirmationCodeLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customConfirmationCodeLabel.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
customConfirmationCodeLabel.translatedValues[] list Contains the translations for the string. writable
customConfirmationCodeLabel.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
customConfirmationCodeLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customConfirmationCodeLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customGateLabel nested object 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.
writable
customGateLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
customGateLabel.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
customGateLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customGateLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customGateLabel.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
customGateLabel.translatedValues[] list Contains the translations for the string. writable
customGateLabel.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
customGateLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customGateLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customRowLabel nested object 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.
writable
customRowLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
customRowLabel.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
customRowLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customRowLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customRowLabel.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
customRowLabel.translatedValues[] list Contains the translations for the string. writable
customRowLabel.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
customRowLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customRowLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customSeatLabel nested object 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.
writable
customSeatLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
customSeatLabel.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
customSeatLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customSeatLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customSeatLabel.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
customSeatLabel.translatedValues[] list Contains the translations for the string. writable
customSeatLabel.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
customSeatLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customSeatLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customSectionLabel nested object 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.
writable
customSectionLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
customSectionLabel.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
customSectionLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customSectionLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
customSectionLabel.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
customSectionLabel.translatedValues[] list Contains the translations for the string. writable
customSectionLabel.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
customSectionLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
customSectionLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
dateTime nested object The date & time information of the event. writable
dateTime.customDoorsOpenLabel nested object 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.
writable
dateTime.customDoorsOpenLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
dateTime.customDoorsOpenLabel.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
dateTime.customDoorsOpenLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
dateTime.customDoorsOpenLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
dateTime.customDoorsOpenLabel.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
dateTime.customDoorsOpenLabel.translatedValues[] list Contains the translations for the string. writable
dateTime.customDoorsOpenLabel.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
dateTime.customDoorsOpenLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
dateTime.customDoorsOpenLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
dateTime.doorsOpen string 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.
writable
dateTime.doorsOpenLabel string 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.

Acceptable values are:
  • "doorsOpen"
  • "gatesOpen"
writable
dateTime.end string The date/time when the event ends. 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.
writable
dateTime.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#eventDateTime".
dateTime.start string 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.
writable
enableSmartTap boolean Available only to Smart Tap enabled partners. Contact support for additional guidance. writable
eventId string 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).
writable
eventName nested object The name of the event, such as "LA Dodgers at SF Giants". writable
eventName.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
eventName.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
eventName.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
eventName.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
eventName.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
eventName.translatedValues[] list Contains the translations for the string. writable
eventName.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
eventName.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
eventName.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
finePrint nested object The fine print, terms, or conditions of the ticket. writable
finePrint.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
finePrint.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
finePrint.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
finePrint.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
finePrint.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
finePrint.translatedValues[] list Contains the translations for the string. writable
finePrint.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
finePrint.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
finePrint.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
gateLabel string 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.

Acceptable values are:
  • "door"
  • "entrance"
  • "gate"
writable
heroImage nested object 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. writable
heroImage.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#image".
heroImage.sourceUri nested object The URI for the image. writable
heroImage.sourceUri.description string 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.
writable
heroImage.sourceUri.id string The ID associated with a uri. This field is here to enable ease of management of uris. writable
heroImage.sourceUri.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#uri".
heroImage.sourceUri.localizedDescription nested object Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. writable
heroImage.sourceUri.localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
heroImage.sourceUri.localizedDescription.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
heroImage.sourceUri.localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
heroImage.sourceUri.localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
heroImage.sourceUri.localizedDescription.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
heroImage.sourceUri.localizedDescription.translatedValues[] list Contains the translations for the string. writable
heroImage.sourceUri.localizedDescription.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
heroImage.sourceUri.localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
heroImage.sourceUri.localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
heroImage.sourceUri.uri string 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. writable
hexBackgroundColor string 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. writable
homepageUri nested object 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). writable
homepageUri.description string 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.
writable
homepageUri.id string The ID associated with a uri. This field is here to enable ease of management of uris. writable
homepageUri.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#uri".
homepageUri.localizedDescription nested object Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. writable
homepageUri.localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
homepageUri.localizedDescription.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
homepageUri.localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
homepageUri.localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
homepageUri.localizedDescription.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
homepageUri.localizedDescription.translatedValues[] list Contains the translations for the string. writable
homepageUri.localizedDescription.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
homepageUri.localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
homepageUri.localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
homepageUri.uri string 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. writable
id string 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[] list Image module data. If image modules data is also defined on the object, those will be merged with the image data defined on the class. The maximum number of these fields (combined with the object) is 1. writable
imageModulesData[].id string The ID associated with an image module. This field is here to enable ease of management of image modules.
imageModulesData[].mainImage nested object A 100% width image. writable
imageModulesData[].mainImage.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#image".
imageModulesData[].mainImage.sourceUri nested object The URI for the image. writable
imageModulesData[].mainImage.sourceUri.description string 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.
writable
imageModulesData[].mainImage.sourceUri.id string The ID associated with a uri. This field is here to enable ease of management of uris. writable
imageModulesData[].mainImage.sourceUri.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#uri".
imageModulesData[].mainImage.sourceUri.localizedDescription nested object Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. writable
imageModulesData[].mainImage.sourceUri.localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
imageModulesData[].mainImage.sourceUri.localizedDescription.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
imageModulesData[].mainImage.sourceUri.localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
imageModulesData[].mainImage.sourceUri.localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
imageModulesData[].mainImage.sourceUri.localizedDescription.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
imageModulesData[].mainImage.sourceUri.localizedDescription.translatedValues[] list Contains the translations for the string. writable
imageModulesData[].mainImage.sourceUri.localizedDescription.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
imageModulesData[].mainImage.sourceUri.localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
imageModulesData[].mainImage.sourceUri.localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
imageModulesData[].mainImage.sourceUri.uri string 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. writable
infoModuleData nested object Deprecated. Use textModulesData instead. writable
infoModuleData.labelValueRows[] list A list of collections of labels and values. These will be displayed one after the other in a singular column. writable
infoModuleData.labelValueRows[].columns[] list 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. writable
infoModuleData.labelValueRows[].columns[].label string The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout. writable
infoModuleData.labelValueRows[].columns[].localizedLabel nested object Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.

writable
infoModuleData.labelValueRows[].columns[].localizedLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
infoModuleData.labelValueRows[].columns[].localizedLabel.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
infoModuleData.labelValueRows[].columns[].localizedLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedLabel.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
infoModuleData.labelValueRows[].columns[].localizedLabel.translatedValues[] list Contains the translations for the string. writable
infoModuleData.labelValueRows[].columns[].localizedLabel.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
infoModuleData.labelValueRows[].columns[].localizedLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedValue nested object Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout. writable
infoModuleData.labelValueRows[].columns[].localizedValue.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
infoModuleData.labelValueRows[].columns[].localizedValue.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
infoModuleData.labelValueRows[].columns[].localizedValue.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedValue.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
infoModuleData.labelValueRows[].columns[].localizedValue.translatedValues[] list Contains the translations for the string. writable
infoModuleData.labelValueRows[].columns[].localizedValue.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
infoModuleData.labelValueRows[].columns[].localizedValue.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedValue.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].value string The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout. writable
infoModuleData.showLastUpdateTime boolean Deprecated writable
issuerName string The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. writable
kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#eventTicketClass".
linksModuleData nested object Links module data. If links module data is also defined on the object, both will be displayed. The maximum number of these fields (combined with the object) is 10. writable
linksModuleData.uris[] list The list of URIs. writable
linksModuleData.uris[].description string 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.
writable
linksModuleData.uris[].id string The ID associated with a uri. This field is here to enable ease of management of uris. writable
linksModuleData.uris[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#uri".
linksModuleData.uris[].localizedDescription nested object Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. writable
linksModuleData.uris[].localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
linksModuleData.uris[].localizedDescription.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
linksModuleData.uris[].localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
linksModuleData.uris[].localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
linksModuleData.uris[].localizedDescription.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
linksModuleData.uris[].localizedDescription.translatedValues[] list Contains the translations for the string. writable
linksModuleData.uris[].localizedDescription.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
linksModuleData.uris[].localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
linksModuleData.uris[].localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
linksModuleData.uris[].uri string 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. writable
localizedIssuerName nested object Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. writable
localizedIssuerName.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
localizedIssuerName.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
localizedIssuerName.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
localizedIssuerName.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
localizedIssuerName.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
localizedIssuerName.translatedValues[] list Contains the translations for the string. writable
localizedIssuerName.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
localizedIssuerName.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
localizedIssuerName.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
locations[] list 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.

This is only supported by the gift cards, loyalty, and offers verticals.
writable
locations[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#latLongPoint".
locations[].latitude double The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected. writable
locations[].longitude double The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected. writable
logo.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#image".
logo.sourceUri nested object The URI for the image. writable
logo.sourceUri.description string 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.
writable
logo.sourceUri.id string The ID associated with a uri. This field is here to enable ease of management of uris. writable
logo.sourceUri.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#uri".
logo.sourceUri.localizedDescription nested object Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. writable
logo.sourceUri.localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
logo.sourceUri.localizedDescription.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
logo.sourceUri.localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
logo.sourceUri.localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
logo.sourceUri.localizedDescription.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
logo.sourceUri.localizedDescription.translatedValues[] list Contains the translations for the string. writable
logo.sourceUri.localizedDescription.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
logo.sourceUri.localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
logo.sourceUri.localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
logo.sourceUri.uri string 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. writable
messages[] list 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. writable
messages[].body string The message body. writable
messages[].displayInterval nested object 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. writable
messages[].displayInterval.end nested object 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.
writable
messages[].displayInterval.end.date string 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.
writable
messages[].displayInterval.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#timeInterval".
messages[].displayInterval.start nested object 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.
writable
messages[].displayInterval.start.date string 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.
writable
messages[].header string The message header. writable
messages[].id string 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. writable
messages[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#walletObjectMessage".
messages[].localizedBody nested object Translated strings for the message body. writable
messages[].localizedBody.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
messages[].localizedBody.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
messages[].localizedBody.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedBody.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedBody.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
messages[].localizedBody.translatedValues[] list Contains the translations for the string. writable
messages[].localizedBody.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
messages[].localizedBody.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedBody.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedHeader nested object Translated strings for the message header. writable
messages[].localizedHeader.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
messages[].localizedHeader.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
messages[].localizedHeader.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedHeader.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedHeader.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
messages[].localizedHeader.translatedValues[] list Contains the translations for the string. writable
messages[].localizedHeader.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
messages[].localizedHeader.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedHeader.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].messageType string The type of the message. Currently, this can only be set for offers.

Acceptable values are:
  • "expirationNotification": Notification to display for an offer expiration. The displayInterval.start.date sets the time the notification will appear. It can be set up to 30 days prior to the expiration date. If a time span greater than this is specified, then the notification will trigger at the 30 day mark.
  • "text": Renders the message as text on the card details screen. This is the default message type.
writable
multipleDevicesAndHoldersAllowedStatus string Identifies whether multiple users and devices will save the same object referencing this class.

Acceptable values are:
  • "multipleHolders": Multiple users on multiple devices are allowed.
  • "oneUserAllDevices": One user on multiple devices is allowed.
  • "oneUserOneDevice": Intended for use by select partners in limited circumstances. Contact support for additional information.
writable
redemptionIssuers[] list Available only to Smart Tap enabled partners. Contact support for additional guidance. writable
review nested object The review comments set by the platform when a class is marked approved or rejected.
review.comments string The explanation of why the class was marked approved or rejected.
reviewStatus string 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.

Acceptable values are:
  • "approved"
  • "draft"
  • "rejected"
  • "underReview"
writable
rowLabel string 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.

Acceptable values are:
  • "row"
writable
seatLabel string 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.

Acceptable values are:
  • "seat"
writable
sectionLabel string 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.

Acceptable values are:
  • "section"
  • "theater"
writable
textModulesData[] list Text module data. If text modules data is also defined on the object, both will be displayed. The maximum number of these fields (combined with the object) is 10. writable
textModulesData[].body string 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. writable
textModulesData[].header string The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens. writable
textModulesData[].id string The ID associated with a text module. This field is here to enable ease of management of text modules.
textModulesData[].localizedBody nested object Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens. writable
textModulesData[].localizedBody.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
textModulesData[].localizedBody.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
textModulesData[].localizedBody.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedBody.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedBody.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
textModulesData[].localizedBody.translatedValues[] list Contains the translations for the string. writable
textModulesData[].localizedBody.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
textModulesData[].localizedBody.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedBody.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedHeader nested object Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens. writable
textModulesData[].localizedHeader.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
textModulesData[].localizedHeader.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
textModulesData[].localizedHeader.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedHeader.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedHeader.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
textModulesData[].localizedHeader.translatedValues[] list Contains the translations for the string. writable
textModulesData[].localizedHeader.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
textModulesData[].localizedHeader.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedHeader.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
venue nested object Event venue details. writable
venue.address nested object 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.
writable
venue.address.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
venue.address.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
venue.address.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
venue.address.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
venue.address.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
venue.address.translatedValues[] list Contains the translations for the string. writable
venue.address.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
venue.address.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
venue.address.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
venue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#eventVenue".
venue.name nested object The name of the venue, such as "AT&T Park".

This is required.
writable
venue.name.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
venue.name.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
venue.name.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
venue.name.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
venue.name.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
venue.name.translatedValues[] list Contains the translations for the string. writable
venue.name.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
venue.name.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
venue.name.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
version long Deprecated.
wordMark nested object Deprecated.
wordMark.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#image".
wordMark.sourceUri nested object The URI for the image. writable
wordMark.sourceUri.description string 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.
writable
wordMark.sourceUri.id string The ID associated with a uri. This field is here to enable ease of management of uris. writable
wordMark.sourceUri.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#uri".
wordMark.sourceUri.localizedDescription nested object Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. writable
wordMark.sourceUri.localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
wordMark.sourceUri.localizedDescription.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
wordMark.sourceUri.localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
wordMark.sourceUri.localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
wordMark.sourceUri.localizedDescription.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
wordMark.sourceUri.localizedDescription.translatedValues[] list Contains the translations for the string. writable
wordMark.sourceUri.localizedDescription.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
wordMark.sourceUri.localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
wordMark.sourceUri.localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
wordMark.sourceUri.uri string 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. writable

Methods

addmessage
Adds a message to the event ticket class referenced by the given class ID.
get
Returns the event ticket class with the given class ID.
insert
Inserts an event ticket class with the given ID and properties.
list
Returns a list of all event ticket classes for a given issuer ID.
patch
Updates the event ticket class referenced by the given class ID. This method supports patch semantics.
update
Updates the event ticket class referenced by the given class ID.

Envoyer des commentaires concernant…

Google Pay for Passes