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)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
ช่อง
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 คือไตรต์ RGB แบบฐาน 16 เช่น #ffcc00 นอกจากนี้ คุณยังใช้รูปแบบย่อของชุดค่า 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[]
(deprecated)

object (LatLongPoint)

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

hasUsers

boolean

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

smartTapRedemptionValue

string

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

hasLinkedDevice

boolean

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

disableExpirationNotification

boolean

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

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

infoModuleData

object (InfoModuleData)

เลิกใช้งานแล้ว ให้ใช้ textModulesData แทน

imageModulesData[]

object (ImageModuleData)

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

textModulesData[]

object (TextModuleData)

ข้อมูลโมดูลข้อความ หากมีการกําหนดข้อมูลโมดูลข้อความในชั้นเรียนด้วย ระบบจะแสดงทั้ง 2 รายการ จำนวนสูงสุดของช่องเหล่านี้ที่แสดงคือ 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)

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

linkedObjectIds[]

string

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

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

รหัสออบเจ็กต์ควรเป็นไปตามรูปแบบ issuer IDidentifier โดยที่รหัสแรกจะออกโดย Google และรหัสหลังจะเลือกโดยคุณ

notifyPreference

enum (NotificationSettingsForUpdates)

การตั้งค่าว่าควรมีการแจ้งเตือนเมื่อมีการอัปเดตช่องในออบเจ็กต์นี้หรือไม่ เมื่อตั้งค่าเป็น "แจ้งเตือน" เราจะพยายามเรียกให้ระบบแจ้งเตือนการอัปเดตช่องแก่ผู้ใช้ ระบบจะส่งการแจ้งเตือนเหล่านี้ไปยังผู้ใช้ก็ต่อเมื่อช่องเป็นส่วนหนึ่งของรายการที่อนุญาตเท่านั้น หากตั้งค่าเป็น DO_NOT_NOTIFY หรือ NOTIFICATION_SETTINGS_UNSPECIFIED ระบบจะไม่ทริกเกอร์การแจ้งเตือน การตั้งค่านี้มีอายุไม่นานและจะต้องตั้งค่าพร้อมกับคําขอ PATCH หรือ UPDATE แต่ละรายการ มิฉะนั้นการแจ้งเตือนจะไม่ทริกเกอร์

valueAddedModuleData[]

object (ValueAddedModuleData)

ข้อมูลข้อบังคับมูลค่าเพิ่ม (ไม่บังคับ) สูงสุด 10 รายการบนวัตถุ

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)

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

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 โดยมีหรือไม่มีออฟเซ็ต คุณสามารถระบุเวลาได้สูงสุด 1 นนาโนวินาที คุณสามารถระบุออฟเซ็ตด้วยความแม่นยำเป็นวินาทีได้ (แม้ว่าออฟเซ็ตแบบวินาทีจะไม่เป็นส่วนหนึ่งของ ISO 8601)

เช่น

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

1985-04-12T19:20:50.52-04:00 จะเท่ากับ 20 นาที 50.52 วินาทีหลังจากเวลา 19:00 น. ของวันที่ 12 เมษายน 1985 ซึ่งช้ากว่า UTC 4 ชั่วโมง (ช่วงเวลาเดียวกันกับตัวอย่างข้างต้น) หากกิจกรรมจัดขึ้นที่นิวยอร์ก เขตเวลานี้จะเทียบเท่ากับเวลาออมแสงตะวันออก (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 โดยมีหรือไม่มีออฟเซ็ต คุณสามารถระบุเวลาได้สูงสุด 1 นนาโนวินาที คุณสามารถระบุออฟเซ็ตด้วยความแม่นยำเป็นวินาทีได้ (แม้ว่าออฟเซ็ตแบบวินาทีจะไม่เป็นส่วนหนึ่งของ ISO 8601)

เช่น

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

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

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

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

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

arrivalDateTime

string

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

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

เช่น

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

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

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

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

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

fareName

object (LocalizedString)

คำอธิบาย/ชื่อสั้นๆ ของค่าโดยสารสำหรับการเดินทางขานี้ เช่น "ใช้ได้ทุกเมื่อแบบครั้งเดียว"

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)

การกำหนดที่นั่งของผู้โดยสาร เช่น "no specific seat" ใช้ในกรณีที่ไม่มีตัวระบุที่เฉพาะเจาะจงที่จะใช้ใน 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

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