资源:OfferObject
JSON 表示法 |
---|
{ "kind": string, "classReference": { object ( |
字段 | |
---|---|
kind |
标识所属资源种类。值:固定字符串 |
class |
父类的继承字段的副本。执行 GET 操作期间会检索这些字段。 |
id |
必需。对象的唯一标识符。此 ID 在一个发卡机构的所有对象中必须是唯一的。此值应遵循“issuer ID”格式。identifier”格式,其中前者由 Google 提供,后者由您自行选择。该唯一标识符应仅包含字母数字字符、“.”“_”或“-”。 |
class |
必需。与此对象关联的类。该类必须与此对象属于同一类型、已存在且已获批准。 类 ID 应遵循“issuer ID.identifier”格式,其中前者由 Google 提供,后者由您自行选择。 |
version |
已弃用 |
state |
必需。对象的状态。此字段用于确定对象在应用中的显示方式。例如,系统会将 |
barcode |
条形码的类型和值。 |
messages[] |
在应用中显示的一组消息。此对象的所有用户都将收到其关联消息。这些字段的数量上限为 10。 |
valid |
此对象处于 |
locations[] |
注意:此字段目前不支持触发地理位置通知。 |
has |
指明对象是否具有用户。此字段由平台设置。 |
smart |
系统将通过 NFC 将此对象的此值传输到经过智能感应认证的终端。您还必须正确设置类级字段 |
has |
指明此对象当前是否已关联到某个设备。当用户保存对象并将其关联到自己的设备时,平台会设置此字段。此字段仅供部分合作伙伴使用。如需了解详情,请与支持团队联系。 |
disable |
指明是否明确禁止通知。如果此字段设置为 true,则无论 此属性目前仅可用于设置优惠对象。 |
info |
已弃用。请改用 textModulesData。 |
image |
图片模块数据。从对象级别开始,显示的字段数量上限为 1;对于类对象级别,上限也为 1。 |
text |
文本模块数据。如果还在类中定义了文本模块数据,则将一并显示这些数据。从对象开始,显示的字段数量上限为 10;对于类,上限也为 10。 |
links |
链接模块数据。如果还在类中定义了链接模块数据,则将一并显示这些数据。 |
app |
可选的应用或网站链接,将以按钮的形式显示在卡券正面。如果为相应的类提供了 AppLinkData,则系统只会显示对象 AppLinkData。 |
rotating |
轮播的条形码类型和值。 |
hero |
在卡片正面显示的可选横幅图片。如果没有,系统会显示课程的主打图片(如果有)。如果课程的主打图片也没有显示,则不会显示任何内容。 |
grouping |
用于控制卡券如何分组的信息。 |
pass |
传递对象的约束条件。包括限制 NFC 和屏幕截图行为。 |
save |
对对象的限制,用户在尝试保存卡券之前需要先验证该对象。请注意,此限制仅在省电模式下应用。如果用户保存卡券后限制条件发生了变化,新限制条件不会应用于已保存的卡券。 |
linked |
linkedObjectIds 是应自动附加到此优惠对象的其他对象(例如活动门票、会员卡、优惠、通用卡、礼品卡、公交卡和登机牌)的列表。如果用户已保存此优惠,系统会自动将这些 linkedObjectId 推送到用户的钱包(除非用户关闭了接收此类关联卡券的设置)。 确保已插入 linkedObjectIds 中存在的对象;如果没有,调用将会失败。关联后,关联的对象将无法解除关联。您无法关联属于其他发卡机构的对象。可关联到单个对象的对象数量是有限制的。达到此上限后,系统会静默忽略调用中的新关联对象。 对象 ID 应遵循“issuer ID.identifier”格式,其中前者由 Google 提供,后者由您自行选择。 |
notify |
是否应针对此对象触发字段更新通知。设置为 NOTIFY 时,我们会尝试向用户触发字段更新通知。只有当该字段已列入许可名单时,系统才会向用户发送此类通知。如果设置为 DO_NOT_NOTIFY 或 NOTIFICATION_SETTINGS_UNSPECIFIED,则不会触发任何通知。此设置是暂时性的,需要在每次 PATCH 或 UPDATE 请求中进行设置,否则系统不会触发通知。 |
value |
可选增值模块数据。对象上的最大值为 10。 |
方法 |
|
---|---|
|
向指定对象 ID 引用的优惠对象添加消息。 |
|
返回具有指定对象 ID 的优惠对象。 |
|
插入具有指定 ID 和属性的优惠对象。 |
|
返回指定发卡机构 ID 的所有优惠对象的列表。 |
|
更新指定对象 ID 引用的优惠对象。 |
|
更新指定对象 ID 引用的优惠对象。 |