- HTTP リクエスト
- リクエストの本文
- レスポンスの本文
- Scope3FlightSegment
- Scope3FlightSegment.CabinClass
- Scope3FlightEmissions
- Scope3FlightEmissions.Scope3DataType
- 試してみる
スコープ 3 レポート用の一連のフライト区間の GHG 排出量の推定値を取得します。
レスポンスには、入力された Scope3FlightSegment フライト セグメントと一致するすべてのエントリが、指定された順序で含まれます。推定値は、次のカスケード ロジックを使用して計算されます(最初に使用可能なものを使用)。
origin、destination、carrier、flightNumber、departureDate、cabinClassを指定した TIM ベースの排出量。origin、destination、departureDateの年、cabinClassを指定した場合の一般的なフライトの排出量。- 距離ベースの排出量は、
distanceKm、departureDateの年、cabinClassを使用して計算されます。
この暦年でリクエストされた将来のフライトがある場合、Tier 1 の排出量はサポートされず、Tier 2 または Tier 3 の排出量にフォールバックされます。リクエストされた将来のフライトが今年でない場合は、空のレスポンスが返されます。今後のフライトでは、代わりに computeFlightEmissions API を使用することをおすすめします。
3 つの方法のいずれでも特定のフライトの推定値を取得できない場合、レスポンスは排出量フィールドが空の Scope3FlightEmissions オブジェクトを返します。リクエストは成功とみなされます。一般に、排出量の推定値が欠落するのは、フライトがサーバーに認識されていない場合です(たとえば、特定のフライトが存在しない場合や、リクエストされたペアの一般的なフライト排出量が利用できない場合など)。
次の場合、リクエストは INVALID_ARGUMENT エラーで失敗します。
- リクエストに 1,000 件を超えるフライト区間が含まれています。
- 入力されたフライト区間に 1 つ以上の識別子がありません。たとえば、
TIM_EMISSIONSタイプまたはTYPICAL_FLIGHT_EMISSIONSタイプのマッチングで有効な距離がない出発地/目的地がない、またはDISTANCE_BASED_EMISSIONSタイプのマッチングで距離がない(距離ベースの排出量にフォールバックする場合や、距離ベースの排出量推定が必要な場合は、距離を指定する必要があります)。 - フライトの日付が 2019 年より前である(スコープ 3 のデータは 2019 年以降のみ利用可能)。
- フライト距離が 0 以下です。
- 座席クラスが指定されていません。
リクエストはフォールバック ロジックで処理されるため、構成が誤っているリクエストでも、フォールバック メソッドを使用して有効な排出量推定値が返される可能性があります。たとえば、リクエストに間違った便名が含まれていても、出発地と目的地が指定されていれば、リクエストは成功しますが、返される排出量は一般的なフライトの排出量のみに基づきます。同様に、一般的なフライト排出量リクエストで出発地が指定されていないものの、有効な距離が指定されている場合、距離ベースの排出量のみに基づいてリクエストが成功する可能性があります。そのため、返された排出量のソース(source)を確認して、結果が想定どおりであることを確認する必要があります。
HTTP リクエスト
POST https://travelimpactmodel.googleapis.com/v1/flights:computeScope3FlightEmissions
この URL は gRPC Transcoding 構文を使用します。
リクエストの本文
リクエストの本文には、次の構造のデータが含まれます。
| 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 |
省略可。リクエストされた情報に基づく、乗客 1 人あたりの総フライト排出量(Well-to-Tank と Tank-to-Wake の合計)。これは総排出量であり、TTW 排出量または WTT 排出量を使用する特別な理由がない限り、この数値を使用する必要があります。 |
ttwEmissionsGramsPerPax |
省略可。リクエストされた情報に基づく、乗客 1 人あたりのタンク・トゥ・ウェイク フライト排出量。 |
wttEmissionsGramsPerPax |
省略可。リクエストされた情報に基づく、乗客 1 人あたりの Well-to-Tank フライト排出量。 |
source |
省略可。排出量データのソース。 |
modelVersion |
省略可。排出量の計算に使用されたモデルのバージョン。 |
Scope3FlightEmissions.Scope3DataType
スコープ 3 排出量の計算に使用されるマッチングのタイプ。これはスコープ 3 の回答に使用され、排出量の計算に使用された方法を示します。
| 列挙型 | |
|---|---|
SCOPE3_DATA_TYPE_UNSPECIFIED |
未指定のデータタイプ。 |
TIM_EMISSIONS |
出発地、目的地、航空会社、便名、出発日、出発年に基づく TIM ベースの排出量。 |
TYPICAL_FLIGHT_EMISSIONS |
出発地、目的地、年を基準としたフライト標準排出量。 |
DISTANCE_BASED_EMISSIONS |
移動距離と年に基づく距離ベースの排出量。 |