- Resource: TransitObject
- PassengerType
- TicketStatus
- ConcessionCategory
- TicketRestrictions
- PurchaseDetails
- TicketCost
- TicketLeg
- TicketSeat
- FareClass
- TripType
- ActivationStatus
- State
- DeviceContext
- Methods
Resource: TransitObject
JSON representation |
---|
{ "classReference": { object ( |
Fields | |
---|---|
classReference |
A copy of the inherited fields of the parent class. These fields are retrieved during a GET. |
ticketNumber |
The number of the ticket. This is a unique identifier for the ticket in the transit operator's system. |
passengerType |
The number of passengers. |
passengerNames |
The name(s) of the passengers the ticket is assigned to. The above |
tripId |
This id is used to group tickets together if the user has saved multiple tickets for the same trip. |
ticketStatus |
The status of the ticket. For states which affect display, use the |
customTicketStatus |
A custom status to use for the ticket status value when |
concessionCategory |
The concession category for the ticket. |
customConcessionCategory |
A custom concession category to use when |
ticketRestrictions |
Information about what kind of restrictions there are on using this ticket. For example, which days of the week it must be used, or which routes are allowed to be taken. |
purchaseDetails |
Purchase details for this ticket. |
ticketLeg |
A single ticket leg contains departure and arrival information along with boarding and seating information. If more than one leg is to be specified then use the |
ticketLegs[] |
Each ticket may contain one or more legs. Each leg contains departure and arrival information along with boarding and seating information. If only one leg is to be specified then use the |
hexBackgroundColor |
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 |
tripType |
Required. The type of trip this transit object represents. Used to determine the pass title and/or which symbol to use between the origin and destination. |
id |
Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'. |
classId |
Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. |
version |
Deprecated |
state |
Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an |
barcode |
The barcode type and value. |
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. |
validTimeInterval |
The time period this object will be |
locations[] |
Note: This field is currently not supported to trigger geo notifications. |
hasUsers |
Indicates if the object has users. This field is set by the platform. |
smartTapRedemptionValue |
The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields |
hasLinkedDevice |
Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information. |
disableExpirationNotification |
Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the Currently, this can only be set for offers. |
infoModuleData |
Deprecated. Use textModulesData instead. |
imageModulesData[] |
Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level. |
textModulesData[] |
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. |
linksModuleData |
Links module data. If links module data is also defined on the class, both will be displayed. |
appLinkData |
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 class only object AppLinkData will be displayed. |
activationStatus |
The activation status for the object. Required if the class has |
rotatingBarcode |
The rotating barcode type and value. |
deviceContext |
Device context associated with the object. |
heroImage |
Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed. |
groupingInfo |
Information that controls how passes are grouped together. |
passConstraints |
Pass constraints for the object. Includes limiting NFC and screenshot behaviors. |
saveRestrictions |
Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. |
PassengerType
Enums | |
---|---|
PASSENGER_TYPE_UNSPECIFIED |
|
SINGLE_PASSENGER |
|
singlePassenger |
Legacy alias for |
MULTIPLE_PASSENGERS |
|
multiplePassengers |
Legacy alias for |
TicketStatus
Enums | |
---|---|
TICKET_STATUS_UNSPECIFIED |
|
USED |
|
used |
Legacy alias for |
REFUNDED |
|
refunded |
Legacy alias for |
EXCHANGED |
|
exchanged |
Legacy alias for |
ConcessionCategory
Enums | |
---|---|
CONCESSION_CATEGORY_UNSPECIFIED |
|
ADULT |
|
adult |
Legacy alias for |
CHILD |
|
child |
Legacy alias for |
SENIOR |
|
senior |
Legacy alias for |
TicketRestrictions
JSON representation |
---|
{ "routeRestrictions": { object ( |
Fields | |
---|---|
routeRestrictions |
Restrictions about routes that may be taken. For example, this may be the string "Reserved CrossCountry trains only". |
routeRestrictionsDetails |
More details about the above |
timeRestrictions |
Restrictions about times this ticket may be used. |
otherRestrictions |
Extra restrictions that don't fall under the "route" or "time" categories. |
PurchaseDetails
JSON representation |
---|
{
"purchaseReceiptNumber": string,
"purchaseDateTime": string,
"accountId": string,
"confirmationCode": string,
"ticketCost": {
object ( |
Fields | |
---|---|
purchaseReceiptNumber |
Receipt number/identifier for tracking the ticket purchase via the body that sold the ticket. |
purchaseDateTime |
The purchase date/time of the ticket. 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:
Without offset information, some rich features may not be available. |
accountId |
ID of the account used to purchase the ticket. |
confirmationCode |
The confirmation code for the purchase. This may be the same for multiple different tickets and is used to group tickets together. |
ticketCost |
The cost of the ticket. |
TicketCost
JSON representation |
---|
{ "faceValue": { object ( |
Fields | |
---|---|
faceValue |
The face value of the ticket. |
purchasePrice |
The actual purchase price of the ticket, after tax and/or discounts. |
discountMessage |
A message describing any kind of discount that was applied. |
TicketLeg
JSON representation |
---|
{ "originStationCode": string, "originName": { object ( |
Fields | |
---|---|
originStationCode |
The origin station code. This is required if |
originName |
The name of the origin station. This is required if |
destinationStationCode |
The destination station code. |
destinationName |
The destination name. |
departureDateTime |
The date/time of departure. This is required if there is no validity time interval set on the transit object. 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 origin station. For example, if the departure occurs at the 20th hour of June 5th, 2018 at the origin station, the local date/time portion should be Without offset information, some rich features may not be available. |
arrivalDateTime |
The date/time of arrival. 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 destination station. For example, if the event occurs at the 20th hour of June 5th, 2018 at the destination station, the local date/time portion should be Without offset information, some rich features may not be available. |
fareName |
Short description/name of the fare for this leg of travel. Eg "Anytime Single Use". |
carriage |
The train or ship name/number that the passsenger needs to board. |
platform |
The platform or gate where the passenger can board the carriage. |
zone |
The zone of boarding within the platform. |
ticketSeat |
The reserved seat for the passenger(s). If more than one seat is to be specified then use the |
ticketSeats[] |
The reserved seat for the passenger(s). If only one seat is to be specified then use the |
transitOperatorName |
The name of the transit operator that is operating this leg of a trip. |
transitTerminusName |
Terminus station or destination of the train/bus/etc. |
TicketSeat
JSON representation |
---|
{ "fareClass": enum ( |
Fields | |
---|---|
fareClass |
The fare class of the ticketed seat. |
customFareClass |
A custome fare class to be used if no |
coach |
The identifier of the train car or coach in which the ticketed seat is located. Eg. "10" |
seat |
The identifier of where the ticketed seat is located. Eg. "42". If there is no specific identifier, use |
seatAssignment |
The passenger's seat assignment. Eg. "no specific seat". To be used when there is no specific identifier to use in |
FareClass
Enums | |
---|---|
FARE_CLASS_UNSPECIFIED |
|
ECONOMY |
|
economy |
Legacy alias for |
FIRST |
|
first |
Legacy alias for |
BUSINESS |
|
business |
Legacy alias for |
TripType
Enums | |
---|---|
TRIP_TYPE_UNSPECIFIED |
|
ROUND_TRIP |
|
roundTrip |
Legacy alias for |
ONE_WAY |
|
oneWay |
Legacy alias for |
ActivationStatus
The activation status of the object. This field includes activation status if valuable supports activation.
JSON representation |
---|
{
"state": enum ( |
Fields | |
---|---|
state |
|
State
Enums | |
---|---|
UNKNOWN_STATE |
|
NOT_ACTIVATED |
Not-Activated, this is the default status |
not_activated |
Legacy alias for |
ACTIVATED |
Activated |
activated |
Legacy alias for |
DeviceContext
Device context associated with the object.
JSON representation |
---|
{ "deviceToken": string } |
Fields | |
---|---|
deviceToken |
If set, redemption information will only be returned to the given device upon activation of the object. This should not be used as a stable identifier to trace a user's device. It can change across different passes for the same device or even across different activations for the same device. When setting this, callers must also set hasLinkedDevice on the object being activated. |
Methods |
|
---|---|
|
Adds a message to the transit object referenced by the given object ID. |
|
Returns the transit object with the given object ID. |
|
Inserts an transit object with the given ID and properties. |
|
Returns a list of all transit objects for a given issuer ID. |
|
Updates the transit object referenced by the given object ID. |
|
Updates the transit object referenced by the given object ID. |