REST 资源:offerobject

资源:OfferObject

JSON 表示法

{
  "kind": string,
  "classReference": {
    object (OfferClass)
  },
  "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#offerObject"

classReference

object (OfferClass)

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

id

string

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

classId

string

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

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

version
(deprecated)

string (int64 format)

已弃用

state

enum (State)

对象的状态。此字段用于确定对象在应用中的显示方式。例如,inactive 对象不会再在 Google Pay 应用中显示。

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。

textModulesData[]

object (TextModuleData)

文本模块数据。如果还在类中定义了文本模块数据,则将一并显示这些数据。这些字段(与类组合使用)的数量上限为 10。

方法

addmessage

向给定对象 ID 引用的优惠对象添加消息。

get

返回具有给定对象 ID 的优惠对象。

insert

插入具有给定 ID 和属性的优惠对象。

list

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

patch

更新给定对象 ID 引用的优惠对象。

update

更新给定对象 ID 引用的优惠对象。