Package google.walletobjects.v1.transit

Index

TransitClassService

AddMessage

rpc AddMessage(TransitClassAddMessageRequest) returns (TransitClassAddMessageResponse)

Adds a message to the transit class referenced by the given class ID.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/wallet_object.issuer
Get

rpc Get(TransitClassGetRequest) returns (TransitClass)

Returns the transit class with the given class ID.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/wallet_object.issuer
Insert

rpc Insert(TransitClassInsertRequest) returns (TransitClass)

Inserts a transit class with the given ID and properties.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/wallet_object.issuer
List

rpc List(TransitClassListRequest) returns (TransitClassListResponse)

Returns a list of all transit classes for a given issuer ID.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/wallet_object.issuer
Patch

rpc Patch(TransitClassPatchRequest) returns (TransitClass)

Updates the transit class referenced by the given class ID. This method supports patch semantics.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/wallet_object.issuer
Update

rpc Update(TransitClassUpdateRequest) returns (TransitClass)

Updates the transit class referenced by the given class ID.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/wallet_object.issuer

TransitObjectService

AddMessage

rpc AddMessage(TransitObjectAddMessageRequest) returns (TransitObjectAddMessageResponse)

Adds a message to the transit object referenced by the given object ID.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/wallet_object.issuer
DownloadRotatingBarcodeValues

rpc DownloadRotatingBarcodeValues(TransitObjectDownloadRotatingBarcodeValuesRequest) returns (TransitObjectDownloadRotatingBarcodeValuesResponse)

Downloads rotating barcode values for the transit object referenced by the given object ID.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/wallet_object.issuer
Get

rpc Get(TransitObjectGetRequest) returns (TransitObject)

Returns the transit object with the given object ID.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/wallet_object.issuer
Insert

rpc Insert(TransitObjectInsertRequest) returns (TransitObject)

Inserts an transit object with the given ID and properties.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/wallet_object.issuer
List

rpc List(TransitObjectListRequest) returns (TransitObjectListResponse)

Returns a list of all transit objects for a given issuer ID.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/wallet_object.issuer
Patch

rpc Patch(TransitObjectPatchRequest) returns (TransitObject)

Updates the transit object referenced by the given object ID. This method supports patch semantics.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/wallet_object.issuer
Update

rpc Update(TransitObjectUpdateRequest) returns (TransitObject)

Updates the transit object referenced by the given object ID.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/wallet_object.issuer
UploadRotatingBarcodeValues

rpc UploadRotatingBarcodeValues(TransitObjectUploadRotatingBarcodeValuesRequest) returns (TransitObjectUploadRotatingBarcodeValuesResponse)

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.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/wallet_object.issuer

PurchaseDetails

Fields
purchase_receipt_number

string

Receipt number/identifier for tracking the ticket purchase via the body that sold the ticket.

purchase_date_time

string

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:

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.

Without offset information, some rich features may not be available.

account_id

string

ID of the account used to purchase the ticket.

confirmation_code

string

The confirmation code for the purchase. This may be the same for multiple different tickets and is used to group tickets together.

ticket_cost

TicketCost

The cost of the ticket.

TicketCost

Fields
face_value

Money

The face value of the ticket.

purchase_price

Money

The actual purchase price of the ticket, after tax and/or discounts.

discount_message

LocalizedString

A message describing any kind of discount that was applied.

TicketLeg

Fields
origin_station_code

string

The origin station code. This is required if destinationStationCode is present or if originName is not present.

origin_name

LocalizedString

The name of the origin station. This is required if desinationName is present or if originStationCode is not present.

destination_station_code

string

The destination station code.

destination_name

LocalizedString

The destination name.

departure_date_time

string

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:

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 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 2018-06-05T20:00:00. If the local date/time at the origin station is 4 hours before UTC, an offset of -04:00 may be appended.

Without offset information, some rich features may not be available.

arrival_date_time

string

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:

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 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 2018-06-05T20:00:00. If the local date/time at the destination station is 4 hours before UTC, an offset of -04:00 may be appended.

Without offset information, some rich features may not be available.

fare_name

LocalizedString

Short description/name of the fare for this leg of travel. Eg "Anytime Single Use".

carriage

string

The train or ship name/number that the passsenger needs to board.

platform

string

The platform or gate where the passenger can board the carriage.

zone

string

The zone of boarding within the platform.

ticket_seat

TicketSeat

