REST Resource: loyaltyclass

资源:LoyaltyClass

JSON 表示法
{
  "kind": string,
  "programName": string,
  "programLogo": {
    object (Image)
  },
  "accountNameLabel": string,
  "accountIdLabel": string,
  "rewardsTierLabel": string,
  "rewardsTier": string,
  "localizedProgramName": {
    object (LocalizedString)
  },
  "localizedAccountNameLabel": {
    object (LocalizedString)
  },
  "localizedAccountIdLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTierLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTier": {
    object (LocalizedString)
  },
  "secondaryRewardsTierLabel": string,
  "localizedSecondaryRewardsTierLabel": {
    object (LocalizedString)
  },
  "secondaryRewardsTier": string,
  "localizedSecondaryRewardsTier": {
    object (LocalizedString)
  },
  "discoverableProgram": {
    object (DiscoverableProgram)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideProgramLogo": {
    object (Image)
  }
}
字段
kind
(deprecated)

string

标识这是哪类资源。值:固定字符串 "walletobjects#loyaltyClass"

programName

string

必需。计划名称,例如“亚当服饰”。应用可能会在前 20 个字符后显示省略号,以确保字符串能在较小的屏幕上完整显示。

accountNameLabel

string

帐号名称标签,例如“成员名称”。建议的最大长度为 15 个字符,以确保字符串能在较小的屏幕上完整显示。

accountIdLabel

string

帐号 ID 标签,例如“会员 ID”。建议的最大长度为 15 个字符,以确保字符串能在较小的屏幕上完整显示。

rewardsTierLabel

string

奖励层级标签,例如“奖励层级”。建议的最大长度为 9 个字符,以确保字符串能在较小的屏幕上完整显示。

rewardsTier

string

奖励层级,例如“黄金”或“白金”。建议的最大长度为 7 个字符,以确保字符串能在较小的屏幕上完整显示。

localizedProgramName

object (LocalizedString)

已翻译的 programName 字符串。应用可能会在前 20 个字符后显示省略号,以确保字符串能在较小的屏幕上完整显示。

localizedAccountNameLabel

object (LocalizedString)

已翻译的 accountNameLabel 字符串。建议的最大长度为 15 个字符,以确保字符串能在较小的屏幕上完整显示。

localizedAccountIdLabel

object (LocalizedString)

已翻译的 accountIdLabel 字符串。建议的最大长度为 15 个字符,以确保字符串能在较小的屏幕上完整显示。

localizedRewardsTierLabel

object (LocalizedString)

已翻译的 RewardsTierLabel 字符串。建议的最大长度为 9 个字符,以确保字符串能在较小的屏幕上完整显示。

localizedRewardsTier

object (LocalizedString)

已翻译的 RewardsTier 字符串。建议的最大长度为 7 个字符,以确保字符串能在较小的屏幕上完整显示。

secondaryRewardsTierLabel

string

辅助奖励层级标签,例如“奖励层级”。

localizedSecondaryRewardsTierLabel

object (LocalizedString)

已翻译的 secondaryRewardsTierLabel 字符串。

secondaryRewardsTier

string

辅助奖励层级,例如“黄金”或“白金”。

localizedSecondaryRewardsTier

object (LocalizedString)

已翻译的 secondaryRewardsTier 字符串。

discoverableProgram

object (DiscoverableProgram)

有关如何在 Google Pay 应用中发现和实例化该类的信息。

classTemplateInfo

object (ClassTemplateInfo)

有关应如何显示类的模板信息。如果未设置此政策,Google 将回退到显示一组默认字段。

id

string

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

version
(deprecated)

string (int64 format)

已弃用

issuerName

string

必需。发卡机构名称。建议的最大长度为 20 个字符,以确保字符串能在较小的屏幕上完整显示。

messages[]

object (Message)

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

allowMultipleUsersPerObject
(deprecated)

boolean

已弃用。请改用 multipleDevicesAndHoldersAllowedStatus

homepageUri

object (Uri)

应用首页的 URI。在此字段中填充 URI 与在 linksModuleData 中填充 URI 的效果完全相同(在呈现对象时,显示指向首页的链接通常被视为该对象的 linksModuleData 部分)。

locations[]

object (LatLongPoint)

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

reviewStatus

enum (ReviewStatus)

必需。类的状态。此字段可通过插入、修补或更新 API 调用设置为 draftunderReview。审核状态从 draft 更改为其他状态后,便无法再改回 draft

如果该类尚在开发中,您应将此字段保留为 draftdraft 类不能用于创建任何对象。

如果您认为该类可供使用,则应将此字段设置为 underReview。平台会自动将此字段设置为 approved,它可以立即用于创建或迁移对象。

更新 approved 类时,您应将此字段始终设置为 underReview

review

