REST Resource: genericclass

资源:GenericClass

通用类

JSON 表示法
{
  "id": string,
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "enableSmartTap": boolean,
  "redemptionIssuers": [
    string
  ],
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "messages": [
    {
      object (Message)
    }
  ]
}
字段
id

string

必需。类的唯一标识符。此 ID 在一个发卡机构的所有 ID 中必须是唯一的。此值需要遵循格式 issuerID.identifier,其中 issuerID 由 Google 提供,identifier 由您选择。该唯一标识符只能包含字母数字字符、._-

classTemplateInfo

object (ClassTemplateInfo)

有关应如何显示类的模板信息。如果此政策未设置,Google 将回退为显示一组默认字段。

imageModulesData[]

object (ImageModuleData)

图片模块数据。如果还在该对象中定义了 imageModulesData,则将一并显示这两项。如果两者都设置了,则仅呈现类中的一张图片和对象级的图片。

textModulesData[]

object (TextModuleData)

文本模块数据。如果还在该对象中定义了 textModulesData,则将一并显示这两项。显示的这些字段数量上限为 10 个来自类和 10 个来自对象的字段。

enableSmartTap

boolean

仅适用于支持智能触碰功能的合作伙伴。如需更多指导,请与支持团队联系。

redemptionIssuers[]

string (int64 format)

指明哪些兑换发卡机构可以通过智能触碰兑换卡券。兑换发卡机构由其发卡机构 ID 进行标识。兑换发卡机构必须至少配置一个智能触碰密钥。

此外,还必须正确设置 enableSmartTap 和对象级 smartTapRedemptionLevel 字段,才能让卡券支持智能触碰。

securityAnimation

object (SecurityAnimation)

有关安全动画的可选信息。如果已设置,系统会在卡券详情中呈现安全动画。

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

指明是否允许多个用户和设备保存引用此类的同一对象。

callbackOptions

object (CallbackOptions)

回调选项,用于在最终用户每次保存/删除此类的对象时回调发卡机构。此类的所有对象都可以进行回调。

viewUnlockRequirement

enum (ViewUnlockRequirement)

查看通用卡券的解锁要求选项。

messages[]

object (Message)

应用中显示的一组消息。此对象的所有用户都将收到其相关消息。这些字段的数量上限为 10。

方法

addmessage

向指定类 ID 引用的通用类添加消息。

get

返回具有指定类 ID 的通用类。

insert

插入具有指定 ID 和属性的通用类。

list

返回指定发卡机构 ID 的所有通用类的列表。

patch

更新指定类 ID 引用的通用类。

update

更新指定类 ID 引用的通用类。