The reserved seat for the passenger(s). If more than one seat is to be specified then use the ticketSeats field instead. Both ticketSeat and ticketSeats may not be set.

ticket_seats[]

TicketSeat

The reserved seat for the passenger(s). If only one seat is to be specified then use the ticketSeat field instead. Both ticketSeat and ticketSeats may not be set.

transit_operator_name

LocalizedString

The name of the transit operator that is operating this leg of a trip.

transit_terminus_name

LocalizedString

Terminus station or destination of the train/bus/etc.

TicketRestrictions

Fields
route_restrictions

LocalizedString

Restrictions about routes that may be taken. For example, this may be the string "Reserved CrossCountry trains only".

route_restrictions_details

LocalizedString

More details about the above routeRestrictions.

time_restrictions

LocalizedString

Restrictions about times this ticket may be used.

other_restrictions

LocalizedString

Extra restrictions that don't fall under the "route" or "time" categories.

TicketSeat

Fields
fare_class

FareClass

The fare class of the ticketed seat.

custom_fare_class

LocalizedString

A custome fare class to be used if no fareClass applies. Both fareClass and customFareClass may not be set.

coach

string

The identifier of the train car or coach in which the ticketed seat is located. Eg. "10"

seat

string

The identifier of where the ticketed seat is located. Eg. "42". If there is no specific identifier, use seatAssigment instead.

seat_assignment

LocalizedString

The passenger's seat assignment. Eg. "no specific seat". To be used when there is no specific identifier to use in seat.

FareClass

Enums
FARE_CLASS_UNSPECIFIED
ECONOMY
economy

Legacy alias for ECONOMY. Deprecated.

FIRST
first

Legacy alias for FIRST. Deprecated.

BUSINESS
business

Legacy alias for BUSINESS. Deprecated.

TransitClass

Fields
transit_operator_name

LocalizedString

The name of the transit operator.

transit_type

TransitType

Required. The type of transit this class represents, such as "bus".

watermark

Image

Watermark image to display on the user's device.

language_override

string

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

LocalizedString

A custom label to use for the transit terminus name value (transitObject.ticketLeg.transitTerminusName).

custom_ticket_number_label

LocalizedString

A custom label to use for the ticket number value (transitObject.ticketNumber).

custom_route_restrictions_label

LocalizedString

A custom label to use for the route restrictions value (transitObject.ticketRestrictions.routeRestrictions).

custom_route_restrictions_details_label

LocalizedString

A custom label to use for the route restrictions details value (transitObject.ticketRestrictions.routeRestrictionsDetails).

custom_time_restrictions_label

LocalizedString

A custom label to use for the time restrictions details value (transitObject.ticketRestrictions.timeRestrictions).

custom_other_restrictions_label

LocalizedString

A custom label to use for the other restrictions value (transitObject.ticketRestrictions.otherRestrictions).

custom_purchase_receipt_number_label

LocalizedString

A custom label to use for the purchase receipt number value (transitObject.purchaseDetails.purchaseReceiptNumber).

custom_confirmation_code_label

LocalizedString

A custom label to use for the confirmation code value (transitObject.purchaseDetails.confirmationCode).

custom_purchase_face_value_label

LocalizedString

A custom label to use for the purchase face value (transitObject.purchaseDetails.ticketCost.faceValue).

custom_purchase_price_label

LocalizedString

A custom label to use for the purchase price value (transitObject.purchaseDetails.ticketCost.purchasePrice).

custom_discount_message_label

LocalizedString

A custom label to use for the transit discount message value (transitObject.purchaseDetails.ticketCost.discountMessage).

custom_carriage_label

LocalizedString

A custom label to use for the carriage value (transitObject.ticketLeg.carriage).

custom_seat_label

LocalizedString

A custom label to use for the seat location value (transitObject.ticketLeg.ticketSeat.seat).

custom_coach_label

LocalizedString

A custom label to use for the coach value (transitObject.ticketLeg.ticketSeat.coach).

custom_platform_label

LocalizedString

A custom label to use for the boarding platform value (transitObject.ticketLeg.platform).

custom_zone_label

LocalizedString

A custom label to use for the boarding zone value (transitObject.ticketLeg.zone).

custom_fare_class_label

LocalizedString

A custom label to use for the fare class value (transitObject.ticketLeg.ticketSeat.fareClass).

custom_concession_category_label

LocalizedString

A custom label to use for the transit concession category value (transitObject.concessionCategory).

custom_fare_name_label

LocalizedString

