- בקשת HTTP
- גוף הבקשה
- גוף התשובה
- טיסה
- תאריך
- FlightWithEmissions
- EmissionsGramsPerPax
- ModelVersion
- רוצים לנסות?
שיטה ללא שמירת מצב לאחזור אומדני פליטה. פרטים לגבי אופן החישוב של אומדני הפליטות: https://github.com/google/travel-impact-model
התשובה תכיל את כל הרשומות שתואמות לרגלי הטיסות של הקלט, באותו סדר. אם אין אומדנים זמינים עבור קטע טיסה מסוים, התשובה תחזיר את האובייקט של רגל הטיסה עם שדות פליטה ריקים. הבקשה עדיין תיחשב כמוצלחת. בין הסיבות להיעדר אומדני פליטות:
- הטיסה לא ידועה לשרת.
- בקטע של טיסת הקלט חסר מזהה אחד או יותר.
- תאריך הטיסה חל בעבר.
- סוג המטוס לא נתמך במודל.
- חסרים הגדרות מושב.
הבקשה יכולה לכלול עד 1,000 רגליים לטיסה. אם הבקשה כוללת יותר מ-1,000 טיסות ישירות, אם היא תיכשל ומוצגת שגיאה INVALID_XXXXX.
בקשת HTTP
POST https://travelimpactmodel.googleapis.com/v1/flights:computeFlightEmissions
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"flights": [
{
object ( |
שדות | |
---|---|
flights[] |
חובה. טיסות ישירות שיש להחזיר אומדני פליטה שלהן. |
גוף התגובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:
הגדרת הפלט של התגובה [ flights.computeFlightEmissions][google.travel.sustainability.traveleffectsmodel.v1.ComputeFlightEmissions].
ייצוג JSON |
---|
{ "flightEmissions": [ { object ( |
שדות | |
---|---|
flightEmissions[] |
רשימת טיסות עם אומדני פליטה. |
modelVersion |
גרסת המודל שלפיה חושבו אומדני הפליטה של כל הטיסות בתגובה הזו. |
פרק זמן של פרסום פעיל
כל הפרטים הקשורים לפריט בקשה יחיד לאומדני פליטות של טיסה ישירה.
ייצוג JSON |
---|
{
"origin": string,
"destination": string,
"operatingCarrierCode": string,
"flightNumber": integer,
"departureDate": {
object ( |
שדות | |
---|---|
origin |
חובה. קוד נמל התעופה IATA של מוצא הטיסה, לדוגמה "LHR". |
destination |
חובה. קוד נמל התעופה IATA של יעד הטיסה, לדוגמה "JFK". |
operatingCarrierCode |
חובה. קוד ספק IATA, לדוגמה "AA". |
flightNumber |
חובה. מספר טיסה, למשל 324. |
departureDate |
חובה. תאריך הטיסה באזור הזמן של נמל התעופה שממנו יוצאת הטיסה. הוא חייב להיות תאריך שחל בעתיד או בעתיד. |
תאריך
מייצג תאריך קלנדרי מלא או חלקי, כמו יום הולדת. השעה ביום ואזור הזמן מצוינים במקום אחר או שאינם משמעותיים. התאריך הזה יחסי ללוח השנה הגרגוריאני. הנתון הזה יכול לייצג אחת מהאפשרויות הבאות:
- תאריך מלא, עם ערכים שונים של שנה, חודש ויום.
- חודש ויום, עם שנה של אפס (למשל יום נישואין).
- שנה בפני עצמה, עם חודש של אפס ואפס יום.
- שנה וחודש, עם אפס יום (לדוגמה, תאריך תפוגה של כרטיס אשראי).
סוגים קשורים:
google.type.TimeOfDay
google.type.DateTime
google.protobuf.Timestamp
ייצוג JSON |
---|
{ "year": integer, "month": integer, "day": integer } |
שדות | |
---|---|
year |
שנת התאריך. חייב להיות בין 1 ל-9999, או 0 כדי לציין תאריך ללא שנה. |
month |
החודש בשנה. צריך להיות בין 1 ל-12, או 0 כדי לציין שנה בלי חודש ויום. |
day |
היום בחודש. הערך צריך להיות בין 1 ל-31 והוא תקף לשנה ולחודש, או 0 כדי לציין שנה בלבד או שנה וחודש שבהם היום לא משמעותי. |
FlightWithEmissions
טיסה ישירה עם אומדני פליטה.
ייצוג JSON |
---|
{ "flight": { object ( |
שדות | |
---|---|
flight |
חובה. תואם למזהי הטיסה שצוינו בבקשה. הערה: כל קודי IATA נכתבים באותיות רישיות. |
emissionsGramsPerPax |
אפשרות. מספרים משוערים של פליטות לכל נוסע. לא יהיו מוצגים אם לא ניתן לחשב את הפליטות. לרשימת הסיבות לכך שלא ניתן היה לחשב את הפליטות, ניתן לעיין במאמר [flights.computeFlightEmissions][google.travel.sustainability.traveleffectsmodel.v1.ComputeFlightEmissions]]. |
EmissionsGramsPerPax
נתוני פליטות מקובצים לפי תוצאות של מחלקה.
ייצוג JSON |
---|
{ "first": integer, "business": integer, "premiumEconomy": integer, "economy": integer } |
שדות | |
---|---|
first |
פליטות של נוסע אחד במחלקה ראשונה, בגרם. השדה הזה תמיד מחושב ומאוכלס, בין אם במטוס יש מושבים במחלקה ראשונה או לא. |
business |
פליטות לנוסע אחד במחלקת עסקים בגרם. השדה הזה תמיד יחושב ויאוכלס, גם אם במטוס יש מושבים במחלקת עסקים וגם אם לא. |
premiumEconomy |
ערכי הפליטות לנוסע אחד במחלקת תיירים פלוס, בגרם. השדה הזה תמיד מחושב ומאוכלס, בין אם במטוס יש מושבים במחלקת תיירים פלוס או לא. |
economy |
הפליטה של נוסע אחד במחלקת תיירים, בגרם. השדה הזה תמיד מחושב ומאוכלס, בין אם במטוס יש מושבים במחלקת תיירים או לא. |
ModelVersion
גרסת מודל ההשפעה של הנסיעות. מידע נוסף על הגרסה החדשה של המודל זמין בכתובת https://github.com/google/travel-impact-model/#versioning.
ייצוג JSON |
---|
{ "major": integer, "minor": integer, "patch": integer, "dated": string } |
שדות | |
---|---|
major |
גרסאות ראשיות: שינויים משמעותיים במתודולוגיה (למשל, הוספת מקורות נתונים חדשים למודל שמובילים לשינויים משמעותיים בפלט). שינויים כאלה יתבצעו לעיתים רחוקות והם יוכרזו זמן רב מראש. יכול להיות שיהיו שינויים בגרסת ה-API, שיצייתו להנחיות שבכתובת https://cloud.google.com/endpoints/docs/openapi/versioning-an-api#backwards-incompatible |
minor |
גרסאות משניות: שינויים במודל, שלמרות העקביות בין גרסאות הסכימה השונות, משנים את הפרמטרים של המודל או את ההטמעה. |
patch |
גרסאות תיקון: שינויי הטמעה שנועדו לטפל בבאגים או באי-דיוקים בהטמעת המודל. |
dated |
גרסאות עם תאריך: מערכי הנתונים של המודלים נוצרים מחדש עם נתוני הקלט המתעדכנים, אבל האלגוריתמים לא משתנים באופן קבוע. |