- HTTP リクエスト
- リクエストの本文
- レスポンスの本文
- Scope3FlightSegment
- CabinClass
- Scope3FlightEmissions
- Scope3DataType
- 試してみる
スコープ 3 レポート用のフライト区間のセットの GHG 排出量推定値を取得するステートレス メソッド。
レスポンスには、入力された Scope3FlightSegment フライト区間に一致するすべてのエントリが、指定された順序で含まれます。推定値は、次のカスケード ロジック(使用可能な最初のものを使用)を使用して計算されます。
origin、destination、carrier、flightNumber、departureDate、cabinClassに基づく TIM ベースの排出量。origin、destination、departureDateの年、cabinClassに基づく一般的なフライトの排出量。distanceKm、departureDateの年、cabinClassを使用して計算された距離ベースの排出量。
この暦年にリクエストされた今後のフライトがある場合、Tier 1 の排出量はサポートされず、Tier 2 または 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 |
省略可。キロメートル単位の距離(例: |
CabinClass
フライトの座席クラス。
| 列挙型 | |
|---|---|
CABIN_CLASS_UNSPECIFIED |
座席クラスが指定されていません。 |
ECONOMY |
エコノミー クラス。 |
PREMIUM_ECONOMY |
プレミアム エコノミー クラス。 |
BUSINESS |
ビジネスクラス。 |
FIRST |
ファーストクラス。 |
Scope3FlightEmissions
排出量推定値を含むスコープ 3 のフライト。
| JSON 表現 |
|---|
{ "flight": { object ( |
| フィールド | |
|---|---|
flight |
ID。リクエストのフライト ID と一致します。 |
wtwEmissionsGramsPerPax |
省略可。リクエストされた情報に基づく、乗客 1 人あたりのフライトの総排出量(井戸からタンクまでの排出量とタンクから翼までの排出量の合計)。これは総排出量です。TTW または WTT の排出量を使用する特別な理由がない限り、この数値を使用する必要があります。 |
ttwEmissionsGramsPerPax |
省略可。リクエストされた情報に基づく、乗客 1 人あたりのタンクから翼までのフライトの排出量。 |
wttEmissionsGramsPerPax |
省略可。リクエストされた情報に基づく、乗客 1 人あたりの井戸からタンクまでのフライトの排出量。 |
source |
省略可。排出量データのソース。 |
Scope3DataType
スコープ 3 の排出量の計算に使用される照合のタイプ。これはスコープ 3 のレスポンスに使用され、排出量の計算に使用されたメソッドを示します。
| 列挙型 | |
|---|---|
SCOPE3_DATA_TYPE_UNSPECIFIED |
データ型が指定されていません。 |
TIM_EMISSIONS |
出発地、目的地、航空会社、フライト番号、出発日、年を指定した TIM ベースの排出量。 |
TYPICAL_FLIGHT_EMISSIONS |
出発地、目的地、年を指定した一般的なフライトの排出量。 |
DISTANCE_BASED_EMISSIONS |
移動距離と年数に基づく距離ベースの排出量。 |