资源:GiftCardObject
JSON 表示法 |
---|
{ "kind": string, "classReference": { object ( |
字段 | |
---|---|
kind |
标识这是什么资源类型。值:固定字符串 |
classReference |
父类的继承字段的副本。执行 GET 操作期间会检索这些字段。 |
cardNumber |
必需。卡号。 |
pin |
卡的 PIN 码。 |
balance |
卡的货币余额。 |
balanceUpdateTime |
余额上次更新的日期和时间。 必须提供偏移量。 如果已更新余额,但未提供此属性,系统会默认使用当前时间。 |
eventNumber |
卡的活动编号,供某些礼品卡使用的可选字段。 |
id |
必需。对象的唯一标识符。此 ID 在一个发卡机构的所有对象中必须是唯一的。此值应遵循 issuer ID 格式。identifier,其中前者由 Google 提供,后者由您自行选择。该唯一标识符应仅包含字母数字字符、“.”“_”或“-”。 |
classId |
必需。与此对象关联的类。该类必须与此对象具有相同的类型、必须已存在且已获得批准。 类 ID 应遵循 issuer ID 格式。identifier,其中前者由 Google 提供,后者由您自行选择。 |
version |
已弃用 |
state |
必需。对象的状态。此字段用于确定对象在应用中的显示方式。例如,系统会将 |
barcode |
条形码的类型和值。 |
messages[] |
应用中显示的一组消息。此对象的所有用户都将收到其相关消息。这些字段的数量上限为 10。 |
validTimeInterval |
此对象处于 |
locations[] |
注意:目前不支持使用此字段触发地理位置通知。 |
hasUsers |
指明对象是否具有用户。此字段由平台设置。 |
smartTapRedemptionValue |
将针对此对象通过 NFC 传输到智能触碰认证终端的值。此外,还必须正确设置类级字段 |
hasLinkedDevice |
此对象当前是否已关联到单个设备。当用户保存对象并将其关联到自己的设备时,平台会设置此字段。仅供部分合作伙伴使用。如需了解详情,请与支持团队联系。 |
disableExpirationNotification |
指明是否应明确禁止通知。如果此字段设为 true,则无论 目前,您只能为优惠设置此属性。 |
infoModuleData |
已弃用。请改用 textModulesData。 |
imageModulesData[] |
图片模块数据。对于对象级别,显示的这些字段的最大数量为 1 个;对于类对象级别,显示的数量上限为 1。 |
textModulesData[] |
文本模块数据。如果还在类中定义了文本模块数据,则将一并显示这些数据。对于对象,显示的这些字段数量上限为 10 个,类中的字段数量上限为 10。 |
linksModuleData |
链接模块数据。如果还在类中定义了链接模块数据,则将一并显示这些数据。 |
appLinkData |
可选的应用或网站链接,将以按钮的形式显示在卡券正面。如果为相应类提供了 AppLinkData,则仅会显示对象 AppLinkData。 |
rotatingBarcode |
轮换的条形码类型和值。 |
heroImage |
在卡片正面显示的可选横幅图片。如果没有,则显示课程的主打图片(如果存在)。如果课程的主打图片也不存在,则不会显示任何内容。 |
groupingInfo |
用于控制卡券如何分组的信息。 |
passConstraints |
传递对象的约束条件。包括限制 NFC 和屏幕截图行为。 |
方法 |
|
---|---|
|
向指定对象 ID 引用的礼品卡对象添加消息。 |
|
返回具有指定对象 ID 的礼品卡对象。 |
|
插入具有指定 ID 和属性的礼品卡对象。 |
|
返回指定发卡机构 ID 的所有礼品卡对象的列表。 |
|
更新指定对象 ID 引用的礼品卡对象。 |
|
更新指定对象 ID 引用的礼品卡对象。 |