A custom label to use for the transit fare name value (transitObject.ticketLeg.fareName).

class_template_info

ClassTemplateInfo

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

bool

Controls the display of the single-leg itinerary for this class. By default, an itinerary will only display for multi-leg trips.

id

string

Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.

version
(deprecated)

int64

Deprecated

issuer_name

string

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

messages[]

Message

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)

bool

Deprecated. Use multipleDevicesAndHoldersAllowedStatus instead.

homepage_uri

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[]

LatLongPoint

Note: This field is currently not supported to trigger geo notifications.

review_status

ReviewStatus

Required. The status of the class. This field can be set to draft or underReview using the insert, patch, or update API calls. Once the review state is changed from draft it may not be changed back to draft.

You should keep this field to draft when the class is under development. A draft class cannot be used to create any object.

You should set this field to underReview when you believe the class is ready for use. The platform will automatically set this field to approved and it can be immediately used to create or migrate objects.

When updating an already approved class you should keep setting this field to underReview.

review

Review

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

info_module_data
(deprecated)

InfoModuleData

Deprecated. Use textModulesData instead.

image_modules_data[]

ImageModuleData

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

text_modules_data[]

TextModuleData

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.

redemption_issuers[]

int64

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 enableSmartTap and object level smartTapRedemptionLevel fields must also be set up correctly in order for a pass to support Smart Tap.

country_code

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.

hero_image

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)

Image

Deprecated.

enable_smart_tap

bool

Identifies whether this class supports Smart Tap. The redemptionIssuers and object level smartTapRedemptionLevel fields must also be set up correctly in order for a pass to support Smart Tap.

hex_background_color

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.

localized_issuer_name

LocalizedString

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

MultipleDevicesAndHoldersAllowedStatus

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

callback_options

CallbackOptions

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

SecurityAnimation

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

activation_options

ActivationOptions

Activation options for an activatable ticket.

view_unlock_requirement

ViewUnlockRequirement

View Unlock Requirement options for the transit ticket.

TransitType

Enums
TRANSIT_TYPE_UNSPECIFIED
BUS
bus

Legacy alias for BUS. Deprecated.

RAIL
rail

Legacy alias for RAIL. Deprecated.

TRAM
tram

Legacy alias for TRAM. Deprecated.

FERRY
ferry

Legacy alias for FERRY. Deprecated.

OTHER
other

Legacy alias for OTHER. Deprecated.

TransitClassAddMessageRequest

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

add_message_request

AddMessageRequest

Body of the request.

TransitClassAddMessageResponse

Fields
resource

TransitClass

The updated TransitClass resource.

TransitClassGetRequest

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

TransitClassInsertRequest

Fields
resource

TransitClass

Body of the request.

TransitClassListRequest

Fields
issuer_id

int64

The ID of the issuer authorized to list classes.

token

string

Used to get the next set of results if maxResults is specified, but more than maxResults classes are available in a list. For example, if you have a list of 200 classes and you call list with maxResults set to 20, list will return the first 20 classes and a token. Call list again with maxResults set to 20 and the token to get the next 20 classes.

max_results

int32

Identifies the max number of results returned by a list. All results are returned if maxResults isn't defined.

TransitClassListResponse

Fields
resources[]

TransitClass

Resources corresponding to the list request.

pagination

Pagination

Pagination of the response.

TransitClassPatchRequest

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

resource

TransitClass

Body of the request.

TransitClassUpdateRequest

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

resource

TransitClass

Body of the request.

TransitObject

Fields
class_reference

TransitClass

A copy of the inherited fields of the parent class. These fields are retrieved during a GET.

ticket_number

string

The number of the ticket. This is a unique identifier for the ticket in the transit operator's system.

passenger_type

PassengerType

The number of passengers.

passenger_names

string

The name(s) of the passengers the ticket is assigned to. The above passengerType field is meant to give Google context on this field.

trip_id

string

This id is used to group tickets together if the user has saved multiple tickets for the same trip.

ticket_status

TicketStatus

The status of the ticket. For states which affect display, use the state field instead.

custom_ticket_status

LocalizedString

A custom status to use for the ticket status value when ticketStatus does not provide the right option. Both ticketStatus and customTicketStatus may not be set.

concession_category

ConcessionCategory

The concession category for the ticket.

custom_concession_category

LocalizedString

A custom concession category to use when concessionCategory does not provide the right option. Both concessionCategory and customConcessionCategory may not be set.

ticket_restrictions

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.

purchase_details

