- ทรัพยากร: TransitObject
- PassengerType
- TicketStatus
- ConcessionCategory
- TicketRestrictions
- PurchaseDetails
- TicketCost
- TicketLeg
- TicketSeat
- FareClass
- TripType
- ActivationStatus
- สถานะ
- DeviceContext
- เมธอด
ทรัพยากร: TransitObject
การแสดง JSON |
---|
{ "classReference": { object ( |
ช่อง | |
---|---|
classReference |
สําเนาของช่องที่รับค่าของคลาสหลัก ระบบจะดึงข้อมูลฟิลด์เหล่านี้ระหว่างการเรียก GET |
ticketNumber |
หมายเลขคำขอ ซึ่งเป็นตัวระบุที่ไม่ซ้ำกันสำหรับตั๋วในระบบของผู้ให้บริการขนส่งสาธารณะ |
passengerType |
จำนวนผู้โดยสาร |
passengerNames |
ชื่อของผู้โดยสารที่ได้รับมอบหมายตั๋ว ช่อง |
tripId |
ระบบจะใช้รหัสนี้เพื่อจัดกลุ่มตั๋วเข้าด้วยกันหากผู้ใช้บันทึกตั๋วหลายใบสำหรับการเดินทางเดียวกัน |
ticketStatus |
สถานะของตั๋ว สำหรับสถานะที่ส่งผลต่อการแสดงผล ให้ใช้ฟิลด์ |
customTicketStatus |
สถานะที่กำหนดเองที่จะใช้สำหรับค่าสถานะคำขอแจ้งปัญหาเมื่อ |
concessionCategory |
หมวดหมู่ตั๋วพิเศษ |
customConcessionCategory |
หมวดหมู่ส่วนลดที่กำหนดเองเพื่อใช้เมื่อ |
ticketRestrictions |
ข้อมูลเกี่ยวกับข้อจำกัดประเภทต่างๆ ในการใช้ตั๋วนี้ เช่น วันของสัปดาห์ที่ต้องใช้บัตร หรือเส้นทางที่อนุญาตให้ใช้ |
purchaseDetails |
รายละเอียดการซื้อตั๋วนี้ |
ticketLeg |
เที่ยวบินขาเดียวของตั๋วจะมีข้อมูลการออกเดินทางและเวลาถึง พร้อมทั้งข้อมูลการขึ้นเครื่องและที่นั่ง หากต้องการระบุมากกว่า 1 เส้นทาง ให้ใช้ช่อง |
ticketLegs[] |
ตั๋วแต่ละใบอาจมีเที่ยวบินอย่างน้อย 1 เที่ยว โดยแต่ละเที่ยวจะมีข้อมูลการออกเดินทางและเวลาถึง พร้อมทั้งข้อมูลการขึ้นเครื่องและที่นั่ง หากต้องการระบุเพียงเที่ยวเดียว ให้ใช้ช่อง |
hexBackgroundColor |
สีพื้นหลังของการ์ด หากไม่ได้ตั้งค่า ระบบจะใช้สีหลักของรูปภาพหลัก และหากไม่ได้ตั้งค่ารูปภาพหลัก ระบบจะใช้สีหลักของโลโก้ รูปแบบคือ #rrggbb โดยที่ rrggbb คือไตรต์ RGB แบบฐาน 16 เช่น |
tripType |
ต้องระบุ ประเภทการเดินทางที่ออบเจ็กต์ขนส่งสาธารณะนี้แสดง ใช้เพื่อกำหนดชื่อบัตรและ/หรือสัญลักษณ์ที่จะใช้ระหว่างต้นทางและปลายทาง |
id |
ต้องระบุ ตัวระบุที่ไม่ซ้ำกันสำหรับออบเจ็กต์ รหัสนี้ต้องไม่ซ้ำกันในทุกออบเจ็กต์จากผู้ออกบัตร ค่านี้ควรเป็นไปตามรูปแบบ issuer IDidentifier โดยที่รหัสแรกจะออกโดย Google และรหัสหลังจะเลือกโดยคุณ ตัวระบุที่ไม่ซ้ำกันควรมีเฉพาะอักขระที่เป็นตัวอักษรและตัวเลขคละกัน, '.', '_' หรือ '-' เท่านั้น |
classId |
ต้องระบุ คลาสที่เชื่อมโยงกับออบเจ็กต์นี้ โดยคลาสต้องเป็นประเภทเดียวกับออบเจ็กต์นี้ ต้องมีอยู่แล้ว และได้รับอนุมัติ รหัสชั้นควรเป็นไปตามรูปแบบ issuer IDidentifier โดยที่รหัสแรกจะออกโดย Google และรหัสหลังจะเลือกโดยคุณ |
version |
เลิกใช้ |
state |
ต้องระบุ สถานะของออบเจ็กต์ ช่องนี้ใช้เพื่อกำหนดวิธีแสดงออบเจ็กต์ในแอป เช่น ระบบจะย้ายออบเจ็กต์ |
barcode |
ประเภทและค่าบาร์โค้ด |
messages[] |
อาร์เรย์ข้อความที่แสดงในแอป ผู้ใช้ทั้งหมดของออบเจ็กต์นี้จะได้รับข้อความที่เกี่ยวข้อง จํานวนสูงสุดของช่องเหล่านี้คือ 10 ช่อง |
validTimeInterval |
ระยะเวลาที่ออบเจ็กต์นี้จะกลายเป็น |
locations[] |
หมายเหตุ: ปัจจุบันระบบยังไม่รองรับการใช้ฟิลด์นี้เพื่อทริกเกอร์การแจ้งเตือนตามภูมิศาสตร์ |
hasUsers |
ระบุว่าออบเจ็กต์มีผู้ใช้หรือไม่ แพลตฟอร์มเป็นผู้ตั้งค่าช่องนี้ |
smartTapRedemptionValue |
ค่าที่จะส่งไปยังเครื่องชำระเงินที่ผ่านการรับรอง Smart Tap ผ่าน NFC สำหรับออบเจ็กต์นี้ นอกจากนี้ คุณต้องตั้งค่าช่องระดับชั้นเรียน |
hasLinkedDevice |
ออบเจ็กต์นี้ลิงก์กับอุปกรณ์เครื่องเดียวอยู่หรือไม่ แพลตฟอร์มจะตั้งค่าช่องนี้เมื่อผู้ใช้บันทึกออบเจ็กต์โดยลิงก์กับอุปกรณ์ มีไว้สำหรับพาร์ทเนอร์บางรายเท่านั้น โปรดติดต่อทีมสนับสนุนเพื่อขอข้อมูลเพิ่มเติม |
disableExpirationNotification |
ระบุว่าควรระงับการแจ้งเตือนอย่างชัดเจนหรือไม่ หากตั้งค่าช่องนี้เป็น "จริง" ระบบจะระงับการแจ้งเตือนการหมดอายุให้ผู้ใช้ทราบ ไม่ว่าช่อง ปัจจุบันคุณตั้งค่านี้ได้สำหรับข้อเสนอเท่านั้น |
infoModuleData |
เลิกใช้งานแล้ว ให้ใช้ textModulesData แทน |
imageModulesData[] |
ข้อมูลโมดูลรูปภาพ จำนวนสูงสุดของช่องเหล่านี้ที่แสดงคือ 1 จากระดับออบเจ็กต์และ 1 สำหรับระดับออบเจ็กต์คลาส |
textModulesData[] |
ข้อมูลโมดูลข้อความ หากมีการกําหนดข้อมูลโมดูลข้อความในชั้นเรียนด้วย ระบบจะแสดงทั้ง 2 รายการ จำนวนสูงสุดของช่องเหล่านี้ที่แสดงคือ 10 ช่องจากออบเจ็กต์และ 10 ช่องจากคลาส |
linksModuleData |
ข้อมูลโมดูลลิงก์ หากมีการกําหนดข้อมูลข้อบังคับลิงก์ไว้ในชั้นเรียนด้วย ระบบจะแสดงทั้ง 2 รายการ |
appLinkData |
ลิงก์แอปหรือเว็บไซต์ (ไม่บังคับ) ที่แสดงเป็นปุ่มที่ด้านหน้าบัตร หากระบุ AppLinkData สำหรับคลาสที่เกี่ยวข้อง ระบบจะแสดงเฉพาะออบเจ็กต์ AppLinkData |
activationStatus |
สถานะการเปิดใช้งานสําหรับออบเจ็กต์ ต้องระบุหากคลาสมีการตั้งค่า |
rotatingBarcode |
ประเภทและค่าของบาร์โค้ดแบบหมุน |
deviceContext |
บริบทของอุปกรณ์ที่เชื่อมโยงกับออบเจ็กต์ |
heroImage |
รูปภาพแบนเนอร์ (ไม่บังคับ) ที่แสดงที่ด้านหน้าของการ์ด หากไม่มีรูปภาพ ระบบจะแสดงรูปภาพหลักของชั้นเรียน (หากมี) หากไม่มีรูปภาพหลักของชั้นเรียนด้วย ก็จะไม่มีสิ่งใดแสดง |
groupingInfo |
ข้อมูลที่ควบคุมวิธีจัดกลุ่มบัตรเข้าด้วยกัน |
passConstraints |
ส่งข้อจำกัดสำหรับออบเจ็กต์ รวมถึงการจำกัดการทำงานของ NFC และภาพหน้าจอ |
saveRestrictions |
ข้อจำกัดของออบเจ็กต์ที่ต้องได้รับการยืนยันก่อนที่ผู้ใช้จะพยายามบันทึกบัตร โปรดทราบว่าข้อจํากัดนี้จะมีผลเฉพาะในช่วงประหยัดเวลาเท่านั้น หากข้อจำกัดมีการเปลี่ยนแปลงหลังจากที่ผู้ใช้บันทึกบัตรแล้ว ข้อจำกัดใหม่จะไม่มีผลกับบัตรที่บันทึกไว้แล้ว |
linkedObjectIds[] |
linkedObjectIds คือรายการออบเจ็กต์อื่นๆ เช่น ตั๋วเข้างาน บัตรสะสมคะแนน ข้อเสนอ ทั่วไป บัตรของขวัญ บัตรโดยสาร และบอร์ดดิ้งพาส ซึ่งควรแนบมากับออบเจ็กต์ขนส่งสาธารณะนี้โดยอัตโนมัติ หากผู้ใช้บันทึกบัตรโดยสารนี้ไว้ ระบบจะพุช linkedObjectId เหล่านี้ไปยังกระเป๋าสตางค์ของผู้ใช้โดยอัตโนมัติ (เว้นแต่ผู้ใช้จะปิดการตั้งค่าเพื่อรับบัตรที่ลิงก์ดังกล่าว) ตรวจสอบว่าได้แทรกออบเจ็กต์ที่อยู่ใน linkedObjectIds แล้ว หากไม่ การเรียกใช้จะไม่สําเร็จ เมื่อลิงก์แล้ว คุณจะยกเลิกการลิงก์ออบเจ็กต์ที่ลิงก์ไม่ได้ คุณลิงก์ออบเจ็กต์ที่เป็นของผู้ออกรายอื่นไม่ได้ มีการจํากัดจํานวนออบเจ็กต์ที่ลิงก์กับออบเจ็กต์หนึ่งๆ ได้ หลังจากถึงขีดจำกัดแล้ว ระบบจะไม่สนใจออบเจ็กต์ที่ลิงก์ใหม่ในการโทร รหัสออบเจ็กต์ควรเป็นไปตามรูปแบบ issuer IDidentifier โดยที่รหัสแรกจะออกโดย Google และรหัสหลังจะเลือกโดยคุณ |
notifyPreference |
การตั้งค่าว่าควรมีการแจ้งเตือนเมื่อมีการอัปเดตช่องในออบเจ็กต์นี้หรือไม่ เมื่อตั้งค่าเป็น "แจ้งเตือน" เราจะพยายามเรียกให้ระบบแจ้งเตือนการอัปเดตช่องแก่ผู้ใช้ ระบบจะส่งการแจ้งเตือนเหล่านี้ไปยังผู้ใช้ก็ต่อเมื่อช่องเป็นส่วนหนึ่งของรายการที่อนุญาตเท่านั้น หากตั้งค่าเป็น DO_NOT_NOTIFY หรือ NOTIFICATION_SETTINGS_UNSPECIFIED ระบบจะไม่ทริกเกอร์การแจ้งเตือน การตั้งค่านี้มีอายุไม่นานและจะต้องตั้งค่าพร้อมกับคําขอ PATCH หรือ UPDATE แต่ละรายการ มิฉะนั้นการแจ้งเตือนจะไม่ทริกเกอร์ |
valueAddedModuleData[] |
ข้อมูลข้อบังคับมูลค่าเพิ่ม (ไม่บังคับ) สูงสุด 10 รายการบนวัตถุ |
PassengerType
Enum | |
---|---|
PASSENGER_TYPE_UNSPECIFIED |
|
SINGLE_PASSENGER |
|
singlePassenger |
ชื่อแทนเดิมของ |
MULTIPLE_PASSENGERS |
|
multiplePassengers |
ชื่อแทนเดิมของ |
TicketStatus
Enum | |
---|---|
TICKET_STATUS_UNSPECIFIED |
|
USED |
|
used |
ชื่อแทนเดิมของ |
REFUNDED |
|
refunded |
ชื่อแทนเดิมของ |
EXCHANGED |
|
exchanged |
ชื่อแทนเดิมของ |
ConcessionCategory
Enum | |
---|---|
CONCESSION_CATEGORY_UNSPECIFIED |
|
ADULT |
|
adult |
ชื่อแทนเดิมของ |
CHILD |
|
child |
ชื่อแทนเดิมของ |
SENIOR |
|
senior |
ชื่อแทนเดิมของ |
TicketRestrictions
การแสดง JSON |
---|
{ "routeRestrictions": { object ( |
ช่อง | |
---|---|
routeRestrictions |
ข้อจำกัดเกี่ยวกับเส้นทางที่อาจใช้ได้ เช่น อาจเป็นสตริง "รถไฟ CrossCountry แบบจองเท่านั้น" |
routeRestrictionsDetails |
รายละเอียดเพิ่มเติมเกี่ยวกับ |
timeRestrictions |
ข้อจำกัดเกี่ยวกับเวลาที่สามารถใช้ตั๋วนี้ได้ |
otherRestrictions |
ข้อจำกัดเพิ่มเติมที่ไม่ได้อยู่ในหมวดหมู่ "เส้นทาง" หรือ "เวลา" |
PurchaseDetails
การแสดง JSON |
---|
{
"purchaseReceiptNumber": string,
"purchaseDateTime": string,
"accountId": string,
"confirmationCode": string,
"ticketCost": {
object ( |
ช่อง | |
---|---|
purchaseReceiptNumber |
หมายเลข/ตัวระบุใบเสร็จสำหรับการติดตามการซื้อตั๋วผ่านหน่วยงานที่ขายตั๋ว |
purchaseDateTime |
วันที่/เวลาซื้อตั๋ว รูปแบบนี้คือวันที่/เวลารูปแบบขยายของ ISO 8601 โดยมีหรือไม่มีออฟเซ็ต คุณสามารถระบุเวลาได้สูงสุด 1 นนาโนวินาที คุณสามารถระบุออฟเซ็ตด้วยความแม่นยำเป็นวินาทีได้ (แม้ว่าออฟเซ็ตแบบวินาทีจะไม่เป็นส่วนหนึ่งของ ISO 8601) เช่น
หากไม่มีข้อมูลออฟเซ็ต ฟีเจอร์ริชมีเดียบางอย่างอาจไม่พร้อมใช้งาน |
accountId |
รหัสของบัญชีที่ใช้ซื้อตั๋ว |
confirmationCode |
รหัสยืนยันการซื้อ ซึ่งอาจเหมือนกันสำหรับคำขอแจ้งปัญหาหลายรายการและใช้ในการจัดกลุ่มคำขอแจ้งปัญหาเข้าด้วยกัน |
ticketCost |
ราคาตั๋ว |
TicketCost
การแสดง JSON |
---|
{ "faceValue": { object ( |
ช่อง | |
---|---|
faceValue |
มูลค่าที่ตราไว้ของตั๋ว |
purchasePrice |
ราคาซื้อจริงของตั๋วหลังหักภาษีและ/หรือส่วนลด |
discountMessage |
ข้อความที่อธิบายส่วนลดประเภทต่างๆ ที่ใช้ |
TicketLeg
การแสดง JSON |
---|
{ "originStationCode": string, "originName": { object ( |
ช่อง | |
---|---|
originStationCode |
รหัสสถานีต้นทาง ต้องระบุค่านี้หากมี |
originName |
ชื่อสถานีต้นทาง ต้องระบุค่านี้หากมี |
destinationStationCode |
รหัสสถานีปลายทาง |
destinationName |
ชื่อปลายทาง |
departureDateTime |
วันที่/เวลาออกเดินทาง จำเป็นต้องระบุค่านี้หากไม่มีการตั้งค่าช่วงเวลาที่ถูกต้องในออบเจ็กต์ขนส่ง รูปแบบนี้คือวันที่/เวลารูปแบบขยายของ ISO 8601 โดยมีหรือไม่มีออฟเซ็ต คุณสามารถระบุเวลาได้สูงสุด 1 นนาโนวินาที คุณสามารถระบุออฟเซ็ตด้วยความแม่นยำเป็นวินาทีได้ (แม้ว่าออฟเซ็ตแบบวินาทีจะไม่เป็นส่วนหนึ่งของ ISO 8601) เช่น
ส่วนวันที่/เวลาที่ไม่มีค่าออฟเซ็ตจะถือเป็น "วันที่/เวลาท้องถิ่น" ซึ่งควรเป็นวันที่/เวลาท้องถิ่นที่สถานีต้นทาง ตัวอย่างเช่น หากออกเดินทางเมื่อเวลา 20:00 น. ของวันที่ 5 มิถุนายน 2018 ที่สถานีต้นทาง ส่วนวันที่/เวลาท้องถิ่นควรเป็น หากไม่มีข้อมูลออฟเซต ฟีเจอร์ริชมีเดียบางอย่างอาจไม่พร้อมใช้งาน |
arrivalDateTime |
วันที่/เวลาถึง รูปแบบนี้คือวันที่/เวลารูปแบบขยายของ ISO 8601 โดยมีหรือไม่มีออฟเซ็ต คุณสามารถระบุเวลาได้สูงสุด 1 นนาโนวินาที คุณสามารถระบุออฟเซ็ตด้วยความแม่นยำเป็นวินาทีได้ (แม้ว่าออฟเซ็ตแบบวินาทีจะไม่เป็นส่วนหนึ่งของ ISO 8601) เช่น
ส่วนวันที่/เวลาที่ไม่มีค่าออฟเซ็ตจะถือเป็น "วันที่/เวลาท้องถิ่น" ซึ่งควรเป็นวันที่/เวลาท้องถิ่นของสถานีปลายทาง ตัวอย่างเช่น หากเหตุการณ์เกิดขึ้นในเวลา 20:00 น. ของวันที่ 5 มิถุนายน 2018 ที่สถานีปลายทาง ส่วนวันที่/เวลาท้องถิ่นควรเป็น หากไม่มีข้อมูลออฟเซต ฟีเจอร์ริชมีเดียบางอย่างอาจไม่พร้อมใช้งาน |
fareName |
คำอธิบาย/ชื่อสั้นๆ ของค่าโดยสารสำหรับการเดินทางขานี้ เช่น "ใช้ได้ทุกเมื่อแบบครั้งเดียว" |
carriage |
ชื่อ/หมายเลขรถไฟหรือเรือที่ผู้โดยสารต้องขึ้น |
platform |
ชานชาลาหรือประตูที่ผู้โดยสารขึ้นรถรางได้ |
zone |
โซนขึ้นเครื่องภายในแพลตฟอร์ม |
ticketSeat |
ที่นั่งที่จองไว้สำหรับผู้โดยสาร หากต้องการระบุที่นั่งมากกว่า 1 ที่นั่ง ให้ใช้ช่อง |
ticketSeats[] |
ที่นั่งที่จองไว้สำหรับผู้โดยสาร หากต้องการระบุที่นั่งเพียงที่นั่งเดียว ให้ใช้ช่อง |
transitOperatorName |
ชื่อของผู้ให้บริการขนส่งสาธารณะที่ดำเนินการในส่วนนี้ของการเดินทาง |
transitTerminusName |
สถานีปลายทางหรือจุดหมายของรถไฟ/รถประจำทาง/ฯลฯ |
TicketSeat
การแสดง JSON |
---|
{ "fareClass": enum ( |
ช่อง | |
---|---|
fareClass |
ระดับค่าโดยสารของที่นั่งที่มีตั๋ว |
customFareClass |
ชั้นโดยสารที่กำหนดเองที่จะใช้ในกรณีที่ไม่มี |
coach |
ตัวระบุของรถหรือรถพ่วงที่มีที่นั่งซึ่งซื้อตั๋วไว้ เช่น "10" |
seat |
ตัวระบุตำแหน่งของที่นั่งที่มีตั๋ว เช่น "42" หากไม่มีตัวระบุที่เฉพาะเจาะจง ให้ใช้ |
seatAssignment |
การกำหนดที่นั่งของผู้โดยสาร เช่น "no specific seat" ใช้ในกรณีที่ไม่มีตัวระบุที่เฉพาะเจาะจงที่จะใช้ใน |
FareClass
Enum | |
---|---|
FARE_CLASS_UNSPECIFIED |
|
ECONOMY |
|
economy |
ชื่อแทนเดิมของ |
FIRST |
|
first |
ชื่อแทนเดิมของ |
BUSINESS |
|
business |
ชื่อแทนเดิมของ |
TripType
Enum | |
---|---|
TRIP_TYPE_UNSPECIFIED |
|
ROUND_TRIP |
|
roundTrip |
ชื่อแทนเดิมของ |
ONE_WAY |
|
oneWay |
ชื่อแทนเดิมของ |
ActivationStatus
สถานะการเปิดใช้งานของออบเจ็กต์ ช่องนี้จะมีสถานะการเปิดใช้งานหากเนื้อหามีสถานะเปิดใช้งาน
การแสดง JSON |
---|
{
"state": enum ( |
ช่อง | |
---|---|
state |
|
รัฐ
Enum | |
---|---|
UNKNOWN_STATE |
|
NOT_ACTIVATED |
ไม่ได้เปิดใช้งาน ซึ่งเป็นสถานะเริ่มต้น |
not_activated |
ชื่อแทนเดิมของ |
ACTIVATED |
เปิดใช้งานแล้ว |
activated |
ชื่อแทนเดิมของ |
DeviceContext
บริบทของอุปกรณ์ที่เชื่อมโยงกับออบเจ็กต์
การแสดง JSON |
---|
{ "deviceToken": string } |
ช่อง | |
---|---|
deviceToken |
หากตั้งค่าไว้ ระบบจะแสดงข้อมูลการแลกสิทธิ์ในอุปกรณ์ที่ระบุเท่านั้นเมื่อมีการเปิดใช้งานออบเจ็กต์ ไม่ควรใช้ข้อมูลนี้เป็นตัวระบุที่คงที่เพื่อติดตามอุปกรณ์ของผู้ใช้ หมายเลขบัตรอาจแตกต่างกันไปในแต่ละบัตรสำหรับอุปกรณ์เครื่องเดียวกัน หรือแม้แต่ในการเปิดใช้งานที่แตกต่างกันสำหรับอุปกรณ์เครื่องเดียวกัน เมื่อตั้งค่านี้ ผู้เรียกใช้ต้องตั้งค่า hasLinkedDevice บนออบเจ็กต์ที่เปิดใช้งานด้วย |
เมธอด |
|
---|---|
|
เพิ่มข้อความไปยังออบเจ็กต์ขนส่งสาธารณะที่อ้างอิงโดยรหัสออบเจ็กต์ที่ระบุ |
|
แสดงผลออบเจ็กต์ขนส่งสาธารณะที่มีรหัสออบเจ็กต์ที่ระบุ |
|
แทรกออบเจ็กต์ขนส่งสาธารณะที่มีรหัสและพร็อพเพอร์ตี้ที่ระบุ |
|
แสดงรายการออบเจ็กต์ขนส่งสาธารณะทั้งหมดสำหรับรหัสผู้ออกบัตรที่ระบุ |
|
อัปเดตออบเจ็กต์ขนส่งสาธารณะที่อ้างอิงโดยรหัสออบเจ็กต์ที่ระบุ |
|
อัปเดตออบเจ็กต์ขนส่งสาธารณะที่อ้างอิงโดยรหัสออบเจ็กต์ที่ระบุ |