REST Resource: eventticketclass

资源:EventTicketClass

JSON 表示法
{
  "kind": string,
  "eventName": {
    object (LocalizedString)
  },
  "eventId": string,
  "logo": {
    object (Image)
  },
  "venue": {
    object (EventVenue)
  },
  "dateTime": {
    object (EventDateTime)
  },
  "confirmationCodeLabel": enum (ConfirmationCodeLabel),
  "customConfirmationCodeLabel": {
    object (LocalizedString)
  },
  "seatLabel": enum (SeatLabel),
  "customSeatLabel": {
    object (LocalizedString)
  },
  "rowLabel": enum (RowLabel),
  "customRowLabel": {
    object (LocalizedString)
  },
  "sectionLabel": enum (SectionLabel),
  "customSectionLabel": {
    object (LocalizedString)
  },
  "gateLabel": enum (GateLabel),
  "customGateLabel": {
    object (LocalizedString)
  },
  "finePrint": {
    object (LocalizedString)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideLogo": {
    object (Image)
  }
}
字段
kind
(deprecated)

string

标识这是哪类资源。值:固定字符串 "walletobjects#eventTicketClass"

eventName

object (LocalizedString)

必需。活动的名称,例如“洛杉矶道奇队对阵旧金山巨人队”。

eventId

string

事件的 ID。对于同一帐号中的每个活动,此 ID 都应是唯一的。如果用户为同一活动保存了多张门票,可使用此 ID 将门票组合在一起。最多可以包含 64 个字符。

如果提供,分组将会稳定。请警惕意外冲突,避免将不应分组的门票归为一组。如果您对每个活动只使用一个类,则只需将此属性设置为 classId(含或不含发卡机构 ID 部分)。

如果未提供,平台将尝试使用其他数据对门票进行分组(可能不稳定)。

venue

object (EventVenue)

活动场地详细信息。

dateTime

object (EventDateTime)

活动的日期和时间信息。

confirmationCodeLabel

enum (ConfirmationCodeLabel)

用于卡片详细信息视图中的确认码值 (eventTicketObject.reservationInfo.confirmationCode) 的标签。每个可用选项都会映射到一组已本地化的字符串,以便根据用户的语言区域向其显示翻译。

不能同时设置 confirmationCodeLabelcustomConfirmationCodeLabel。如果二者均未设置,则默认此标签是已本地化的“确认码”。如果未设置确认码字段,则不会使用此标签。

customConfirmationCodeLabel

object (LocalizedString)

用于卡片详细信息视图中的确认码值 (eventTicketObject.reservationInfo.confirmationCode) 的自定义标签。仅当默认的“确认码”标签或某个 confirmationCodeLabel 选项不够用时,才应使用此标签。

不能同时设置 confirmationCodeLabelcustomConfirmationCodeLabel。如果二者均未设置,则默认此标签是已本地化的“确认码”。如果未设置确认码字段,则不会使用此标签。

seatLabel

enum (SeatLabel)

用于卡片详细信息视图中的座位值 (eventTicketObject.seatInfo.seat) 的标签。每个可用选项都会映射到一组已本地化的字符串,以便根据用户的语言区域向其显示翻译。

不能同时设置 seatLabelcustomSeatLabel。如果二者均未设置,则默认此标签是已本地化的“座位”。如果未设置“座位”字段,则不会使用此标签。

customSeatLabel

object (LocalizedString)

用于卡片详细信息视图中的座位值 (eventTicketObject.seatInfo.seat) 的自定义标签。仅当默认的“座位”标签或某个 seatLabel 选项不够用时,才应使用此标签。

不能同时设置 seatLabelcustomSeatLabel。如果二者均未设置,则默认此标签是已本地化的“座位”。如果未设置“座位”字段,则不会使用此标签。

rowLabel

enum (RowLabel)

用于卡片详细信息视图中的行值 (eventTicketObject.seatInfo.row) 的标签。每个可用选项都会映射到一组已本地化的字符串,以便根据用户的语言区域向其显示翻译。

不能同时设置 rowLabelcustomRowLabel。如果二者均未设置,则默认此标签是已本地化的“行”。如果未设置“行”字段,则不会使用此标签。

customRowLabel

object (LocalizedString)

用于卡片详细信息视图中的行值 (eventTicketObject.seatInfo.row) 的自定义标签。仅当默认的“排”标签或某个 rowLabel 选项不够用时,才应使用此标签。

