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)
    }
  ],
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
字段
id

string

必需。类的唯一标识符。此 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 进行标识。兑换发行商必须至少配置一个 Smart Tap 键。

此外,还必须正确设置 enableSmartTap 和对象级 smartTapRedemptionLevel 字段,才能支持智能感应式付款。

securityAnimation

object (SecurityAnimation)

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

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

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

callbackOptions

object (CallbackOptions)

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

viewUnlockRequirement

enum (ViewUnlockRequirement)

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

messages[]

object (Message)

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

valueAddedModuleData[]

object (ValueAddedModuleData)

添加了可选值模块数据。每门课程最多 10 人。对于一次传递,系统只会显示 10 个错误,并优先显示来自对象的错误。

方法

addmessage

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

get

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

insert

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

list

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

patch

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

update

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