object (Review)

当某个类被标记为 approvedrejected 时,由平台设置的评价备注。

infoModuleData
(deprecated)

object (InfoModuleData)

已弃用。请改用 textModulesData。

imageModulesData[]

object (ImageModuleData)

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

textModulesData[]

object (TextModuleData)

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

redemptionIssuers[]

string (int64 format)

指明哪些兑换发卡机构可以通过智能触碰功能兑换卡券。兑换发卡机构由其发卡机构 ID 进行标识。兑换发卡机构必须至少配置一个智能触碰密钥。

此外,还必须正确设置 enableSmartTap 字段以及对象级 smartTapRedemptionValue barcode.value, oraccountId` 字段之一,卡券才能支持智能触碰。

countryCode

string

国家/地区代码,用于在用户不在该国家/地区时显示卡片所在的国家/地区,以及在用户的语言区域未推出该内容时显示本地化内容。

heroImage

object (Image)

在卡片正面显示的可选横幅图片。如果不存在,则不会显示任何内容。图片将以 100% 宽度显示。

wordMark
(deprecated)

object (Image)

已弃用。

enableSmartTap

boolean

标识此类是否支持智能触碰。此外,还必须正确设置 redemptionIssuers 字段以及对象级 smartTapRedemptionLevel barcode.value, or accountId` 字段之一,卡券才能支持智能触碰。

hexBackgroundColor

string

卡片的背景颜色。如果未设置,则系统会使用主打图片的正文色;如果未设置主打图片,则使用徽标的正文色。格式为 #rrggbb,其中 rrggbb 是十六进制 RGB 三元组,例如 #ffcc00。您也可以使用 RGB 三元组的简写版本(即 #rgb),例如 #fc0

localizedIssuerName

object (LocalizedString)

已翻译的 issuerName 字符串。建议的最大长度为 20 个字符,以确保字符串能在较小的屏幕上完整显示。

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

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

callbackOptions

object (CallbackOptions)

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

securityAnimation

object (SecurityAnimation)

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

viewUnlockRequirement

enum (ViewUnlockRequirement)

查看会员卡的解锁要求选项。

DiscoverableProgram

有关如何在 Android Pay 应用中发现并实例化某个类的信息。搜索会员卡或礼品卡计划,然后扫描或手动输入。

JSON 表示法
{
  "merchantSignupInfo": {
    object (DiscoverableProgramMerchantSignupInfo)
  },
  "merchantSigninInfo": {
    object (DiscoverableProgramMerchantSigninInfo)
  },
  "state": enum (State)
}
字段
merchantSignupInfo

object (DiscoverableProgramMerchantSignupInfo)

有关能否通过商家网站注册加入此计划并添加有价卡券的信息。在启用 MERCHANT_HOSTED_SIGNUP 的情况下使用。

merchantSigninInfo

object (DiscoverableProgramMerchantSigninInfo)

有关能否通过商家网站登录此计划并添加有价卡券的信息。在启用 MERCHANT_HOSTED_SIGNIN 的情况下使用。

state

enum (State)

可发现的计划的公开范围状态。

DiscoverableProgramMerchantSignupInfo

有关商家自管的计划注册流程的信息。

JSON 表示法
{
  "signupWebsite": {
    object (Uri)
  },
  "signupSharedDatas": [
    enum (SharedDataType)
  ]
}
字段
signupWebsite

object (Uri)

用于将用户定向至商家注册网站的网址。

signupSharedDatas[]

enum (SharedDataType)

通过 POST 请求发送到注册网站网址的用户数据。系统会对此信息进行编码并共享,以便商家网站可以预填充用户注册加入可发现计划时使用的字段。

SharedDataType

枚举
SHARED_DATA_TYPE_UNSPECIFIED
FIRST_NAME
LAST_NAME
STREET_ADDRESS 单行地址字段
ADDRESS_LINE_1 多行地址字段
ADDRESS_LINE_2
ADDRESS_LINE_3
CITY
STATE
ZIPCODE
COUNTRY
EMAIL
PHONE

DiscoverableProgramMerchantSigninInfo

有关商家托管的计划登录流程的信息。

JSON 表示法
{
  "signinWebsite": {
    object (Uri)
  }
}
字段
signinWebsite

object (Uri)

用于将用户定向至商家登录网站的网址。

状态

枚举
STATE_UNSPECIFIED
TRUSTED_TESTERS 仅对有权访问发卡机构帐号的测试人员显示。
trustedTesters

TRUSTED_TESTERS 的旧别名,已弃用。

LIVE 所有人都可以看到。
live

LIVE 的旧别名,已弃用。

DISABLED 不显示。
disabled

DISABLED 的旧别名,已弃用。

方法

addmessage

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

get

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

insert

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

list

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

patch

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

update

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