不能同时设置 rowLabelcustomRowLabel。如果二者均未设置,则默认此标签是已本地化的“行”。如果未设置“行”字段,则不会使用此标签。

sectionLabel

enum (SectionLabel)

用于卡片详细信息视图中的区值 (eventTicketObject.seatInfo.section) 的标签。每个可用选项都会映射到一组已本地化的字符串,以便根据用户的语言区域向其显示翻译。

不能同时设置 sectionLabelcustomSectionLabel。如果二者均未设置,则默认此标签是已本地化的“区”。如果未设置“section”字段,则不会使用此标签。

customSectionLabel

object (LocalizedString)

用于卡片详细信息视图中的区值 (eventTicketObject.seatInfo.section) 的自定义标签。仅当默认的“区”标签或某个 sectionLabel 选项不够用时,才应使用此标签。

不能同时设置 sectionLabelcustomSectionLabel。如果二者均未设置,则默认此标签是已本地化的“区”。如果未设置“section”字段,则不会使用此标签。

gateLabel

enum (GateLabel)

用于卡片详细信息视图中的入口值 (eventTicketObject.seatInfo.gate) 的标签。每个可用选项都会映射到一组已本地化的字符串,以便根据用户的语言区域向其显示翻译。

不能同时设置 gateLabelcustomGateLabel。如果二者均未设置,则默认此标签是已本地化的“入口”。如果未设置“入口”字段,则不会使用此标签。

customGateLabel

object (LocalizedString)

用于卡片详细信息视图中的入口值 (eventTicketObject.seatInfo.gate) 的自定义标签。仅当默认的“入口”标签或某个 gateLabel 选项不够用时,才应使用此标签。

不能同时设置 gateLabelcustomGateLabel。如果二者均未设置,则默认此标签是已本地化的“入口”。如果未设置“入口”字段,则不会使用此标签。

finePrint

object (LocalizedString)

门票的细则、条款及条件。

classTemplateInfo

object (ClassTemplateInfo)

有关应如何显示类的模板信息。如果未设置此政策,Google 将回退到显示一组默认字段。

id

string

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

version
(deprecated)

string (int64 format)

已弃用

issuerName

string

必需。发卡机构名称。建议的最大长度为 20 个字符,以确保字符串能在较小的屏幕上完整显示。

messages[]

object (Message)

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

allowMultipleUsersPerObject
(deprecated)

boolean

已弃用。请改用 multipleDevicesAndHoldersAllowedStatus

homepageUri

object (Uri)

应用首页的 URI。在此字段中填充 URI 与在 linksModuleData 中填充 URI 的效果完全相同(在呈现对象时,显示指向首页的链接通常被视为该对象的 linksModuleData 部分)。

locations[]

object (LatLongPoint)

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

reviewStatus

enum (ReviewStatus)

必需。类的状态。此字段可通过插入、修补或更新 API 调用设置为 draftunderReview。审核状态从 draft 更改为其他状态后,便无法再改回 draft

如果该类尚在开发中,您应将此字段保留为 draftdraft 类不能用于创建任何对象。

如果您认为该类可供使用,则应将此字段设置为 underReview。平台会自动将此字段设置为 approved,它可以立即用于创建或迁移对象。

更新 approved 类时,您应将此字段始终设置为 underReview

review

object (Review)

当某个类被标记为 approvedrejected 时,由平台设置的评价备注。

infoModuleData
(deprecated)

object (InfoModuleData)

已弃用。请改用 textModulesData。

imageModulesData[]

object (ImageModuleData)

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

textModulesData[]

object (TextModuleData)

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

redemptionIssuers[]

string (int64 format)

指明哪些兑换发卡机构可以通过智能触碰功能兑换卡券。兑换发卡机构由其发卡机构 ID 进行标识。兑换发卡机构必须至少配置一个智能触碰密钥。

此外,必须正确设置 enableSmartTap 和对象级 smartTapRedemptionLevel 字段,卡券才能支持智能触碰。

countryCode

string

国家/地区代码,用于在用户不在该国家/地区时显示卡片所在的国家/地区,以及在用户的语言区域未推出该内容时显示本地化内容。

heroImage

object (Image)

在卡片正面显示的可选横幅图片。如果不存在,则不会显示任何内容。图片将以 100% 宽度显示。

wordMark
(deprecated)

object (Image)

已弃用。

enableSmartTap

boolean

