REST Resource: flightobject

משאב: FlightObject

ייצוג ב-JSON 
{
  "kind": string,
  "classReference": {
    object (FlightClass)
  },
  "passengerName": string,
  "boardingAndSeatingInfo": {
    object (BoardingAndSeatingInfo)
  },
  "reservationInfo": {
    object (ReservationInfo)
  },
  "securityProgramLogo": {
    object (Image)
  },
  "hexBackgroundColor": string,
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
שדות
kind
(deprecated)

string

מזהה את סוג המשאב. ערך: המחרוזת הקבועה "walletobjects#flightObject".
classReference

object (FlightClass)

עותק של השדות שעברו בירושה מכיתה ההורה. השדות האלה מאוחזרים במהלך קריאה מסוג GET.
passengerName

string

חובה. שם הנוסע כפי שהוא מופיע בכרטיס העלייה למטוס.

לדוגמה: "Dave M Gahan" או "Gahan/Dave" או "GAHAN/DAVEM"
boardingAndSeatingInfo

object (BoardingAndSeatingInfo)

מידע ספציפי לנוסעים לגבי העלייה למטוס והושבה.
reservationInfo

object (ReservationInfo)

חובה. מידע על הזמנת טיסה.
hexBackgroundColor

string

צבע הרקע של הכרטיס. אם לא תגדירו צבע, המערכת תשתמש בצבע השולט בתמונת ה-Hero. אם לא תגדירו תמונה ראשית, המערכת תשתמש בצבע השולט בלוגו. הפורמט הוא #rrggbb, כאשר rrggbb הוא טריופל RGB ב-hex, למשל #ffcc00. אפשר גם להשתמש בקיצור של טריופל RGB, שהוא #rgb, למשל #fc0.
id

string

חובה. המזהה הייחודי של אובייקט. המזהה הזה חייב להיות ייחודי בכל האובייקטים של מנפיק. הערך צריך להיות בפורמט issuer ID.identifier, כאשר המזהה הראשון מונפק על ידי Google והשני נבחר על ידכם. המזהה הייחודי צריך לכלול רק תווים אלפאנומריים, '.', '_' או '-'.
classId

string

חובה. הכיתה שמשויכת לאובייקט הזה. הכיתה צריכה להיות מאותו סוג כמו האובייקט הזה, היא כבר צריכה להתקיים והיא צריכה להיות מאושרת.

מזהי הכיתות צריכים להיות בפורמט issuer ID.identifier כאשר הראשון הונפק על ידי Google והאחרון נבחר על ידך.
version
(deprecated)

string (int64 format)

הוצא משימוש
state

enum (State)

חובה. המצב של האובייקט. השדה הזה משמש לקביעת האופן שבו אובייקט מוצג באפליקציה. לדוגמה, אובייקט inactive מועבר לקטע 'כרטיסים שפג תוקפם'.
barcode

object (Barcode)

סוג הברקוד והערך שלו.
messages[]

object (Message)

מערך של הודעות שמוצגות באפליקציה. כל המשתמשים באובייקט הזה יקבלו את ההודעות המשויכות אליו. המספר המקסימלי של השדות האלה הוא 10.
validTimeInterval

object (TimeInterval)

פרק הזמן שבו האובייקט יהיה active ואפשר יהיה להשתמש בו. המצב של האובייקט ישתנה ל-expired כשפרק הזמן הזה יפוג.
locations[]
(deprecated)

object (LatLongPoint)

הערה: בשלב הזה אין תמיכה בשדה הזה להפעלת התראות גיאוגרפיות.
hasUsers

boolean

מציין אם יש לאובייקט משתמשים. השדה הזה מוגדר על ידי הפלטפורמה.
smartTapRedemptionValue

string

הערך שיישלח לאובייקט הזה למסוף מאושר של Smart Tap באמצעות NFC. כדי שהכרטיס יתמוך בתכונה 'הקשה חכמה', צריך להגדיר בצורה נכונה גם את השדות enableSmartTap ו-redemptionIssuers ברמת הכיתה. יש תמיכה רק בתווי ASCII.
hasLinkedDevice

boolean

אם האובייקט הזה מקושר כרגע למכשיר אחד. השדה הזה מוגדר על ידי הפלטפורמה כשמשתמש שומר את האובייקט ומקשר אותו למכשיר שלו. מיועד לשימוש של שותפים נבחרים. לקבלת מידע נוסף, אפשר לפנות לתמיכה.
disableExpirationNotification

boolean

מציין אם צריך לדכא את ההתראות באופן מפורש. אם השדה הזה מוגדר כ-true, ללא קשר לשדה messages, ההתראות על תפוגה לא יוצגו למשתמש. כברירת מחדל, השדה הזה מוגדר כ-false.

בשלב הזה אפשר להגדיר את האפשרות הזו רק לטיסות.
infoModuleData

object (InfoModuleData)

הוצא משימוש. במקום זאת, צריך להשתמש ב-textModulesData.
imageModulesData[]

object (ImageModuleData)

נתוני מודול התמונה. המספר המקסימלי של השדות האלה שמוצגים הוא 1 ברמת האובייקט ו-1 ברמת אובייקט הכיתה.
textModulesData[]

object (TextModuleData)

נתונים של מודול טקסט. אם גם נתוני מודול הטקסט מוגדרים במחלקה, שניהם יוצגו. מספר השדות המקסימלי שמוצג הוא 10 מהאובייקט ו-10 מהמחלקה.
rotatingBarcode

object (RotatingBarcode)

הסוג והערך של הברקוד המסתובב.
heroImage

object (Image)

תמונה אופציונלית של באנר שמוצגת בחזית הכרטיס. אם לא, תוצג תמונת ה-Hero של הכיתה, אם יש כזו. אם גם התמונה הראשית (Hero) של הכיתה לא מופיעה, לא יוצג דבר.
groupingInfo

object (GroupingInfo)

מידע שקובע את אופן הקיבוץ של הכרטיסים.
passConstraints

object (PassConstraints)

מעבירים את האילוצים של האובייקט. כולל הגבלת התנהגויות של NFC וצילומי מסך.
saveRestrictions

object (SaveRestrictions)

הגבלות על האובייקט שצריך לאמת לפני שהמשתמש ינסה לשמור את הכרטיס. חשוב לזכור שההגבלות האלה יחולו רק במהלך זמן השמירה. אם ההגבלות השתנו אחרי שהמשתמש שמר את הכרטיס, ההגבלות החדשות לא יחולו על כרטיס שכבר נשמר.
linkedObjectIds[]

string

linkedObjectIds היא רשימה של אובייקטים אחרים, כמו כרטיס אירוע, כרטיס מועדון, מבצע, כרטיס גנרי, כרטיס מתנה, כרטיס לתחבורה ציבורית וכרטיס עלייה למטוס, שצריך לצרף באופן אוטומטי לאובייקט הטיסה הזה. אם משתמש שמר את כרטיס העלייה למטוס הזה, מזהי ה-linkedObjectIds האלה יועברו באופן אוטומטי לארנק של המשתמש (אלא אם הוא השבית את ההגדרה לקבלת כרטיסים מקושרים כאלה).

חשוב לוודא שהאובייקטים שמופיעים ב-linkedObjectIds כבר הוכנסו – אחרת הקריאות ייכשל. אחרי שמקשרים אובייקטים, אי אפשר לבטל את הקישור שלהם. אי אפשר לקשר אובייקטים ששייכים למנפיק אחר. יש מגבלה על מספר האובייקטים שאפשר לקשר לאובייקט יחיד. כשמגיעים למגבלה, המערכת מתעלמת מאובייקטים מקושרים חדשים בשיחה בלי להציג התראות.

מזהי האובייקטים צריכים להיות בפורמט issuer ID.identifier, כאשר הראשון מונפק על ידי Google והשני נבחר על ידכם.
notifyPreference

enum (NotificationSettingsForUpdates)

האם עדכוני שדות באובייקט הזה יפעילו התראות. כשהערך מוגדר ל-NOTIFY, ננסה להפעיל התראה למשתמשים על עדכון השדה. ההתראות האלה יישלחו למשתמשים רק אם השדה הוא חלק מרשימת היתרים. אם הערך מוגדר כ-DO_NOT_NOTIFY או כ-NOTIFICATION_SETTINGS_UNSPECIFIED, לא תופעל התראה. ההגדרה הזו היא זמנית וצריך להגדיר אותה בכל בקשת PATCH או UPDATE, אחרת לא תופעל התראה.
valueAddedModuleData[]

object (ValueAddedModuleData)

נתונים אופציונליים של מודול עם ערך מוסף. עד עשר באותו אובייקט.

BoardingAndSeatingInfo

ייצוג ב-JSON 
{
  "kind": string,
  "boardingGroup": string,
  "seatNumber": string,
  "seatClass": string,
  "boardingPrivilegeImage": {
    object (Image)
  },
  "boardingPosition": string,
  "sequenceNumber": string,
  "boardingDoor": enum (BoardingDoor),
  "seatAssignment": {
    object (LocalizedString)
  }
}
שדות
kind
(deprecated)

string

מזהה את סוג המשאב. ערך: המחרוזת הקבועה "walletobjects#boardingAndSeatingInfo".
boardingGroup

string

הערך של קבוצת עלייה למטוס (או אזור) שבה הנוסע צריך לעלות.

לדוגמה: "B"

התווית של הערך הזה תיקבע על ידי השדה boardingPolicy ב-flightClass שאליו מפנה האובייקט הזה.
seatNumber

string

הערך של מושב הנוסע. אם אין מזהה ספציפי, צריך להשתמש ב-seatAssignment במקום זאת.

לדוגמה: '25A'
seatClass

string

הערך של מחלקת המושבים.

לדוגמה: 'מחלקת תיירים' או 'מחלקת תיירים פלוס'
boardingPrivilegeImage

object (Image)

תמונה קטנה שמוצגת מעל הברקוד להצגת הכרטיס. חברות התעופה יכולות להשתמש בו כדי להעביר לכם מידע על הרשאות מיוחדות לעלייה למטוס. אם הוגדר גם הלוגו של תוכנית האבטחה, יכול להיות שהתמונה הזו תעובד לצד הלוגו של תוכנית האבטחה הזו.
boardingPosition

string

הערך של מיקום העלייה למטוס.

לדוגמה: '76'
sequenceNumber

string

מספר הסדרה בכרטיס העלייה למטוס. בדרך כלל, הסדר הזה תואם לסדר שבו הנוסעים נכנסו למטוס. חברת התעופה עשויה להשתמש במספר הזה לצורך עלייה ידנית למטוס ולתגי מזוודות.

לדוגמה: '49'
boardingDoor

enum (BoardingDoor)

מגדירים את השדה הזה רק אם יש יותר מדלת אחת או יותר מגשר אחד לעלייה למטוס, ואתם רוצים להדפיס במפורש את מיקום הדלת בכרטיס העלייה למטוס. רוב חברות התעופה מפנות את הנוסעים לדלת או לגשר הנכונים באמצעות ה-seatClass. במקרים כאלה, לא צריך להגדיר את boardingDoor.
seatAssignment

object (LocalizedString)

מושב הנוסע לשימוש כשאין מזהה ספציפי שאפשר להשתמש בו ב-seatNumber.

לדוגמה: "assigned at gate"

BoardingDoor

טיפוסים בני מנייה (enum)
BOARDING_DOOR_UNSPECIFIED
FRONT
front

כינוי קודם של FRONT. הוצא משימוש.
BACK
back

כינוי מדור קודם של BACK. הוצא משימוש.

ReservationInfo

ייצוג JSON 
{
  "kind": string,
  "confirmationCode": string,
  "eticketNumber": string,
  "frequentFlyerInfo": {
    object (FrequentFlyerInfo)
  }
}
שדות
kind
(deprecated)

string

מזהה את סוג המשאב. ערך: המחרוזת הקבועה "walletobjects#reservationInfo".
confirmationCode

string

קוד האישור הנדרש לביצוע צ'ק-אין לטיסה הזו.

זהו המספר שהנוסע מזין בקיוסק בנמל התעופה כדי לחפש את הטיסה ולהדפיס כרטיס עלייה למטוס.
eticketNumber

string

מספר הכרטיס האלקטרוני.
frequentFlyerInfo

object (FrequentFlyerInfo)

מידע על חברות הנוסע המתמיד.

FrequentFlyerInfo

ייצוג ב-JSON 
{
  "kind": string,
  "frequentFlyerProgramName": {
    object (LocalizedString)
  },
  "frequentFlyerNumber": string
}
שדות
kind
(deprecated)

string

מזהה מה סוג המשאב הזה. ערך: המחרוזת הקבועה "walletobjects#frequentFlyerInfo".
frequentFlyerProgramName

object (LocalizedString)

שם תוכנית הנוסע המתמיד. למשל: "Lufthansa Miles & More"
frequentFlyerNumber

string

מספר הנוסע המתמיד.

חובה לכל אובייקט בתצוגת עץ מסוג walletobjects#frequentFlyerInfo.

שיטות

addmessage

 הוספת הודעה לאובייקט הטיסה שמוזכר במזהה האובייקט הנתון.

get

 הפונקציה מחזירה את אובייקט הטיסה עם מזהה האובייקט שצוין.

insert

 מוסיפה אובייקט טיסה עם המזהה והמאפיינים הנתונים.

list

 הפונקציה מחזירה רשימה של כל אובייקטי הטיסות למזהה מנפיק נתון.

patch

 הקוד מעדכן את אובייקט הטיסה שמוזכר במזהה האובייקט הנתון.

update

 הקוד מעדכן את אובייקט הטיסה שמוזכר במזהה האובייקט הנתון.