REST Resource: transitobject

ทรัพยากร: TransitObject

การแสดง JSON
{
  "classReference": {
    object (TransitClass)
  },
  "ticketNumber": string,
  "passengerType": enum (PassengerType),
  "passengerNames": string,
  "tripId": string,
  "ticketStatus": enum (TicketStatus),
  "customTicketStatus": {
    object (LocalizedString)
  },
  "concessionCategory": enum (ConcessionCategory),
  "customConcessionCategory": {
    object (LocalizedString)
  },
  "ticketRestrictions": {
    object (TicketRestrictions)
  },
  "purchaseDetails": {
    object (PurchaseDetails)
  },
  "ticketLeg": {
    object (TicketLeg)
  },
  "ticketLegs": [
    {
      object (TicketLeg)
    }
  ],
  "hexBackgroundColor": string,
  "tripType": enum (TripType),
  "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)
  },
  "activationStatus": {
    object (ActivationStatus)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "deviceContext": {
    object (DeviceContext)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  }
}
ช่อง
classReference

object (TransitClass)

สำเนาของช่องที่รับช่วงมาจากชั้นเรียนหลัก ระบบจะดึงข้อมูลช่องเหล่านี้ระหว่าง GET

ticketNumber

string

จำนวนตั๋ว รหัสนี้คือตัวระบุที่ไม่ซ้ำกันสำหรับตั๋วในระบบของผู้ให้บริการขนส่งสาธารณะ

passengerType

enum (PassengerType)

จำนวนผู้โดยสาร

passengerNames

string

ชื่อของผู้โดยสารที่กำหนดตั๋วให้ ช่อง passengerType ด้านบนมีไว้เพื่อให้บริบทแก่ Google ในช่องนี้

tripId

string

รหัสนี้ใช้เพื่อจัดกลุ่มตั๋วเข้าด้วยกันในกรณีที่ผู้ใช้บันทึกตั๋วหลายใบสำหรับการเดินทางเดียวกัน

ticketStatus

enum (TicketStatus)

สถานะของคำขอแจ้งปัญหา สำหรับรัฐที่มีผลต่อการแสดงผล ให้ใช้ช่อง state แทน

customTicketStatus

object (LocalizedString)

สถานะที่กำหนดเองที่จะใช้กับค่าสถานะของตั๋วเมื่อ ticketStatus ไม่ได้ระบุตัวเลือกที่ถูกต้อง ตั้งค่าทั้ง ticketStatus และ customTicketStatus ไม่ได้

concessionCategory

enum (ConcessionCategory)

หมวดหมู่ตั๋วราคาพิเศษ

customConcessionCategory

object (LocalizedString)

หมวดหมู่ส่วนลดที่กำหนดเองเพื่อใช้เมื่อ concessionCategory ไม่มีตัวเลือกที่เหมาะสม ตั้งค่าทั้ง concessionCategory และ customConcessionCategory ไม่ได้

ticketRestrictions

object (TicketRestrictions)

ข้อมูลเกี่ยวกับประเภทข้อจำกัดในการใช้ตั๋วนี้ เช่น ต้องใช้วันใดของสัปดาห์ หรือเส้นทางที่อนุญาตให้ใช้

purchaseDetails

object (PurchaseDetails)

รายละเอียดการซื้อตั๋วนี้

ticketLeg

object (TicketLeg)

ตั๋วเที่ยวเดียวประกอบด้วยข้อมูลการออกเดินทางและขาเข้า รวมถึงข้อมูลการขึ้นเครื่องและที่นั่ง หากต้องระบุขามากกว่า 1 ขา ให้ใช้ช่อง ticketLegs แทน ตั้งค่าทั้ง ticketLeg และ ticketLegs ไม่ได้

ticketLegs[]

object (TicketLeg)

ตั๋วแต่ละใบอาจมีอย่างน้อย 1 ขา เที่ยวบินแต่ละเที่ยวจะมีข้อมูลการออกเดินทางและขาเข้า รวมถึงข้อมูลการขึ้นเครื่องและที่นั่ง หากมีการระบุขาเพียงขาเดียว ให้ใช้ช่อง ticketLeg แทน ตั้งค่าทั้ง ticketLeg และ ticketLegs ไม่ได้

