REST Resource: transitclass

资源：TransitClass

JSON 表示法 
{
  "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)
    }
  ],
  "merchantLocations": [
    {
      object (MerchantLocation)
    }
  ]
}
字段
transitOperatorName

object (LocalizedString)

公交运营商的名称。
transitType

enum (TransitType)

必需。此类所表示的公交类型，例如“公交车”。
watermark

object (Image)

要显示在用户设备上的水印图片。
languageOverride

string

如果存在此字段，则提供到用户设备上的公交车票将始终使用此语言。表示 BCP 47 语言标记。示例值为“en-US”“en-GB”“de”或“de-AT”。
customTransitTerminusNameLabel

object (LocalizedString)

用于公交终点站名称值 (transitObject.ticketLeg.transitTerminusName) 的自定义标签。
customTicketNumberLabel

object (LocalizedString)

用于车票号码值 (transitObject.ticketNumber) 的自定义标签。
customRouteRestrictionsLabel

object (LocalizedString)

用于路线限制值 (transitObject.ticketRestrictions.routeRestrictions) 的自定义标签。
customRouteRestrictionsDetailsLabel

object (LocalizedString)

用于路线限制详细信息值 (transitObject.ticketRestrictions.routeRestrictionsDetails) 的自定义标签。
customTimeRestrictionsLabel

object (LocalizedString)

用于时间限制详细信息值 (transitObject.ticketRestrictions.timeRestrictions) 的自定义标签。
customOtherRestrictionsLabel

object (LocalizedString)

用于其他限制值 (transitObject.ticketRestrictions.otherRestrictions) 的自定义标签。
customPurchaseReceiptNumberLabel

object (LocalizedString)

用于购票收据编号值 (transitObject.purchaseDetails.purchaseReceiptNumber) 的自定义标签。
customConfirmationCodeLabel

object (LocalizedString)

用于确认码值 (transitObject.purchaseDetails.confirmationCode) 的自定义标签。
customPurchaseFaceValueLabel

object (LocalizedString)

用于购票面值 (transitObject.purchaseDetails.ticketCost.faceValue) 的自定义标签。
customPurchasePriceLabel

object (LocalizedString)

用于购票价格值 (transitObject.purchaseDetails.ticketCost.purchasePrice) 的自定义标签。
customDiscountMessageLabel

object (LocalizedString)

用于公交折扣消息值 (transitObject.purchaseDetails.ticketCost.discountMessage) 的自定义标签。
customCarriageLabel

object (LocalizedString)

用于车厢值 (transitObject.ticketLeg.carriage) 的自定义标签。
customSeatLabel

object (LocalizedString)

用于座位位置值 (transitObject.ticketLeg.ticketSeat.seat) 的自定义标签。
customCoachLabel

object (LocalizedString)

用于卧铺车厢值 (transitObject.ticketLeg.ticketSeat.coach) 的自定义标签。
customPlatformLabel

object (LocalizedString)

用于乘车站台值 (transitObject.ticketLeg.platform) 的自定义标签。
customZoneLabel

object (LocalizedString)

用于乘车区值 (transitObject.ticketLeg.zone) 的自定义标签。
customFareClassLabel

object (LocalizedString)

用于票价等级值 (transitObject.ticketLeg.ticketSeat.fareClass) 的自定义标签。
customConcessionCategoryLabel

object (LocalizedString)

用于公交优惠类别值 (transitObject.concessionCategory) 的自定义标签。
customFareNameLabel

object (LocalizedString)

用于公交票价名称值 (transitObject.ticketLeg.fareName) 的自定义标签。
classTemplateInfo

object (ClassTemplateInfo)

有关应如何显示类的模板信息。如果未设置，Google 将回退为显示默认字段集。
enableSingleLegItinerary

boolean

控制此类的单段行程的显示。默认情况下，仅显示多段行程。
id

string

必需。类的唯一标识符。此 ID 在一个发卡机构的所有类中必须是唯一的。此值应遵循 issuer ID 格式。identifier”格式，其中前者由 Google 提供，后者由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”“_”或“-”。
version
(deprecated)

string (int64 format)

已弃用
issuerName

string

必需。发卡机构名称。建议的最大长度为 20 个字符，以确保字符串能在较小的屏幕上完整显示。
messages[]

object (Message)

在应用中显示的一组消息。此对象的所有用户都将收到其关联消息。这些字段的数量上限为 10。
allowMultipleUsersPerObject
(deprecated)

boolean

已弃用。请改用 multipleDevicesAndHoldersAllowedStatus。
homepageUri

object (Uri)

应用首页的 URI。在此字段中填充 URI 的效果与在 linksModuleData 中填充 URI 的效果完全相同（在呈现对象时，显示的首页链接通常被认为是该对象的 linksModuleData 部分）。
locations[]
(deprecated)

object (LatLongPoint)

注意：此字段目前不支持触发地理位置通知。
reviewStatus

enum (ReviewStatus)

必需。类的状态。此字段可通过插入、修补或更新 API 调用设置为 draft 或 underReview。审核状态从 draft 更改为其他状态后，便无法再改回 draft。

如果该类尚在开发中，您应将此字段保留为 draft。draft 类不能用于创建任何对象。