标识此类是否支持智能触碰。此外,必须正确设置 redemptionIssuers 和对象级 smartTapRedemptionLevel 字段,卡券才能支持智能触碰。

hexBackgroundColor

string

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

localizedIssuerName

object (LocalizedString)

已翻译的 issuerName 字符串。建议的最大长度为 20 个字符,以确保字符串能在较小的屏幕上完整显示。

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

指明是否允许多个用户和设备保存引用此类的同一个对象。

callbackOptions

object (CallbackOptions)

回调选项,用于在最终用户每次保存/删除此类的对象时回调发卡机构。此类的所有对象都可以进行回调。

securityAnimation

object (SecurityAnimation)

有关安全动画的可选信息。如果已设置,系统会在卡券详细信息中呈现安全动画。

viewUnlockRequirement

enum (ViewUnlockRequirement)

查看活动门票的解锁要求选项。

EventVenue

JSON 表示法
{
  "kind": string,
  "name": {
    object (LocalizedString)
  },
  "address": {
    object (LocalizedString)
  }
}
字段
kind
(deprecated)

string

标识这是哪类资源。值:固定字符串 "walletobjects#eventVenue"

name

object (LocalizedString)

场地的名称,例如“AT&T Park”。

这是必填字段。

address

object (LocalizedString)

场地的地址,例如“24 Willie Mays Plaza\nSan Francisco, CA 94107”。各地址行之间用换行符 (\n) 分隔。

这是必填字段。

EventDateTime

JSON 表示法
{
  "kind": string,
  "doorsOpen": string,
  "start": string,
  "end": string,
  "doorsOpenLabel": enum (DoorsOpenLabel),
  "customDoorsOpenLabel": {
    object (LocalizedString)
  }
}
字段
kind
(deprecated)

string

标识这是哪类资源。值:固定字符串 "walletobjects#eventDateTime"

doorsOpen

string

场地的开始入场日期/时间。

这是 ISO 8601 扩展格式的日期/时间,可带也可不带偏移量。时间最高可指定到纳秒级精度。偏移量可指定到秒级精度(即使 ISO 8601 中未以秒为精度指定偏移量)。

例如:

1985-04-12T23:20:50.52Z 表示世界协调时间 (UTC) 1985 年 4 月 12 日 23 时 20 分 50.52 秒。

1985-04-12T19:20:50.52-04:00 表示比世界协调时间 (UTC) 早 4 个小时的 1985 年 4 月 12 日 19 时 20 分 50.52 秒(与上述示例的同一时刻)。如果活动地点为纽约,则此时间相当于美国东部夏令时 (EDT)。请注意,在采用夏令时的地区,偏移量会有所不同,具体取决于一年中的时间。

1985-04-12T19:20:50.52 表示不带偏移量信息的 1985 年 4 月 12 日 19 时 20 分 50.52 秒。

不带偏移量的日期/时间部分被视为“当地日期/时间”。此时间应为场地的当地日期/时间。例如,如果在该场地开展活动的时间为 2018 年 6 月 5 日 20 时,则当地日期/时间部分应为 2018-06-05T20:00:00。如果场地的当地日期/时间比世界协调时间 (UTC) 早 4 个小时,则可附加 -04:00 的偏移量。

如果没有偏移信息,您可能无法使用某些丰富的功能。

start

string

活动的开始日期/时间。如果活动持续数天,则应为第一天的开始日期/时间。

这是 ISO 8601 扩展格式的日期/时间,可带也可不带偏移量。时间最高可指定到纳秒级精度。偏移量可指定到秒级精度(即使 ISO 8601 中未以秒为精度指定偏移量)。

例如:

1985-04-12T23:20:50.52Z 表示世界协调时间 (UTC) 1985 年 4 月 12 日 23 时 20 分 50.52 秒。

1985-04-12T19:20:50.52-04:00 表示比世界协调时间 (UTC) 早 4 个小时的 1985 年 4 月 12 日 19 时 20 分 50.52 秒(与上述示例的同一时刻)。如果活动地点为纽约,则此时间相当于美国东部夏令时 (EDT)。请注意,在采用夏令时的地区,偏移量会有所不同,具体取决于一年中的时间。

1985-04-12T19:20:50.52 表示不带偏移量信息的 1985 年 4 月 12 日 19 时 20 分 50.52 秒。

