指数
FlightClassService(接口)FlightObjectService(接口)AirportInfo(消息)BoardingAndSeatingInfo(消息)BoardingAndSeatingInfo.BoardingDoor(枚举)BoardingAndSeatingPolicy(消息)BoardingAndSeatingPolicy.BoardingPolicy(枚举)BoardingAndSeatingPolicy.SeatClassPolicy(枚举)FlightCarrier(消息)FlightClass(消息)FlightClass.FlightStatus(枚举)FlightClassAddMessageRequest(消息)FlightClassAddMessageResponse(消息)FlightClassGetRequest(消息)FlightClassInsertRequest(消息)FlightClassListRequest(消息)FlightClassListResponse(消息)FlightClassPatchRequest(消息)FlightClassUpdateRequest(消息)FlightHeader(消息)FlightObject(消息)FlightObjectAddMessageRequest(消息)FlightObjectAddMessageResponse(消息)FlightObjectGetRequest(消息)FlightObjectInsertRequest(消息)FlightObjectListRequest(消息)FlightObjectListResponse(消息)FlightObjectPatchRequest(消息)FlightObjectUpdateRequest(消息)FrequentFlyerInfo(消息)ReservationInfo(消息)
FlightClassService
| AddMessage | |
|---|---|
|
向指定类 ID 引用的航班类添加消息。
|
|
| Get | |
|---|---|
|
返回具有指定类 ID 的航班类。
|
|
| Insert | |
|---|---|
|
插入具有指定 ID 和属性的航班类。
|
|
| List | |
|---|---|
|
返回指定发卡机构 ID 的所有航班类的列表。
|
|
| Patch | |
|---|---|
|
更新指定类 ID 引用的航班类。此方法支持补丁语义。
|
|
| Update | |
|---|---|
|
更新指定类 ID 引用的航班类。
|
|
FlightObjectService
| AddMessage | |
|---|---|
|
向指定对象 ID 引用的航班对象添加消息。
|
|
| Get | |
|---|---|
|
返回具有指定对象 ID 的航班对象。
|
|
| Insert | |
|---|---|
|
插入具有指定 ID 和属性的航班对象。
|
|
| List | |
|---|---|
|
返回指定发卡机构 ID 对应的所有航班对象的列表。
|
|
| Patch | |
|---|---|
|
更新指定对象 ID 引用的航班对象。此方法支持补丁语义。
|
|
| Update | |
|---|---|
|
更新指定对象 ID 引用的航班对象。
|
|
AirportInfo
| 字段 | |
|---|---|
kind |
指明资源的种类。值:固定字符串 |
airport_iata_code |
IATA 机场代码(3 个字符)。对于 例如:“SFO” |
terminal |
航站楼名称。例如:“INTL”或“I” |
gate |
登机口的名称。例如:“B59”或“59” |
airport_name_override |
可选字段,它替换由 IATA 定义的机场城市名称。默认情况下,Google 会采用提供的 如需了解官方 IATA 机场城市名称,请访问 IATA 机场城市名称网站。例如,对于机场 IATA 代码“LTN”,IATA 网站显示对应的机场城市是“伦敦”。 如果未填写此字段,Google 将会显示“伦敦”。 但是,在此字段中填入自定义名称(例如“伦敦卢顿”)可以替换“伦敦”。 |
BoardingAndSeatingInfo
| 字段 | |
|---|---|
kind |
指明资源的种类。值:固定字符串 |
boarding_group |
该乘客登机时所用的登机组(或登机区域)的值。 例如:“B” 此值的标签将由此对象引用的 |
seat_number |
乘客舱位值。如果没有特定标识符,请改用 例如:“25A” |
seat_class |
舱位等级的值。 例如:“经济舱”或“舒适经济舱” |
boarding_privilege_image |
登机牌条形码上方显示的小图。航空公司可以用它来显示特殊的登机特权。如果还设置了安全计划徽标,则此图片可能会与安全计划徽标一起显示。 |
boarding_position |
登机位置的值。 例如:“76” |
sequence_number |
登机牌上的序号。它通常与乘客办理登机手续的顺序一致。航空公司可能会在人工登机手续和行李标签中使用该序号。 例如:“49” |
boarding_door |
仅当此航班有多个登机门或登机桥,并且您希望将登机门位置明确打印在登机牌上时,才设置此字段。大多数航空公司会按照 |
seat_assignment |
乘客的座位分配。在 例如:“在登机口分配” |
BoardingDoor
| 枚举 | |
|---|---|
BOARDING_DOOR_UNSPECIFIED |
|
FRONT |
|
front |
|
BACK |
|
back |
|
BoardingAndSeatingPolicy
| 字段 | |
|---|---|
kind |
指明资源的种类。值:固定字符串 |
boarding_policy |
表示航空公司的登机政策。 如果未设置,Google 将默认采用 |
seat_class_policy |
就座政策,它规定我们如何显示舱位等级。如果未设置,Google 将默认采用 |
BoardingPolicy
| 枚举 | |
|---|---|
BOARDING_POLICY_UNSPECIFIED |
|
ZONE_BASED |
|
zoneBased |
|
GROUP_BASED |
|
groupBased |
|
BOARDING_POLICY_OTHER |
|
boardingPolicyOther |
|
SeatClassPolicy
| 枚举 | |
|---|---|
SEAT_CLASS_POLICY_UNSPECIFIED |
|
CABIN_BASED |
|
cabinBased |
|
CLASS_BASED |
|
classBased |
|
TIER_BASED |
|
tierBased |
|
SEAT_CLASS_POLICY_OTHER |
|
seatClassPolicyOther |
|
FlightCarrier
| 字段 | |
|---|---|
kind |
指明资源的种类。值:固定字符串 |
carrier_iata_code |
销售航空公司(与承运航空公司相对)的 IATA 航空公司代码,使用两个字符来表示。对于 例如:瑞士航空的销售航空公司 IATA 代码为“LX” |
carrier_icao_code |
销售航空公司(与承运航空公司相对)的 ICAO 航空公司代码,使用三个字符来表示。对于 例如:易捷航空的销售航空公司 ICAO 代码为“EZY” |
airline_name |
使用 carrierIataCode 来指定的航空公司本地化名称。如果未设置,则系统使用来自 例如:“LX”对应的本地化名称为“瑞士航空” |
airline_logo |
使用 carrierIataCode 和 localizedAirlineName 来描述的航空公司徽标。此徽标将呈现在卡详细信息视图的顶部。 |
airline_alliance_logo |
航空联盟的徽标,显示在乘客登机时扫描的二维码上方。 |
FlightClass
| 字段 | |
|---|---|
kind |
指明资源的种类。值:固定字符串 |
local_scheduled_departure_date_time |
必需。飞机离开登机口(而不是跑道)的预定日期和时间 注意:此字段的值不应太接近起飞时间。如需更新起飞时间(延误等),请设置 这是 ISO 8601 扩展格式的日期/时间,不带偏移量。可以指定精确到毫秒的时间。 例如: 此时间应该是机场的当地日期/时间(不是世界协调时间 (UTC))。 如果提供了世界协调时间 (UTC) 偏移量,Google 将拒绝请求。时区将由 Google 根据起飞机场来计算。 |
local_estimated_or_actual_departure_date_time |
飞机离开登机口的预计时间,或飞机离开登机口的实际时间。注意:此时间不是飞机离开跑道的时间。 如果至少满足下列一个条件,则您应该设置此字段:
这是 ISO 8601 扩展格式的日期/时间,不带偏移量。可以指定精确到毫秒的时间。 例如: 此时间应该是机场的当地日期/时间(不是世界协调时间 (UTC))。 如果提供了世界协调时间 (UTC) 偏移量,Google 将拒绝请求。时区将由 Google 根据起飞机场来计算。 如果未设置,Google 将根据其他来源的数据进行设置。 |
local_boarding_date_time |
将会印在登机牌上的登机时间。 这是 ISO 8601 扩展格式的日期/时间,不带偏移量。可以指定精确到毫秒的时间。 例如: 此时间应该是机场的当地日期/时间(不是世界协调时间 (UTC))。 如果提供了世界协调时间 (UTC) 偏移量,Google 将拒绝请求。时区将由 Google 根据起飞机场来计算。 如果未设置,Google 将根据其他来源的数据进行设置。 |
local_scheduled_arrival_date_time |
飞机到达目的地登机口(而非跑道)的预定时间。 注意:此字段的值不应太接近航班时间。如需更新起飞时间(延误等),请设置 这是 ISO 8601 扩展格式的日期/时间,不带偏移量。可以指定精确到毫秒的时间。 例如: 此时间应该是机场的当地日期/时间(不是世界协调时间 (UTC))。 如果提供了世界协调时间 (UTC) 偏移量,Google 将拒绝请求。时区将由 Google 根据到达机场来计算。 如果未设置,Google 将根据其他来源的数据进行设置。 |
local_estimated_or_actual_arrival_date_time |
飞机到达目的地登机口(而非跑道)的预计时间,或飞机到达登机口的实际时间。 如果至少满足下列一个条件,则您应该设置此字段:
这是 ISO 8601 扩展格式的日期/时间,不带偏移量。可以指定精确到毫秒的时间。 例如: 此时间应该是机场的当地日期/时间(不是世界协调时间 (UTC))。 如果提供了世界协调时间 (UTC) 偏移量,Google 将拒绝请求。时区将由 Google 根据到达机场来计算。 如果未设置,Google 将根据其他来源的数据进行设置。 |
flight_header |
必需。关于航空公司和航班号的信息。 |
origin |
必需。出发地机场。 |
destination |
必需。目的地机场。 |
flight_status |
本次航班的状态。 如果未设置,Google 将根据 FlightStats 等其他来源的数据来计算状态。 注意:API 响应中不会返回 Google 计算的状态。 |
boarding_and_seating_policy |
登机和就座政策。这些政策指示向用户显示哪些标签。 |
local_gate_closing_date_time |
将会印在登机牌上的登机口关闭时间。如果您不想将此时间印在登机牌上,请不要设置此字段。 这是 ISO 8601 扩展格式的日期/时间,不带偏移量。可以指定精确到毫秒的时间。 例如: 此时间应该是机场的当地日期/时间(不是世界协调时间 (UTC))。 如果提供了世界协调时间 (UTC) 偏移量,Google 将拒绝请求。时区将由 Google 根据起飞机场来计算。 |
class_template_info |
有关应如何显示类的模板信息。 如果未设置,Google 将回退为显示默认字段集。 |
language_override |
如果存在此字段,则提供到用户设备上的登机牌将始终使用此语言。表示 BCP 47 语言标记。示例值为“en-US”、“en-GB”、“de”或“de-AT”。 |
id |
必需。类的唯一标识符。此 ID 在一个发卡机构的所有类中必须是唯一的。此值应遵循“issuer IDidentifier”格式,其中发卡机构 ID 由 Google 提供,标识符由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。 |
version |
已弃用 |
issuer_name |
必需。发行机构名称。建议的最大长度为 20 个字符,以确保字符串能在较小的屏幕上完整显示。 |
messages[] |
在应用中显示的一组消息。此对象的所有用户都将收到其关联消息。这些字段的数量上限为 10。 |
allow_multiple_users_per_object |
已弃用。请改用 |
homepage_uri |
应用首页的 URI。在此字段中填充 URI 的效果与在 linksModuleData 中填充 URI 的效果完全相同(在呈现对象时,显示的首页链接通常被认为是该对象的 linksModuleData 部分)。 |
locations[] |
|
review_status |
必需。类的状态。此字段可通过插入、修补或更新 API 调用设置为 如果该类尚在开发中,您应将此字段保留为 如果您认为该类可以随时使用,您应将此字段设置为 更新 |
review |
当某个类被标记为 |
info_module_data |
已弃用。请改用 textModulesData。 |
image_modules_data[] |
图片模块数据。从对象级别开始,显示的字段数量上限为 1;对于类对象级别,上限也为 1。 |
text_modules_data[] |
文本模块数据。如果还在类中定义了文本模块数据,则将一并显示这些数据。从对象开始,显示的字段数量上限为 10;对于类,上限也为 10。 |
links_module_data |
链接模块数据。如果还在对象中定义了链接模块数据,则将一并显示这些数据。 |
redemption_issuers[] |
仅适用于支持智能触碰技术的合作伙伴。如需更多指导,请与支持人员联系。 |
country_code |
国家/地区代码,用于在用户不在该国家/地区时显示发卡国家/地区,以及在用户的语言区域未推出该内容时显示本地化的内容。 |
hero_image |
在卡片正面显示的可选横幅图片。如果不存在,则不会显示任何内容。图片将以 100% 宽度显示。 |
word_mark |
已弃用。 |
enable_smart_tap |
仅适用于支持智能触碰技术的合作伙伴。如需更多指导,请与支持人员联系。 |
hex_background_color |
卡片的背景颜色。如果未设置,则使用主打图片的主体色;如果未设置主打图片,则使用徽标的主体色。格式为 #rrggbb,其中 rrggbb 为十六进制 RGB 三元组,例如 |
localized_issuer_name |
已翻译的 issuer_name 字符串。建议的最大长度为 20 个字符,以确保字符串能在较小的屏幕上完整显示。 |
multiple_devices_and_holders_allowed_status |
指明是否允许多个用户和设备保存引用该类的同一个对象。 |
callback_options |
回调选项,用于在最终用户每次保存/删除此类的对象时回调发卡机构。此类的所有对象都可进行回调。 |
FlightStatus
| 枚举 | |
|---|---|
FLIGHT_STATUS_UNSPECIFIED |
|
SCHEDULED |
航班准时、提前或延误。 |
scheduled |
|
ACTIVE |
航班正在飞行(滑行、起飞、降落、升空)。 |
active |
|
LANDED |
航班已降落在原始目的地。 |
landed |
|
CANCELLED |
航班已取消。 |
cancelled |
|
REDIRECTED |
航班已升空,但要飞往与原始目的地不同的机场。 |
redirected |
|
DIVERTED |
航班已降落在与原始目的地不同的机场。 |
diverted |
|
FlightClassAddMessageRequest
| 字段 | |
|---|---|
resource_id |
类的唯一标识符。此 ID 在一个发卡机构的所有类中必须是唯一的。此值应遵循“issuer IDidentifier”格式,其中发卡机构 ID 由 Google 提供,标识符由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。 |
add_message_request |
请求的正文。 |
FlightClassAddMessageResponse
| 字段 | |
|---|---|
resource |
更新后的 FlightClass 资源。 |
FlightClassGetRequest
| 字段 | |
|---|---|
resource_id |
类的唯一标识符。此 ID 在一个发卡机构的所有类中必须是唯一的。此值应遵循“issuer IDidentifier”格式,其中发卡机构 ID 由 Google 提供,标识符由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。 |
FlightClassInsertRequest
| 字段 | |
|---|---|
resource |
请求的正文。 |
FlightClassListRequest
| 字段 | |
|---|---|
issuer_id |
有权列出类的发卡机构的 ID。 |
token |
如果已指定 |
max_results |
确定列表返回的结果数上限。如果未定义 |
FlightClassListResponse
| 字段 | |
|---|---|
resources[] |
与列表请求相对应的资源。 |
pagination |
响应的分页。 |
FlightClassPatchRequest
| 字段 | |
|---|---|
resource_id |
类的唯一标识符。此 ID 在一个发卡机构的所有类中必须是唯一的。此值应遵循“issuer IDidentifier”格式,其中发卡机构 ID 由 Google 提供,标识符由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。 |
resource |
请求的正文。 |
FlightClassUpdateRequest
| 字段 | |
|---|---|
resource_id |
类的唯一标识符。此 ID 在一个发卡机构的所有类中必须是唯一的。此值应遵循“issuer IDidentifier”格式,其中发卡机构 ID 由 Google 提供,标识符由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。 |
resource |
请求的正文。 |
FlightHeader
| 字段 | |
|---|---|
kind |
指明资源的种类。值:固定字符串 |
carrier |
关于航空公司的信息。这是 |
flight_number |
不含 IATA 航空公司代码的航班号。此字段应仅包含数字。这是 例如:“123” |
operating_carrier |
关于承运航空公司的信息。 |
operating_flight_number |
承运航空公司使用的不含 IATA 代码的航班号。此字段应仅包含数字。 例如:“234” |
FlightObject
| 字段 | |
|---|---|
kind |
指明资源的种类。值:固定字符串 |
class_reference |
父类的继承字段的副本。执行 GET 操作期间会检索这些字段。 |
passenger_name |
必需。显示在登机牌上的乘客姓名。 例如:“Dave M Gahan”、“Gahan/Dave”或“GAHAN/DAVEM” |
boarding_and_seating_info |
具体客户的登机和座位信息。 |
reservation_info |
必需。航班预订信息。 |
security_program_logo |
适用于乘客的安全计划图片。 |
hex_background_color |
卡片的背景颜色。如果未设置,则使用主打图片的主体色;如果未设置主打图片,则使用徽标的主体色。格式为 #rrggbb,其中 rrggbb 为十六进制 RGB 三元组,例如 |
id |
必需。对象的唯一标识符。此 ID 在一个发卡机构的所有对象中必须是唯一的。此值应遵循“issuer IDidentifier”格式,其中发卡机构 ID 由 Google 提供,标识符由您自行选择。该唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。 |
class_id |
必需。与此对象关联的类。该类必须与此对象具有相同的类型、已存在且已获批准。 类 ID 应遵循“issuer IDidentifier”格式,其中发卡机构 ID 由 Google 提供,标识符由您自行选择。 |
version |
已弃用 |
state |
必需。对象的状态。此字段用于确定对象在应用中的显示方式。例如,系统会将 |
barcode |
条形码的类型和值。 |
messages[] |
在应用中显示的一组消息。此对象的所有用户都将收到其关联消息。这些字段的数量上限为 10。 |
valid_time_interval |
此对象处于 |
locations[] |
可使用对象的位置的列表。平台使用此信息来触发发送给用户的地理定位通知。请注意,对象中的位置会替换类中的位置,而类中的位置又会替换 Google 商家信息 ID 中的位置。 |
has_users |
指明对象是否具有用户。此字段由平台设置。 |
smart_tap_redemption_value |
仅适用于支持智能触碰技术的合作伙伴。如需更多指导,请与支持人员联系。 |
has_linked_device |
指明此对象当前是否已关联到某个设备。当用户保存对象并将其关联到自己的设备时,平台会设置此字段。此字段仅供部分合作伙伴使用。如需获取更多信息,请与支持人员联系。 |
disable_expiration_notification |
指明是否明确禁止通知。如果此字段设置为 true,则无论 此属性目前仅可用于设置航班。 |
info_module_data |
已弃用。请改用 textModulesData。 |
image_modules_data[] |
图片模块数据。从对象级别开始,显示的字段数量上限为 1;对于类对象级别,上限也为 1。 |
text_modules_data[] |
文本模块数据。如果还在类中定义了文本模块数据,则将一并显示这些数据。从对象开始,显示的字段数量上限为 10;对于类,上限也为 10。 |
links_module_data |
链接模块数据。如果还在类中定义了链接模块数据,则将一并显示这些数据。 |
app_link_data |
有关合作伙伴应用链接的可选信息。 |
FlightObjectAddMessageRequest
| 字段 | |
|---|---|
resource_id |
对象的唯一标识符。此 ID 在一个发卡机构的所有对象中必须是唯一的。此值应遵循“issuer IDidentifier”格式,其中发卡机构 ID 由 Google 提供,标识符由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。 |
add_message_request |
请求的正文。 |
FlightObjectAddMessageResponse
| 字段 | |
|---|---|
resource |
更新后的 FlightObject 资源。 |
FlightObjectGetRequest
| 字段 | |
|---|---|
resource_id |
对象的唯一标识符。此 ID 在一个发卡机构的所有对象中必须是唯一的。此值应遵循“issuer IDidentifier”格式,其中发卡机构 ID 由 Google 提供,标识符由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。 |
FlightObjectInsertRequest
| 字段 | |
|---|---|
resource |
请求的正文。 |
FlightObjectListRequest
| 字段 | |
|---|---|
class_id |
要列出其对象的类的 ID。 |
token |
如果已指定 |
max_results |
确定列表返回的结果数上限。如果未定义 |
FlightObjectListResponse
| 字段 | |
|---|---|
resources[] |
与列表请求相对应的资源。 |
pagination |
响应的分页。 |
FlightObjectPatchRequest
| 字段 | |
|---|---|
resource_id |
对象的唯一标识符。此 ID 在一个发卡机构的所有对象中必须是唯一的。此值应遵循“issuer IDidentifier”格式,其中发卡机构 ID 由 Google 提供,标识符由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。 |
resource |
请求的正文。 |
FlightObjectUpdateRequest
| 字段 | |
|---|---|
resource_id |
对象的唯一标识符。此 ID 在一个发卡机构的所有对象中必须是唯一的。此值应遵循“issuer IDidentifier”格式,其中发卡机构 ID 由 Google 提供,标识符由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。 |
resource |
请求的正文。 |
FrequentFlyerInfo
| 字段 | |
|---|---|
kind |
指明资源的种类。值:固定字符串 |
frequent_flyer_program_name |
飞行常客奖励计划的名称。例如:“汉莎航空飞常里程汇” |
frequent_flyer_number |
飞行常客奖励计划编号。 对于每个类型为 |
ReservationInfo
| 字段 | |
|---|---|
kind |
指明资源的种类。值:固定字符串 |
confirmation_code |
办理此航班登机手续所需的确认码。 乘客在机场自助服务终端查询航班并打印登机牌时需要输入此号码。 |
eticket_number |
电子机票号码。 |
frequent_flyer_info |
飞行常客奖励计划会员信息。 |