Package google.travel.sustainability.travelimpactmodel.v1

インデックス

• TravelImpactModelService（インターフェース）
• ComputeFlightEmissionsRequest（メッセージ）
• ComputeFlightEmissionsResponse（メッセージ）
• ComputeScope3FlightEmissionsRequest（メッセージ）
• ComputeScope3FlightEmissionsResponse（メッセージ）
• ComputeTypicalFlightEmissionsRequest（メッセージ）
• ComputeTypicalFlightEmissionsResponse（メッセージ）
• ContrailsImpactBucket（列挙型）
• EasaLabelMetadata（メッセージ）
• EmissionsGramsPerPax（メッセージ）
• Flight（メッセージ）
• FlightWithEmissions（メッセージ）
• Market（メッセージ）
• ModelVersion（メッセージ）
• Scope3FlightEmissions（メッセージ）
• Scope3FlightEmissions.Scope3DataType（列挙型）
• Scope3FlightSegment（メッセージ）
• Scope3FlightSegment.CabinClass（列挙型）
• Source（列挙型）
• TypicalFlightEmissions（メッセージ）

TravelImpactModelService

二酸化炭素の推定排出量を提供する API。

ComputeFlightEmissions

rpc ComputeFlightEmissions(ComputeFlightEmissionsRequest) returns (ComputeFlightEmissionsResponse) 排出量の推定値を取得するステートレス メソッド。排出量の推定値の計算方法については、GitHub をご覧ください。 レスポンスには、入力されたフライト レグと一致するすべてのエントリが同じ順序で含まれます。特定のフライト区間で推定値がない場合、レスポンスは排出量フィールドが空のフライト区間オブジェクトを返します。リクエストは成功とみなされます。排出量の推定値が表示されない理由としては、次のようなものが考えられます。 フライトがサーバーに認識されていません。 入力されたフライトレグに 1 つ以上の識別子がありません。 フライトの日付が過去の日付です。 この航空機タイプはモデルでサポートされていません。 シートの設定がありません。 リクエストには最大 1,000 個のフライト レッグを含めることができます。リクエストに 1, 000 を超える直行便が含まれている場合、INVALID_ARGUMENT エラーで失敗します。

ComputeScope3FlightEmissions

rpc ComputeScope3FlightEmissions(ComputeScope3FlightEmissionsRequest) returns (ComputeScope3FlightEmissionsResponse) スコープ 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）のソースを確認して、結果が想定どおりであることを確認する必要があります。

ComputeTypicalFlightEmissions
rpc ComputeTypicalFlightEmissions(ComputeTypicalFlightEmissionsRequest) returns (ComputeTypicalFlightEmissionsResponse) 2 つの空港間（市場とも呼ばれます）のフライト標準排出量の推定値を取得します。特定の市場で推定値が利用できない場合、レスポンスは排出量フィールドが空の市場オブジェクトを返します。リクエストは成功とみなされます。 一般的な排出量の推定値の計算方法について詳しくは、GitHub をご覧ください。 リクエストには最大 1,000 個のマーケットを含めることができます。リクエストに 1, 000 を超えるマーケットが含まれている場合、INVALID_ARGUMENT エラーで失敗します。

ComputeFlightEmissionsRequest

ComputeFlightEmissions リクエストの入力定義。

フィールド
flights[]	Flight 必須。往復の二酸化炭素排出量の推定値を返す直行便。

ComputeFlightEmissionsResponse

ComputeFlightEmissions レスポンスの出力定義。

フィールド
flight_emissions[]	FlightWithEmissions 推定排出量を含むフライト レグのリスト。
model_version	ModelVersion このレスポンス内のすべてのフライトの排出量推定値が計算されたモデル バージョン。

ComputeScope3FlightEmissionsRequest

Scope 3 排出量をリクエストするフライト セグメントのリスト。

フィールド
flights[]	Scope3FlightSegment 必須。排出量の推定値を返すフライト。
model_version	ModelVersion 省略可。このリクエスト内のすべてのフライトの排出量推定値が計算されたモデル バージョン。

ComputeScope3FlightEmissionsResponse

スコープ 3 の推定排出量を含むフライトのリスト。

フィールド
flight_emissions[]	Scope3FlightEmissions 推定排出量を含むフライト セグメントのリスト。
model_version	ModelVersion このレスポンス内のすべてのフライトの排出量推定値が計算されたモデル バージョン。

ComputeTypicalFlightEmissionsRequest

標準的な排出量をリクエストする空港（市場）のペアのリスト。

フィールド
markets[]	Market 必須。この市場ペアのフライト標準排出量の推定値をリクエストします。リクエストできるマーケットは最大 1,000 個です。

ComputeTypicalFlightEmissionsResponse

レスポンスには、排出量だけでなくモデルのバージョンも含まれます。

フィールド
typical_flight_emissions[]	TypicalFlightEmissions 市場のフライト標準排出量がリクエストされました。
model_version	ModelVersion このレスポンス内のすべてのフライトのフライト標準排出量の推定値が計算されたモデル バージョン。

