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

สีพื้นหลังของการ์ด หากไม่ได้ตั้งค่า ระบบจะใช้สีหลักของรูปภาพหลัก และหากไม่ได้ตั้งค่ารูปภาพหลัก ระบบจะใช้สีหลักของโลโก้ รูปแบบคือ #rrggbb โดยที่ rrggbb คือไตรต์ RGB แบบฐาน 16 เช่น #ffcc00 นอกจากนี้ คุณยังใช้รูปแบบย่อของชุดค่า RGB ซึ่งก็คือ #rgb เช่น #fc0 ได้ด้วย
id

string

ต้องระบุ ตัวระบุที่ไม่ซ้ำกันสำหรับออบเจ็กต์ รหัสนี้ต้องไม่ซ้ำกันในทุกออบเจ็กต์จากผู้ออกบัตร ค่านี้ควรเป็นไปตามรูปแบบ issuer IDidentifier โดยที่รหัสแรกจะออกโดย Google และรหัสหลังจะเลือกโดยคุณ ตัวระบุที่ไม่ซ้ำกันควรมีเฉพาะอักขระที่เป็นตัวอักษรและตัวเลขคละกัน, '.', '_' หรือ '-' เท่านั้น
classId

string

ต้องระบุ คลาสที่เชื่อมโยงกับออบเจ็กต์นี้ โดยคลาสต้องเป็นประเภทเดียวกับออบเจ็กต์นี้ ต้องมีอยู่แล้ว และได้รับอนุมัติ

รหัสชั้นควรเป็นไปตามรูปแบบ issuer IDidentifier โดยที่รหัสแรกจะออกโดย 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

ระบุว่าควรระงับการแจ้งเตือนอย่างชัดเจนหรือไม่ หากตั้งค่าช่องนี้เป็น "จริง" ระบบจะระงับการแจ้งเตือนการหมดอายุให้ผู้ใช้ทราบ ไม่ว่าช่อง messages จะเป็นอย่างไรก็ตาม โดยค่าเริ่มต้น ระบบจะตั้งค่าช่องนี้เป็นเท็จ

ปัจจุบันคุณตั้งค่านี้ได้สำหรับเที่ยวบินเท่านั้น
infoModuleData

object (InfoModuleData)

เลิกใช้งานแล้ว ให้ใช้ textModulesData แทน
imageModulesData[]

object (ImageModuleData)

ข้อมูลโมดูลรูปภาพ จำนวนสูงสุดของช่องเหล่านี้ที่แสดงคือ 1 จากระดับออบเจ็กต์และ 1 สำหรับระดับออบเจ็กต์คลาส
textModulesData[]

object (TextModuleData)

ข้อมูลโมดูลข้อความ หากมีการกําหนดข้อมูลโมดูลข้อความในชั้นเรียนด้วย ระบบจะแสดงทั้ง 2 รายการ จำนวนสูงสุดของช่องเหล่านี้ที่แสดงคือ 10 ช่องจากออบเจ็กต์และ 10 ช่องจากคลาส
rotatingBarcode

object (RotatingBarcode)

ประเภทและค่าของบาร์โค้ดแบบหมุน
heroImage

object (Image)

รูปภาพแบนเนอร์ (ไม่บังคับ) ที่แสดงที่ด้านหน้าของการ์ด หากไม่มีรูปภาพ ระบบจะแสดงรูปภาพหลักของชั้นเรียน (หากมี) หากไม่มีรูปภาพหลักของชั้นเรียนด้วย ก็จะไม่มีสิ่งใดแสดง
groupingInfo

object (GroupingInfo)

ข้อมูลที่ควบคุมวิธีจัดกลุ่มบัตรเข้าด้วยกัน
passConstraints

object (PassConstraints)

ส่งข้อจำกัดสำหรับออบเจ็กต์ รวมถึงการจำกัดการทำงานของ NFC และภาพหน้าจอ
saveRestrictions

object (SaveRestrictions)

