REST Resource: flightobject

资源:FlightObject

JSON 表示法
{
  "kind": string,
  "classReference": {
    object (FlightClass)
  },
  "passengerName": string,
  "boardingAndSeatingInfo": {
    object (BoardingAndSeatingInfo)
  },
  "reservationInfo": {
    object (ReservationInfo)
  },
  "securityProgramLogo": {
    object (Image)
  },
  "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)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  }
}
字段
kind
(deprecated)

string

标识这是什么资源类型。值:固定字符串 "walletobjects#flightObject"

classReference

object (FlightClass)

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

passengerName

string

必需。显示在登机牌上的乘客姓名。

例如:“Dave M Gahan”“Gahan/Dave”或“GAHAN/DAVEM”

boardingAndSeatingInfo

object (BoardingAndSeatingInfo)

具体客户的登机和座位信息。

reservationInfo

object (ReservationInfo)

必需。航班预订信息。

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)

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

groupingInfo

object (GroupingInfo)

用于控制卡券如何分组的信息。

passConstraints

object (PassConstraints)

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

BoardingAndSeatingInfo

JSON 表示法
{
  "kind": string,
  "boardingGroup": string,
  "seatNumber": string,
  "seatClass": string,
  "boardingPrivilegeImage": {
    object (Image)
  },
  "boardingPosition": string,
  "sequenceNumber": string,
  "boardingDoor": enum (BoardingDoor),
  "seatAssignment": {
    object (LocalizedString)
  }
}
字段
kind
(deprecated)

string

标识这是什么资源类型。值:固定字符串 "walletobjects#boardingAndSeatingInfo"

boardingGroup

string

该乘客登机时所用的登机组(或登机区域)的值。

例如:“B”

此值的标签将由此对象引用的 flightClass 中的 boardingPolicy 字段确定。

seatNumber

string

乘客座位的值。如果没有特定标识符,请改用 seatAssignment

例如:“25A”

seatClass

string

座位等级的值。

例如:“经济舱”或“Economy Plus”

boardingPrivilegeImage

object (Image)

登机牌条形码上方显示的小图片。航空公司可以用它来表明任何特殊登机特权。如果还设置了安全计划徽标,则此图片可能会与该安全计划的徽标一起显示。

boardingPosition

string

登机位置的值。

例如:“76”

sequenceNumber

string

登机牌上的序列号。这通常与乘客办理登机手续的顺序一致。航空公司可能会在人工登机手续和行李标签中使用该数字。

例如:“49”

boardingDoor

enum (BoardingDoor)

仅当此航班登机通过多个登机门或登机桥,并且您希望在登机牌上明确打印登机门位置时,才设置此字段。大多数航空公司会按照 seatClass 指定登机门/登机桥,将乘客分流到相应的登机门或登机桥。在这些情况下,不应设置 boardingDoor

seatAssignment

object (LocalizedString)

乘客的座位分配。在 seatNumber 中没有要使用的特定标识符时使用。

例如:“在登机口分配”

BoardingDoor

枚举
BOARDING_DOOR_UNSPECIFIED
FRONT
front

FRONT 的旧别名,已弃用。

BACK
back

BACK 的旧别名,已弃用。

ReservationInfo

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

string

标识这是什么资源类型。值:固定字符串 "walletobjects#reservationInfo"

confirmationCode

string

办理此航班登机手续所需的确认码。

乘客在机场自助服务终端查询航班并打印登机牌时需要输入此号码。

eticketNumber

string

电子机票号码。

frequentFlyerInfo

object (FrequentFlyerInfo)

飞行常客奖励计划会员信息。

FrequentFlyerInfo

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

string

标识这是什么资源类型。值:固定字符串 "walletobjects#frequentFlyerInfo"

frequentFlyerProgramName

object (LocalizedString)

飞行常客奖励计划的名称。例如:“汉莎航空飞常里程汇”

frequentFlyerNumber

string

飞行常客奖励计划号码。

对于每个类型为 walletobjects#frequentFlyerInfo 的嵌套对象,此属性为必需属性。

方法

addmessage

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

get

返回具有指定对象 ID 的航班对象。

insert

插入具有指定 ID 和属性的航班对象。

list

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

patch

更新指定对象 ID 引用的航班对象。

update

更新指定对象 ID 引用的航班对象。