REST Resource: genericobject

{
  "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
  ]
}

enum (GenericType)

指定卡片所属的 GenericType。

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (Image)

卡券的徽标图片。该图片会显示在左上角的卡片详细信息视图中，以及列表/缩略图视图中。如果没有徽标，系统会将 cardTitle 的第一个字母显示为徽标。

string

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

object (Notifications)

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

string

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

string

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

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

object (Barcode)

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

object (Image)

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

object (TimeInterval)

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

object (ImageModuleData)

图片模块数据。如果同时设置了类级和对象级图片，系统只会渲染其中一个图片。

object (TextModuleData)

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

object (LinksModuleData)

链接模块数据。如果还在类中定义了 linksModuleData，则将一并显示这两项数据。从类开始，显示的字段数量上限为 10；对于对象，上限也为 10。

object (AppLinkData)

可选的应用或网站链接，将以按钮的形式显示在卡券正面。如果为相应类提供了 AppLinkData，则系统只会显示对象 AppLinkData。

object (GroupingInfo)

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

string

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

object (RotatingBarcode)

轮替条形码设置/详细信息。

enum (State)

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

boolean

指示对象是否有用户。此字段由平台设置。

object (Message)

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

object (PassConstraints)

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

object (Image)

卡券的宽幅徽标。如果提供，此图片将替代卡片视图左上角的徽标。

object (SaveRestrictions)

对对象的限制，用户在尝试保存卡券之前需要先验证该对象。请注意，此限制仅在省电模式下应用。如果在用户保存卡券后限制发生变化，新的限制将不会应用于已保存的卡券。

object (ValueAddedModuleData)

添加了可选值模块数据。对象上的最大值为 10。

string

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

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

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

{
  "expiryNotification": {
    object (ExpiryNotification)
  },
  "upcomingNotification": {
    object (UpcomingNotification)
  }
}

object (ExpiryNotification)

系统会在银行卡过期前的特定时间触发通知。

object (UpcomingNotification)

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

{
  "enableNotification": boolean
}

boolean

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

{
  "enableNotification": boolean
}

boolean

指示对象是否需要启用即将发布的通知。