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)
  }
}
字段
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[]

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 和屏幕截图行为。

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”或“West”。

此字段可本地化,因此您可以翻译字词或对标识符中的字符使用不同的字母。

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 引用的活动门票对象。