REST Resource: loyaltyobject

资源:LoyaltyObject

JSON 表示法
{
  "kind": string,
  "classReference": {
    object (LoyaltyClass)
  },
  "accountName": string,
  "accountId": string,
  "loyaltyPoints": {
    object (LoyaltyPoints)
  },
  "linkedOfferIds": [
    string
  ],
  "secondaryLoyaltyPoints": {
    object (LoyaltyPoints)
  },
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  }
}
字段
kind
(deprecated)

string

标识这是什么资源类型。值:固定字符串 "walletobjects#loyaltyObject"

classReference

object (LoyaltyClass)

父类的继承字段的副本。执行 GET 操作期间会检索这些字段。

accountName

string

会员帐号持有人姓名,例如“李明”。建议的最大长度为 20 个字符,以确保字符串能在较小的屏幕上完整显示。

accountId

string

会员帐号标识符。建议的长度上限为 20 个字符。

loyaltyPoints

object (LoyaltyPoints)

会员奖励积分的标签、余额和类型。

linkedOfferIds[]

string

与此会员卡关联的优惠对象的列表。优惠对象必须已存在。

优惠对象 ID 应遵循 issuer ID 格式。identifier,其中前者由 Google 提供,后者由您自行选择。

secondaryLoyaltyPoints

object (LoyaltyPoints)

次要会员卡奖励积分的标签、余额和类型。与主要积分一起显示。

id

string

必需。对象的唯一标识符。此 ID 在一个发卡机构的所有对象中必须是唯一的。此值应遵循 issuer ID 格式。identifier,其中前者由 Google 提供,后者由您自行选择。该唯一标识符应仅包含字母数字字符、“.”“_”或“-”。

classId

string

必需。与此对象关联的类。该类必须与此对象具有相同的类型、必须已存在且已获得批准。

类 ID 应遵循 issuer ID 格式。identifier,其中前者由 Google 提供,后者由您自行选择。

version
(deprecated)

string (int64 format)

已弃用

state

enum (State)

必需。对象的状态。此字段用于确定对象在应用中的显示方式。例如,系统会将 inactive 对象移至“过期卡券”部分。

barcode

object (Barcode)

条形码的类型和值。

messages[]

object (Message)

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

validTimeInterval

object (TimeInterval)

此对象处于 active 状态且可供使用的时间段。这段时间过后,对象的状态将更改为 expired

locations[]

object (LatLongPoint)

注意:目前不支持使用此字段触发地理位置通知。

hasUsers

boolean

指明对象是否具有用户。此字段由平台设置。

smartTapRedemptionValue

string

将针对此对象通过 NFC 传输到智能触碰认证终端的值。此外,还必须正确设置类级字段 enableSmartTapredemptionIssuers,才能使卡券支持智能触碰。仅支持 ASCII 字符。

如果未设置此值,但类级字段 enableSmartTapredemptionIssuers 已正确设置,则 barcode.valueaccountId 字段将用作后备字段(如果存在)。

hasLinkedDevice

boolean

此对象当前是否已关联到单个设备。当用户保存对象并将其关联到自己的设备时,平台会设置此字段。仅供部分合作伙伴使用。如需了解详情,请与支持团队联系。

disableExpirationNotification

boolean

指明是否应明确禁止通知。如果此字段设为 true,则无论 messages 字段为何,系统都会禁止向用户发出失效通知。默认情况下,此字段设置为 false。

目前,您只能为优惠设置此属性。

infoModuleData

object (InfoModuleData)

已弃用。请改用 textModulesData。

imageModulesData[]

object (ImageModuleData)

图片模块数据。对于对象级别,显示的这些字段的最大数量为 1 个;对于类对象级别,显示的数量上限为 1。

textModulesData[]

object (TextModuleData)

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

rotatingBarcode

object (RotatingBarcode)

轮换的条形码类型和值。

heroImage

object (Image)

在卡片正面显示的可选横幅图片。如果没有,则显示课程的主打图片(如果存在)。如果课程的主打图片也不存在,则不会显示任何内容。

groupingInfo

object (GroupingInfo)

用于控制卡券如何分组的信息。

passConstraints

object (PassConstraints)

传递对象的约束条件。包括限制 NFC 和屏幕截图行为。

LoyaltyPoints

JSON 表示法
{
  "label": string,
  "balance": {
    object (LoyaltyPointsBalance)
  },
  "localizedLabel": {
    object (LocalizedString)
  }
}
字段
label

string

积分标签,例如“积分”。建议的长度上限为 9 个字符。

balance

object (LoyaltyPointsBalance)

帐号持有人的积分余额,例如“500”或“10.00 美元”。建议的长度上限为 7 个字符。对于 loyaltyPointssecondaryLoyaltyPoints,此字段是必填字段。

localizedLabel

object (LocalizedString)

已翻译的标签字符串。建议的长度上限为 9 个字符。

LoyaltyPointsBalance

JSON 表示法
{
  "string": string,
  "int": integer,
  "double": number,
  "money": {
    object (Money)
  }
}
字段
string

string

余额的字符串形式。只应填充这些子类型(string、int、double、money)之一。

int

integer

余额的整数形式。只应填充这些子类型(string、int、double、money)之一。

double

number

double 类型的余额。只应填充这些子类型(string、int、double、money)之一。

money

object (Money)

余额的货币形式。只应填充这些子类型(string、int、double、money)之一。

方法

addmessage

向指定对象 ID 引用的会员卡对象添加消息。

get

返回具有指定对象 ID 的会员卡对象。

insert

插入具有指定 ID 和属性的会员卡对象。

list

返回指定发卡机构 ID 的所有会员卡对象的列表。

modifylinkedofferobjects

修改具有指定 ID 的会员卡对象的关联优惠对象。

patch

更新指定对象 ID 引用的会员卡对象。

update

更新指定对象 ID 引用的会员卡对象。