REST Resource: genericobject

资源：GenericObject

通用对象

JSON 表示法 
{
  "genericType": enum (GenericType),
  "cardTitle": {
    object (LocalizedString)
  },
  "subheader": {
    object (LocalizedString)
  },
  "header": {
    object (LocalizedString)
  },
  "logo": {
    object (Image)
  },
  "hexBackgroundColor": string,
  "notifications": {
    object (Notifications)
  },
  "id": string,
  "classId": string,
  "barcode": {
    object (Barcode)
  },
  "heroImage": {
    object (Image)
  },
  "validTimeInterval": {
    object (TimeInterval)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "smartTapRedemptionValue": string,
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "state": enum (State),
  "hasUsers": boolean,
  "messages": [
    {
      object (Message)
    }
  ],
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ],
  "linkedObjectIds": [
    string
  ]
}
字段
genericType

enum (GenericType)

指定卡片所属的 GenericType。
cardTitle

object (LocalizedString)

必需。卡券的标头。这通常是商家名称，例如“XXX 健身房”“AAA 保险”。此字段是必填字段，会显示在卡券顶部的标题行中。
subheader

object (LocalizedString)

卡券的标题标签，例如此卡券的适用地点。显示在卡券详情视图的标题行中标题正上方。
header

object (LocalizedString)

必需。卡券的标题，例如“7 折优惠券”“图书卡”或“代金券”。此字段是必填字段，会显示在卡券详情视图的标题行中。
hexBackgroundColor

string

卡片的背景颜色。如果未设置，则使用主打图片的正文色；如果未设置主打图片，则使用徽标的正文色；如果未设置徽标，则 Google 会选择一种颜色。
notifications

object (Notifications)

为此对象启用的通知设置。
id

string

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

string

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

类 ID 应遵循“issuerID.identifier”格式，其中 issuerID 由 Google 提供，identifier 由您自行选择。
barcode

object (Barcode)

条形码的类型和值。如果卡券没有条形码，我们可以允许发卡机构设置 Barcode.alternate_text 并仅显示该值。
heroImage

object (Image)

在卡片正面显示的横幅图片（如果有）。图片将以 100% 宽度显示。
validTimeInterval

object (TimeInterval)

此对象被视为有效或可供使用的时段。超过该时间段后，系统会将该对象视为已过期，这会影响用户设备上的呈现效果。
imageModulesData[]

object (ImageModuleData)

图片模块数据。如果设置了类和对象级图片，系统仅会渲染其中一张图片。
textModulesData[]

object (TextModuleData)

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

object (GroupingInfo)

用于控制卡券分组方式的信息。
smartTapRedemptionValue

string

系统将通过 NFC 将此对象的此值传输到经过智能感应认证的终端。您还必须正确设置类级字段 enableSmartTap 和 redemptionIssuers，才能让卡券支持智能感应。仅支持 ASCII 字符。
rotatingBarcode

object (RotatingBarcode)

轮播的条形码设置/详细信息。
state

enum (State)

对象的状态。此字段用于确定对象在应用中的显示方式。例如，系统会将 inactive 对象移至“过期卡券”部分。如果未提供此值，系统会将对象视为 ACTIVE。
hasUsers

boolean

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

object (Message)

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

object (PassConstraints)

为对象传递约束条件。包括限制 NFC 和屏幕截图行为。
saveRestrictions

object (SaveRestrictions)

对对象的限制，用户在尝试保存卡券之前需要先验证该对象。请注意，此限制仅在保存时间内适用。如果在用户保存卡券后限制发生变化，新的限制将不会应用于已保存的卡券。
valueAddedModuleData[]

object (ValueAddedModuleData)

添加了可选值模块数据。对象最多 10 个。
linkedObjectIds[]

string

linkObjectIds 是应自动附加到此泛型对象的其他对象（例如活动门票、会员卡、优惠、通用、礼品卡、公交卡和登机牌）的列表。如果用户保存了此通用卡券，系统会自动将这些 linkedObjectId 推送到用户的钱包（除非用户关闭了接收此类关联卡券的设置）。

确保“linkedObjectIds”中存在的对象已插入，否则，调用将会失败。关联后，关联的对象将无法解除关联。您无法关联属于其他发卡机构的对象。可关联到单个对象的对象数量是有限制的。达到此上限后，系统会静默忽略调用中的新关联对象。

对象 ID 应遵循“issuer ID.identifier”格式，其中前者由 Google 提供，后者由您自行选择。

GenericType

通用卡片的类型。

枚举
GENERIC_TYPE_UNSPECIFIED 未指定的泛型类型。
GENERIC_SEASON_PASS 季票
GENERIC_UTILITY_BILLS 公共事业缴费单
GENERIC_PARKING_PASS 停车卡
GENERIC_VOUCHER Voucher
GENERIC_GYM_MEMBERSHIP 健身房会员卡
GENERIC_LIBRARY_MEMBERSHIP 图书馆会员卡
GENERIC_RESERVATIONS 预留
GENERIC_AUTO_INSURANCE 汽车保险卡
GENERIC_HOME_INSURANCE 住宅保险卡
GENERIC_ENTRY_TICKET 门票
GENERIC_RECEIPT 收据
GENERIC_LOYALTY_CARD 会员卡。请注意，建议使用专用会员卡卡券类型，而不是此通用类型。与通用卡券类型相比，专用会员卡卡券类型提供更多功能。
GENERIC_OTHER 其他类型

通知

指明是否需要为对象启用通知。我们仅支持 ExpiryNotification/UpcomingNotification 中的一种。expiryNotification 优先于 upcomingNotification。也就是说，如果设置了 expiryNotification，系统会忽略 upcomingNotification 字段。

JSON 表示法 
{
  "expiryNotification": {
    object (ExpiryNotification)
  },
  "upcomingNotification": {
    object (UpcomingNotification)
  }
}
字段
expiryNotification

object (ExpiryNotification)

系统会在卡片到期前的特定时间触发通知。
upcomingNotification

object (UpcomingNotification)

在卡片可供使用之前，系统会在特定时间触发通知。

ExpiryNotification

表示发卡机构希望 Google 钱包在卡片到期前 2 天发送到期通知。

JSON 表示法 
{
  "enableNotification": boolean
}
字段
enableNotification

boolean

指示对象是否需要启用到期通知。

UpcomingNotification

表示发卡机构希望 Google 钱包在卡生效/可用前 1 天发送即将发出的卡有效通知。

JSON 表示法 
{
  "enableNotification": boolean
}
字段
enableNotification

boolean

指示是否需要为对象启用即将到来通知。

方法

addmessage

 向指定对象 ID 引用的通用对象添加消息。

get

 返回具有指定对象 ID 的通用对象。

insert

 插入具有指定 ID 和属性的通用对象。

list

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

patch

 更新指定对象 ID 引用的通用对象。

update

 更新指定对象 ID 引用的通用对象。