- 资源:GiftCardObject
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- 方法
资源: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 个。 |
linksModuleData |
链接模块数据。如果还在类中定义了链接模块数据,则将一并显示这些数据。 |
appLinkData |
(可选)应用或网站链接,将作为按钮显示在卡券正面。如果为相应的类提供了 AppLinkData,则系统只会显示对象 AppLinkData。 |
rotatingBarcode |
轮播的条形码类型和值。 |
heroImage |
在卡片正面显示的可选横幅图片。如果没有,则会显示课程的主打图片(如果有)。如果课程的主打图片也没有显示,则不会显示任何内容。 |
groupingInfo |
用于控制卡券如何分组的信息。 |
passConstraints |
为对象传递约束条件。包括限制 NFC 和屏幕截图行为。 |
saveRestrictions |
针对需要在用户尝试保存卡券之前验证的对象的限制。请注意,此限制仅在保存时间内适用。如果在用户保存卡券后限制发生变化,新的限制将不会应用于已保存的卡券。 |
方法 |
|
---|---|
|
向指定对象 ID 引用的礼品卡对象添加消息。 |
|
返回具有指定对象 ID 的礼品卡对象。 |
|
插入具有指定 ID 和属性的礼品卡对象。 |
|
返回指定发卡机构 ID 的所有礼品卡对象的列表。 |
|
更新指定对象 ID 引用的礼品卡对象。 |
|
更新指定对象 ID 引用的礼品卡对象。 |