PurchaseDetails

Purchase details for this ticket.

ticket_leg

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 field instead. Both ticketLeg and ticketLegs may not be set.

ticket_legs[]

TicketLeg

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 ticketLeg field instead. Both ticketLeg and ticketLegs may not be set.

hex_background_color

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.

trip_type

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

string

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

string

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)

int64

Deprecated

state

State

Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an inactive object is moved to the "Expired passes" section.

barcode

Barcode

The barcode type and value.

messages[]

Message

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

TimeInterval

The time period this object will be active and object can be used. An object's state will be changed to expired when this time period has passed.

locations[]

LatLongPoint

Note: This field is currently not supported to trigger geo notifications.

has_users

bool

Indicates if the object has users. This field is set by the platform.

smart_tap_redemption_value

string

The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields enableSmartTap and redemptionIssuers must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.

has_linked_device

bool

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

bool

Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the messages field, expiration notifications to the user will be suppressed. By default, this field is set to false.

Currently, this can only be set for offers.

info_module_data

InfoModuleData

Deprecated. Use textModulesData instead.

image_modules_data[]

ImageModuleData

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

text_modules_data[]

TextModuleData

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.

activation_status

ActivationStatus

The activation status for the object. Required if the class has activationOptions set.

rotating_barcode

RotatingBarcode

The rotating barcode type and value.

device_context

DeviceContext

Device context associated with the object.

hero_image

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

GroupingInfo

Information that controls how passes are grouped together.

pass_constraints

PassConstraints

Pass constraints for the object. Includes limiting NFC and screenshot behaviors.

ConcessionCategory

Enums
CONCESSION_CATEGORY_UNSPECIFIED
ADULT
adult

Legacy alias for ADULT. Deprecated.

CHILD
child

Legacy alias for CHILD. Deprecated.

SENIOR
senior

Legacy alias for SENIOR. Deprecated.

PassengerType

Enums
PASSENGER_TYPE_UNSPECIFIED
SINGLE_PASSENGER
singlePassenger

Legacy alias for SINGLE_PASSENGER. Deprecated.

MULTIPLE_PASSENGERS
multiplePassengers

Legacy alias for MULTIPLE_PASSENGERS. Deprecated.

TicketStatus

Enums
TICKET_STATUS_UNSPECIFIED
USED
used

Legacy alias for USED. Deprecated.

REFUNDED
refunded

Legacy alias for REFUNDED. Deprecated.

EXCHANGED
exchanged

Legacy alias for EXCHANGED. Deprecated.

TripType

Enums
TRIP_TYPE_UNSPECIFIED
ROUND_TRIP
roundTrip

Legacy alias for ROUND_TRIP. Deprecated.

ONE_WAY
oneWay

Legacy alias for ONE_WAY. Deprecated.

TransitObjectAddMessageRequest

Fields
resource_id

string

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

AddMessageRequest

Body of the request.

TransitObjectAddMessageResponse

Fields
resource

TransitObject

The updated TransitObject resource.

TransitObjectDownloadRotatingBarcodeValuesRequest

Request to download rotating barcode values.

Fields
resource_id

string

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

Media

A reference to the rotating barcode values payload that will be downloaded.

TransitObjectGetRequest

Fields
resource_id

string

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

TransitObject

Body of the request.

TransitObjectListRequest

Fields
class_id

string

The ID of the class whose objects will be listed.

token

string

Used to get the next set of results if maxResults is specified, but more than maxResults objects are available in a list. For example, if you have a list of 200 objects and you call list with maxResults set to 20, list will return the first 20 objects and a token. Call list again with maxResults set to 20 and the token to get the next 20 objects.

max_results

int32

Identifies the max number of results returned by a list. All results are returned if maxResults isn't defined.

TransitObjectListResponse

Fields
resources[]

TransitObject

Resources corresponding to the list request.

pagination

Pagination

Pagination of the response.

TransitObjectPatchRequest

Fields
resource_id

string

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

TransitObject

Body of the request.

TransitObjectUpdateRequest

Fields
resource_id

string

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

TransitObject

Body of the request.

TransitObjectUploadRotatingBarcodeValuesRequest

Request to upload rotating barcode values.

Fields
resource_id

string

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

Media

A reference to the rotating barcode values payload that was uploaded.

media_request_info

MediaRequestInfo

Extra information about the uploaded media.

TransitObjectUploadRotatingBarcodeValuesResponse

This type has no fields.

Response for uploading rotating barcode values.