REST Resource: offerclass

资源：OfferClass

JSON 表示法 
{
  "kind": string,
  "title": string,
  "redemptionChannel": enum (RedemptionChannel),
  "provider": string,
  "titleImage": {
    object (Image)
  },
  "details": string,
  "finePrint": string,
  "helpUri": {
    object (Uri)
  },
  "localizedTitle": {
    object (LocalizedString)
  },
  "localizedProvider": {
    object (LocalizedString)
  },
  "localizedDetails": {
    object (LocalizedString)
  },
  "localizedFinePrint": {
    object (LocalizedString)
  },
  "shortTitle": string,
  "localizedShortTitle": {
    object (LocalizedString)
  },
  "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),
  "wideTitleImage": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
字段
kind
(deprecated)

string

表明这是哪类资源。值：固定字符串 "walletobjects#offerClass"。
title

string

必需。优惠的标题，例如“购买任一件 T 恤衫八折优惠”。建议的最大长度为 60 个字符，以确保字符串能在较小的屏幕上完整显示。
redemptionChannel

enum (RedemptionChannel)

必需。适用于此优惠的兑换渠道。
provider

string

必需。优惠提供方（集合商家名称或商家名称）。建议的最大长度为 12 个字符，以确保字符串能在较小的屏幕上完整显示。
titleImage

object (Image)

优惠的标题图片。此图片将显示在应用的详细信息视图和列表视图中。
details

string

优惠详情。
finePrint

string

优惠的细则或条款，例如“在亚当服饰店购买任意一件 T 恤即享八折优惠”。
helpUri

object (Uri)

优惠的帮助链接，例如 http://myownpersonaldomain.com/help
localizedTitle

object (LocalizedString)

已翻译的标题字符串。建议的最大长度为 60 个字符，以确保字符串能在较小的屏幕上完整显示。
localizedProvider

object (LocalizedString)

已翻译的提供方字符串。建议的最大长度为 12 个字符，以确保字符串能在较小的屏幕上完整显示。
localizedDetails

object (LocalizedString)

已翻译的详情字符串。
localizedFinePrint

object (LocalizedString)

已翻译的 finePrint 字符串。
shortTitle

string

优惠的标题简写形式，例如“八折优惠”，供用户快速了解大致优惠内容。建议的最大长度为 20 个字符。
localizedShortTitle

object (LocalizedString)

已翻译的短标题字符串。建议的最大长度为 20 个字符。
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[]
(deprecated)

object (LatLongPoint)

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

enum (ReviewStatus)

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

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

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

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

object (Review)

当某个类被标记为 approved 或 rejected 时，由平台设置的评论注释。
infoModuleData
(deprecated)

object (InfoModuleData)

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

object (ImageModuleData)

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

object (TextModuleData)

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

string (int64 format)

用于标识哪些兑换发卡机构可以通过智能感应功能兑换卡券。兑换发卡机构通过其发卡机构 ID 进行标识。兑换发行商必须至少配置一个 Smart Tap 键。

此外，还必须正确设置 enableSmartTap 和对象级 smartTapRedemptionLevel 字段，才能支持智能感应式付款。
countryCode

string

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

object (Image)

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

object (Image)

已弃用。
enableSmartTap

boolean

确定此类是否支持智能感应。此外，还必须正确设置 redemptionIssuers 和对象级 smartTapRedemptionLevel 字段，才能支持智能感应式付款。
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)

查看相应优惠的“解锁要求”选项。
wideTitleImage

object (Image)

优惠的宽幅标题图片。如果提供，此图片将替代卡片视图左上角的标题图片。
notifyPreference

enum (NotificationSettingsForUpdates)

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

object (ValueAddedModuleData)

添加了可选值模块数据。每门课程最多 10 人。对于一次传递，系统只会显示 10 个错误，并优先显示来自对象的错误。

RedemptionChannel

枚举
REDEMPTION_CHANNEL_UNSPECIFIED
INSTORE
instore

INSTORE 的旧别名。已弃用。
ONLINE
online

ONLINE 的旧别名。已弃用。
BOTH
both

BOTH 的旧别名。已弃用。
TEMPORARY_PRICE_REDUCTION
temporaryPriceReduction

TEMPORARY_PRICE_REDUCTION 的旧别名。已弃用。

方法

addmessage

 向指定类 ID 引用的优惠类添加消息。

get

 返回具有指定类 ID 的优惠类。

insert

 插入具有指定 ID 和属性的优惠类。

list

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

patch

 更新指定类 ID 引用的优惠类。

update

 更新指定类 ID 引用的优惠类。