- HTTP リクエスト
- リクエストの本文
- レスポンスの本文
- Scope3FlightSegment
- CabinClass
- Scope3FlightEmissions
- Scope3DataType
- 試してみる
スコープ 3 のレポート用に一連のフライト セグメントの GHG 排出量推定値を取得するステートレス メソッド。
レスポンスには、入力された Scope3FlightSegment
フライト セグメントと一致するすべてのエントリが、指定された順序で含まれます。推定値は、次のカスケード ロジックを使用して計算されます(使用可能な最初の値を使用)。
origin
、destination
、carrier
、flightNumber
、departureDate
、cabinClass
が指定された場合の TIM ベースの排出量。origin
、destination
、departureDate
の年、cabinClass
を指定した場合の一般的なフライトの CO2 排出量。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 年より前である(Scope 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
Scope 3 の排出量を取得するフライト パラメータ。
JSON 表現 |
---|
{ "departureDate": { object ( |
フィールド | |
---|---|
departureDate |
必須。出発空港のタイムゾーンでのフライトの日付。一般的なフライトと距離ベースの排出量モデルでは、年のみが必要です(月と日の値は無視されるため、省略するか、0 に設定するか、有効な日付に設定できます)。同様に、TIM の排出量に特定の日付が指定されていない場合は、一般的なフライト(または距離ベース)の排出量にフォールバックします。 |
cabinClass |
必須。フライトの座席クラス。 |
origin |
省略可。フライトの出発空港の IATA 空港コード(例: |
destination |
省略可。フライトの目的地の IATA 空港コード(例: |
carrierCode |
省略可。IATA 航空会社コード(例: |
flightNumber |
省略可。フライト番号(例: |
distanceKm |
省略可。距離(キロメートル単位)。例: |
CabinClass
フライトの座席クラス。
列挙型 | |
---|---|
CABIN_CLASS_UNSPECIFIED |
座席クラスが指定されていません。 |
ECONOMY |
エコノミー クラス。 |
PREMIUM_ECONOMY |
プレミアム エコノミー クラス。 |
BUSINESS |
ビジネスクラス。 |
FIRST |
ファースト クラスです。 |
Scope3FlightEmissions
推定排出量を含むスコープ 3 のフライト。
JSON 表現 |
---|
{ "flight": { object ( |
フィールド | |
---|---|
flight |
必須。リクエスト内のフライト ID と一致します。 |
wtwEmissionsGramsPerPax |
省略可。リクエストされた情報に基づく、乗客 1 人あたりのフライトの総排出量(Well-to-Tank と Tank-to-Wake の合計)。これは総排出量です。TTW または WTT の排出量を使用する特別な理由がない限り、この数値を使用する必要があります。 |
ttwEmissionsGramsPerPax |
省略可。リクエストされた情報に基づく、乗客 1 人あたりのタンクから航跡までのフライト排出量。 |
wttEmissionsGramsPerPax |
省略可。リクエストされた情報に基づく、乗客 1 人あたりの Well-to-tank 航空機排出量。 |
source |
省略可。排出量データのソース。 |
Scope3DataType
スコープ 3 の排出量の計算に使用される照合のタイプ。これは、排出量の計算に使用された方法を示す Scope 3 の回答に使用されます。
列挙型 | |
---|---|
SCOPE3_DATA_TYPE_UNSPECIFIED |
データ型が指定されていません。 |
TIM_EMISSIONS |
出発地、目的地、航空会社、フライト番号、出発日、年を指定して、TIM に基づく排出量を返します。 |
TYPICAL_FLIGHT_EMISSIONS |
出発地、目的地、年を指定して、標準的なフライトの排出量を返します。 |
DISTANCE_BASED_EMISSIONS |
移動距離と年数に基づく距離ベースの排出量。 |