hexBackgroundColor

string

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

tripType

enum (TripType)

ต้องระบุ ประเภทการเดินทางที่ออบเจ็กต์ขนส่งสาธารณะนี้แสดง ใช้กำหนดชื่อบัตรและ/หรือสัญลักษณ์ที่จะใช้ระหว่างต้นทางและปลายทาง

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[]

object (LatLongPoint)

หมายเหตุ: ปัจจุบันฟิลด์นี้ไม่ได้รับการสนับสนุนเพื่อเรียกใช้การแจ้งเตือนทางภูมิศาสตร์

hasUsers

boolean

ระบุว่าออบเจ็กต์มีผู้ใช้หรือไม่ แพลตฟอร์มนี้เป็นผู้กำหนดค่าฟิลด์นี้

smartTapRedemptionValue

string

ค่าที่จะส่งไปยังเครื่องชำระเงินที่ได้รับการรับรองของการแตะอัจฉริยะผ่าน NFC สำหรับออบเจ็กต์นี้ นอกจากนี้จะต้องตั้งค่าช่องระดับชั้นเรียน enableSmartTap และ redemptionIssuers ให้ถูกต้องเพื่อให้บัตรรองรับการแตะอัจฉริยะ รองรับเฉพาะอักขระ ASCII

hasLinkedDevice

boolean

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

disableExpirationNotification

boolean

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

ปัจจุบันตั้งค่านี้ได้สำหรับข้อเสนอเท่านั้น

infoModuleData

object (InfoModuleData)

เลิกใช้งานแล้ว โปรดใช้ textModulesData แทน

imageModulesData[]

object (ImageModuleData)

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

textModulesData[]

object (TextModuleData)

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

activationStatus

object (ActivationStatus)

สถานะการเปิดใช้งานของออบเจ็กต์ ต้องระบุหากชั้นเรียนตั้งค่า activationOptions ไว้

rotatingBarcode

object (RotatingBarcode)

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

deviceContext

object (DeviceContext)

บริบทอุปกรณ์ที่เชื่อมโยงกับออบเจ็กต์

heroImage

object (Image)

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

groupingInfo

object (GroupingInfo)

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

passConstraints

object (PassConstraints)

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

saveRestrictions

object (SaveRestrictions)

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

PassengerType

Enum
PASSENGER_TYPE_UNSPECIFIED
SINGLE_PASSENGER
singlePassenger

ชื่อแทนเดิมสำหรับ SINGLE_PASSENGER เลิกใช้งานแล้ว

MULTIPLE_PASSENGERS
multiplePassengers

ชื่อแทนเดิมสำหรับ MULTIPLE_PASSENGERS เลิกใช้งานแล้ว

TicketStatus

Enum
TICKET_STATUS_UNSPECIFIED
USED
used

ชื่อแทนเดิมสำหรับ USED เลิกใช้งานแล้ว

REFUNDED
refunded

ชื่อแทนเดิมสำหรับ REFUNDED เลิกใช้งานแล้ว

EXCHANGED
exchanged

ชื่อแทนเดิมสำหรับ EXCHANGED เลิกใช้งานแล้ว

ConcessionCategory

Enum
CONCESSION_CATEGORY_UNSPECIFIED
ADULT
adult

ชื่อแทนเดิมสำหรับ ADULT เลิกใช้งานแล้ว

CHILD
child

ชื่อแทนเดิมสำหรับ CHILD เลิกใช้งานแล้ว

SENIOR
senior

ชื่อแทนเดิมสำหรับ SENIOR เลิกใช้งานแล้ว

TicketRestrictions

การแสดง JSON
{
  "routeRestrictions": {
    object (LocalizedString)
  },
  "routeRestrictionsDetails": {
    object (LocalizedString)
  },
  "timeRestrictions": {
    object (LocalizedString)
  },
  "otherRestrictions": {
    object (LocalizedString)
  }
}
ช่อง
routeRestrictions

