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)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  }
}
字段
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 传输到智能触碰认证终端的值。此外，还必须正确设置类级字段 enableSmartTap 和 redemptionIssuers，卡券才支持智能触碰。仅支持 ASCII 字符。

如果未设置此值，但类级字段 enableSmartTap 和 redemptionIssuers 设置正确，则 barcode.value 或 accountId 字段将用作后备字段（如果存在）。
hasLinkedDevice

boolean

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

boolean

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

目前，只能为优惠设置此字段。
infoModuleData

object (InfoModuleData)

已弃用。请改用 textModulesData。
imageModulesData[]

object (ImageModuleData)

图片模块数据。从对象级别开始，显示的字段数量上限为 1；对于类对象级别，则最多只能显示 1 个字段。
textModulesData[]

object (TextModuleData)

文本模块数据。如果还在类中定义了文本模块数据，则将一并显示这些数据。对于对象和类，这些字段最多可显示 10 个。
rotatingBarcode

object (RotatingBarcode)

轮播的条形码类型和值。
heroImage

object (Image)

在卡片正面显示的可选横幅图片。如果没有，则会显示课程的主打图片（如果有）。如果课程的主打图片也没有显示，则不会显示任何内容。
groupingInfo

object (GroupingInfo)

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

object (PassConstraints)

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

object (SaveRestrictions)

针对需要在用户尝试保存卡券之前验证的对象的限制。请注意，此限制仅在保存时间内适用。如果在用户保存卡券后限制发生变化，新的限制将不会应用于已保存的卡券。

LoyaltyPoints

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

string

积分标签，例如“积分”。建议的最大长度为 9 个字符。
balance

object (LoyaltyPointsBalance)

账号持有人的积分余额，例如“500”或“$10.00”。建议的最大长度为 7 个字符。对于 loyaltyPoints 和 secondaryLoyaltyPoints，此字段是必填字段。
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 引用的会员卡对象。