ContrailsImpactBucket

飛行機雲による温暖化の影響の、総 CO2e 排出量の影響に対する重要性。

列挙型
CONTRAILS_IMPACT_UNSPECIFIED	飛行機雲の影響は指定されていません。
CONTRAILS_IMPACT_NEGLIGIBLE	飛行機雲の影響は、CO2e の総排出量と比較するとごくわずかです。
CONTRAILS_IMPACT_MODERATE	飛行機雲の影響は、CO2e の総排出量に匹敵します。
CONTRAILS_IMPACT_SEVERE	飛行機雲の影響は、CO2e 総排出量の影響よりも大きくなります。

EasaLabelMetadata

EASA のフライト排出量ラベルに関するメタデータ。

フィールド
label_issue_date	Date ラベルが発行された日付。
label_expiry_date	Date ラベルの有効期限。ラベルは、この日付の終了まで表示できます。
label_version	string ラベルのバージョン。
saf_discount_percentage	double ラベルに適用される持続可能な航空燃料（SAF）の排出量割引率。これは、10 進数で表した割合です。値は区間 [0,1] 内にあります。たとえば、0.0021 は 0.21% を意味します。 この割引と排出量の削減は EASA ラベルで報告されますが、この API で配信される CO2e の推定値には含まれていません。

EmissionsGramsPerPax

座席クラスごとの排出量の結果をグループ化します。

フィールド
first	int32 ファースト クラスの乗客 1 人あたりの二酸化炭素排出量（グラム単位）。このフィールドは、航空機にファーストクラスの座席があるかどうかに関係なく、常に計算されて入力されます。
business	int32 ビジネスクラスの乗客 1 人あたりの二酸化炭素排出量（グラム）。このフィールドは、航空機にビジネスクラスの座席があるかどうかに関係なく、常に計算されて入力されます。
premium_economy	int32 プレミアム エコノミー クラスの乗客 1 人あたりの二酸化炭素排出量（グラム）。このフィールドは、航空機にプレミアム エコノミー クラスの座席があるかどうかに関係なく、常に計算されて入力されます。
economy	int32 エコノミー クラスの乗客 1 人あたりの二酸化炭素排出量（グラム）。このフィールドは、航空機にエコノミー クラスの座席があるかどうかに関係なく、常に計算されて入力されます。

フライト

直行便の排出量推定値の単一のリクエスト アイテムに関連するすべての詳細。

フィールド
origin	string 必須。フライトの出発空港の IATA 空港コード（例: 「LHR」）。
destination	string 必須。フライトの目的地の IATA 空港コード（例: 「JFK」）。
operating_carrier_code	string 必須。IATA 航空会社コード（例: AA）。
flight_number	int32 必須。フライト番号（例: 324）。
departure_date	Date 必須。出発空港のタイムゾーンでのフライトの日付。現在または将来の日付を指定する必要があります。

FlightWithEmissions

推定排出量が表示された直行便。

フィールド
flight	Flight 必須。リクエスト内のフライト ID と照合します。注: IATA コードはすべて大文字で表記します。
source	Source 省略可。排出量データのソース。
emissions_grams_per_pax	EmissionsGramsPerPax 省略可。乗客 1 人あたりの推定排出量。排出量を計算できなかった場合は存在しません。排出量を計算できなかった理由の一覧については、ComputeFlightEmissions をご覧ください。
easa_label_metadata	EasaLabelMetadata 省略可。EASA のフライト排出量ラベルに関するメタデータ。排出量データソースが EASA の場合にのみ設定されます。
contrails_impact_bucket	ContrailsImpactBucket 省略可。飛行機雲による温暖化の影響の、総 CO2e 排出量の影響に対する重要性。

マーケット

2 つの空港。

フィールド
origin	string 必須。フライトの出発空港の IATA 空港コード（例: 「LHR」）。
destination	string 必須。フライトの目的地の IATA 空港コード（例: 「JFK」）。

ModelVersion

Travel Impact Model のバージョン。モデルのバージョニングの詳細については、GitHub をご覧ください。

フィールド
major	int32 メジャー バージョン: 方法論の大きな変更（モデルに新しいデータソースを追加して、出力に大きな変更が生じるなど）。このような変更は頻繁に行われるものではなく、十分な事前告知を行います。API バージョンの変更を伴う場合があります。この変更は Google Cloud API のガイドラインに準拠します。
minor	int32 マイナー バージョン: スキーマ バージョン間で一貫性を保ちながら、モデル パラメータまたは実装を変更するモデルの変更。
patch	int32 パッチ バージョン: モデル実装のバグや不正確さを修正するための実装変更。
dated	string 日付付きバージョン: モデルのデータセットは、更新された入力データで再作成されますが、アルゴリズムは定期的に変更されません。

Scope3FlightEmissions

推定排出量を含むスコープ 3 のフライト。