object (LocalizedString)

ข้อจำกัดเกี่ยวกับเส้นทางที่อาจใช้ เช่น อาจเป็นสตริง "รถไฟข้ามประเทศที่จองไว้เท่านั้น"

routeRestrictionsDetails

object (LocalizedString)

รายละเอียดเพิ่มเติมเกี่ยวกับ routeRestrictions ข้างต้น

timeRestrictions

object (LocalizedString)

ข้อจำกัดเกี่ยวกับเวลาที่ต้องใช้ตั๋วนี้

otherRestrictions

object (LocalizedString)

ข้อจำกัดเพิ่มเติมที่ไม่ได้อยู่ภายใต้ "เส้นทาง" หรือ "เวลา" หมวดหมู่ต่างๆ

PurchaseDetails

การแสดง JSON
{
  "purchaseReceiptNumber": string,
  "purchaseDateTime": string,
  "accountId": string,
  "confirmationCode": string,
  "ticketCost": {
    object (TicketCost)
  }
}
ช่อง
purchaseReceiptNumber

string

หมายเลข/ตัวระบุใบเสร็จสำหรับติดตามการซื้อตั๋วผ่านหน่วยงานที่จำหน่ายตั๋ว

purchaseDateTime

string

วันที่/เวลาที่ซื้อตั๋ว

นี่คือวันที่/เวลาในรูปแบบ ISO 8601 แบบขยาย ไม่ว่าจะมีหรือไม่มีออฟเซ็ต สามารถระบุเวลาได้ละเอียดถึงระดับนาโนวินาที คุณสามารถระบุค่าออฟเซ็ตด้วยความแม่นยำของวินาที (แม้ว่าวินาทีออฟเซ็ตจะไม่ได้เป็นส่วนหนึ่งของ ISO 8601 ก็ตาม)

เช่น

1985-04-12T23:20:50.52Z จะใช้เวลา 20 นาที 50.52 วินาทีหลังจาก 23 ชั่วโมงของวันที่ 12 เมษายน 1985 ในเขตเวลา UTC

1985-04-12T19:20:50.52-04:00 จะเป็น 20 นาที 50.52 วินาทีหลังจากชั่วโมงที่ 19 ของวันที่ 12 เมษายน 1985 เป็นเวลา 4 ชั่วโมงก่อน UTC (ทันทีเหมือนกับตัวอย่างด้านบน) ถ้ากิจกรรมจัดขึ้นที่นิวยอร์ก เวลานี้จะเทียบเท่ากับเวลาออมแสงตะวันออก (EDT) โปรดทราบว่าออฟเซ็ตจะแตกต่างกันไปในภูมิภาคที่ใช้เวลาออมแสง (หรือฤดูร้อน) โดยขึ้นอยู่กับช่วงเวลาของปี

1985-04-12T19:20:50.52 จะเป็น 20 นาที 50.52 วินาทีหลังจาก 19 ชั่วโมงของวันที่ 12 เมษายน 1985 โดยไม่มีข้อมูลออฟเซ็ต

หากไม่มีข้อมูลออฟเซ็ต ฟีเจอร์สื่อสมบูรณ์บางอย่างอาจใช้งานไม่ได้

accountId

string

รหัสบัญชีที่ใช้ซื้อตั๋ว

confirmationCode

string

รหัสยืนยันสำหรับการซื้อ คำขอนี้อาจเหมือนกันสำหรับตั๋วต่างๆ หลายใบและใช้เพื่อจัดกลุ่มตั๋วเข้าด้วยกัน

ticketCost

object (TicketCost)

ค่าใช้จ่ายของตั๋ว

TicketCost

การแสดง JSON
{
  "faceValue": {
    object (Money)
  },
  "purchasePrice": {
    object (Money)
  },
  "discountMessage": {
    object (LocalizedString)
  }
}
ช่อง
faceValue

object (Money)

ราคาหน้าบัตร

purchasePrice

object (Money)

