Package google.travel.sustainability.travelimpactmodel.v1

索引

• TravelImpactModelService（接口）
• ComputeFlightEmissionsRequest（消息）
• ComputeFlightEmissionsResponse（消息）
• ComputeScope3FlightEmissionsRequest（消息）
• ComputeScope3FlightEmissionsResponse（消息）
• ComputeTypicalFlightEmissionsRequest（消息）
• ComputeTypicalFlightEmissionsResponse（消息）
• ContrailsImpactBucket（枚举）
• EasaLabelMetadata（消息）
• EmissionsGramsPerPax（消息）
• Flight（消息）
• FlightWithEmissions（消息）
• Market（消息）
• ModelVersion（消息）
• Scope3FlightEmissions（消息）
• Scope3FlightEmissions.Scope3DataType（枚举）
• Scope3FlightSegment（消息）
• Scope3FlightSegment.CabinClass（枚举）
• Source（枚举）
• TypicalFlightEmissions（消息）

TravelImpactModelService

用于提供碳排放量估算的 API。

ComputeFlightEmissions
rpc ComputeFlightEmissions(ComputeFlightEmissionsRequest) returns (ComputeFlightEmissionsResponse) 用于检索排放量估算的无状态方法。如需详细了解排放量估算值的计算方式，请参阅 GitHub 响应将包含与输入航段匹配的所有条目，并按相同的顺序排列。如果某个航段没有估算值，则响应将返回包含空排放量字段的航段对象。相应请求仍会被视为成功。排放量估计值缺失的原因包括： 服务器无法识别相应航班。 输入的航班段缺少一个或多个标识符。 航班日期是过去的日期。 相应型号不支持该飞机类型。 缺少座位配置。 该请求最多可包含 1,000 个航班段。如果请求包含的直飞航班超过 1000 个，则会失败并显示 INVALID_ARGUMENT 错误。

ComputeScope3FlightEmissions

rpc ComputeScope3FlightEmissions(ComputeScope3FlightEmissionsRequest) returns (ComputeScope3FlightEmissionsResponse) 用于检索一组飞行段的温室气体排放量估计值以进行范围 3 报告的无状态方法。 响应将包含与输入 Scope3FlightSegment 航班段匹配的所有条目，并按提供的顺序排列。系统将使用以下级联逻辑（使用第一个可用的逻辑）计算估计值： 基于 TIM 的排放量（给定 origin、destination、carrier、flightNumber、departureDate 和 cabinClass）。 给定 origin、destination、年份（departureDate）和 cabinClass 的典型航班排放量。 使用 distanceKm、departureDate 中的年份和 cabinClass 计算的基于距离的排放量。 如果此日历年内有未来航班请求，我们不支持 Tier 1 排放，并将回退到 Tier 2 或 3 排放。如果所请求的未来航班不在当前日历年内，我们将返回空响应。我们建议在未来的航班中使用 computeFlightEmissions API。 如果无法通过任何一种方法估算特定航班的碳排放量，响应将返回一个包含空排放量字段的 Scope3FlightEmissions 对象。相应请求仍会被视为成功。一般来说，如果服务器不知道相应航班（例如，不存在特定航班，或者没有所请求的配对的典型航班排放量），则会缺少排放量估算值。 如果出现以下情况，请求将失败并显示 INVALID_ARGUMENT 错误： 相应请求包含的航班段超过 1,000 个。 输入的航班段缺少一个或多个标识符。例如，缺少起点/终点，且没有有效的距离（对于 TIM_EMISSIONS 或 TYPICAL_FLIGHT_EMISSIONS 类型匹配），或者缺少距离（对于 DISTANCE_BASED_EMISSIONS 类型匹配；如果您想回退到基于距离的排放量或想获得基于距离的排放量估算值，则需要指定距离）。 航班日期在 2019 年之前（范围 3 数据仅适用于 2019 年及之后）。 飞行距离为 0 或更低。 缺少舱位。 由于请求是使用回退逻辑处理的，因此配置错误的请求可能会使用回退方法返回有效的排放估算值。例如，如果请求的航班号有误，但指定了出发地和目的地，请求仍会成功，但返回的碳排放量将仅基于典型航班的碳排放量。同样，如果请求缺少典型航班排放请求的来源，但指定了有效距离，则该请求可能会仅基于距离的排放量成功。因此，应检查返回的广播的来源 (source)，以确认结果是否符合预期。

ComputeTypicalFlightEmissions
rpc ComputeTypicalFlightEmissions(ComputeTypicalFlightEmissionsRequest) returns (ComputeTypicalFlightEmissionsResponse) 检索两个机场（也称为市场）之间的典型航班排放量估算值。如果某个市场没有估算值，响应将返回排放字段为空的市场对象。系统仍会将该请求视为成功。 如需详细了解典型排放量估算的计算方式，请访问 GitHub。 请求最多可包含 1,000 个市场。如果请求包含的市场数量超过 1000 个，则会失败并显示 INVALID_ARGUMENT 错误。

