Index
TransitClassService
(interface)TransitObjectService
(interface)PurchaseDetails
(message)TicketCost
(message)TicketLeg
(message)TicketRestrictions
(message)TicketSeat
(message)TicketSeat.FareClass
(enum)TransitClass
(message)TransitClass.TransitType
(enum)TransitClassAddMessageRequest
(message)TransitClassAddMessageResponse
(message)TransitClassGetRequest
(message)TransitClassInsertRequest
(message)TransitClassListRequest
(message)TransitClassListResponse
(message)TransitClassPatchRequest
(message)TransitClassUpdateRequest
(message)TransitObject
(message)TransitObject.ConcessionCategory
(enum)TransitObject.PassengerType
(enum)TransitObject.TicketStatus
(enum)TransitObject.TripType
(enum)TransitObjectAddMessageRequest
(message)TransitObjectAddMessageResponse
(message)TransitObjectDownloadRotatingBarcodeValuesRequest
(message)TransitObjectDownloadRotatingBarcodeValuesResponse
(message)TransitObjectGetRequest
(message)TransitObjectInsertRequest
(message)TransitObjectListRequest
(message)TransitObjectListResponse
(message)TransitObjectPatchRequest
(message)TransitObjectUpdateRequest
(message)TransitObjectUploadRotatingBarcodeValuesRequest
(message)TransitObjectUploadRotatingBarcodeValuesResponse
(message)
TransitClassService
AddMessage |
---|
Adds a message to the transit class referenced by the given class ID.
|
Get |
---|
Returns the transit class with the given class ID.
|
Insert |
---|
Inserts a transit class with the given ID and properties.
|
List |
---|
Returns a list of all transit classes for a given issuer ID.
|
Patch |
---|
Updates the transit class referenced by the given class ID. This method supports patch semantics.
|
Update |
---|
Updates the transit class referenced by the given class ID.
|
TransitObjectService
AddMessage |
---|
Adds a message to the transit object referenced by the given object ID.
|
DownloadRotatingBarcodeValues |
---|
Downloads rotating barcode values for the transit object referenced by the given object ID.
|
Get |
---|
Returns the transit object with the given object ID.
|
Insert |
---|
Inserts an transit object with the given ID and properties.
|
List |
---|
Returns a list of all transit objects for a given issuer ID.
|
Patch |
---|
Updates the transit object referenced by the given object ID. This method supports patch semantics.
|
Update |
---|
Updates the transit object referenced by the given object ID.
|
UploadRotatingBarcodeValues |
---|
Uploads rotating barcode values for the transit object referenced by the given object ID. Note the max upload size is specified in google3/production/config/cdd/apps-upload/customers/payments-consumer-passes/config.gcl and enforced by Scotty.
|
PurchaseDetails
Fields | |
---|---|
purchase_receipt_number |
Receipt number/identifier for tracking the ticket purchase via the body that sold the ticket. |
purchase_date_time |
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. |
account_id |
ID of the account used to purchase the ticket. |
confirmation_code |
The confirmation code for the purchase. This may be the same for multiple different tickets and is used to group tickets together. |
ticket_cost |
The cost of the ticket. |
TicketCost
Fields | |
---|---|
face_value |
The face value of the ticket. |
purchase_price |
The actual purchase price of the ticket, after tax and/or discounts. |
discount_message |
A message describing any kind of discount that was applied. |
TicketLeg
Fields | |
---|---|
origin_station_code |
The origin station code. This is required if |
origin_name |
The name of the origin station. This is required if |
destination_station_code |
The destination station code. |
destination_name |
The destination name. |
departure_date_time |
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. |
arrival_date_time |
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. |
fare_name |
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. |
ticket_seat |
The reserved seat for the passenger(s). If more than one seat is to be specified then use the |
ticket_seats[] |
The reserved seat for the passenger(s). If only one seat is to be specified then use the |
transit_operator_name |
The name of the transit operator that is operating this leg of a trip. |
transit_terminus_name |
Terminus station or destination of the train/bus/etc. |
TicketRestrictions
Fields | |
---|---|
route_restrictions |
Restrictions about routes that may be taken. For example, this may be the string "Reserved CrossCountry trains only". |
route_restrictions_details |
More details about the above |
time_restrictions |
Restrictions about times this ticket may be used. |
other_restrictions |
Extra restrictions that don't fall under the "route" or "time" categories. |
TicketSeat
Fields | |
---|---|
fare_class |
The fare class of the ticketed seat. |
custom_fare_class |
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 |
seat_assignment |
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 |
TransitClass
Fields | |
---|---|
transit_operator_name |
The name of the transit operator. |
logo |
Required. The logo image of the ticket. This image is displayed in the card detail view of the app. |
transit_type |
Required. The type of transit this class represents, such as "bus". |
watermark |
Watermark image to display on the user's device. |
language_override |
If this field is present, transit tickets served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". |
custom_transit_terminus_name_label |
A custom label to use for the transit terminus name value ( |
custom_ticket_number_label |
A custom label to use for the ticket number value ( |
custom_route_restrictions_label |
A custom label to use for the route restrictions value ( |
custom_route_restrictions_details_label |
A custom label to use for the route restrictions details value ( |
custom_time_restrictions_label |
A custom label to use for the time restrictions details value ( |
custom_other_restrictions_label |
A custom label to use for the other restrictions value ( |
custom_purchase_receipt_number_label |
A custom label to use for the purchase receipt number value ( |
custom_confirmation_code_label |
A custom label to use for the confirmation code value ( |
custom_purchase_face_value_label |
A custom label to use for the purchase face value ( |
custom_purchase_price_label |
A custom label to use for the purchase price value ( |
custom_discount_message_label |
A custom label to use for the transit discount message value ( |
custom_carriage_label |
A custom label to use for the carriage value ( |
custom_seat_label |
A custom label to use for the seat location value ( |
custom_coach_label |
A custom label to use for the coach value ( |
custom_platform_label |
A custom label to use for the boarding platform value ( |
custom_zone_label |
A custom label to use for the boarding zone value ( |
custom_fare_class_label |
A custom label to use for the fare class value ( |
custom_concession_category_label |
A custom label to use for the transit concession category value ( |
custom_fare_name_label |
A custom label to use for the transit fare name value ( |
class_template_info |
Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display. |
enable_single_leg_itinerary |
Controls the display of the single-leg itinerary for this class. By default, an itinerary will only display for multi-leg trips. |
id |
Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. |
version |
Deprecated |
issuer_name |
Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. |
messages[] |
An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10. |
allow_multiple_users_per_object |
Deprecated. Use |
homepage_uri |
The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object). |
locations[] |
Note: This field is currently not supported to trigger geo notifications. |
review_status |
Required. The status of the class. This field can be set to You should keep this field to You should set this field to When updating an already |
review |
The review comments set by the platform when a class is marked |
info_module_data |
Deprecated. Use textModulesData instead. |
image_modules_data[] |
Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level. |
text_modules_data[] |
Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. |
links_module_data |
Links module data. If links module data is also defined on the object, both will be displayed. |
redemption_issuers[] |
Identifies which redemption issuers can redeem the pass over Smart Tap. Redemption issuers are identified by their issuer ID. Redemption issuers must have at least one Smart Tap key configured. The |
country_code |
Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale. |
hero_image |
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. |
word_mark |
Deprecated. |
enable_smart_tap |
Identifies whether this class supports Smart Tap. The |
hex_background_color |
The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as |
localized_issuer_name |
Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. |
multiple_devices_and_holders_allowed_status |
Identifies whether multiple users and devices will save the same object referencing this class. |
callback_options |
Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback. |
security_animation |
Optional information about the security animation. If this is set a security animation will be rendered on pass details. |
activation_options |
Activation options for an activatable ticket. |
view_unlock_requirement |
View Unlock Requirement options for the transit ticket. |
wide_logo |
The wide logo of the ticket. When provided, this will be used in place of the logo in the top left of the card view. |
TransitType
Enums | |
---|---|
TRANSIT_TYPE_UNSPECIFIED |
|
BUS |
|
bus |
Legacy alias for |
RAIL |
|
rail |
Legacy alias for |
TRAM |
|
tram |
Legacy alias for |
FERRY |
|
ferry |
Legacy alias for |
OTHER |
|
other |
Legacy alias for |
TransitClassAddMessageRequest
Fields | |
---|---|
resource_id |
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 '-'. |
add_message_request |
Body of the request. |
TransitClassAddMessageResponse
Fields | |
---|---|
resource |
The updated TransitClass resource. |
TransitClassGetRequest
Fields | |
---|---|
resource_id |
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 '-'. |
TransitClassInsertRequest
Fields | |
---|---|
resource |
Body of the request. |
TransitClassListRequest
Fields | |
---|---|
issuer_id |
The ID of the issuer authorized to list classes. |
token |
Used to get the next set of results if |
max_results |
Identifies the max number of results returned by a list. All results are returned if |
TransitClassListResponse
Fields | |
---|---|
resources[] |
Resources corresponding to the list request. |
pagination |
Pagination of the response. |
TransitClassPatchRequest
Fields | |
---|---|
resource_id |
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 '-'. |
resource |
Body of the request. |
TransitClassUpdateRequest
Fields | |
---|---|
resource_id |
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 '-'. |
resource |
Body of the request. |
TransitObject
Fields | |
---|---|
class_reference |
A copy of the inherited fields of the parent class. These fields are retrieved during a GET. |
ticket_number |
The number of the ticket. This is a unique identifier for the ticket in the transit operator's system. |
passenger_type |
The number of passengers. |
passenger_names |
The name(s) of the passengers the ticket is assigned to. The above |
trip_id |
This id is used to group tickets together if the user has saved multiple tickets for the same trip. |
ticket_status |
The status of the ticket. For states which affect display, use the |
custom_ticket_status |
A custom status to use for the ticket status value when |
concession_category |
The concession category for the ticket. |
custom_concession_category |
A custom concession category to use when |
ticket_restrictions |
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. |
purchase_details |
Purchase details for this ticket. |
ticket_leg |
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 |
ticket_legs[] |
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 |
hex_background_color |
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 |
trip_type |
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 '-'. |
class_id |
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. |
valid_time_interval |
The time period this object will be |
locations[] |
Note: This field is currently not supported to trigger geo notifications. |
has_users |
Indicates if the object has users. This field is set by the platform. |
smart_tap_redemption_value |
The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields |
has_linked_device |
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. |
disable_expiration_notification |
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. |
info_module_data |
Deprecated. Use textModulesData instead. |
image_modules_data[] |
Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level. |
text_modules_data[] |
Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. |
links_module_data |
Links module data. If links module data is also defined on the class, both will be displayed. |
app_link_data |
Optional information about the partner app link. |
activation_status |
The activation status for the object. Required if the class has |
rotating_barcode |
The rotating barcode type and value. |
device_context |
Device context associated with the object. |
hero_image |
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. |
grouping_info |
Information that controls how passes are grouped together. |
pass_constraints |
Pass constraints for the object. Includes limiting NFC and screenshot behaviors. |
ConcessionCategory
Enums | |
---|---|
CONCESSION_CATEGORY_UNSPECIFIED |
|
ADULT |
|
adult |
Legacy alias for |
CHILD |
|
child |
Legacy alias for |
SENIOR |
|
senior |
Legacy alias for |
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 |
TripType
Enums | |
---|---|
TRIP_TYPE_UNSPECIFIED |
|
ROUND_TRIP |
|
roundTrip |
Legacy alias for |
ONE_WAY |
|
oneWay |
Legacy alias for |
TransitObjectAddMessageRequest
Fields | |
---|---|
resource_id |
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. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. |
add_message_request |
Body of the request. |
TransitObjectAddMessageResponse
Fields | |
---|---|
resource |
The updated TransitObject resource. |
TransitObjectDownloadRotatingBarcodeValuesRequest
Request to download rotating barcode values.
Fields | |
---|---|
resource_id |
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. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. |
TransitObjectDownloadRotatingBarcodeValuesResponse
Response containing a reference to the barcode values.
Fields | |
---|---|
blob |
A reference to the rotating barcode values payload that will be downloaded. |
TransitObjectGetRequest
Fields | |
---|---|
resource_id |
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. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. |
TransitObjectInsertRequest
Fields | |
---|---|
resource |
Body of the request. |
TransitObjectListRequest
Fields | |
---|---|
class_id |
The ID of the class whose objects will be listed. |
token |
Used to get the next set of results if |
max_results |
Identifies the max number of results returned by a list. All results are returned if |
TransitObjectListResponse
Fields | |
---|---|
resources[] |
Resources corresponding to the list request. |
pagination |
Pagination of the response. |
TransitObjectPatchRequest
Fields | |
---|---|
resource_id |
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. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. |
resource |
Body of the request. |
TransitObjectUpdateRequest
Fields | |
---|---|
resource_id |
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. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. |
resource |
Body of the request. |
TransitObjectUploadRotatingBarcodeValuesRequest
Request to upload rotating barcode values.
Fields | |
---|---|
resource_id |
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. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'. |
blob |
A reference to the rotating barcode values payload that was uploaded. |
media_request_info |
Extra information about the uploaded media. |
TransitObjectUploadRotatingBarcodeValuesResponse
This type has no fields.
Response for uploading rotating barcode values.