REST Resource: eventticketobject

资源:EventTicketObject

JSON 表示法
{
  "kind": string,
  "classReference": {
    object (EventTicketClass)
  },
  "seatInfo": {
    object (EventSeat)
  },
  "reservationInfo": {
    object (EventReservationInfo)
  },
  "ticketHolderName": string,
  "ticketNumber": string,
  "ticketType": {
    object (LocalizedString)
  },
  "faceValue": {
    object (Money)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "linkedOfferIds": [
    string
  ],
  "hexBackgroundColor": string,
  "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)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "heroImage": {
    object (Image)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
字段
kind
(deprecated)

string

表明这是哪类资源。值:固定字符串 "walletobjects#eventTicketObject"

classReference

object (EventTicketClass)

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

seatInfo

object (EventSeat)

此门票的座位详细信息。

reservationInfo

object (EventReservationInfo)

此门票的预订详细信息。在同一订单中购买的所有门票都会具有此信息。

ticketHolderName

string

门票持有者的姓名(如果门票已分配给某人)。例如“John Doe”或“Jane Doe”。

ticketNumber

string

门票的号码。它可以是以下各门票的一个唯一标识符:发行者系统中的所有门票、活动的所有门票(例如 XYZ1234512345)或订单中的所有门票(1、2、3 等)。

ticketType

object (LocalizedString)

门票的类型,例如“成人”“儿童”“VIP”或“标准”。

faceValue

object (Money)

门票的面值,与印在实物门票上的面额一致。

groupingInfo

object (GroupingInfo)

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

linkedOfferIds[]

string

与此活动门票关联的优惠对象的列表。优惠对象必须已存在。

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

hexBackgroundColor

string

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

id

string

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

classId

string

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

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

version
(deprecated)

string (int64 format)

已弃用

state

enum (State)

必需。对象的状态。此字段用于确定对象在应用中的显示方式。例如,系统会将 inactive 对象移至“过期卡券”部分:

barcode

object (Barcode)

条形码的类型和值。

messages[]

object (Message)

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

validTimeInterval

object (TimeInterval)

此对象处于 active 状态且可供使用的时间段。这段时间过后,对象的状态将更改为 expired

locations[]
(deprecated)

object (LatLongPoint)

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

hasUsers

boolean

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

smartTapRedemptionValue

string

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

hasLinkedDevice

boolean

指明此对象当前是否已关联到某个设备。当用户保存对象并将其关联到自己的设备时,平台会设置此字段。此字段仅供部分合作伙伴使用。如需了解详情,请与支持团队联系。

disableExpirationNotification

boolean

指明是否明确禁止通知。如果此字段设置为 true,则无论 messages 字段为何,都会禁止向用户发出失效通知。此字段默认设置为 false。

此属性目前仅可用于设置优惠对象。

infoModuleData

object (InfoModuleData)

已弃用。请改用 textModulesData。

imageModulesData[]

object (ImageModuleData)

图片模块数据。从对象级别开始,显示的字段数量上限为 1;对于类对象级别,上限也为 1。

textModulesData[]

object (TextModuleData)

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

rotatingBarcode

object (RotatingBarcode)

轮播的条形码类型和值。

heroImage

object (Image)

在卡片正面显示的可选横幅图片。如果没有,则会显示课程的主打图片(如果有)。如果课程的主打图片也不存在,则不会显示任何内容。

passConstraints

object (PassConstraints)

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

saveRestrictions

object (SaveRestrictions)

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

linkedObjectIds[]

string

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

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

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

notifyPreference

enum (NotificationSettingsForUpdates)

是否应针对此对象触发字段更新通知。如果设置为 NOTIFY,我们将尝试触发向用户发送的字段更新通知。只有当字段在许可名单内时,系统才会向用户发送这些通知。如果设置为 DO_NOT_NOTIFY 或 NOTIFICATION_SETTINGS_UNSPECIFIED,则不会触发任何通知。此设置是暂时性的,需要在每次 PATCH 或 UPDATE 请求中进行设置,否则系统不会触发通知。

valueAddedModuleData[]

object (ValueAddedModuleData)

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

EventSeat

JSON 表示法
{
  "kind": string,
  "seat": {
    object (LocalizedString)
  },
  "row": {
    object (LocalizedString)
  },
  "section": {
    object (LocalizedString)
  },
  "gate": {
    object (LocalizedString)
  }
}
字段
kind
(deprecated)

string

表明这是哪类资源。值:固定字符串 "walletobjects#eventSeat"

seat

object (LocalizedString)

座位号,例如“1”“2”“3”或任何其他座位标识符。

此字段可本地化,因此您可以翻译字词或使用其他字母作为标识符中的字符。

row

object (LocalizedString)

座位所在的排,例如“1”“E”“BB”或“A5”。

此字段可本地化,因此您可以翻译字词或使用其他字母作为标识符中的字符。

section

object (LocalizedString)

座位所在的区,例如“121”。

此字段可本地化,因此您可以翻译字词或使用其他字母作为标识符中的字符。

gate

object (LocalizedString)

门票持有者到达其座位所经的入口,例如“A”入口或“西”入口。

此字段可本地化,因此您可以翻译字词或使用其他字母作为标识符中的字符。

EventReservationInfo

JSON 表示法
{
  "kind": string,
  "confirmationCode": string
}
字段
kind
(deprecated)

string

表明这是哪类资源。值:固定字符串 "walletobjects#eventReservationInfo"

confirmationCode

string

活动预订的确认码。也可能以“订单号”“确认号”“预订号”或其他等效形式出现。

方法

addmessage

向指定对象 ID 引用的活动门票对象添加消息。

get

返回具有指定对象 ID 的活动门票对象。

insert

插入具有指定 ID 和属性的活动门票对象。

list

返回指定发卡机构 ID 的所有活动门票对象的列表。

modifylinkedofferobjects

修改具有指定 ID 的活动门票对象的关联优惠对象。

patch

更新指定对象 ID 引用的活动门票对象。

update

更新指定对象 ID 引用的活动门票对象。