REST Resource: transitclass

Resource: TransitClass

JSON representation 
{
  "transitOperatorName": {
    object (LocalizedString)
  },
  "logo": {
    object (Image)
  },
  "transitType": enum (TransitType),
  "watermark": {
    object (Image)
  },
  "languageOverride": string,
  "customTransitTerminusNameLabel": {
    object (LocalizedString)
  },
  "customTicketNumberLabel": {
    object (LocalizedString)
  },
  "customRouteRestrictionsLabel": {
    object (LocalizedString)
  },
  "customRouteRestrictionsDetailsLabel": {
    object (LocalizedString)
  },
  "customTimeRestrictionsLabel": {
    object (LocalizedString)
  },
  "customOtherRestrictionsLabel": {
    object (LocalizedString)
  },
  "customPurchaseReceiptNumberLabel": {
    object (LocalizedString)
  },
  "customConfirmationCodeLabel": {
    object (LocalizedString)
  },
  "customPurchaseFaceValueLabel": {
    object (LocalizedString)
  },
  "customPurchasePriceLabel": {
    object (LocalizedString)
  },
  "customDiscountMessageLabel": {
    object (LocalizedString)
  },
  "customCarriageLabel": {
    object (LocalizedString)
  },
  "customSeatLabel": {
    object (LocalizedString)
  },
  "customCoachLabel": {
    object (LocalizedString)
  },
  "customPlatformLabel": {
    object (LocalizedString)
  },
  "customZoneLabel": {
    object (LocalizedString)
  },
  "customFareClassLabel": {
    object (LocalizedString)
  },
  "customConcessionCategoryLabel": {
    object (LocalizedString)
  },
  "customFareNameLabel": {
    object (LocalizedString)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "enableSingleLegItinerary": boolean,
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "activationOptions": {
    object (ActivationOptions)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideLogo": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
Fields
transitOperatorName

object (LocalizedString)

The name of the transit operator.
transitType

enum (TransitType)

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

object (Image)

Watermark image to display on the user's device.
languageOverride

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (ClassTemplateInfo)

Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
enableSingleLegItinerary

boolean

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)

string (int64 format)

Deprecated
issuerName

string

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

object (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.
allowMultipleUsersPerObject
(deprecated)

boolean

Deprecated. Use multipleDevicesAndHoldersAllowedStatus instead.
homepageUri

object (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[]
(deprecated)

object (LatLongPoint)

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

enum (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

object (Review)

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

object (InfoModuleData)

Deprecated. Use textModulesData instead.
imageModulesData[]

object (ImageModuleData)

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

object (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.
redemptionIssuers[]

string (int64 format)

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

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

object (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.
wordMark
(deprecated)

object (Image)

Deprecated.
enableSmartTap

boolean

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

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

object (LocalizedString)

Translated strings for the issuerName. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

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

object (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

object (SecurityAnimation)

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

object (ActivationOptions)

Activation options for an activatable ticket.
viewUnlockRequirement

enum (ViewUnlockRequirement)

View Unlock Requirement options for the transit ticket.
notifyPreference

enum (NotificationSettingsForUpdates)

Whether or not field updates to this class should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.
valueAddedModuleData[]

object (ValueAddedModuleData)

Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.

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.

ActivationOptions

ActivationOptions for the class

JSON representation 
{
  "activationUrl": string,
  "allowReactivation": boolean
}
Fields
activationUrl

string

HTTPS URL that supports REST semantics. Would be used for requesting activation from partners for given valuable, triggered by the users.
allowReactivation

boolean

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

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.

update

 Updates the transit class referenced by the given class ID.