REST 资源: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)
  }
}
字段
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 在一个发卡机构的所有类中必须是唯一的。此值应遵循“发卡机构 ID.标识符”格式,其中前者由 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[]

object (LatLongPoint)

reviewStatus

enum (ReviewStatus)

类的状态。此字段可通过 insert、patch 或 update API 调用设置为 draftunderReview。审核状态从 draft 更改为其他状态后,便无法再改回 draft

如果该类尚在开发中,您应将此字段设置为 draftdraft 类不能用于创建任何对象。

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

更新 approved 类时,您应将此字段始终设置为 underReview

review

object (Review)

当某个类被标记为 approvedrejected 时,由平台设置的评论意见。

infoModuleData
(deprecated)

object (InfoModuleData)

已弃用。请改用 textModulesData。

imageModulesData[]

object (ImageModuleData)

图片模块数据。如果还在对象中定义了图片模块数据,则这些数据将与类中定义的图片数据进行合并。这些字段(与对象合并)的数量上限为 1。

textModulesData[]

object (TextModuleData)

文本模块数据。如果还在对象中定义了文本模块数据,则将一并显示这些数据。这些字段(与对象合并)的数量上限为 10。

redemptionIssuers[]

string (int64 format)

仅适用于支持智能触碰技术的合作伙伴。如需更多指导,请与支持人员联系。

countryCode

string

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

heroImage

object (Image)

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

wordMark
(deprecated)

object (Image)

已弃用。

enableSmartTap

boolean

仅适用于支持智能触碰技术的合作伙伴。如需更多指导,请与支持人员联系。

hexBackgroundColor

string

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

localizedIssuerName

object (LocalizedString)

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

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

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

callbackOptions

object (CallbackOptions)

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

TransitType

枚举
TRANSIT_TYPE_UNSPECIFIED
BUS
bus

BUS 的旧别名,现已弃用。

RAIL
rail

RAIL 的旧别名,现已弃用。

TRAM
tram

TRAM 的旧别名,现已弃用。

FERRY
ferry

FERRY 的旧别名,现已弃用。

OTHER
other

OTHER 的旧别名,现已弃用。

方法

addmessage

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

get

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

insert

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

list

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

patch

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

update

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