ราคาซื้อจริงของตั๋ว รวมภาษีและ/หรือส่วนลด

discountMessage

object (LocalizedString)

ข้อความที่อธิบายส่วนลดทุกประเภทที่ใช้

TicketLeg

การแสดง JSON
{
  "originStationCode": string,
  "originName": {
    object (LocalizedString)
  },
  "destinationStationCode": string,
  "destinationName": {
    object (LocalizedString)
  },
  "departureDateTime": string,
  "arrivalDateTime": string,
  "fareName": {
    object (LocalizedString)
  },
  "carriage": string,
  "platform": string,
  "zone": string,
  "ticketSeat": {
    object (TicketSeat)
  },
  "ticketSeats": [
    {
      object (TicketSeat)
    }
  ],
  "transitOperatorName": {
    object (LocalizedString)
  },
  "transitTerminusName": {
    object (LocalizedString)
  }
}
ช่อง
originStationCode

string

รหัสสถานีต้นทาง ต้องระบุหากมี destinationStationCode อยู่แล้วหรือหากไม่มี originName

originName

object (LocalizedString)

ชื่อของสถานีต้นทาง ต้องระบุหากมี desinationName อยู่แล้วหรือหากไม่มี originStationCode

destinationStationCode

string

รหัสสถานีปลายทาง

destinationName

object (LocalizedString)

ชื่อปลายทาง

departureDateTime

string

วันที่/เวลาออกเดินทาง ต้องระบุค่านี้หากไม่ได้กำหนดช่วงเวลาที่ใช้งานได้ในออบเจ็กต์การนำส่ง

นี่คือวันที่/เวลาในรูปแบบ ISO 8601 แบบขยาย ไม่ว่าจะมีหรือไม่มีออฟเซ็ต สามารถระบุเวลาได้ละเอียดถึงระดับนาโนวินาที คุณสามารถระบุค่าออฟเซ็ตด้วยความแม่นยำของวินาที (แม้ว่าวินาทีออฟเซ็ตจะไม่ได้เป็นส่วนหนึ่งของ ISO 8601 ก็ตาม)

เช่น

1985-04-12T23:20:50.52Z จะใช้เวลา 20 นาที 50.52 วินาทีหลังจาก 23 ชั่วโมงของวันที่ 12 เมษายน 1985 ในเขตเวลา UTC

1985-04-12T19:20:50.52-04:00 จะเป็น 20 นาที 50.52 วินาทีหลังจากชั่วโมงที่ 19 ของวันที่ 12 เมษายน 1985 เป็นเวลา 4 ชั่วโมงก่อน UTC (ทันทีเหมือนกับตัวอย่างด้านบน) ถ้ากิจกรรมจัดขึ้นที่นิวยอร์ก เวลานี้จะเทียบเท่ากับเวลาออมแสงตะวันออก (EDT) โปรดทราบว่าออฟเซ็ตจะแตกต่างกันไปในภูมิภาคที่ใช้เวลาออมแสง (หรือฤดูร้อน) โดยขึ้นอยู่กับช่วงเวลาของปี

1985-04-12T19:20:50.52 จะเป็น 20 นาที 50.52 วินาทีหลังจาก 19 ชั่วโมงของวันที่ 12 เมษายน 1985 โดยไม่มีข้อมูลออฟเซ็ต

ส่วนของวันที่/เวลาที่ไม่มีการชดเชยจะถือว่าเป็น "วันที่/เวลาท้องถิ่น" ซึ่งควรเป็นวันที่/เวลาท้องถิ่นที่สถานีต้นทาง ตัวอย่างเช่น หากการออกเดินทางเกิดขึ้นในชั่วโมงที่ 20 ของวันที่ 5 มิถุนายน 2018 ที่สถานีต้นทาง วันที่และเวลาท้องถิ่นควรเป็น 2018-06-05T20:00:00 หากวันที่/เวลาท้องถิ่นของสถานีต้นทางคือ 4 ชั่วโมงก่อน UTC อาจมีการเพิ่มออฟเซ็ต -04:00

