REST 资源:giftcardclass

资源:GiftCardClass

JSON 表示法

{
  "kind": string,
  "merchantName": string,
  "programLogo": {
    object (Image)
  },
  "pinLabel": string,
  "eventNumberLabel": string,
  "allowBarcodeRedemption": boolean,
  "localizedMerchantName": {
    object (LocalizedString)
  },
  "localizedPinLabel": {
    object (LocalizedString)
  },
  "localizedEventNumberLabel": {
    object (LocalizedString)
  },
  "cardNumberLabel": string,
  "localizedCardNumberLabel": {
    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)
  }
}
字段
kind
(deprecated)

string

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

merchantName

string

商家名称,例如“Adam's Apparel”。应用可能会在前 20 个字符后显示省略号,以确保字符串能在较小的屏幕上完整显示。

pinLabel

string

用于显示 PIN 码的标签,例如“4 位数 PIN 码”。

eventNumberLabel

string

用于显示活动编号的标签,例如“目标活动编号”。

allowBarcodeRedemption

boolean

确定商家是否支持使用条形码兑换礼品卡。如果为 true,应用会在“礼品卡详细信息”屏幕上显示礼品卡的条形码。如果为 false,则不会显示条形码。

localizedMerchantName

object (LocalizedString)

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

localizedPinLabel

object (LocalizedString)

已翻译的 pinLabel 字符串。

localizedEventNumberLabel

object (LocalizedString)

已翻译的 eventNumberLabel 字符串。

cardNumberLabel

string

用于显示卡号的标签,例如“卡号”。

localizedCardNumberLabel

object (LocalizedString)

已翻译的 cardNumberLabel 字符串。

classTemplateInfo

object (ClassTemplateInfo)

有关应如何显示类的模板信息。 如果未设置,Google 将回退为显示默认字段集。

id

string

必选。类的唯一标识符。此 ID 在一个发卡机构的所有类中必须是唯一的。此值应遵循“issuer ID.identifier”格式,其中发卡机构 ID 由 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)

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

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;对于类,上限也为 10。

redemptionIssuers[]

string (int64 format)

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

countryCode

string

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

heroImage

object (Image)

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

wordMark
(deprecated)

object (Image)

已弃用。

enableSmartTap

boolean

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

hexBackgroundColor

string

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

localizedIssuerName

object (LocalizedString)

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

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

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

callbackOptions

object (CallbackOptions)

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

方法

addmessage

向指定类 ID 引用的礼品卡类添加消息。

get

返回具有指定类 ID 的礼品卡类。

insert

插入具有指定 ID 和属性的礼品卡类。

list

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

patch

更新指定类 ID 引用的礼品卡类。

update

更新指定类 ID 引用的礼品卡类。