v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1495145304.5 KB
transitobject

Inserts an transit object with the given ID and properties.

post/walletobjects/v1/transitObject

Request body

classIdstring

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.

concessionCategory'CONCESSION_CATEGORY_UNSPECIFIED' | 'ADULT' | 'adult' | 'CHILD' | 'child' | 'SENIOR' | 'senior'

The concession category for the ticket.

disableExpirationNotificationboolean

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.

hasLinkedDeviceboolean

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.

hasUsersboolean

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

hexBackgroundColorstring

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.

idstring

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

passengerNamesstring

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

passengerType'PASSENGER_TYPE_UNSPECIFIED' | 'SINGLE_PASSENGER' | 'singlePassenger' | 'MULTIPLE_PASSENGERS' | 'multiplePassengers'

The number of passengers.

smartTapRedemptionValuestring

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.

state'STATE_UNSPECIFIED' | 'ACTIVE' | 'active' | 'COMPLETED' | 'completed' | 'EXPIRED' | 'expired' | 'INACTIVE' | 'inactive'

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.

ticketNumberstring

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

ticketStatus'TICKET_STATUS_UNSPECIFIED' | 'USED' | 'used' | 'REFUNDED' | 'refunded' | 'EXCHANGED' | 'exchanged'

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

tripIdstring

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

tripType'TRIP_TYPE_UNSPECIFIED' | 'ROUND_TRIP' | 'roundTrip' | 'ONE_WAY' | 'oneWay'

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.

versionstring int64

Deprecated

Response

Successful response

classIdstring

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.

concessionCategory'CONCESSION_CATEGORY_UNSPECIFIED' | 'ADULT' | 'adult' | 'CHILD' | 'child' | 'SENIOR' | 'senior'

The concession category for the ticket.

disableExpirationNotificationboolean

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.

hasLinkedDeviceboolean

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.

hasUsersboolean

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

hexBackgroundColorstring

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.

idstring

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

passengerNamesstring

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

passengerType'PASSENGER_TYPE_UNSPECIFIED' | 'SINGLE_PASSENGER' | 'singlePassenger' | 'MULTIPLE_PASSENGERS' | 'multiplePassengers'

The number of passengers.

smartTapRedemptionValuestring

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.

state'STATE_UNSPECIFIED' | 'ACTIVE' | 'active' | 'COMPLETED' | 'completed' | 'EXPIRED' | 'expired' | 'INACTIVE' | 'inactive'

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.

ticketNumberstring

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

ticketStatus'TICKET_STATUS_UNSPECIFIED' | 'USED' | 'used' | 'REFUNDED' | 'refunded' | 'EXCHANGED' | 'exchanged'

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

tripIdstring

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

tripType'TRIP_TYPE_UNSPECIFIED' | 'ROUND_TRIP' | 'roundTrip' | 'ONE_WAY' | 'oneWay'

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.

versionstring int64

Deprecated