ComputeFlightEmissionsRequest

针对 ComputeFlightEmissions 请求的输入定义。

字段
flights[]	Flight 必需。直飞航班，用于返回排放量估算值。

ComputeFlightEmissionsResponse

针对 ComputeFlightEmissions 响应的输出定义。

字段
flight_emissions[]	FlightWithEmissions 包含排放量预估值的航段列表。
model_version	ModelVersion 计算相应回答中所有航班的排放量估算值所依据的模型版本。

ComputeScope3FlightEmissionsRequest

要请求的飞行段的范围 3 排放量列表。

字段
flights[]	Scope3FlightSegment 必需。要返回排放量估算的航班。
model_version	ModelVersion 可选。计算相应请求中所有航班的排放量估算值所依据的模型版本。

ComputeScope3FlightEmissionsResponse

包含范围 3 排放量估算的航班列表。

字段
flight_emissions[]	Scope3FlightEmissions 包含排放量预估值的航班段列表。
model_version	ModelVersion 计算相应回答中所有航班的排放量估算值所依据的模型版本。

ComputeTypicalFlightEmissionsRequest

要请求典型排放量的机场（市场）对的列表。

字段
markets[]	Market 必需。请求获取相应市场对的典型航班排放量估算值。最多可请求 1,000 个市场。

ComputeTypicalFlightEmissionsResponse

响应包含排放量，还包含模型版本。

字段
typical_flight_emissions[]	TypicalFlightEmissions 请求了市场的典型航班排放量。
model_version	ModelVersion 计算此响应中所有航班的典型航班排放量估算值所依据的模型版本。

ContrailsImpactBucket

航迹云增温影响相对于二氧化碳当量总排放量影响的显著性。

枚举
CONTRAILS_IMPACT_UNSPECIFIED	未指定凝结尾的影响。
CONTRAILS_IMPACT_NEGLIGIBLE	与二氧化碳当量总排放量相比，航迹云的影响微不足道。
CONTRAILS_IMPACT_MODERATE	航迹云的影响与二氧化碳当量的总排放量相当。
CONTRAILS_IMPACT_SEVERE	航迹云的影响高于二氧化碳当量排放总量的影响。

EasaLabelMetadata

有关 EASA 航班排放量标签的元数据。

字段
label_issue_date	Date 标签的签发日期。
label_expiry_date	Date 标签的失效日期。此标签可显示到此日期结束。
label_version	string 标签的版本。
saf_discount_percentage	double 应用于标签的可再生航空燃料 (SAF) 排放折扣百分比。以小数形式表示的百分比。这些值介于区间 [0,1] 内。例如，0.0021 表示 0.21%。 此折扣和减排量由 EASA 标签报告，但未包含在此 API 分发的二氧化碳当量估算值中。

EmissionsGramsPerPax

按舱位等级分组的排放量结果。

字段
first	int32 头等舱中一位乘客的排放量（以克为单位）。无论飞机是否配备头等舱座位，系统都会始终计算并填充此字段。
business	int32 一位商务舱乘客的排放量（以克为单位）。无论飞机是否配备商务舱座位，系统都会始终计算并填充此字段。
premium_economy	int32 一位乘客乘坐豪华经济舱的排放量（以克为单位）。无论飞机是否配备了高级经济舱座位，系统都会始终计算并填充此字段。
economy	int32 一位经济舱乘客的排放量（以克为单位）。无论飞机是否配备经济舱座位，系统都会始终计算并填充此字段。

机票

与直飞航班排放量估算值的单个请求项相关的所有详细信息。

字段
origin	string 必需。航班出发地的 IATA 机场代码，例如“LHR”。
destination	string 必需。航班目的地的 IATA 机场代码，例如“JFK”。
operating_carrier_code	string 必需。IATA 航空公司代码，例如“AA”。
flight_number	int32 必需。航班号，例如 324。
departure_date	Date 必需。航班日期（以始发机场的时区为准）。必须是当前或未来的日期。

FlightWithEmissions

直飞航班，并提供排放量预估值。

字段
flight	Flight 必需。匹配请求中的实验标识符。注意：所有 IATA 代码均采用大写形式。
source	Source 可选。排放数据来源。
emissions_grams_per_pax	EmissionsGramsPerPax 可选。每位乘客的排放量预估值。如果无法计算碳排放量，则不会显示此属性。如需查看无法计算排放量的原因列表，请参阅 ComputeFlightEmissions。
easa_label_metadata	EasaLabelMetadata 可选。有关 EASA 航班排放量标签的元数据。仅在排放数据源为 EASA 时进行设置。
contrails_impact_bucket	ContrailsImpactBucket 可选。航迹云增温影响相对于二氧化碳当量总排放量影响的显著性。

Market

一对机场。

字段
origin	string 必需。航班出发地的 IATA 机场代码，例如“LHR”。
destination	string 必需。航班目的地的 IATA 机场代码，例如“JFK”。

ModelVersion

旅行影响模型版本。如需详细了解模型版本控制，请参阅 GitHub。

