资源:GenericObject
通用对象
JSON 表示法 |
---|
{ "genericType": enum ( |
字段 | |
---|---|
genericType |
指定卡片所属的 |
cardTitle |
必需。卡券的标题。这通常是商家名称,例如“XXX Gym”“AAA 保险”。此字段是必填字段,会显示在卡券顶部的标题行中。 |
subheader |
卡券的标题标签,例如可使用此卡券的位置。显示在卡券详情视图中标题行的标题上方。 |
header |
必需。卡券的标题,例如“半价优惠券”“图书馆卡”或“代金券”。此字段是必填字段,会显示在卡券详情视图的标题行中。 |
logo |
卡券的徽标图片。此图片显示在左上方的卡片详情视图中,以及列表/缩略图视图中。如果徽标不存在,“ |
hexBackgroundColor |
卡片的背景颜色。如果未设置此政策,系统将使用主打图片的正文色;如果未设置主打图片,则会使用徽标的正文色;如果未设置,则使用 Google 选择的颜色。 |
notifications |
为此对象启用的通知设置。 |
id |
必需。对象的唯一标识符。此 ID 在一个发卡机构的所有对象中必须是唯一的。此值需要遵循格式 |
classId |
必需。与此对象关联的类。该类必须与此对象具有相同的类型、必须已存在且已获得批准。 类 ID 应遵循 |
barcode |
条形码的类型和值。如果卡券没有条形码,我们允许发卡机构设置 Barcode.alternate_text 并仅显示该代码。 |
heroImage |
卡片正面显示的横幅图片(如果存在)。图片将以 100% 宽度显示。 |
validTimeInterval |
此对象被视为有效或可用的时间段。超过此时间段后,对象将被视为已过期,这会影响用户设备上的呈现。 |
imageModulesData[] |
图片模块数据。如果两者都设置了,则仅呈现类中的一张图片和对象级的图片。 |
textModulesData[] |
文本模块数据。如果还在类中定义了 |
linksModuleData |
链接模块数据。如果还在类中定义了 |
appLinkData |
可选的应用或网站链接,将以按钮的形式显示在卡券正面。如果为相应类提供了 AppLinkData,则仅会显示对象 AppLinkData。 |
groupingInfo |
用于控制卡券如何分组的信息。 |
smartTapRedemptionValue |
将针对此对象通过 NFC 传输到智能触碰认证终端的值。此外,还必须正确设置类级字段 |
rotatingBarcode |
轮换条形码设置/详细信息。 |
state |
对象的状态。此字段用于确定对象在应用中的显示方式。例如,系统会将 |
hasUsers |
指明对象是否具有用户。此字段由平台设置。 |
passConstraints |
传递对象的约束条件。包括限制 NFC 和屏幕截图行为。 |
wideLogo |
卡券的宽徽标。此图标(如果提供)将取代卡片视图左上角的徽标。 |
GenericType
通用卡片的类型。
枚举 | |
---|---|
GENERIC_TYPE_UNSPECIFIED |
未指定的通用类型。 |
GENERIC_SEASON_PASS |
季票 |
GENERIC_UTILITY_BILLS |
公共事业缴费单 |
GENERIC_PARKING_PASS |
停车卡 |
GENERIC_VOUCHER |
Voucher |
GENERIC_GYM_MEMBERSHIP |
健身房会员卡 |
GENERIC_LIBRARY_MEMBERSHIP |
图书馆会员卡 |
GENERIC_RESERVATIONS |
预留 |
GENERIC_AUTO_INSURANCE |
汽车保险卡 |
GENERIC_HOME_INSURANCE |
住宅保险卡 |
GENERIC_ENTRY_TICKET |
门票 |
GENERIC_RECEIPT |
收据 |
GENERIC_OTHER |
其他类型 |
通知
指明对象是否需要启用通知。我们仅支持 ExpiryNotification/RecentNotification 中的一个。expiryNotification
的优先级高于 upcomingNotification
。换言之,如果设置了 expiryNotification
,就会忽略 upcomingNotification
字段。
JSON 表示法 |
---|
{ "expiryNotification": { object ( |
字段 | |
---|---|
expiryNotification |
系统会在卡到期前的特定时间触发通知。 |
upcomingNotification |
系统会在该卡可以使用之前的特定时间触发通知。 |
ExpiryNotification
表明发卡机构希望 Google 电子钱包在卡到期前 2 天发送到期通知。
JSON 表示法 |
---|
{ "enableNotification": boolean } |
字段 | |
---|---|
enableNotification |
指明对象是否需要启用到期通知。 |
UpcomingNotification
表示发卡机构希望 Google 电子钱包在卡生效/可用前 1 天发送即将生效的卡失效通知。
JSON 表示法 |
---|
{ "enableNotification": boolean } |
字段 | |
---|---|
enableNotification |
指明对象是否需要启用即将显示的通知。 |
方法 |
|
---|---|
|
向指定对象 ID 引用的通用对象添加消息。 |
|
返回具有指定对象 ID 的通用对象。 |
|
插入具有指定 ID 和属性的通用对象。 |
|
返回指定发卡机构 ID 的所有通用对象的列表。 |
|
更新指定对象 ID 引用的通用对象。 |
|
更新指定对象 ID 引用的通用对象。 |