フィールド
flight	Scope3FlightSegment 必須。リクエスト内のフライト ID と一致します。
wtw_emissions_grams_per_pax	int64 省略可。リクエストされた情報に基づく、乗客 1 人あたりのフライトの総排出量（Well-to-Tank と Tank-to-Wake の合計）。これは総排出量です。TTW または WTT の排出量を使用する特別な理由がない限り、この数値を使用する必要があります。
ttw_emissions_grams_per_pax	int64 省略可。リクエストされた情報に基づく、乗客 1 人あたりのタンクから航跡までのフライト排出量。
wtt_emissions_grams_per_pax	int64 省略可。リクエストされた情報に基づく、乗客 1 人あたりの Well-to-tank 航空機排出量。
source	Scope3DataType 省略可。排出量データのソース。

Scope3DataType

スコープ 3 の排出量の計算に使用される照合のタイプ。これは、排出量の計算に使用された方法を示す Scope 3 の回答に使用されます。

列挙型
SCOPE3_DATA_TYPE_UNSPECIFIED	データ型が指定されていません。
TIM_EMISSIONS	出発地、目的地、航空会社、フライト番号、出発日、年を指定して、TIM に基づく排出量を返します。
TYPICAL_FLIGHT_EMISSIONS	出発地、目的地、年を指定して、標準的なフライトの排出量を返します。
DISTANCE_BASED_EMISSIONS	移動距離と年数に基づく距離ベースの排出量。

Scope3FlightSegment

Scope 3 の排出量を取得するフライト パラメータ。

フィールド
departure_date	Date 必須。出発空港のタイムゾーンでのフライトの日付。一般的なフライトと距離ベースの排出量モデルでは、年のみが必要です（月と日の値は無視されるため、省略するか、0 に設定するか、有効な日付に設定できます）。同様に、TIM の排出量に特定の日付が指定されていない場合は、一般的なフライト（または距離ベース）の排出量にフォールバックします。
cabin_class	CabinClass 必須。フライトの座席クラス。
origin	string 省略可。フライトの出発空港の IATA 空港コード（例: YVR）。目的地、航空会社、フライト番号とともに指定された場合、特定のフライトを照合するために使用されます。一致するフライトがない場合は、まず、指定された出発空港と到着空港間の一般的なフライトと照合します。それ以外の場合は、フライトの距離が指定されていれば、距離ベースの排出量モデルを使用します。
destination	string 省略可。フライトの目的地の IATA 空港コード（例: ICN）。出発地、航空会社、フライト番号とともに指定された場合、特定のフライトを照合するために使用されます。一致するフライトがない場合は、まず、指定された出発空港と到着空港間の一般的なフライトと照合します。それ以外の場合は、フライトの距離が指定されていれば、距離ベースの排出量モデルを使用します。
carrier_code	string 省略可。IATA 航空会社コード（例: KE）。特定のフライトのマッチングが必要な場合は、この設定が必要です。それ以外の場合、この値は一般的なフライトと距離ベースの排出量モデルでは使用されません。運航航空会社と販売航空会社の両方のコードを指定できます（コードシェアも対象となります）。
flight_number	int32 省略可。フライト番号（例: 71）。これは、出発地、目的地、航空会社とともに便名が指定されている場合に、特定のフライトを照合するために最初に使われます。フライト番号が指定されていない場合は、まず、指定された出発空港と到着空港間の一般的なフライトにフライトを照合しようとします。失敗した場合や、出発地と目的地が指定されていない場合は、指定されたフライト距離に基づいて距離ベースの排出量モデルが使用されます。
distance_km	int64 省略可。距離（キロメートル単位）。例: 2423。これは、出発地と到着地が指定されていない場合や、一致する標準的なフライトがない場合に、フライトを距離ベースの排出量と照合するために使用されます。このフィールドは 0 ～ 2.5e16 km の値をサポートしています。

CabinClass

フライトの座席クラス。

列挙型
CABIN_CLASS_UNSPECIFIED	座席クラスが指定されていません。
ECONOMY	エコノミー クラス。
PREMIUM_ECONOMY	プレミアム エコノミー クラス。
BUSINESS	ビジネスクラス。
FIRST	ファースト クラスです。

ソース

排出量データのソース。

列挙型
SOURCE_UNSPECIFIED	排出量データのソースは指定されていません。
TIM	排出量データは Travel Impact Model のものです。
EASA	排出量データは EASA の環境ラベルのものです。

TypicalFlightEmissions

特定の市場のフライト標準排出量の推定値

フィールド
market	Market 必須。リクエスト内のフライト ID と照合します。注: IATA コードはすべて大文字で表記します。
emissions_grams_per_pax	EmissionsGramsPerPax 省略可。リクエストされた市場の乗客 1 人あたりの標準的なフライト排出量。標準的な排出量を計算できなかった場合は表示されません。一般的なフライトの排出量を計算できなかった理由の一覧については、GitHub をご覧ください。