- ทรัพยากร: TransitObject
- PassengerType
- TicketStatus
- ConcessionCategory
- TicketRestrictions
- PurchaseDetails
- TicketCost
- TicketLeg
- TicketSeat
- FareClass
- TripType
- ActivationStatus
- สถานะ
- DeviceContext
- เมธอด
ทรัพยากร: TransitObject
การแสดง JSON |
---|
{ "classReference": { object ( |
ช่อง | |
---|---|
class |
สำเนาของช่องที่รับช่วงมาจากชั้นเรียนหลัก ระบบจะดึงข้อมูลฟิลด์เหล่านี้ระหว่างการเรียก GET |
ticket |
จำนวนตั๋ว รหัสนี้คือตัวระบุที่ไม่ซ้ำกันสำหรับตั๋วในระบบของผู้ให้บริการขนส่งสาธารณะ |
passenger |
จำนวนผู้โดยสาร |
passenger |
ชื่อของผู้โดยสารที่กำหนดตั๋วให้ ช่อง |
trip |
ระบบจะใช้รหัสนี้เพื่อจัดกลุ่มตั๋วเข้าด้วยกันหากผู้ใช้บันทึกตั๋วหลายใบสำหรับการเดินทางเดียวกัน |
ticket |
สถานะของคำขอแจ้งปัญหา สำหรับรัฐที่มีผลต่อการแสดงผล ให้ใช้ช่อง |
custom |
สถานะที่กำหนดเองที่จะใช้กับค่าสถานะของตั๋วเมื่อ |
concession |
หมวดหมู่ตั๋วราคาพิเศษ |
custom |
หมวดหมู่ส่วนลดที่กำหนดเองเพื่อใช้เมื่อ |
ticket |
ข้อมูลเกี่ยวกับประเภทข้อจำกัดในการใช้ตั๋วนี้ เช่น วันของสัปดาห์ที่ต้องใช้บัตร หรือเส้นทางที่อนุญาตให้ใช้บัตร |
purchase |
รายละเอียดการซื้อตั๋วนี้ |
ticket |
เที่ยวบินขาเดียวของตั๋วจะมีข้อมูลการออกเดินทางและเวลาถึง พร้อมทั้งข้อมูลการขึ้นเครื่องและที่นั่ง หากต้องการระบุเส้นทางมากกว่า 1 เส้นทาง ให้ใช้ช่อง |
ticket |
ตั๋วแต่ละใบอาจมีอย่างน้อย 1 ขา เที่ยวบินแต่ละเที่ยวจะมีข้อมูลการออกเดินทางและขาเข้า รวมถึงข้อมูลการขึ้นเครื่องและที่นั่ง หากต้องการระบุเพียงเที่ยวเดียว ให้ใช้ช่อง |
hex |
สีพื้นหลังของการ์ด หากไม่ได้ตั้งค่า ระบบจะใช้สีหลักของรูปภาพหลัก และหากไม่ได้ตั้งค่ารูปภาพหลัก ระบบจะใช้สีหลักของโลโก้ รูปแบบคือ #rrggbb โดยที่ rrggbb เป็น 3 ทางคือ RGB แบบเลขฐานสิบหก เช่น |
trip |
ต้องระบุ ประเภทการเดินทางที่ออบเจ็กต์ขนส่งสาธารณะนี้แสดง ใช้กำหนดชื่อบัตรและ/หรือสัญลักษณ์ที่จะใช้ระหว่างต้นทางและปลายทาง |
id |
ต้องระบุ ตัวระบุที่ไม่ซ้ำกันสำหรับออบเจ็กต์ รหัสนี้ต้องไม่ซ้ำกันในทุกออบเจ็กต์จากผู้ออกบัตร ค่านี้ควรเป็นไปตามรูปแบบ issuer IDidentifierที่บัญชีแรกออกโดย Google และคุณเป็นผู้เลือกรายการหลัง ตัวระบุที่ไม่ซ้ำกันควรมีเฉพาะอักขระที่เป็นตัวอักษรและตัวเลขคละกัน, ".", "_" หรือ "-" เท่านั้น |
class |
ต้องระบุ คลาสที่เชื่อมโยงกับออบเจ็กต์นี้ คลาสต้องเป็นประเภทเดียวกันกับออบเจ็กต์นี้ ต้องมีอยู่ก่อนแล้ว และต้องได้รับอนุมัติ รหัสชั้นเรียนควรอยู่ในรูปแบบ issuer IDidentifierที่บัญชีแรกออกโดย Google และคุณเป็นผู้เลือกรายการหลัง |
version |
เลิกใช้ |
state |
ต้องระบุ สถานะของออบเจ็กต์ ช่องนี้ใช้เพื่อกำหนดวิธีแสดงออบเจ็กต์ในแอป เช่น ระบบจะย้ายออบเจ็กต์ |
barcode |
ประเภทและค่าของบาร์โค้ด |
messages[] |
อาร์เรย์ข้อความที่แสดงในแอป ผู้ใช้ทั้งหมดของออบเจ็กต์นี้จะได้รับข้อความที่เกี่ยวข้อง จำนวนช่องสูงสุดคือ 10 ช่อง |
valid |
ระยะเวลาที่ออบเจ็กต์นี้จะกลายเป็น |
locations[] |
หมายเหตุ: ปัจจุบันระบบยังไม่รองรับการใช้ช่องนี้เพื่อทริกเกอร์การแจ้งเตือนทางภูมิศาสตร์ |
has |
ระบุว่าออบเจ็กต์มีผู้ใช้หรือไม่ แพลตฟอร์มจะเป็นผู้ตั้งค่าช่องนี้ |
smart |
ค่าที่จะส่งไปยังเครื่องชำระเงินที่ได้รับการรับรองของการแตะอัจฉริยะผ่าน NFC สำหรับออบเจ็กต์นี้ นอกจากนี้จะต้องตั้งค่าช่องระดับชั้นเรียน |
has |
ระบุว่าออบเจ็กต์นี้ลิงก์กับอุปกรณ์เดียวอยู่หรือไม่ แพลตฟอร์มจะตั้งค่าช่องนี้เมื่อผู้ใช้บันทึกออบเจ็กต์โดยลิงก์กับอุปกรณ์ มีไว้สำหรับใช้โดยพาร์ทเนอร์บางราย โปรดติดต่อทีมสนับสนุนเพื่อขอข้อมูลเพิ่มเติม |
disable |
ระบุว่าควรระงับการแจ้งเตือนอย่างชัดเจนหรือไม่ หากตั้งค่าช่องนี้เป็น "จริง" ระบบจะระงับการแจ้งเตือนการหมดอายุให้ผู้ใช้ทราบ ไม่ว่าช่อง ปัจจุบันคุณตั้งค่านี้ได้สำหรับข้อเสนอเท่านั้น |
info |
เลิกใช้งานแล้ว ให้ใช้ textModulesData แทน |
image |
ข้อมูลโมดูลรูปภาพ จำนวนสูงสุดของช่องเหล่านี้ที่แสดงคือ 1 จากระดับออบเจ็กต์และ 1 สำหรับระดับออบเจ็กต์คลาส |
text |
ข้อมูลโมดูลข้อความ หากมีการกำหนดข้อมูลโมดูลข้อความไว้ในคลาสด้วย ทั้งสองรายการจะแสดงขึ้น จำนวนสูงสุดของฟิลด์เหล่านี้ที่แสดงคือ 10 รายการจากออบเจ็กต์ และ 10 รายการจากคลาส |
links |
ข้อมูลโมดูลลิงก์ หากมีการกำหนดข้อมูลโมดูลลิงก์ไว้ในคลาสด้วย ทั้งสองรายการจะแสดงขึ้น |
app |
ลิงก์แอปหรือเว็บไซต์ที่ไม่บังคับซึ่งจะแสดงเป็นปุ่มด้านหน้าบัตร หากมีการระบุ AppLinkData ให้กับออบเจ็กต์ AppLinkData คลาสเท่านั้นที่เกี่ยวข้องจะแสดง |
activation |
สถานะการเปิดใช้งานของออบเจ็กต์ ต้องระบุหากชั้นเรียนตั้งค่า |
rotating |
ประเภทและค่าของบาร์โค้ดแบบหมุนเวียน |
device |
บริบทอุปกรณ์ที่เชื่อมโยงกับออบเจ็กต์ |
hero |
รูปภาพแบนเนอร์ที่ไม่บังคับซึ่งแสดงอยู่ด้านหน้าของการ์ด หากไม่มี ระบบจะแสดงรูปภาพหลักของชั้นเรียน (หากมี) หากไม่มีรูปภาพหลักของชั้นเรียนด้วย ก็จะไม่มีสิ่งใดแสดง |
grouping |
ข้อมูลที่ควบคุมวิธีจัดกลุ่มบัตรเข้าด้วยกัน |
pass |
ส่งข้อจำกัดสำหรับออบเจ็กต์ รวมถึงการจำกัดการทำงานของ NFC และภาพหน้าจอ |
save |
ข้อจำกัดของออบเจ็กต์ที่ต้องได้รับการยืนยันก่อนที่ผู้ใช้จะพยายามบันทึกบัตร โปรดทราบว่าจะมีการใช้ข้อจำกัดนี้เมื่อประหยัดเวลาเท่านั้น หากข้อจำกัดเปลี่ยนแปลงหลังจากที่ผู้ใช้บันทึกบัตร ข้อจำกัดใหม่จะไม่มีผลกับบัตรที่บันทึกไว้แล้ว |
linked |
linkedObjectIds คือรายการออบเจ็กต์อื่นๆ เช่น ตั๋วเข้างาน บัตรสะสมคะแนน ข้อเสนอ ทั่วไป บัตรของขวัญ บัตรโดยสาร และบอร์ดดิ้งพาส ซึ่งควรแนบมากับออบเจ็กต์ขนส่งสาธารณะนี้โดยอัตโนมัติ หากผู้ใช้บันทึกบัตรโดยสารนี้ไว้ ระบบจะพุช linkedObjectId เหล่านี้ไปยังกระเป๋าสตางค์ของผู้ใช้โดยอัตโนมัติ (เว้นแต่ผู้ใช้จะปิดการตั้งค่าเพื่อรับบัตรที่ลิงก์ดังกล่าว) ตรวจสอบว่าได้แทรกออบเจ็กต์ที่อยู่ใน linkedObjectIds แล้ว หากไม่ การเรียกใช้จะไม่สําเร็จ เมื่อลิงก์แล้ว คุณจะยกเลิกการลิงก์ออบเจ็กต์ที่ลิงก์ไม่ได้ คุณลิงก์ออบเจ็กต์ที่เป็นของผู้ออกรายอื่นไม่ได้ มีการจํากัดจํานวนออบเจ็กต์ที่ลิงก์กับออบเจ็กต์หนึ่งๆ ได้ หลังจากถึงขีดจำกัดแล้ว ระบบจะละเว้นออบเจ็กต์ที่ลิงก์ใหม่ในการเรียกโดยไม่มีการแจ้งเตือน รหัสออบเจ็กต์ควรเป็นไปตามรูปแบบ issuer IDidentifier โดยที่รหัสแรกจะออกโดย Google และรหัสหลังจะเลือกโดยคุณ |
notify |
การอัปเดตช่องออบเจ็กต์นี้ควรทริกเกอร์การแจ้งเตือนหรือไม่ เมื่อตั้งค่าเป็น "แจ้งเตือน" เราจะพยายามเรียกให้ระบบแจ้งเตือนการอัปเดตช่องแก่ผู้ใช้ ระบบจะส่งการแจ้งเตือนเหล่านี้ไปยังผู้ใช้เฉพาะเมื่อช่องนี้เป็นส่วนหนึ่งของรายการที่อนุญาต หากตั้งค่าเป็น DO_NOT_NOTIFY หรือ NOTIFICATION_SETTINGS_UNSPECIFIED ระบบจะไม่ทริกเกอร์การแจ้งเตือน การตั้งค่านี้เป็นแบบชั่วคราวและจำเป็นต้องกำหนดด้วยคำขอ Patch หรืออัปเดตแต่ละรายการ มิฉะนั้นการแจ้งเตือนจะไม่ทริกเกอร์ |
value |
ข้อมูลโมดูลที่เพิ่มมูลค่าซึ่งไม่บังคับ สูงสุด 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 ( |
ช่อง | |
---|---|
route |
ข้อจำกัดเกี่ยวกับเส้นทางที่อาจใช้ เช่น อาจเป็นสตริง "รถไฟ CrossCountry แบบจองเท่านั้น" |
route |
รายละเอียดเพิ่มเติมเกี่ยวกับ |
time |
ข้อจำกัดเกี่ยวกับเวลาที่สามารถใช้ตั๋วนี้ได้ |
other |
ข้อจำกัดเพิ่มเติมที่ไม่อยู่ในหมวดหมู่ "เส้นทาง" หรือ "เวลา" |
PurchaseDetails
การแสดง JSON |
---|
{
"purchaseReceiptNumber": string,
"purchaseDateTime": string,
"accountId": string,
"confirmationCode": string,
"ticketCost": {
object ( |
ช่อง | |
---|---|
purchase |
หมายเลข/ตัวระบุใบเสร็จสำหรับติดตามการซื้อตั๋วผ่านหน่วยงานที่จำหน่ายตั๋ว |
purchase |
วันที่/เวลาที่ซื้อตั๋ว นี่คือวันที่/เวลาในรูปแบบ ISO 8601 แบบขยาย ไม่ว่าจะมีหรือไม่มีออฟเซ็ต สามารถระบุเวลาได้ละเอียดถึงระดับนาโนวินาที คุณระบุออฟเซ็ตด้วยความแม่นยำเป็นวินาทีได้ (แม้ว่าออฟเซ็ตแบบวินาทีจะไม่เป็นส่วนหนึ่งของ ISO 8601) เช่น
ฟีเจอร์ริชมีเดียบางอย่างอาจไม่พร้อมใช้งานหากไม่มีข้อมูลออฟเซ็ต |
account |
รหัสบัญชีที่ใช้ซื้อตั๋ว |
confirmation |
รหัสยืนยันสำหรับการซื้อ ซึ่งอาจเหมือนกันสำหรับคำขอแจ้งปัญหาหลายรายการและใช้ในการจัดกลุ่มคำขอแจ้งปัญหาเข้าด้วยกัน |
ticket |
ค่าใช้จ่ายของตั๋ว |
TicketCost
การแสดง JSON |
---|
{ "faceValue": { object ( |
ช่อง | |
---|---|
face |
มูลค่าที่ตราไว้ของตั๋ว |
purchase |
ราคาซื้อจริงของตั๋ว รวมภาษีและ/หรือส่วนลด |
discount |
ข้อความที่อธิบายส่วนลดประเภทต่างๆ ที่ใช้ |
TicketLeg
การแสดง JSON |
---|
{ "originStationCode": string, "originName": { object ( |
ช่อง | |
---|---|
origin |
รหัสสถานีต้นทาง ต้องระบุหากมี |
origin |
ชื่อของสถานีต้นทาง ต้องระบุหากมี |
destination |
รหัสสถานีปลายทาง |
destination |
ชื่อปลายทาง |
departure |
วันที่/เวลาออกเดินทาง จำเป็นต้องระบุค่านี้หากไม่มีการตั้งค่าช่วงเวลาที่ถูกต้องในออบเจ็กต์ขนส่ง นี่คือวันที่/เวลาในรูปแบบ ISO 8601 แบบขยาย ไม่ว่าจะมีหรือไม่มีออฟเซ็ต คุณสามารถระบุเวลาได้สูงสุด 1 นนาโนวินาที คุณสามารถระบุค่าชดเชยด้วยความแม่นยำของวินาที (แม้ว่าวินาทีออฟเซ็ตจะไม่ได้เป็นส่วนหนึ่งของ ISO 8601 ก็ตาม) เช่น
ส่วนของวันที่/เวลาที่ไม่มีการชดเชยจะถือว่าเป็น "วันที่/เวลาท้องถิ่น" ซึ่งควรเป็นวันที่/เวลาท้องถิ่นที่สถานีต้นทาง ตัวอย่างเช่น หากการออกเดินทางเกิดขึ้นในชั่วโมงที่ 20 ของวันที่ 5 มิถุนายน 2018 ที่สถานีต้นทาง วันที่และเวลาท้องถิ่นควรเป็น หากไม่มีข้อมูลออฟเซต ฟีเจอร์ริชมีเดียบางอย่างอาจไม่พร้อมใช้งาน |
arrival |
วันที่/เวลามาถึง นี่คือวันที่/เวลารูปแบบขยาย ISO 8601 ที่มีหรือไม่มีออฟเซ็ต สามารถระบุเวลาได้ละเอียดถึงระดับนาโนวินาที คุณสามารถระบุค่าชดเชยด้วยความแม่นยำของวินาที (แม้ว่าวินาทีออฟเซ็ตจะไม่ได้เป็นส่วนหนึ่งของ ISO 8601 ก็ตาม) เช่น
ส่วนของวันที่/เวลาที่ไม่มีการชดเชยจะถือว่าเป็น "วันที่/เวลาท้องถิ่น" ซึ่งควรเป็นวันที่/เวลาท้องถิ่นของสถานีปลายทาง ตัวอย่างเช่น หากเหตุการณ์เกิดขึ้นเมื่อเวลา 20:00 น. ของวันที่ 5 มิถุนายน 2018 ที่สถานีปลายทาง ส่วนวันที่/เวลาท้องถิ่นควรเป็น หากไม่มีข้อมูลออฟเซต ฟีเจอร์ริชมีเดียบางอย่างอาจไม่พร้อมใช้งาน |
fare |
คำอธิบาย/ชื่อสั้นๆ ของค่าโดยสารสำหรับการเดินทางเที่ยวนี้ เช่น "ใช้ได้ทุกเมื่อแบบครั้งเดียว" |
carriage |
ชื่อ/หมายเลขรถไฟหรือเรือที่ผู้โดยสารต้องขึ้นเครื่อง |
platform |
ชานชาลาหรือประตูที่ผู้โดยสารขึ้นรถรางได้ |
zone |
โซนการขึ้นเครื่องภายในแพลตฟอร์ม |
ticket |
ที่นั่งที่จองไว้สำหรับผู้โดยสาร หากต้องการระบุที่นั่งมากกว่า 1 ที่นั่ง ให้ใช้ช่อง |
ticket |
ที่นั่งที่สงวนไว้สำหรับผู้โดยสาร หากมีการระบุที่นั่งเพียงที่เดียว ให้ใช้ช่อง |
transit |
ชื่อของผู้ให้บริการขนส่งสาธารณะที่ดำเนินการในการเดินทางครั้งนี้ |
transit |
สถานีปลายทางหรือปลายทางของรถไฟ/รถประจำทาง/ฯลฯ |
TicketSeat
การแสดง JSON |
---|
{ "fareClass": enum ( |
ช่อง | |
---|---|
fare |
ชั้นโดยสารของที่นั่งที่ต้องใช้ตั๋ว |
custom |
ระดับค่าโดยสารที่กำหนดเองที่จะใช้หากไม่มี |
coach |
ตัวระบุของรถหรือรถพ่วงที่มีที่นั่งซึ่งซื้อตั๋วไว้ เช่น "10" |
seat |
ตัวระบุตำแหน่งของที่นั่งที่มีตั๋ว เช่น "42" หากไม่มีตัวระบุที่เจาะจง ให้ใช้ |
seat |
การกำหนดที่นั่งของผู้โดยสาร เช่น "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 } |
ช่อง | |
---|---|
device |
หากตั้งค่าไว้ ระบบจะแสดงข้อมูลการแลกสิทธิ์ในอุปกรณ์ที่ระบุเท่านั้นเมื่อมีการเปิดใช้งานออบเจ็กต์ ไม่ควรใช้ข้อมูลนี้เป็นตัวระบุที่คงที่เพื่อติดตามอุปกรณ์ของผู้ใช้ หมายเลขบัตรอาจแตกต่างกันไปในแต่ละบัตรสำหรับอุปกรณ์เครื่องเดียวกัน หรือแม้แต่ในการเปิดใช้งานที่แตกต่างกันสำหรับอุปกรณ์เครื่องเดียวกัน เมื่อตั้งค่านโยบายนี้ ผู้โทรจะต้องตั้งค่า hasLinkedDevice ในออบเจ็กต์ที่เปิดใช้งานอยู่ด้วย |
เมธอด |
|
---|---|
|
เพิ่มข้อความไปยังออบเจ็กต์ขนส่งสาธารณะที่อ้างอิงโดยรหัสออบเจ็กต์ที่ระบุ |
|
แสดงผลออบเจ็กต์ขนส่งสาธารณะที่มีรหัสออบเจ็กต์ที่ระบุ |
|
แทรกออบเจ็กต์ขนส่งสาธารณะที่มีรหัสและพร็อพเพอร์ตี้ที่กำหนด |
|
แสดงผลรายการออบเจ็กต์การขนส่งทั้งหมดสำหรับรหัสผู้ออกคีย์ที่ระบุ |
|
อัปเดตออบเจ็กต์ขนส่งสาธารณะที่อ้างอิงโดยรหัสออบเจ็กต์ที่ระบุ |
|
อัปเดตออบเจ็กต์ขนส่งสาธารณะที่อ้างอิงโดยรหัสออบเจ็กต์ที่ระบุ |