Resource: TransitClass
JSON representation |
---|
{ "transitOperatorName": { object ( |
Fields | |
---|---|
transitOperatorName |
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. |
transitType |
Required. The type of transit this class represents, such as "bus". |
watermark |
Watermark image to display on the user's device. |
languageOverride |
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". |
customTransitTerminusNameLabel |
A custom label to use for the transit terminus name value ( |
customTicketNumberLabel |
A custom label to use for the ticket number value ( |
customRouteRestrictionsLabel |
A custom label to use for the route restrictions value ( |
customRouteRestrictionsDetailsLabel |
A custom label to use for the route restrictions details value ( |
customTimeRestrictionsLabel |
A custom label to use for the time restrictions details value ( |
customOtherRestrictionsLabel |
A custom label to use for the other restrictions value ( |
customPurchaseReceiptNumberLabel |
A custom label to use for the purchase receipt number value ( |
customConfirmationCodeLabel |
A custom label to use for the confirmation code value ( |
customPurchaseFaceValueLabel |
A custom label to use for the purchase face value ( |
customPurchasePriceLabel |
A custom label to use for the purchase price value ( |
customDiscountMessageLabel |
A custom label to use for the transit discount message value ( |
customCarriageLabel |
A custom label to use for the carriage value ( |
customSeatLabel |
A custom label to use for the seat location value ( |
customCoachLabel |
A custom label to use for the coach value ( |
customPlatformLabel |
A custom label to use for the boarding platform value ( |
customZoneLabel |
A custom label to use for the boarding zone value ( |
customFareClassLabel |
A custom label to use for the fare class value ( |
customConcessionCategoryLabel |
A custom label to use for the transit concession category value ( |
customFareNameLabel |
A custom label to use for the transit fare name value ( |
classTemplateInfo |
Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display. |
enableSingleLegItinerary |
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 |
issuerName |
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. |
allowMultipleUsersPerObject |
Deprecated. Use |
homepageUri |
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. |
reviewStatus |
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 |
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 object, both will be displayed. |
redemptionIssuers[] |
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 |
countryCode |
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. |
heroImage |
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. |
wordMark |
Deprecated. |
enableSmartTap |
Identifies whether this class supports Smart Tap. 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 |
localizedIssuerName |
Translated strings for the issuerName. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. |
multipleDevicesAndHoldersAllowedStatus |
Identifies whether multiple users and devices will save the same object referencing this class. |
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. |
securityAnimation |
Optional information about the security animation. If this is set a security animation will be rendered on pass details. |
activationOptions |
Activation options for an activatable ticket. |
viewUnlockRequirement |
View Unlock Requirement options for the transit ticket. |
wideLogo |
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. |
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 object that will be used instead. |
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 |
ActivationOptions
ActivationOptions for the class
JSON representation |
---|
{ "activationUrl": string, "allowReactivation": boolean } |
Fields | |
---|---|
activationUrl |
HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users. |
allowReactivation |
Flag to allow users to make activation call from different device. This allows client to render the activation button enabled even if the activationStatus is ACTIVATED but the requested device is different than the current device. |
Methods |
|
---|---|
|
Adds a message to the transit class referenced by the given class ID. |
|
Returns the transit class with the given class ID. |
|
Inserts a transit class with the given ID and properties. |
|
Returns a list of all transit classes for a given issuer ID. |
|
Updates the transit class referenced by the given class ID. |
|
Updates the transit class referenced by the given class ID. |