ข้อจำกัดของออบเจ็กต์ที่ต้องได้รับการยืนยันก่อนที่ผู้ใช้จะพยายามบันทึกบัตร โปรดทราบว่าข้อจํากัดนี้จะมีผลเฉพาะในช่วงประหยัดเวลาเท่านั้น หากข้อจำกัดมีการเปลี่ยนแปลงหลังจากที่ผู้ใช้บันทึกบัตรแล้ว ข้อจำกัดใหม่จะไม่มีผลกับบัตรที่บันทึกไว้แล้ว
linkedObjectIds[]

string

linkedObjectIds คือรายการออบเจ็กต์อื่นๆ เช่น ตั๋วเข้างาน บัตรสะสมคะแนน ข้อเสนอ ทั่วไป บัตรของขวัญ บัตรโดยสาร และบอร์ดดิ้งพาส ซึ่งควรแนบมากับออบเจ็กต์เที่ยวบินนี้โดยอัตโนมัติ หากผู้ใช้บันทึกบัตรโดยสารนี้ไว้ ระบบจะพุช linkedObjectId เหล่านี้ไปยังกระเป๋าสตางค์ของผู้ใช้โดยอัตโนมัติ (เว้นแต่ผู้ใช้จะปิดการตั้งค่าเพื่อรับบัตรที่ลิงก์ดังกล่าว)

ตรวจสอบว่าได้แทรกออบเจ็กต์ที่อยู่ใน linkedObjectIds แล้ว หากไม่ การเรียกใช้จะไม่สําเร็จ เมื่อลิงก์แล้ว คุณจะยกเลิกการลิงก์ออบเจ็กต์ที่ลิงก์ไม่ได้ คุณลิงก์ออบเจ็กต์ที่เป็นของผู้ออกรายอื่นไม่ได้ มีการจํากัดจํานวนออบเจ็กต์ที่ลิงก์กับออบเจ็กต์หนึ่งๆ ได้ หลังจากถึงขีดจำกัดแล้ว ระบบจะไม่สนใจออบเจ็กต์ที่ลิงก์ใหม่ในการโทร

รหัสออบเจ็กต์ควรเป็นไปตามรูปแบบ issuer IDidentifier โดยที่รหัสแรกจะออกโดย Google และรหัสหลังจะเลือกโดยคุณ
notifyPreference

enum (NotificationSettingsForUpdates)

การตั้งค่าว่าควรมีการแจ้งเตือนเมื่อมีการอัปเดตช่องในออบเจ็กต์นี้หรือไม่ เมื่อตั้งค่าเป็น "แจ้งเตือน" เราจะพยายามเรียกให้ระบบแจ้งเตือนการอัปเดตช่องแก่ผู้ใช้ ระบบจะส่งการแจ้งเตือนเหล่านี้ไปยังผู้ใช้ก็ต่อเมื่อช่องเป็นส่วนหนึ่งของรายการที่อนุญาตเท่านั้น หากตั้งค่าเป็น DO_NOT_NOTIFY หรือ NOTIFICATION_SETTINGS_UNSPECIFIED ระบบจะไม่ทริกเกอร์การแจ้งเตือน การตั้งค่านี้มีอายุไม่นานและจะต้องตั้งค่าพร้อมกับคําขอ PATCH หรือ UPDATE แต่ละรายการ มิฉะนั้นการแจ้งเตือนจะไม่ทริกเกอร์
valueAddedModuleData[]

object (ValueAddedModuleData)

ข้อมูลข้อบังคับมูลค่าเพิ่ม (ไม่บังคับ) สูงสุด 10 รายการบนวัตถุ

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)

ตั้งค่าช่องนี้เฉพาะในกรณีที่เที่ยวบินนี้ขึ้นเครื่องผ่านประตูหรือสะพานมากกว่า 1 แห่ง และคุณต้องการพิมพ์ตำแหน่งประตูอย่างชัดเจนบนบัตร boarding pass สายการบินส่วนใหญ่จะกำหนดเส้นทางให้ผู้โดยสารไปยังประตูหรือสะพานที่ถูกต้องโดยระบุประตู/สะพานด้วย 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

 อัปเดตออบเจ็กต์เที่ยวบินที่อ้างอิงโดยรหัสออบเจ็กต์ที่ระบุ