- ทรัพยากร: 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 เป็น 3 ทางคือ RGB แบบเลขฐานสิบหก เช่น |
tripType |
ต้องระบุ ประเภทการเดินทางที่ออบเจ็กต์ขนส่งสาธารณะนี้แสดง ใช้กำหนดชื่อบัตรและ/หรือสัญลักษณ์ที่จะใช้ระหว่างต้นทางและปลายทาง |
id |
ต้องระบุ ตัวระบุที่ไม่ซ้ำกันสำหรับออบเจ็กต์ รหัสนี้ต้องไม่ซ้ำกันในออบเจ็กต์ทั้งหมดจากผู้ให้บริการ ค่านี้ควรเป็นไปตามรูปแบบ issuer IDidentifierที่บัญชีแรกออกโดย Google และคุณเป็นผู้เลือกรายการหลัง ตัวระบุที่ไม่ซ้ำกันควรมีเฉพาะอักขระที่เป็นตัวอักษรและตัวเลขคละกัน, ".", "_" หรือ "-" เท่านั้น |
classId |
ต้องระบุ คลาสที่เชื่อมโยงกับออบเจ็กต์นี้ คลาสต้องเป็นประเภทเดียวกันกับออบเจ็กต์นี้ ต้องมีอยู่ก่อนแล้ว และต้องได้รับอนุมัติ รหัสชั้นเรียนควรอยู่ในรูปแบบ issuer IDidentifierที่บัญชีแรกออกโดย Google และคุณเป็นผู้เลือกรายการหลัง |
version |
เลิกใช้ |
state |
ต้องระบุ สถานะของออบเจ็กต์ ช่องนี้ใช้เพื่อกำหนดการแสดงออบเจ็กต์ในแอป เช่น ย้ายออบเจ็กต์ |
barcode |
ประเภทและค่าของบาร์โค้ด |
messages[] |
อาร์เรย์ของข้อความที่แสดงในแอป ผู้ใช้ทั้งหมดของออบเจ็กต์นี้จะได้รับข้อความที่เกี่ยวข้อง จำนวนช่องสูงสุดคือ 10 ช่อง |
validTimeInterval |
ระยะเวลาที่ออบเจ็กต์นี้จะเป็น |
locations[] |
หมายเหตุ: ปัจจุบันฟิลด์นี้ไม่ได้รับการสนับสนุนเพื่อเรียกใช้การแจ้งเตือนทางภูมิศาสตร์ |
hasUsers |
ระบุว่าออบเจ็กต์มีผู้ใช้หรือไม่ แพลตฟอร์มนี้เป็นผู้กำหนดค่าฟิลด์นี้ |
smartTapRedemptionValue |
ค่าที่จะส่งไปยังเครื่องชำระเงินที่ได้รับการรับรองของการแตะอัจฉริยะผ่าน NFC สำหรับออบเจ็กต์นี้ นอกจากนี้จะต้องตั้งค่าช่องระดับชั้นเรียน |
hasLinkedDevice |
ระบุว่าออบเจ็กต์นี้ลิงก์กับอุปกรณ์เดียวอยู่หรือไม่ แพลตฟอร์มจะตั้งค่าช่องนี้เมื่อผู้ใช้บันทึกออบเจ็กต์เพื่อลิงก์กับอุปกรณ์ของตน มีไว้สำหรับใช้โดยพาร์ทเนอร์บางราย โปรดติดต่อทีมสนับสนุนเพื่อขอข้อมูลเพิ่มเติม |
disableExpirationNotification |
ระบุว่าควรระงับการแจ้งเตือนอย่างชัดเจนหรือไม่ หากตั้งค่าช่องนี้เป็น "จริง" โดยไม่คำนึงถึงช่อง ปัจจุบันตั้งค่านี้ได้สำหรับข้อเสนอเท่านั้น |
infoModuleData |
เลิกใช้งานแล้ว โปรดใช้ textModulesData แทน |
imageModulesData[] |
ข้อมูลโมดูลรูปภาพ จำนวนสูงสุดของช่องเหล่านี้ที่แสดงคือ 1 ช่องจากระดับออบเจ็กต์และ 1 ช่องสำหรับระดับออบเจ็กต์ของคลาส |
textModulesData[] |
ข้อมูลโมดูลข้อความ หากมีการกำหนดข้อมูลโมดูลข้อความไว้ในคลาสด้วย ทั้งสองรายการจะแสดงขึ้น จำนวนสูงสุดของฟิลด์เหล่านี้ที่แสดงคือ 10 รายการจากออบเจ็กต์ และ 10 รายการจากคลาส |
linksModuleData |
ข้อมูลโมดูลลิงก์ หากมีการกำหนดข้อมูลโมดูลลิงก์ไว้ในคลาสด้วย ทั้งสองรายการจะแสดงขึ้น |
appLinkData |
ลิงก์แอปหรือเว็บไซต์ที่ไม่บังคับซึ่งจะแสดงเป็นปุ่มด้านหน้าบัตร หากมีการระบุ AppLinkData ให้กับออบเจ็กต์ AppLinkData คลาสเท่านั้นที่เกี่ยวข้องจะแสดง |
activationStatus |
สถานะการเปิดใช้งานของออบเจ็กต์ ต้องระบุหากชั้นเรียนตั้งค่า |
rotatingBarcode |
ประเภทและค่าของบาร์โค้ดแบบหมุนเวียน |
deviceContext |
บริบทอุปกรณ์ที่เชื่อมโยงกับออบเจ็กต์ |
heroImage |
รูปภาพแบนเนอร์ที่ไม่บังคับซึ่งแสดงอยู่ด้านหน้าของการ์ด หากไม่มี ระบบจะแสดงรูปภาพหลักของชั้นเรียน (หากมี) หากไม่มีรูปภาพหลักของชั้นเรียนด้วย ก็จะไม่มีการแสดงรูปภาพใดๆ |
groupingInfo |
ข้อมูลที่ควบคุมวิธีจัดกลุ่มบัตรเข้าด้วยกัน |
passConstraints |
ส่งผ่านข้อจำกัดสำหรับออบเจ็กต์ รวมถึงการจำกัดการทำงานของ NFC และภาพหน้าจอ |
saveRestrictions |
ข้อจำกัดในออบเจ็กต์ที่ต้องยืนยันก่อนที่ผู้ใช้จะบันทึกบัตร โปรดทราบว่าจะมีการใช้ข้อจำกัดนี้เมื่อประหยัดเวลาเท่านั้น หากข้อจำกัดเปลี่ยนแปลงหลังจากที่ผู้ใช้บันทึกบัตร ข้อจำกัดใหม่จะไม่มีผลกับบัตรที่บันทึกไว้แล้ว |
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 |
ข้อจำกัดเกี่ยวกับเส้นทางที่อาจใช้ เช่น อาจเป็นสตริง "รถไฟข้ามประเทศที่จองไว้เท่านั้น" |
routeRestrictionsDetails |
รายละเอียดเพิ่มเติมเกี่ยวกับ |
timeRestrictions |
ข้อจำกัดเกี่ยวกับเวลาที่ต้องใช้ตั๋วนี้ |
otherRestrictions |
ข้อจำกัดเพิ่มเติมที่ไม่ได้อยู่ภายใต้ "เส้นทาง" หรือ "เวลา" หมวดหมู่ต่างๆ |
PurchaseDetails
การแสดง JSON |
---|
{
"purchaseReceiptNumber": string,
"purchaseDateTime": string,
"accountId": string,
"confirmationCode": string,
"ticketCost": {
object ( |
ช่อง | |
---|---|
purchaseReceiptNumber |
หมายเลข/ตัวระบุใบเสร็จสำหรับติดตามการซื้อตั๋วผ่านหน่วยงานที่จำหน่ายตั๋ว |
purchaseDateTime |
วันที่/เวลาที่ซื้อตั๋ว นี่คือวันที่/เวลาในรูปแบบ ISO 8601 แบบขยาย ไม่ว่าจะมีหรือไม่มีออฟเซ็ต สามารถระบุเวลาได้ละเอียดถึงระดับนาโนวินาที คุณสามารถระบุค่าออฟเซ็ตด้วยความแม่นยำของวินาที (แม้ว่าวินาทีออฟเซ็ตจะไม่ได้เป็นส่วนหนึ่งของ 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 แบบขยาย ไม่ว่าจะมีหรือไม่มีออฟเซ็ต สามารถระบุเวลาได้ละเอียดถึงระดับนาโนวินาที คุณสามารถระบุค่าออฟเซ็ตด้วยความแม่นยำของวินาที (แม้ว่าวินาทีออฟเซ็ตจะไม่ได้เป็นส่วนหนึ่งของ ISO 8601 ก็ตาม) เช่น
ส่วนของวันที่/เวลาที่ไม่มีการชดเชยจะถือว่าเป็น "วันที่/เวลาท้องถิ่น" ซึ่งควรเป็นวันที่/เวลาท้องถิ่นที่สถานีต้นทาง ตัวอย่างเช่น หากการออกเดินทางเกิดขึ้นในชั่วโมงที่ 20 ของวันที่ 5 มิถุนายน 2018 ที่สถานีต้นทาง วันที่และเวลาท้องถิ่นควรเป็น หากไม่มีข้อมูลออฟเซ็ต ฟีเจอร์สื่อสมบูรณ์บางอย่างอาจใช้งานไม่ได้ |
arrivalDateTime |
วันที่/เวลาที่มาถึง นี่คือวันที่/เวลาในรูปแบบ ISO 8601 แบบขยาย ไม่ว่าจะมีหรือไม่มีออฟเซ็ต สามารถระบุเวลาได้ละเอียดถึงระดับนาโนวินาที คุณสามารถระบุค่าออฟเซ็ตด้วยความแม่นยำของวินาที (แม้ว่าวินาทีออฟเซ็ตจะไม่ได้เป็นส่วนหนึ่งของ ISO 8601 ก็ตาม) เช่น
ส่วนของวันที่/เวลาที่ไม่มีการชดเชยจะถือว่าเป็น "วันที่/เวลาท้องถิ่น" ซึ่งควรเป็นวันที่/เวลาท้องถิ่นที่สถานีปลายทาง ตัวอย่างเช่น หากกิจกรรมเกิดขึ้นในชั่วโมงที่ 20 ของวันที่ 5 มิถุนายน 2018 ที่สถานีปลายทาง ส่วนที่เป็นวันที่/เวลาท้องถิ่นควรเป็น หากไม่มีข้อมูลออฟเซ็ต ฟีเจอร์สื่อสมบูรณ์บางอย่างอาจใช้งานไม่ได้ |
fareName |
คำอธิบาย/ชื่อสั้นๆ ของค่าโดยสารสำหรับการเดินทางเที่ยวนี้ เช่น "Anytime Single Use" |
carriage |
ชื่อ/หมายเลขรถไฟหรือเรือที่ผู้โดยสารต้องขึ้นเครื่อง |
platform |
ชานชาลาหรือประตูที่ผู้โดยสารจะขึ้นตู้โดยสารได้ |
zone |
โซนการขึ้นเครื่องภายในแพลตฟอร์ม |
ticketSeat |
ที่นั่งที่สงวนไว้สำหรับผู้โดยสาร หากต้องระบุใบอนุญาตมากกว่า 1 ที่ ให้ใช้ช่อง |
ticketSeats[] |
ที่นั่งที่สงวนไว้สำหรับผู้โดยสาร หากมีการระบุที่นั่งเพียงที่เดียว ให้ใช้ช่อง |
transitOperatorName |
ชื่อของผู้ให้บริการขนส่งสาธารณะที่ดำเนินการในการเดินทางครั้งนี้ |
transitTerminusName |
สถานีปลายทางหรือปลายทางของรถไฟ/รถประจำทาง/ฯลฯ |
TicketSeat
การแสดง JSON |
---|
{ "fareClass": enum ( |
ช่อง | |
---|---|
fareClass |
ชั้นโดยสารของที่นั่งที่ต้องใช้ตั๋ว |
customFareClass |
ระดับค่าโดยสารที่กำหนดเองที่จะใช้หากไม่มี |
coach |
ตัวระบุตู้โดยสารหรือรถบัสที่มีที่นั่งซึ่งซื้อตั๋วไว้ เช่น "10" |
seat |
ตัวระบุตำแหน่งของที่นั่งที่ซื้อตั๋ว เช่น "42" หากไม่มีตัวระบุที่เจาะจง ให้ใช้ |
seatAssignment |
การกำหนดที่นั่งของผู้โดยสาร เช่น "ไม่มีที่นั่งที่เจาะจง" ใช้เมื่อไม่มีตัวระบุที่เจาะจงให้ใช้ใน |
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 ในออบเจ็กต์ที่เปิดใช้งานอยู่ด้วย |
เมธอด |
|
---|---|
|
เพิ่มข้อความไปยังออบเจ็กต์ขนส่งสาธารณะที่อ้างอิงโดยรหัสออบเจ็กต์ที่กำหนด |
|
แสดงผลออบเจ็กต์ทรานซิชันที่มีรหัสออบเจ็กต์ที่ระบุ |
|
แทรกออบเจ็กต์ขนส่งสาธารณะที่มีรหัสและพร็อพเพอร์ตี้ที่กำหนด |
|
แสดงผลรายการออบเจ็กต์การขนส่งทั้งหมดสำหรับรหัสผู้ออกคีย์ที่ระบุ |
|
อัปเดตออบเจ็กต์ทรานซิชันที่อ้างอิงโดยรหัสออบเจ็กต์ที่กำหนด |
|
อัปเดตออบเจ็กต์ทรานซิชันที่อ้างอิงโดยรหัสออบเจ็กต์ที่กำหนด |