REST 资源:flightclass

资源:FlightClass

JSON 表示法

{
  "kind": string,
  "localScheduledDepartureDateTime": string,
  "localEstimatedOrActualDepartureDateTime": string,
  "localBoardingDateTime": string,
  "localScheduledArrivalDateTime": string,
  "localEstimatedOrActualArrivalDateTime": string,
  "flightHeader": {
    object (FlightHeader)
  },
  "origin": {
    object (AirportInfo)
  },
  "destination": {
    object (AirportInfo)
  },
  "flightStatus": enum (FlightStatus),
  "boardingAndSeatingPolicy": {
    object (BoardingAndSeatingPolicy)
  },
  "localGateClosingDateTime": string,
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "languageOverride": string,
  "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)
  }
}
字段
kind
(deprecated)

string

指明资源的种类。值:固定字符串 "walletobjects#flightClass"

localScheduledDepartureDateTime

string

必选。飞机离开登机口(而不是跑道)的预定日期和时间

注意:此字段的值不应太接近起飞时间。如需更新起飞时间(延误等),请设置 localEstimatedOrActualDepartureDateTime

这是 ISO 8601 扩展格式的日期/时间,不带偏移量。可以指定精确到毫秒的时间。

例如:2027-03-05T06:30:00

此时间应该是机场的当地日期/时间(不是世界协调时间 (UTC))。

如果提供了世界协调时间 (UTC) 偏移量,Google 将拒绝请求。时区将由 Google 根据起飞机场来计算。

localEstimatedOrActualDepartureDateTime

string

飞机离开登机口的预计时间,或飞机离开登机口的实际时间。注意:此时间不是飞机离开跑道的时间。

如果至少满足下列一个条件,则您应该设置此字段:

  • 此时间与预定时间不同。Google 将使用此时间来计算延误时间。
  • 飞机已离开登机口。Google 将使用此时间来通知用户航班的实际起飞时间。

这是 ISO 8601 扩展格式的日期/时间,不带偏移量。可以指定精确到毫秒的时间。

例如:2027-03-05T06:30:00

此时间应该是机场的当地日期/时间(不是世界协调时间 (UTC))。

如果提供了世界协调时间 (UTC) 偏移量,Google 将拒绝请求。时区将由 Google 根据起飞机场来计算。

如果未设置,Google 将根据其他来源的数据进行设置。

localBoardingDateTime

string

将会印在登机牌上的登机时间。

这是 ISO 8601 扩展格式的日期/时间,不带偏移量。可以指定精确到毫秒的时间。

例如:2027-03-05T06:30:00

此时间应该是机场的当地日期/时间(不是世界协调时间 (UTC))。

如果提供了世界协调时间 (UTC) 偏移量,Google 将拒绝请求。时区将由 Google 根据起飞机场来计算。

如果未设置,Google 将根据其他来源的数据进行设置。

localScheduledArrivalDateTime

string

飞机到达目的地登机口(而非跑道)的预定时间。

注意:此字段的值不应太接近航班时间。如需更新起飞时间(延误等),请设置 localEstimatedOrActualArrivalDateTime

这是 ISO 8601 扩展格式的日期/时间,不带偏移量。可以指定精确到毫秒的时间。

例如:2027-03-05T06:30:00

此时间应该是机场的当地日期/时间(不是世界协调时间 (UTC))。

如果提供了世界协调时间 (UTC) 偏移量,Google 将拒绝请求。时区将由 Google 根据到达机场来计算。

如果未设置,Google 将根据其他来源的数据进行设置。

localEstimatedOrActualArrivalDateTime

string

飞机到达目的地登机口(而非跑道)的预计时间,或飞机到达登机口的实际时间。

如果至少满足下列一个条件,则您应该设置此字段:

  • 此时间与预定时间不同。Google 将使用此时间来计算延误时间。
  • 飞机已抵达登机口。Google 将使用此时间来通知用户航班已抵达登机口。

这是 ISO 8601 扩展格式的日期/时间,不带偏移量。可以指定精确到毫秒的时间。

例如:2027-03-05T06:30:00