หากไม่มีข้อมูลออฟเซ็ต ฟีเจอร์สื่อสมบูรณ์บางอย่างอาจใช้งานไม่ได้

arrivalDateTime

string

วันที่/เวลาที่มาถึง

นี่คือวันที่/เวลาในรูปแบบ ISO 8601 แบบขยาย ไม่ว่าจะมีหรือไม่มีออฟเซ็ต สามารถระบุเวลาได้ละเอียดถึงระดับนาโนวินาที คุณสามารถระบุค่าออฟเซ็ตด้วยความแม่นยำของวินาที (แม้ว่าวินาทีออฟเซ็ตจะไม่ได้เป็นส่วนหนึ่งของ ISO 8601 ก็ตาม)

เช่น

1985-04-12T23:20:50.52Z จะใช้เวลา 20 นาที 50.52 วินาทีหลังจาก 23 ชั่วโมงของวันที่ 12 เมษายน 1985 ในเขตเวลา UTC

1985-04-12T19:20:50.52-04:00 จะเป็น 20 นาที 50.52 วินาทีหลังจากชั่วโมงที่ 19 ของวันที่ 12 เมษายน 1985 เป็นเวลา 4 ชั่วโมงก่อน UTC (ทันทีเหมือนกับตัวอย่างด้านบน) ถ้ากิจกรรมจัดขึ้นที่นิวยอร์ก เวลานี้จะเทียบเท่ากับเวลาออมแสงตะวันออก (EDT) โปรดทราบว่าออฟเซ็ตจะแตกต่างกันไปในภูมิภาคที่ใช้เวลาออมแสง (หรือฤดูร้อน) โดยขึ้นอยู่กับช่วงเวลาของปี

1985-04-12T19:20:50.52 จะเป็น 20 นาที 50.52 วินาทีหลังจาก 19 ชั่วโมงของวันที่ 12 เมษายน 1985 โดยไม่มีข้อมูลออฟเซ็ต

ส่วนของวันที่/เวลาที่ไม่มีการชดเชยจะถือว่าเป็น "วันที่/เวลาท้องถิ่น" ซึ่งควรเป็นวันที่/เวลาท้องถิ่นที่สถานีปลายทาง ตัวอย่างเช่น หากกิจกรรมเกิดขึ้นในชั่วโมงที่ 20 ของวันที่ 5 มิถุนายน 2018 ที่สถานีปลายทาง ส่วนที่เป็นวันที่/เวลาท้องถิ่นควรเป็น 2018-06-05T20:00:00 หากวันที่/เวลาท้องถิ่นที่สถานีปลายทางคือ 4 ชั่วโมงก่อน UTC อาจมีการเพิ่มออฟเซ็ต -04:00

หากไม่มีข้อมูลออฟเซ็ต ฟีเจอร์สื่อสมบูรณ์บางอย่างอาจใช้งานไม่ได้

fareName

object (LocalizedString)

คำอธิบาย/ชื่อสั้นๆ ของค่าโดยสารสำหรับการเดินทางเที่ยวนี้ เช่น "Anytime Single Use"

carriage

string

ชื่อ/หมายเลขรถไฟหรือเรือที่ผู้โดยสารต้องขึ้นเครื่อง

platform

string

ชานชาลาหรือประตูที่ผู้โดยสารจะขึ้นตู้โดยสารได้

zone

string

โซนการขึ้นเครื่องภายในแพลตฟอร์ม

ticketSeat

object (TicketSeat)

ที่นั่งที่สงวนไว้สำหรับผู้โดยสาร หากต้องระบุใบอนุญาตมากกว่า 1 ที่ ให้ใช้ช่อง ticketSeats แทน ตั้งค่าทั้ง ticketSeat และ ticketSeats ไม่ได้

ticketSeats[]

object (TicketSeat)

ที่นั่งที่สงวนไว้สำหรับผู้โดยสาร หากมีการระบุที่นั่งเพียงที่เดียว ให้ใช้ช่อง ticketSeat แทน ตั้งค่าทั้ง ticketSeat และ ticketSeats ไม่ได้