不带偏移量的日期/时间部分被视为“当地日期/时间”。此时间应为场地的当地日期/时间。例如,如果在该场地开展活动的时间为 2018 年 6 月 5 日 20 时,则当地日期/时间部分应为 2018-06-05T20:00:00。如果场地的当地日期/时间比世界协调时间 (UTC) 早 4 个小时,则可附加 -04:00 的偏移量。

如果没有偏移信息,您可能无法使用某些丰富的功能。

end

string

活动的结束日期/时间。如果活动持续数天,则应为最后一天的结束日期/时间。

这是 ISO 8601 扩展格式的日期/时间,可带也可不带偏移量。时间最高可指定到纳秒级精度。偏移量可指定到秒级精度(即使 ISO 8601 中未以秒为精度指定偏移量)。

例如:

1985-04-12T23:20:50.52Z 表示世界协调时间 (UTC) 1985 年 4 月 12 日 23 时 20 分 50.52 秒。

1985-04-12T19:20:50.52-04:00 表示比世界协调时间 (UTC) 早 4 个小时的 1985 年 4 月 12 日 19 时 20 分 50.52 秒(与上述示例的同一时刻)。如果活动地点为纽约,则此时间相当于美国东部夏令时 (EDT)。请注意,在采用夏令时的地区,偏移量会有所不同,具体取决于一年中的时间。

1985-04-12T19:20:50.52 表示不带偏移量信息的 1985 年 4 月 12 日 19 时 20 分 50.52 秒。

不带偏移量的日期/时间部分被视为“当地日期/时间”。此时间应为场地的当地日期/时间。例如,如果在该场地开展活动的时间为 2018 年 6 月 5 日 20 时,则当地日期/时间部分应为 2018-06-05T20:00:00。如果场地的当地日期/时间比世界协调时间 (UTC) 早 4 个小时,则可附加 -04:00 的偏移量。

如果没有偏移信息,您可能无法使用某些丰富的功能。

doorsOpenLabel

enum (DoorsOpenLabel)

用于卡片详细信息视图中的开始入场时间值 (doorsOpen) 的标签。每个可用选项都会映射到一组已本地化的字符串,以便根据用户的语言区域向其显示翻译。

不能同时设置 doorsOpenLabelcustomDoorsOpenLabel。如果二者均未设置,则默认此标签是已本地化的“开始入场”。如果未设置“开始入场时间”字段,则不会使用此标签。

customDoorsOpenLabel

object (LocalizedString)

用于卡片详细信息视图中的开始入场时间值 (doorsOpen) 的自定义标签。仅当默认的“开始入场时间”标签或某个 doorsOpenLabel 选项不够用时,才应使用此标签。

不能同时设置 doorsOpenLabelcustomDoorsOpenLabel。如果二者均未设置,则默认此标签是已本地化的“开始入场”。如果未设置“开始入场时间”字段,则不会使用此标签。

DoorsOpenLabel

枚举
DOORS_OPEN_LABEL_UNSPECIFIED
DOORS_OPEN
doorsOpen

DOORS_OPEN 的旧别名,已弃用。

GATES_OPEN
gatesOpen

GATES_OPEN 的旧别名,已弃用。

ConfirmationCodeLabel

枚举
CONFIRMATION_CODE_LABEL_UNSPECIFIED
CONFIRMATION_CODE
confirmationCode

CONFIRMATION_CODE 的旧别名,已弃用。

CONFIRMATION_NUMBER
confirmationNumber

CONFIRMATION_NUMBER 的旧别名,已弃用。

ORDER_NUMBER
orderNumber

ORDER_NUMBER 的旧别名,已弃用。

RESERVATION_NUMBER
reservationNumber

RESERVATION_NUMBER 的旧别名,已弃用。

SeatLabel

枚举
SEAT_LABEL_UNSPECIFIED
SEAT
seat

SEAT 的旧别名,已弃用。

RowLabel

枚举
ROW_LABEL_UNSPECIFIED
ROW
row

ROW 的旧别名,已弃用。

SectionLabel

枚举
SECTION_LABEL_UNSPECIFIED
SECTION
section

SECTION 的旧别名,已弃用。

THEATER
theater

THEATER 的旧别名,已弃用。

GateLabel

枚举
GATE_LABEL_UNSPECIFIED
GATE
gate

GATE 的旧别名,已弃用。

DOOR
door

DOOR 的旧别名,已弃用。

ENTRANCE
entrance

ENTRANCE 的旧别名,已弃用。

方法

addmessage

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

get

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

insert

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

list

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

patch

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

update

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