- ทรัพยากร: 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 แบบเลขฐาน 16 เช่น |
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[] |
ข้อมูลโมดูลข้อความ หากมีการกำหนดข้อมูลโมดูลข้อความไว้ในคลาสด้วย ระบบจะแสดงทั้ง 2 รายการ โดยจำนวนสูงสุดของช่องที่แสดงคือ 10 ช่องจากออบเจ็กต์ และ 10 ช่องจากคลาส |
linksModuleData |
ข้อมูลโมดูลลิงก์ หากมีการกำหนดข้อมูลโมดูลลิงก์ไว้ในคลาสด้วย ระบบจะแสดงทั้ง 2 รายการ |
appLinkData |
ลิงก์ของแอปหรือเว็บไซต์ (ไม่บังคับ) ซึ่งจะแสดงเป็นปุ่มที่ด้านหน้าบัตร หากมีการระบุ AppLinkData สำหรับออบเจ็กต์เฉพาะคลาสที่เกี่ยวข้อง ระบบจะแสดง AppLinkData |
activationStatus |
สถานะการเปิดใช้งานของออบเจ็กต์ ต้องระบุหากชั้นเรียนตั้งค่า |
rotatingBarcode |
ประเภทและค่าบาร์โค้ดแบบหมุน |
deviceContext |
บริบทอุปกรณ์ที่เชื่อมโยงกับออบเจ็กต์ |
heroImage |
รูปภาพแบนเนอร์ที่ไม่บังคับจะแสดงที่ด้านหน้าการ์ด หากไม่มี ระบบจะแสดงรูปภาพหลักของชั้นเรียน (หากมี) หากไม่มีรูปภาพหลักของชั้นเรียนด้วย ก็จะไม่มีรูปภาพใดๆ ปรากฏขึ้น |
groupingInfo |
ข้อมูลที่ควบคุมวิธีจัดกลุ่มบัตรเข้าด้วยกัน |
passConstraints |
ส่งผ่านข้อจำกัดสำหรับออบเจ็กต์ รวมถึงการจำกัดการทำงานของ NFC และภาพหน้าจอ |
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 |
คำอธิบาย/ชื่อค่าโดยสารสั้นๆ สำหรับการเดินทางครั้งนี้ เช่น "ใช้ครั้งเดียวได้ทุกเมื่อ" |
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 ในออบเจ็กต์ที่เปิดใช้งานด้วย |
วิธีการ |
|
---|---|
|
เพิ่มข้อความลงในออบเจ็กต์การส่งที่อ้างอิงตามรหัสออบเจ็กต์ที่ระบุ |
|
แสดงผลออบเจ็กต์แผนการเดินทางที่มีรหัสออบเจ็กต์ที่ระบุ |
|
แทรกออบเจ็กต์การส่งที่มีรหัสและพร็อพเพอร์ตี้ที่ระบุ |
|
แสดงรายการออบเจ็กต์แผนการเดินทางทั้งหมดสำหรับรหัสผู้ออกบัตรที่ระบุ |
|
อัปเดตออบเจ็กต์การรับส่งที่อ้างอิงตามรหัสออบเจ็กต์ที่ระบุ |
|
อัปเดตออบเจ็กต์การรับส่งที่อ้างอิงตามรหัสออบเจ็กต์ที่ระบุ |