资源:TransitClass
JSON 表示法 |
---|
{ "transitOperatorName": { object ( |
字段 | |
---|---|
transitOperatorName |
公交运营商的名称。 |
logo |
必需。门票的徽标图片。此图片会显示在应用的卡片详细信息视图中。 |
transitType |
必需。此类所表示的公交类型,例如“公交车”。 |
watermark |
要显示在用户设备上的水印图片。 |
languageOverride |
如果存在此字段,则提供到用户设备上的公交车票将始终使用此语言。表示 BCP 47 语言标记。示例值包括“en-US”“en-GB”“de”或“de-AT”。 |
customTransitTerminusNameLabel |
用于公交终点站名称值 ( |
customTicketNumberLabel |
用于车票编号值 ( |
customRouteRestrictionsLabel |
用于路线限制值 ( |
customRouteRestrictionsDetailsLabel |
用于路由限制详细信息值 ( |
customTimeRestrictionsLabel |
用于时间限制详细信息值 ( |
customOtherRestrictionsLabel |
用于其他限制值 ( |
customPurchaseReceiptNumberLabel |
用于购买收据编号值 ( |
customConfirmationCodeLabel |
用于确认码值 ( |
customPurchaseFaceValueLabel |
用于购票面值 ( |
customPurchasePriceLabel |
用于购买价格值 ( |
customDiscountMessageLabel |
用于公交折扣消息值 ( |
customCarriageLabel |
用于车厢值 ( |
customSeatLabel |
用于座位位置值 ( |
customCoachLabel |
用于教练值 ( |
customPlatformLabel |
用于乘车平台值 ( |
customZoneLabel |
用于乘车区值 ( |
customFareClassLabel |
用于票价等级值 ( |
customConcessionCategoryLabel |
用于公交优惠类别值 ( |
customFareNameLabel |
用于公交票价名称值 ( |
classTemplateInfo |
有关应如何显示类的模板信息。如果此政策未设置,Google 将回退为显示一组默认字段。 |
enableSingleLegItinerary |
控制此类的单段行程的显示。默认情况下,系统只会针对多段行程显示行程。 |
id |
必需。类的唯一标识符。此 ID 在一个发卡机构的所有类中必须是唯一的。此值应遵循 issuer ID 格式。identifier,其中前者由 Google 提供,后者由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”“_”或“-”。 |
version |
已弃用 |
issuerName |
必需。发卡机构名称。建议的最大长度为 20 个字符,以确保字符串能在较小的屏幕上完整显示。 |
messages[] |
应用中显示的一组消息。此对象的所有用户都将收到其相关消息。这些字段的数量上限为 10。 |
allowMultipleUsersPerObject |
已弃用。请改用 |
homepageUri |
应用首页的 URI。在此字段中填充 URI 产生的行为与在 linksModuleData 中填充 URI 完全相同(在呈现对象时,显示指向首页的链接通常会被认为是该对象的 linksModuleData 部分)。 |
locations[] |
注意:目前不支持使用此字段触发地理位置通知。 |
reviewStatus |
必需。类的状态。可以使用 insert、patch 或 update API 调用将此字段设置为 如果该类尚在开发中,您应将此字段保留为 如果您认为该类可供使用,则应将此字段设置为 更新 |
review |
当某个类被标记为 |
infoModuleData |
已弃用。请改用 textModulesData。 |
imageModulesData[] |
图片模块数据。对于对象级别,显示的这些字段的最大数量为 1 个;对于类对象级别,显示的数量上限为 1。 |
textModulesData[] |
文本模块数据。如果还在类中定义了文本模块数据,则将一并显示这些数据。对于对象,显示的这些字段数量上限为 10 个,类中的字段数量上限为 10。 |
linksModuleData |
链接模块数据。如果还在对象中定义了链接模块数据,则将一并显示这些数据。 |
redemptionIssuers[] |
指明哪些兑换发卡机构可以通过智能触碰兑换卡券。兑换发卡机构由其发卡机构 ID 进行标识。兑换发卡机构必须至少配置一个智能触碰密钥。 此外,还必须正确设置 |
countryCode |
国家/地区代码,用于显示银行卡所在的国家/地区(当用户不在该国家/地区时),以及在用户的语言区域没有内容时显示本地化内容。 |
heroImage |
在卡片正面显示的可选横幅图片。如果不存在,则不会显示任何内容。图片将以 100% 宽度显示。 |
wordMark |
已弃用。 |
enableSmartTap |
标识此类是否支持智能触碰。此外,还必须正确设置 |
hexBackgroundColor |
卡片的背景颜色。如果未设置,则系统会使用主打图片的正文色;如果未设置主打图片,则使用徽标的正文色。格式为 #rrggbb,其中 rrggbb 是十六进制 RGB 三元组,例如 |
localizedIssuerName |
已翻译的 publisherName 字符串。建议的最大长度为 20 个字符,以确保字符串能在较小的屏幕上完整显示。 |
multipleDevicesAndHoldersAllowedStatus |
指明是否允许多个用户和设备保存引用此类的同一对象。 |
callbackOptions |
回调选项,用于在最终用户每次保存/删除此类的对象时回调发卡机构。此类的所有对象都可以进行回调。 |
securityAnimation |
有关安全动画的可选信息。如果已设置,系统会在卡券详情中呈现安全动画。 |
activationOptions |
可激活的票据的激活选项。 |
viewUnlockRequirement |
查看公交车票的解锁要求选项。 |
wideLogo |
门票的宽徽标。此图标(如果提供)将取代卡片视图左上角的徽标。 |
appLinkData |
可选的应用或网站链接,将以按钮的形式显示在卡券正面。如果为将改用的相应对象提供了 AppLinkData。 |
TransitType
枚举 | |
---|---|
TRANSIT_TYPE_UNSPECIFIED |
|
BUS |
|
bus |
|
RAIL |
|
rail |
|
TRAM |
|
tram |
|
FERRY |
|
ferry |
|
OTHER |
|
other |
|
ActivationOptions
类的 ActivationOptions
JSON 表示法 |
---|
{ "activationUrl": string, "allowReactivation": boolean } |
字段 | |
---|---|
activationUrl |
支持 REST 语义的 HTTPS 网址。将用于针对给定的价值(由用户触发)请求合作伙伴激活。 |
allowReactivation |
用于允许用户通过其他设备拨打激活电话的标志。这样一来,即使激活状态为 ACTIVATED 但请求的设备与当前设备不同,客户端也可以呈现已启用的激活按钮。 |
方法 |
|
---|---|
|
向指定类 ID 引用的公交类添加消息。 |
|
返回具有指定类 ID 的公交类。 |
|
插入具有指定 ID 和属性的公交类。 |
|
返回指定发卡机构 ID 的所有公交类的列表。 |
|
更新指定类 ID 引用的公交类。 |
|
更新指定类 ID 引用的公交类。 |