transitOperatorName

object (LocalizedString)

ชื่อของผู้ให้บริการขนส่งสาธารณะที่ดำเนินการในการเดินทางครั้งนี้

transitTerminusName

object (LocalizedString)

สถานีปลายทางหรือปลายทางของรถไฟ/รถประจำทาง/ฯลฯ

TicketSeat

การแสดง JSON
{
  "fareClass": enum (FareClass),
  "customFareClass": {
    object (LocalizedString)
  },
  "coach": string,
  "seat": string,
  "seatAssignment": {
    object (LocalizedString)
  }
}
ช่อง
fareClass

enum (FareClass)

ชั้นโดยสารของที่นั่งที่ต้องใช้ตั๋ว

customFareClass

object (LocalizedString)

ระดับค่าโดยสารที่กำหนดเองที่จะใช้หากไม่มี fareClass ตั้งค่าทั้ง fareClass และ customFareClass ไม่ได้

coach

string

ตัวระบุตู้โดยสารหรือรถบัสที่มีที่นั่งซึ่งซื้อตั๋วไว้ เช่น "10"

seat

string

ตัวระบุตำแหน่งของที่นั่งที่ซื้อตั๋ว เช่น "42" หากไม่มีตัวระบุที่เจาะจง ให้ใช้ seatAssigment แทน

seatAssignment

object (LocalizedString)

การกำหนดที่นั่งของผู้โดยสาร เช่น "ไม่มีที่นั่งที่เจาะจง" ใช้เมื่อไม่มีตัวระบุที่เจาะจงให้ใช้ใน seat

FareClass

Enum
FARE_CLASS_UNSPECIFIED
ECONOMY
economy

ชื่อแทนเดิมสำหรับ ECONOMY เลิกใช้งานแล้ว

FIRST
first

ชื่อแทนเดิมสำหรับ FIRST เลิกใช้งานแล้ว

BUSINESS
business

ชื่อแทนเดิมสำหรับ BUSINESS เลิกใช้งานแล้ว

TripType

Enum
TRIP_TYPE_UNSPECIFIED
ROUND_TRIP
roundTrip

ชื่อแทนเดิมสำหรับ ROUND_TRIP เลิกใช้งานแล้ว

ONE_WAY
oneWay

ชื่อแทนเดิมสำหรับ ONE_WAY เลิกใช้งานแล้ว

ActivationStatus

สถานะการเปิดใช้งานของออบเจ็กต์ ช่องนี้จะมีสถานะการเปิดใช้งาน หากมีค่าเป็นการสนับสนุนการเปิดใช้งาน

การแสดง JSON
{
  "state": enum (State)
}
ช่อง
state

enum (State)

รัฐ

Enum
UNKNOWN_STATE
NOT_ACTIVATED ยังไม่ได้เปิดใช้งาน นี่คือสถานะเริ่มต้น
not_activated

ชื่อแทนเดิมสำหรับ NOT_ACTIVATED เลิกใช้งานแล้ว

ACTIVATED เปิดใช้งานแล้ว
activated

ชื่อแทนเดิมสำหรับ ACTIVATED เลิกใช้งานแล้ว

DeviceContext

บริบทอุปกรณ์ที่เชื่อมโยงกับออบเจ็กต์

การแสดง JSON
{
  "deviceToken": string
}
ช่อง
deviceToken

string

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

เมธอด

addmessage

เพิ่มข้อความไปยังออบเจ็กต์ขนส่งสาธารณะที่อ้างอิงโดยรหัสออบเจ็กต์ที่กำหนด

get

แสดงผลออบเจ็กต์ทรานซิชันที่มีรหัสออบเจ็กต์ที่ระบุ

insert

แทรกออบเจ็กต์ขนส่งสาธารณะที่มีรหัสและพร็อพเพอร์ตี้ที่กำหนด

list

แสดงผลรายการออบเจ็กต์การขนส่งทั้งหมดสำหรับรหัสผู้ออกคีย์ที่ระบุ

patch

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

update

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