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)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
字段
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[]
(deprecated)

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；对于类，上限也为 10。
rotatingBarcode

object (RotatingBarcode)

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

object (Image)

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

object (GroupingInfo)

用于控制卡券分组方式的信息。
passConstraints

object (PassConstraints)

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

object (SaveRestrictions)

对对象的限制，用户在尝试保存卡券之前需要先验证该对象。请注意，此限制仅在省电模式下应用。如果用户保存卡券后限制条件发生了变化，新限制条件不会应用于已保存的卡券。
linkedObjectIds[]

string

linkObjectIds 是应自动附加到此会员卡对象的其他对象的列表，例如活动门票、会员卡、优惠、通用、礼品卡、公交卡和登机牌。如果用户已保存此会员卡，则系统会自动将这些 linkedObjectId 推送到用户的钱包（除非用户关闭了接收此类关联卡券的设置）。

确保已插入 linkedObjectIds 中存在的对象；如果没有，调用将会失败。一旦建立关联，已关联的对象便无法解除关联。您无法关联属于其他发卡机构的对象。可与单个对象关联的对象数量存在限制。达到此上限后，系统会静默忽略调用中的新关联对象。

对象 ID 应遵循“issuer ID.identifier”格式，其中前者由 Google 提供，后者由您自行选择。
notifyPreference

enum (NotificationSettingsForUpdates)

是否应针对此对象触发字段更新通知。设置为 NOTIFY 时，我们会尝试向用户触发字段更新通知。只有当字段在许可名单内时，系统才会向用户发送这些通知。如果设置为 DO_NOT_NOTIFY 或 NOTIFICATION_SETTINGS_UNSPECIFIED，则不会触发任何通知。此设置是暂时性的，需要在每次 PATCH 或 UPDATE 请求中进行设置，否则系统不会触发通知。
valueAddedModuleData[]

object (ValueAddedModuleData)

可选增值模块数据。对象最多 10 个。

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 类型的余额。只应填充这些子类型（string、int、double、money）之一。
int

integer

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

number

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

object (Money)

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

方法

addmessage

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

get

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

insert

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

list

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

modifylinkedofferobjects

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

patch

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

update

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