此时间应该是机场的当地日期/时间(不是世界协调时间 (UTC))。

如果提供了世界协调时间 (UTC) 偏移量,Google 将拒绝请求。时区将由 Google 根据到达机场来计算。

如果未设置,Google 将根据其他来源的数据进行设置。

flightHeader

object (FlightHeader)

必选。关于航空公司和航班号的信息。

origin

object (AirportInfo)

必选。出发地机场。

destination

object (AirportInfo)

必选。目的地机场。

flightStatus

enum (FlightStatus)

本次航班的状态。

如果未设置,Google 将根据 FlightStats 等其他来源的数据来计算状态。

注意:API 响应中不会返回 Google 计算的状态。

boardingAndSeatingPolicy

object (BoardingAndSeatingPolicy)

登机和就座政策。这些政策指示向用户显示哪些标签。

localGateClosingDateTime

string

将会印在登机牌上的登机口关闭时间。如果您不想将此时间印在登机牌上,请不要设置此字段。

这是 ISO 8601 扩展格式的日期/时间,不带偏移量。可以指定精确到毫秒的时间。

例如:2027-03-05T06:30:00

此时间应该是机场的当地日期/时间(不是世界协调时间 (UTC))。

如果提供了世界协调时间 (UTC) 偏移量,Google 将拒绝请求。时区将由 Google 根据起飞机场来计算。

classTemplateInfo

object (ClassTemplateInfo)

有关应如何显示类的模板信息。 如果未设置,Google 将回退为显示默认字段集。

languageOverride

string

如果存在此字段,则提供到用户设备上的登机牌将始终使用此语言。表示 BCP 47 语言标记。示例值为“en-US”、“en-GB”、“de”或“de-AT”。

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;对于类,上限也为 10。

redemptionIssuers[]

string (int64 format)

仅适用于支持智能触碰技术的合作伙伴。如需更多指导,请与支持人员联系。

countryCode

string

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

heroImage

object (Image)

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

wordMark
(deprecated)

object (Image)

已弃用。

enableSmartTap

boolean

仅适用于支持智能触碰技术的合作伙伴。如需更多指导,请与支持人员联系。

hexBackgroundColor

string

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

localizedIssuerName

object (LocalizedString)

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

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

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

callbackOptions

object (CallbackOptions)

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

FlightHeader

JSON 表示法

{
  "kind": string,
  "carrier": {
    object (FlightCarrier)
  },
  "flightNumber": string,
  "operatingCarrier": {
    object (FlightCarrier)
  },
  "operatingFlightNumber": string
}
字段
kind
(deprecated)

string

指明资源的种类。值:固定字符串 "walletobjects#flightHeader"

carrier

object (FlightCarrier)

关于航空公司的信息。这是 flightHeader 的必需属性。

flightNumber

string

不含 IATA 航空公司代码的航班号。此字段应仅包含数字。这是 flightHeader 的必需属性。

例如:“123”

operatingCarrier

object (FlightCarrier)

关于承运航空公司的信息。

operatingFlightNumber

string

承运航空公司使用的不含 IATA 代码的航班号。此字段应仅包含数字。

例如:“234”

FlightCarrier

JSON 表示法

{
  "kind": string,
  "carrierIataCode": string,
  "carrierIcaoCode": string,
  "airlineName": {
    object (LocalizedString)
  },
  "airlineLogo": {
    object (Image)
  },
  "airlineAllianceLogo": {
    object (Image)
  }
}
字段
kind
(deprecated)

string

指明资源的种类。值:固定字符串 "walletobjects#flightCarrier"

carrierIataCode

string

销售航空公司(与承运航空公司相对)的 IATA 航空公司代码,使用两个字符来表示。对于 carrieroperatingCarrier,必须提供一个此类值,或者提供 carrierIcaoCode

例如:瑞士航空的销售航空公司 IATA 代码为“LX”

carrierIcaoCode

string

销售航空公司(与承运航空公司相对)的 ICAO 航空公司代码,使用三个字符来表示。对于 carrieroperatingCarrier,必须提供一个此类值,或者提供 carrierIataCode

