- HTTP 要求
- 要求主體
- 回應主體
- Scope3FlightSegment
- Scope3FlightSegment.CabinClass
- Scope3FlightEmissions
- Scope3FlightEmissions.Scope3DataType
- 試試看!
擷取一組航班航段的溫室氣體排放量估計值,用於範圍 3 報告。
回應會包含與輸入的 Scope3FlightSegment 航班區段相符的所有項目,順序與輸入時相同。系統會使用下列層疊邏輯計算預估值 (使用第一個可用的值):
- 根據
origin、destination、carrier、flightNumber、departureDate和cabinClass提供的資料,以旅遊影響模型 (TIM) 為基礎計算排放量。 origin、destination、departureDate年和cabinClass的一般航班碳排放量。- 使用
distanceKm、departureDate和cabinClass計算的距離相關排放量。
如果今年度有未來的航班要求,我們不支援第 1 級排放量,將改用第 2 級或第 3 級排放量。如果要求的未來航班不在今年,我們會傳回空白回應。建議您在日後的測試中使用 computeFlightEmissions API。
如果使用上述任一方法,都無法取得特定航班的預估排放量,回應就會傳回 Scope3FlightEmissions 物件,但排放量欄位會留空。系統仍會將要求視為成功。一般來說,如果伺服器無法辨識航班 (例如沒有特定航班,或無法提供所要求配對的一般航班碳排放量),就會發生碳排放量估算值遺失的情況。
如有下列情況,要求會失敗並顯示 INVALID_ARGUMENT 錯誤:
- 要求包含超過 1,000 個航班航段。
- 輸入的航班航段缺少一或多個 ID。舉例來說,如果缺少
TIM_EMISSIONS或TYPICAL_FLIGHT_EMISSIONS類型相符項目的有效距離,或缺少DISTANCE_BASED_EMISSIONS類型相符項目的距離 (如要改用距離計算排放量或取得距離估算值,就必須指定距離)。 - 航班日期在 2019 年之前 (僅提供 2019 年之後的範圍 3 資料)。
- 飛行距離為 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 |
ID。與要求中的航班 ID 相符。 |
wtwEmissionsGramsPerPax |
(選用步驟) 根據要求資訊,每位乘客的航班排放總量 (油井到油箱和油箱到尾流的排放量總和)。這是排放總量,除非有使用 TTW 或 WTT 排放量的具體原因,否則應使用這個數字。 |
ttwEmissionsGramsPerPax |
(選用步驟) 根據要求資訊,計算每位乘客的「油箱到尾流」航班排放量。 |
wttEmissionsGramsPerPax |
(選用步驟) 根據要求資訊,計算每位乘客的油井到油箱航班排放量。 |
source |
(選用步驟) 排放量資料的來源。 |
Scope3FlightEmissions.Scope3DataType
用於計算範圍 3 排放量的比對類型。用於範圍 3 回覆,標示計算排放量所用的方法。
| 列舉 | |
|---|---|
SCOPE3_DATA_TYPE_UNSPECIFIED |
未指定資料類型。 |
TIM_EMISSIONS |
根據出發地、目的地、航空公司、航班編號、出發日期和年份,計算出 TIM 排放量。 |
TYPICAL_FLIGHT_EMISSIONS |
特定出發地、目的地和年份的一般航班碳排放量。 |
DISTANCE_BASED_EMISSIONS |
根據行駛距離和年份計算的排放量。 |