Method: flights.computeScope3FlightEmissions

用于检索一组航班段的温室气体排放量估算值(用于范围 3 报告)的无状态方法。

响应将包含与输入 Scope3FlightSegment 航班段匹配的所有条目,且顺序与提供的顺序相同。估算值将使用以下级联逻辑(使用第一个可用的逻辑)计算:

  1. 根据 origindestinationcarrierflightNumberdepartureDatecabinClass 计算的基于 TIM 的排放量。
  2. 根据 origindestinationdepartureDate 中的年份和 cabinClass 计算的典型航班排放量。
  3. 根据 distanceKmdepartureDate 中的年份和 cabinClass 计算的基于距离的排放量。

如果请求的未来航班在本日历年内,我们将不支持第 1 层级的碳排放量,而是回退到第 2 层级或第 3 层级的碳排放量。如果请求的未来航班不在本日历年内,我们将返回空响应。我们建议,对于未来航班,请改用 computeFlightEmissions API。

如果使用这三种方法中的任何一种都无法估算特定航班的排放量,响应将返回一个包含空排放量字段的 Scope3FlightEmissions 对象。请求仍将被视为成功。通常,当服务器不知道航班时(例如,不存在特定航班,或者请求的航班对没有典型的航班排放量),就会出现排放量估算值缺失的情况。

如果出现以下情况,请求将失败并返回 INVALID_ARGUMENT 错误:

  • 请求包含 1,000 个以上的航班段。
  • 输入航班段缺少一个或多个标识符。例如,缺少始发地/目的地,且没有与 TIM_EMISSIONSTYPICAL_FLIGHT_EMISSIONS 类型匹配的有效距离;或者缺少与 DISTANCE_BASED_EMISSIONS 类型匹配的距离(如果您想回退到基于距离的排放量或想要基于距离的排放量估算值,则需要指定距离)。
  • 航班日期早于 2019 年(范围 3 数据仅适用于 2019 年及之后)。
  • 航班距离为 0 或更低。
  • 缺少舱位。

由于请求是使用回退逻辑处理的,因此配置错误的请求可能会使用回退方法返回有效的排放量估算值。例如,如果请求的航班号错误,但指定了出发地和目的地,请求仍会成功,但返回的排放量将仅基于典型的航班排放量。同样,如果请求缺少典型航班碳排放量请求的出发地,但指定了有效距离,请求可能会仅基于基于距离的碳排放量而成功。因此,您应检查返回的排放量的来源 (source),以确认结果是否符合预期。

HTTP 请求

POST https://travelimpactmodel.googleapis.com/v1/flights:computeScope3FlightEmissions

网址采用 gRPC 转码语法。

请求正文

请求正文中包含结构如下的数据:

JSON 表示法
{
  "flights": [
    {
      object (Scope3FlightSegment)
    }
  ],
  "modelVersion": {
    object (ModelVersion)
  }
}
字段
flights[]

object (Scope3FlightSegment)

必需。要返回排放量估算值的航班。

modelVersion

object (ModelVersion)

可选。计算此请求中所有航班的排放量估算值所依据的模型版本。

响应正文

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

如果成功,响应正文将包含结构如下的数据:

JSON 表示法
{
  "flightEmissions": [
    {
      object (Scope3FlightEmissions)
    }
  ],
  "modelVersion": {
    object (ModelVersion)
  }
}
字段
flightEmissions[]

object (Scope3FlightEmissions)

包含排放量估算值的航班段列表。

modelVersion

object (ModelVersion)

计算此响应中所有航班的排放量估算值所依据的模型版本。

Scope3FlightSegment

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

JSON 表示法
{
  "departureDate": {
    object (Date)
  },
  "cabinClass": enum (CabinClass),
  "origin": string,
  "destination": string,
  "carrierCode": string,
  "flightNumber": integer,
  "distanceKm": string
}
字段
departureDate

object (Date)

必需。航班在出发地机场时区的日期。对于典型航班和基于距离的排放量模型,只需要年份(系统会忽略月份和日期值,因此,在这些情况下,可以省略月份和日期值,也可以将其设置为 0,或者设置为有效日期)。相应地,如果未提供 TIM 排放量的具体日期,我们将回退到典型航班(或基于距离的)排放量。

cabinClass

enum (CabinClass)

必需。航班的舱位。

origin

string

可选。航班始发地的 3 个字符的 IATA 机场代码,例如 YVR。如果与目的地、航空公司和航班号一起提供,则用于匹配特定航班。如果没有匹配项,我们将首先尝试将航班与提供的出发地和目的地机场之间的典型航班进行匹配。否则,如果提供了航班距离,我们将使用基于距离的排放量模型。

destination

string

可选。航班目的地的 3 个字符的 IATA 机场代码,例如 ICN。如果与出发地、运输公司和航班号一起提供,则用于匹配特定航班。如果没有匹配项,我们将首先尝试将航班与提供的出发地和目的地机场之间的典型航班进行匹配。否则,如果提供了航班距离,我们将使用基于距离的排放量模型。

carrierCode

string

可选。2 个字符的 IATA 航空公司代码,例如 KE。如果需要匹配特定航班,则必须提供此代码。否则,对于典型航班和基于距离的排放量模型,此代码将不会使用。这可以是运营航空公司代码和营销航空公司代码(即涵盖代码共享)。

flightNumber

integer

可选。最多 4 位数的 航班号,例如 71,范围为 [1, 9999]。如果指定了航班号以及出发地、目的地和运输公司,系统会首先使用此航班号来匹配特定航班。如果未指定航班号,我们将首先尝试将航班与提供的出发地和目的地机场之间的典型航班进行匹配。如果匹配失败和/或未提供出发地和目的地,我们将根据提供的航班距离使用基于距离的碳排放模型。

distanceKm

string (int64 format)

可选。以公里为单位的距离,例如 2423,范围为 [1, 2.5e16) 公里。如果未提供出发地和目的地,或者没有匹配的典型航班,则用于将航班与基于距离的碳排放量进行匹配。

CabinClass

航班的舱位。

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

Scope3FlightEmissions

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

JSON 表示法
{
  "flight": {
    object (Scope3FlightSegment)
  },
  "wtwEmissionsGramsPerPax": string,
  "ttwEmissionsGramsPerPax": string,
  "wttEmissionsGramsPerPax": string,
  "source": enum (Scope3DataType)
}
字段
flight

object (Scope3FlightSegment)

标识符。与请求中的航班标识符匹配。

wtwEmissionsGramsPerPax

string (int64 format)

可选。根据请求的信息,每位乘客的总航班排放量(从油井到油箱的排放量与从油箱到尾迹的排放量之和)。这是总排放量,除非您有使用 TTW 或 WTT 排放量的具体原因,否则应使用此数字。

ttwEmissionsGramsPerPax

string (int64 format)

可选。根据请求的信息,每位乘客从油箱到尾迹的航班排放量。

wttEmissionsGramsPerPax

string (int64 format)

可选。根据请求的信息,每位乘客从油井到油箱的航班排放量。

source

enum (Scope3DataType)

可选。排放量数据的来源。

Scope3DataType

用于计算范围 3 排放量的匹配类型。这用于范围 3 响应,用于标记计算排放量所使用的方法。

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