REST 资源: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)
  }
}
字段
kind
(deprecated)

string

指明资源的种类。值:固定字符串 "walletobjects#loyaltyObject"

classReference

object (LoyaltyClass)

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

accountName

string

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

accountId

string

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

loyaltyPoints

object (LoyaltyPoints)

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

linkedOfferIds[]

string

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

优惠对象 ID 应遵循“发卡机构 ID.标识符”格式,其中前者由 Google 提供,后者由您自行选择。

secondaryLoyaltyPoints

object (LoyaltyPoints)

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

id

string

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

classId

string

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

类 ID 应遵循“<发卡机构 ID>.<标识符>”格式,其中发卡机构 ID 由 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)

可使用对象的位置的列表。平台使用此信息来触发发送给用户的地理定位通知。请注意,对象中的位置会替换类中的位置,而类中的位置又会替换 Google 商家信息 ID 中的位置。

hasUsers

boolean

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

smartTapRedemptionValue

string

仅适用于支持智能触碰技术的合作伙伴。如需更多指导,请与支持人员联系。

hasLinkedDevice

boolean

指明此对象当前是否已关联到某个设备。当用户保存对象并将其关联到自己的设备时,平台会设置此字段。此字段仅供部分合作伙伴使用。如需获取更多信息,请与支持人员联系。

disableExpirationNotification

boolean

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

此属性目前仅可用于设置优惠对象。

infoModuleData

object (InfoModuleData)

已弃用。请改用 textModulesData。

imageModulesData[]

object (ImageModuleData)

图片模块数据。从对象级别开始,显示的字段数量上限为 1;对于类对象级别,上限也为 1。

textModulesData[]

object (TextModuleData)

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

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 类型的余额。只应填充这些子类型(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 引用的会员卡对象。