字段
major	int32 主要版本：方法发生重大变化（例如，向模型添加新数据源，导致输出发生重大变化）。此类变更不会经常发生，并且会提前很长时间公布。可能涉及 API 版本变更，这些变更将遵循 Google Cloud API 指南
minor	int32 次要版本：对模型进行的更改，虽然在不同架构版本中保持一致，但会更改模型参数或实现。
patch	int32 补丁版本：旨在解决模型实现中的 bug 或不准确之处的实现变更。
dated	string 带日期的版本：模型数据集会定期使用更新后的输入数据重新创建，但算法不会发生变化。

Scope3FlightEmissions

范围 3 航班，附有排放量预估值。

字段
flight	Scope3FlightSegment 必需。匹配请求中的实验标识符。
wtw_emissions_grams_per_pax	int64 可选。根据所请求的信息，每位乘客的总飞行排放量（油井到油箱和油箱到尾迹的排放量之和）。这是总排放量，除非您有使用 TTW 或 WTT 排放量的具体原因，否则应使用此数值。
ttw_emissions_grams_per_pax	int64 可选。根据所请求的信息，每位乘客的从油箱到尾迹的飞行排放量。
wtt_emissions_grams_per_pax	int64 可选。根据所请求的信息，每位乘客的从油井到油箱的飞行排放量。
source	Scope3DataType 可选。排放数据来源。

Scope3DataType

用于计算范围 3 排放量的匹配类型。用于范围 3 回答，用于标记计算排放量所用的方法。

枚举
SCOPE3_DATA_TYPE_UNSPECIFIED	未指定数据类型。
TIM_EMISSIONS	基于出发地、目的地、运输公司、航班号、出发日期和年份的 TIM 排放量。
TYPICAL_FLIGHT_EMISSIONS	指定出发地、目的地和年份的典型航班排放量。
DISTANCE_BASED_EMISSIONS	基于行驶距离和年份的排放量。

Scope3FlightSegment

用于提取范围 3 排放量的航班参数。

字段
departure_date	Date 必需。航班日期（以始发机场的时区为准）。对于典型的基于飞行和距离的排放模型，只需要年份（系统会忽略月份和日期值，因此，在这些情况下，可以省略月份和日期值，也可以将其设置为 0 或有效日期）。相应地，如果未提供特定日期的 TIM 排放量，我们将改用典型航班（或基于距离的）排放量。
cabin_class	CabinClass 必需。相应航班的舱位。
origin	string 可选。航班出发地的 IATA 机场代码，例如 YVR。如果与目的地、航空公司和航班号一起提供，则用于匹配特定航班。如果没有匹配项，我们会先尝试将航班与所提供的出发地机场和目的地机场之间的典型航班进行匹配。否则，如果提供了航班距离，我们将使用基于距离的排放模型。
destination	string 可选。航班目的地的 IATA 机场代码，例如 ICN。如果与始发地、航空公司和航班号一起提供，则用于匹配特定航班。如果没有匹配项，我们会先尝试将航班与所提供的出发地机场和目的地机场之间的典型航班进行匹配。否则，如果提供了航班距离，我们将使用基于距离的排放模型。
carrier_code	string 可选。IATA 航空公司代码，例如 KE。如果需要匹配特定航班，则必须提供此信息。否则，对于典型的航班和基于距离的排放模型，此参数不会使用。这可以是运营航空公司代码，也可以是营销航空公司代码（即涵盖代码共享）。
flight_number	int32 可选。航班号，例如 71。如果指定了航班号以及始发地、目的地和航空公司，系统会先使用此参数来匹配特定航班。如果未指定航班号，我们会先尝试将航班与所提供的始发机场和到达机场之间的典型航班进行匹配。如果该方法失败，并且/或者未提供出发地和目的地，我们将使用基于所提供飞行距离的基于距离的排放模型。
distance_km	int64 可选。以公里为单位的距离，例如 2423。当未提供始发地和目的地或没有匹配的典型航班时，此值用于将航班与基于距离的排放量进行匹配。此字段支持介于 0 和 2.5e16 公里之间的值。

CabinClass

相应航班的舱位。

枚举
CABIN_CLASS_UNSPECIFIED	未指定舱位。
ECONOMY	经济舱。
PREMIUM_ECONOMY	豪华经济舱。
BUSINESS	商务舱。
FIRST	头等舱。

来源

排放数据来源。

枚举
SOURCE_UNSPECIFIED	碳排放数据的来源未指定。
TIM	排放数据来自旅行影响模型。
EASA	排放数据来自 EASA 环保标签。

TypicalFlightEmissions

特定市场的典型航班排放量估算值

字段
market	Market 必需。匹配请求中的实验标识符。注意：所有 IATA 代码均采用大写形式。
emissions_grams_per_pax	EmissionsGramsPerPax 可选。所请求市场的每位乘客的典型航班排放量。如果无法计算典型排放量，则不会显示此属性。如需查看无法计算典型航班排放量的原因列表，请参阅 GitHub。