资源:GiftCardClass
| JSON 表示法 | 
|---|
| { "kind": string, "merchantName": string, "programLogo": { object ( | 
| 字段 | |
|---|---|
| kind | 
 表明这是哪类资源。值:固定字符串  | 
| merchantName | 
 商家名称,例如“Adam's Apparel”。应用可能会在前 20 个字符后显示省略号,以确保字符串能在较小的屏幕上完整显示。 | 
| programLogo | 
 礼品卡计划或公司的徽标。此徽标显示在应用的详细信息和列表视图中。 | 
| pinLabel | 
 用于显示 PIN 码的标签,例如“4 位数 PIN 码”。 | 
| eventNumberLabel | 
 用于显示活动编号的标签,例如“目标活动编号”。 | 
| allowBarcodeRedemption | 
 确定商家是否支持使用条形码兑换礼品卡。如果为 true,应用会在“礼品卡详细信息”屏幕上显示礼品卡的条形码。如果为 false,则不会显示条形码。 | 
| localizedMerchantName | 
 已翻译的 merchantName 字符串。应用可能会在前 20 个字符后显示省略号,以确保字符串能在较小的屏幕上完整显示。 | 
| localizedPinLabel | 
 已翻译的 pinLabel 字符串。 | 
| localizedEventNumberLabel | 
 已翻译的 eventNumberLabel 字符串。 | 
| cardNumberLabel | 
 用于显示卡号的标签,例如“卡号”。 | 
| localizedCardNumberLabel | 
 已翻译的 cardNumberLabel 字符串。 | 
| classTemplateInfo | 
 有关应如何显示类的模板信息。如果未设置,Google 将回退为显示默认字段集。 | 
| id | 
 必需。类的唯一标识符。此 ID 在一个发卡机构的所有类中必须是唯一的。此值应遵循 issuer ID 格式。identifier”格式,其中前者由 Google 提供,后者由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”“_”或“-”。 | 
| version | 
 已弃用 | 
| issuerName | 
 必需。发卡机构名称。建议的最大长度为 20 个字符,以确保字符串能在较小的屏幕上完整显示。 | 
| messages[] | 
 在应用中显示的一组消息。此对象的所有用户都将收到其关联消息。这些字段的数量上限为 10。 | 
| allowMultipleUsersPerObject | 
 已弃用。请改用  | 
| homepageUri | 
 应用首页的 URI。在此字段中填充 URI 的效果与在 linksModuleData 中填充 URI 的效果完全相同(在呈现对象时,显示的首页链接通常被认为是该对象的 linksModuleData 部分)。 | 
| locations[] | 
 注意:此字段目前不支持触发地理位置通知。 | 
| reviewStatus | 
 必需。类的状态。此字段可通过插入、修补或更新 API 调用设置为  如果该类尚在开发中,您应将此字段保留为  如果您认为该类可以随时使用,您应将此字段设置为  更新已设为  | 
| review | 
 当某个类被标记为  | 
| infoModuleData | 
 已弃用。请改用 textModulesData。 | 
| imageModulesData[] | 
 图片模块数据。从对象级别开始,显示的字段数量上限为 1;对于类对象级别,上限也为 1。 | 
| textModulesData[] | 
 文本模块数据。如果还在类中定义了文本模块数据,则将一并显示这些数据。从对象开始,显示的字段数量上限为 10;对于类,上限也为 10。 | 
| linksModuleData | 
 链接模块数据。如果还在对象中定义了链接模块数据,则将一并显示这些数据。 | 
| redemptionIssuers[] | 
 用于标识哪些兑换发卡机构可以通过智能感应功能兑换卡券。兑换发卡机构通过其发卡机构 ID 进行标识。兑换发行商必须至少配置一个 Smart Tap 键。 此外,还必须正确设置  | 
| countryCode | 
 国家/地区代码,用于在用户不在该国家/地区时显示发卡国家/地区,以及在用户的语言区域未推出该内容时显示本地化的内容。 | 
| heroImage | 
 在卡片正面显示的可选横幅图片。如果不存在,则不会显示任何内容。图片将以 100% 宽度显示。 | 
| wordMark | 
 已弃用。 | 
| enableSmartTap | 
 确定此类是否支持智能感应。此外,还必须正确设置  | 
| hexBackgroundColor | 
 卡片的背景颜色。如果未设置,则使用主打图片的正文色;如果未设置主打图片,则使用徽标的正文色。格式为 #rrggbb,其中 rrggbb 为十六进制 RGB 三元组,例如  | 
| localizedIssuerName | 
 已翻译的 issuerName 字符串。建议的最大长度为 20 个字符,以确保字符串能在较小的屏幕上完整显示。 | 
| multipleDevicesAndHoldersAllowedStatus | 
 指明是否允许多个用户和设备保存引用该类的同一个对象。 | 
| callbackOptions | 
 回调选项,用于在最终用户每次保存/删除此类的对象时回调发卡机构。此类的所有对象都可进行回调。 | 
| securityAnimation | 
 有关安全动画的可选信息。如果设置此属性,系统会在卡券详情中呈现安全动画。 | 
| viewUnlockRequirement | 
 查看礼品卡的“解锁要求”选项。 | 
| wideProgramLogo | 
 礼品卡计划或公司的宽幅徽标。如果提供,此图片将替代卡片视图左上角的计划徽标。 | 
| notifyPreference | 
 是否应针对此类触发字段更新通知。设置为 NOTIFY 时,我们会尝试向用户触发字段更新通知。只有当该字段已列入许可名单时,系统才会向用户发送这些通知。如果未指定,则不会触发任何通知。此设置是暂时性的,需要在每次 PATCH 或 UPDATE 请求中进行设置,否则系统不会触发通知。 | 
| appLinkData | 
 可选的应用或网站链接,将以按钮的形式显示在卡券正面。如果为相应对象提供了 AppLinkData,则系统会改用该 AppLinkData。 | 
| valueAddedModuleData[] | 
 添加了可选值模块数据。每门课程最多 10 人。对于一次传递,系统只会显示 10 个错误,并优先显示来自对象的错误。 | 
| merchantLocations[] | 
 商家营业地点。一个课程最多只能有 10 名学生。超出 10 个的任何其他 MerchantLocation 都将被拒绝。当用户进入 Google 设置的点周围半径范围内时,这些位置会触发通知。此字段取代了已废弃的 LatLongPoints。 | 
| 方法 | |
|---|---|
| 
 | 向指定类 ID 引用的礼品卡类添加消息。 | 
| 
 | 返回具有指定类 ID 的礼品卡类。 | 
| 
 | 插入具有指定 ID 和属性的礼品卡类。 | 
| 
 | 返回指定发卡机构 ID 的所有礼品卡类的列表。 | 
| 
 | 更新指定类 ID 引用的礼品卡类。 | 
| 
 | 更新指定类 ID 引用的礼品卡类。 | 