例如:易捷航空的销售航空公司 ICAO 代码为“EZY”

airlineName

object (LocalizedString)

使用 carrierIataCode 来指定的航空公司本地化名称。如果未设置,则系统使用来自 FlightClassissuerNamelocalizedIssuerName 用于显示目的。

例如:“LX”对应的本地化名称为“瑞士航空”

AirportInfo

JSON 表示法

{
  "kind": string,
  "airportIataCode": string,
  "terminal": string,
  "gate": string,
  "airportNameOverride": {
    object (LocalizedString)
  }
}
字段
kind
(deprecated)

string

指明资源的种类。值:固定字符串 "walletobjects#airportInfo"

airportIataCode

string

IATA 机场代码(3 个字符)。对于 origindestination,此字段为必填字段。

例如:“SFO”

terminal

string

航站楼名称。例如:“INTL”或“I”

gate

string

登机口的名称。例如:“B59”或“59”

airportNameOverride

object (LocalizedString)

可选字段,它替换由 IATA 定义的机场城市名称。默认情况下,Google 会采用提供的 airportIataCode 并将其映射至由 IATA 定义的官方机场城市名称。

如需了解官方 IATA 机场城市名称,请访问 IATA 机场城市名称网站。例如,对于机场 IATA 代码“LTN”,IATA 网站显示对应的机场城市是“伦敦”。

如果未填写此字段,Google 将会显示“伦敦”。

但是,在此字段中填入自定义名称(例如“伦敦卢顿”)将会替换“伦敦”。

FlightStatus

枚举
FLIGHT_STATUS_UNSPECIFIED
SCHEDULED 航班准时、提前或延误。
scheduled

SCHEDULED 的旧别名。现已弃用。

ACTIVE 航班正在飞行(滑行、起飞、降落、升空)。
active

ACTIVE 的旧别名。现已弃用。

LANDED 航班已降落在原始目的地。
landed

LANDED 的旧别名。现已弃用。

CANCELLED 航班已取消。
cancelled

CANCELLED 的旧别名。现已弃用。

REDIRECTED 航班已升空,但要飞往与原始目的地不同的机场。
redirected

REDIRECTED 的旧别名。现已弃用。

DIVERTED 航班已降落在与原始目的地不同的机场。
diverted

DIVERTED 的旧别名。现已弃用。

BoardingAndSeatingPolicy

JSON 表示法

{
  "kind": string,
  "boardingPolicy": enum (BoardingPolicy),
  "seatClassPolicy": enum (SeatClassPolicy)
}
字段
kind
(deprecated)

string

指明资源的种类。值:固定字符串 "walletobjects#boardingAndSeatingPolicy"

boardingPolicy

enum (BoardingPolicy)

表示航空公司的登机政策。 如果未设置,Google 将默认采用 zoneBased

seatClassPolicy

enum (SeatClassPolicy)

就座政策,它规定我们如何显示舱位等级。如果未设置,Google 将默认采用 cabinBased

BoardingPolicy

枚举
BOARDING_POLICY_UNSPECIFIED
ZONE_BASED
zoneBased

ZONE_BASED 的旧别名。现已弃用。

GROUP_BASED
groupBased

GROUP_BASED 的旧别名,已弃用。

BOARDING_POLICY_OTHER
boardingPolicyOther

BOARDING_POLICY_OTHER 的旧别名,已弃用。

SeatClassPolicy

枚举
SEAT_CLASS_POLICY_UNSPECIFIED
CABIN_BASED
cabinBased

CABIN_BASED 的旧别名。现已弃用。

CLASS_BASED
classBased

CLASS_BASED 的旧别名,已弃用。

TIER_BASED
tierBased

TIER_BASED 的旧别名,已弃用。

SEAT_CLASS_POLICY_OTHER
seatClassPolicyOther

SEAT_CLASS_POLICY_OTHER 的旧别名,已弃用。

方法

addmessage

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

get

返回具有指定类 ID 的航班类。

insert

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

list

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

patch

更新指定类 ID 引用的航班类。

update

更新指定类 ID 引用的航班类。