v1

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

Inserts a transit class with the given ID and properties.

post/walletobjects/v1/transitClass

Request body

allowMultipleUsersPerObjectboolean

Deprecated. Use multipleDevicesAndHoldersAllowedStatus instead.

countryCodestring

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.

enableSingleLegItineraryboolean

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

enableSmartTapboolean

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.

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

issuerNamestring

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

languageOverridestring

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

multipleDevicesAndHoldersAllowedStatus'STATUS_UNSPECIFIED' | 'MULTIPLE_HOLDERS' | 'multipleHolders' | 'ONE_USER_ALL_DEVICES' | 'oneUserAllDevices' | 'ONE_USER_ONE_DEVICE' | 'oneUserOneDevice'

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

redemptionIssuersstring[]

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.

reviewStatus'REVIEW_STATUS_UNSPECIFIED' | 'UNDER_REVIEW' | 'underReview' | 'APPROVED' | 'approved' | 'REJECTED' | 'rejected' | 'DRAFT' | 'draft'

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.

transitType'TRANSIT_TYPE_UNSPECIFIED' | 'BUS' | 'bus' | 'RAIL' | 'rail' | 'TRAM' | 'tram' | 'FERRY' | 'ferry' | 'OTHER' | 'other'

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

versionstring int64

Deprecated

viewUnlockRequirement'VIEW_UNLOCK_REQUIREMENT_UNSPECIFIED' | 'UNLOCK_NOT_REQUIRED' | 'UNLOCK_REQUIRED_TO_VIEW'

View Unlock Requirement options for the transit ticket.

Response

Successful response

allowMultipleUsersPerObjectboolean

Deprecated. Use multipleDevicesAndHoldersAllowedStatus instead.

countryCodestring

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.

enableSingleLegItineraryboolean

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

enableSmartTapboolean

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.

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

issuerNamestring

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

languageOverridestring

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

multipleDevicesAndHoldersAllowedStatus'STATUS_UNSPECIFIED' | 'MULTIPLE_HOLDERS' | 'multipleHolders' | 'ONE_USER_ALL_DEVICES' | 'oneUserAllDevices' | 'ONE_USER_ONE_DEVICE' | 'oneUserOneDevice'

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

redemptionIssuersstring[]

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.

reviewStatus'REVIEW_STATUS_UNSPECIFIED' | 'UNDER_REVIEW' | 'underReview' | 'APPROVED' | 'approved' | 'REJECTED' | 'rejected' | 'DRAFT' | 'draft'

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.

transitType'TRANSIT_TYPE_UNSPECIFIED' | 'BUS' | 'bus' | 'RAIL' | 'rail' | 'TRAM' | 'tram' | 'FERRY' | 'ferry' | 'OTHER' | 'other'

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

versionstring int64

Deprecated

viewUnlockRequirement'VIEW_UNLOCK_REQUIREMENT_UNSPECIFIED' | 'UNLOCK_NOT_REQUIRED' | 'UNLOCK_REQUIRED_TO_VIEW'

View Unlock Requirement options for the transit ticket.