- HTTP 请求
- 请求正文
- 响应正文
- Scope3FlightSegment
- Scope3FlightSegment.CabinClass
- Scope3FlightEmissions
- Scope3FlightEmissions.Scope3DataType
- 试试看!
检索一组航段的温室气体排放量估算值,以用于范围 3 报告。
响应将包含与输入 Scope3FlightSegment 航段匹配的所有条目,并按提供的顺序排列。系统将使用以下级联逻辑(使用第一个可用的逻辑)计算估算值:
- 基于 TIM 的排放量,给定
origin、destination、carrier、flightNumber、departureDate和cabinClass。 origin、destination、departureDate年和cabinClass的典型航班排放量。- 基于距离的排放量是使用
distanceKm、departureDate年和cabinClass计算得出的。
如果请求的航班在本日历年内,我们不支持第 1 层级排放量,而是会回退到第 2 层级或第 3 层级排放量。如果请求的未来航班不在本公历年内,我们将返回空响应。我们建议您在未来的航班中使用 computeFlightEmissions API。
如果通过这三种方法都无法获取某个航班的预估值,则响应将返回一个 Scope3FlightEmissions 对象,其中包含空的排放量字段。该请求仍会被视为成功。通常,如果服务器无法识别航班(例如,不存在特定航班,或者所请求的航班对没有典型航班排放量),就会出现排放量估算值缺失的情况。
如果出现以下情况,请求将失败并显示 INVALID_ARGUMENT 错误:
- 请求包含超过 1,000 个航段。
- 输入的航段缺少一个或多个标识符。例如,缺少出发地/目的地,且没有有效的距离,无法进行
TIM_EMISSIONS或TYPICAL_FLIGHT_EMISSIONS类型匹配;或者缺少距离,无法进行DISTANCE_BASED_EMISSIONS类型匹配(如果您想回退到基于距离的排放量,或想要基于距离的排放量估算值,则需要指定距离)。 - 航班日期早于 2019 年(范围 3 数据仅适用于 2019 年及之后)。
- 航班距离为 0 或更低。
- 缺少舱位。
由于请求是使用回退逻辑处理的,因此配置错误的请求可能会使用回退方法返回有效的排放量估算值。例如,如果请求中的航班号有误,但指定了出发地和目的地,则请求仍会成功,但返回的排放量将仅基于典型航班排放量。同样,如果请求缺少典型航班排放请求的出发地,但指定了有效距离,则该请求可能会成功,但仅会返回基于距离的排放量。因此,您应检查返回的排放量 (source) 的来源,以确认结果是否符合预期。
HTTP 请求
POST https://travelimpactmodel.googleapis.com/v1/flights:computeScope3FlightEmissions
网址采用 gRPC 转码语法。
请求正文
请求正文中包含结构如下的数据:
| JSON 表示法 |
|---|
{ "flights": [ { object ( |
| 字段 | |
|---|---|
flights[] |
必需。要返回排放量预估值的航班。 |
modelVersion |
可选。用于计算此请求中所有航班排放量预估值的模型版本。 |
响应正文
包含范围 3 排放量估算值的航班列表。
如果成功,响应正文将包含结构如下的数据:
| JSON 表示法 |
|---|
{ "flightEmissions": [ { object ( |
| 字段 | |
|---|---|
flightEmissions[] |
包含排放量预估值的航段列表。 |
modelVersion |
计算此响应中所有航班的排放量预估值时所用的模型版本。 |
Scope3FlightSegment
用于提取范围 3 排放量的航班参数。
| JSON 表示法 |
|---|
{ "departureDate": { object ( |
| 字段 | |
|---|---|
departureDate |
必需。航班日期(采用始发机场的时区)。对于典型的航班和基于距离的排放模型,只需提供年份(月份和日期值会被忽略,因此在这些情况下,可以省略、设置为 0 或设置为有效日期)。相应地,如果未提供 TIM 排放量的具体日期,我们将回退到典型航班(或基于距离)的排放量。 |
cabinClass |
必需。航班的舱位。 |
origin |
可选。航班出发地的 3 字符 IATA 机场代码,例如 |
destination |
可选。航班目的地的 3 字符 IATA 机场代码,例如 |
carrierCode |
可选。2 个字符的航空公司 IATA 代码,例如 |
flightNumber |
可选。最多 4 位数的航班号,例如 |
distanceKm |
可选。距离(以公里为单位),例如 |
Scope3FlightSegment.CabinClass
航班的舱位。
| 枚举 | |
|---|---|
CABIN_CLASS_UNSPECIFIED |
未指定舱位。 |
ECONOMY |
经济舱。 |
PREMIUM_ECONOMY |
豪华经济舱。 |
BUSINESS |
商务舱。 |
FIRST |
头等舱。 |
Scope3FlightEmissions
范围 3 航班,附带排放量预估值。
| JSON 表示法 |
|---|
{ "flight": { object ( |
| 字段 | |
|---|---|
flight |
标识符。与请求中的航班标识符匹配。 |
wtwEmissionsGramsPerPax |
可选。根据所请求的信息,每位乘客的总航班排放量(油井到油箱和油箱到尾迹的总和)。这是总排放量,除非您有特定原因需要使用 TTW 或 WTT 排放量,否则应使用此数字。 |
ttwEmissionsGramsPerPax |
可选。根据所请求的信息,每位乘客的航班排放量(从油箱到尾迹)。 |
wttEmissionsGramsPerPax |
可选。根据所请求的信息,计算出的每位乘客的航班开采到油箱排放量。 |
source |
可选。排放数据的来源。 |
modelVersion |
可选。计算排放量时所用的模型版本。 |
Scope3FlightEmissions.Scope3DataType
用于计算范围 3 排放量的匹配类型。此字段用于范围 3 响应,标记用于计算排放量的方法。
| 枚举 | |
|---|---|
SCOPE3_DATA_TYPE_UNSPECIFIED |
未指定的数据类型。 |
TIM_EMISSIONS |
根据出发地、目的地、航空公司、航班号、出发日期和年份,提供基于 TIM 的排放量。 |
TYPICAL_FLIGHT_EMISSIONS |
给定出发地、目的地和年份的典型航班排放量。 |
DISTANCE_BASED_EMISSIONS |
基于距离的排放量,根据行驶距离和年份计算。 |