如果您认为该类可以随时使用，您应将此字段设置为 underReview。平台会将此字段自动设置为 approved，它可以立即用于创建或迁移对象。

更新已设为 approved 的类时，您应将此字段始终设置为 underReview。
review

object (Review)

当某个类被标记为 approved 或 rejected 时，由平台设置的评论意见。
infoModuleData
(deprecated)

object (InfoModuleData)

已弃用。请改用 textModulesData。
imageModulesData[]

object (ImageModuleData)

图片模块数据。从对象级别开始，显示的字段数量上限为 1；对于类对象级别，上限也为 1。
textModulesData[]

object (TextModuleData)

文本模块数据。如果还在类中定义了文本模块数据，则将一并显示这些数据。从对象开始，显示的字段数量上限为 10；对于类，上限也为 10。
redemptionIssuers[]

string (int64 format)

用于标识哪些兑换发卡机构可以通过智能感应功能兑换卡券。兑换发卡机构通过其发卡机构 ID 进行标识。兑换发行商必须至少配置一个 Smart Tap 键。

此外，还必须正确设置 enableSmartTap 和对象级 smartTapRedemptionLevel 字段，才能支持智能感应式付款。
countryCode

string

国家/地区代码，用于在用户不在该国家/地区时显示发卡国家/地区，以及在用户的语言区域未推出该内容时显示本地化的内容。
heroImage

object (Image)

在卡片正面显示的可选横幅图片。如果不存在，则不会显示任何内容。图片将以 100% 宽度显示。
wordMark
(deprecated)

object (Image)

已弃用。
enableSmartTap

boolean

确定此类是否支持智能感应。此外，还必须正确设置 redemptionIssuers 和对象级 smartTapRedemptionLevel 字段，才能支持智能感应式付款。
hexBackgroundColor

string

卡片的背景颜色。如果未设置，则使用主打图片的正文色；如果未设置主打图片，则使用徽标的正文色。格式为 #rrggbb，其中 rrggbb 为十六进制 RGB 三元组，例如 #ffcc00。您也可以使用 RGB 三元组的简写版本（即 #rgb），例如 #fc0。
localizedIssuerName

object (LocalizedString)

已翻译的 issuerName 字符串。建议的最大长度为 20 个字符，以确保字符串能在较小的屏幕上完整显示。
multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

指明是否允许多个用户和设备保存引用该类的同一个对象。
callbackOptions

object (CallbackOptions)

回调选项，用于在最终用户每次保存/删除此类的对象时回调发卡机构。此类的所有对象都可进行回调。
securityAnimation

object (SecurityAnimation)

有关安全动画的可选信息。如果设置此属性，系统会在卡券详情中呈现安全动画。
activationOptions

object (ActivationOptions)

可激活票券的激活选项。
viewUnlockRequirement

enum (ViewUnlockRequirement)

查看公交票券的“解锁要求”选项。
notifyPreference

enum (NotificationSettingsForUpdates)

是否应针对此类触发字段更新通知。设置为 NOTIFY 时，我们会尝试向用户触发字段更新通知。只有当该字段已列入许可名单时，系统才会向用户发送这些通知。如果设置为 DO_NOT_NOTIFY 或 NOTIFICATION_SETTINGS_UNSPECIFIED，则不会触发任何通知。此设置是暂时性的，需要在每次 PATCH 或 UPDATE 请求中进行设置，否则系统不会触发通知。
valueAddedModuleData[]

object (ValueAddedModuleData)

添加了可选值模块数据。每门课程最多 10 人。对于一次传递，系统只会显示 10 个错误，并优先显示来自对象的错误。
merchantLocations[]

object (MerchantLocation)

商家营业地点。一个课程最多只能有 10 名学生。超出 10 个的任何其他 MerchantLocation 都将被拒绝。当用户进入 Google 设置的点周围半径范围内时，这些位置会触发通知。此字段取代了已废弃的 LatLongPoints。

TransitType

枚举
TRANSIT_TYPE_UNSPECIFIED
BUS
bus

BUS 的旧别名。已弃用。
RAIL
rail

RAIL 的旧别名。已弃用。
TRAM
tram

TRAM 的旧别名。已弃用。
FERRY
ferry

FERRY 的旧别名。已弃用。
OTHER
other

OTHER 的旧别名。已弃用。

ActivationOptions

类的 ActivationOptions

JSON 表示法 
{
  "activationUrl": string,
  "allowReactivation": boolean
}
字段
activationUrl

string

支持 REST 语义的 HTTPS 网址。用于请求合作伙伴为用户触发的指定优惠启用。
allowReactivation

boolean

用于允许用户从其他设备进行激活通话的标志。这样一来，即使 activationStatus 为 ACTIVATED，但请求的设备与当前设备不同，客户端也可以呈现已启用的激活按钮。

方法

addmessage

 向指定类 ID 引用的公交类添加消息。

get

 返回具有指定类 ID 的公交类。

insert

 插入具有指定 ID 和属性的公交类。

list

 返回指定发卡机构 ID 的所有公交类的列表。

patch

 更新指定类 ID 引用的公交类。

update

 更新指定类 ID 引用的公交类。