REST Resource: transitclass

ทรัพยากร: TransitClass

การแสดง JSON 
{
  "transitOperatorName": {
    object (LocalizedString)
  },
  "logo": {
    object (Image)
  },
  "transitType": enum (TransitType),
  "watermark": {
    object (Image)
  },
  "languageOverride": string,
  "customTransitTerminusNameLabel": {
    object (LocalizedString)
  },
  "customTicketNumberLabel": {
    object (LocalizedString)
  },
  "customRouteRestrictionsLabel": {
    object (LocalizedString)
  },
  "customRouteRestrictionsDetailsLabel": {
    object (LocalizedString)
  },
  "customTimeRestrictionsLabel": {
    object (LocalizedString)
  },
  "customOtherRestrictionsLabel": {
    object (LocalizedString)
  },
  "customPurchaseReceiptNumberLabel": {
    object (LocalizedString)
  },
  "customConfirmationCodeLabel": {
    object (LocalizedString)
  },
  "customPurchaseFaceValueLabel": {
    object (LocalizedString)
  },
  "customPurchasePriceLabel": {
    object (LocalizedString)
  },
  "customDiscountMessageLabel": {
    object (LocalizedString)
  },
  "customCarriageLabel": {
    object (LocalizedString)
  },
  "customSeatLabel": {
    object (LocalizedString)
  },
  "customCoachLabel": {
    object (LocalizedString)
  },
  "customPlatformLabel": {
    object (LocalizedString)
  },
  "customZoneLabel": {
    object (LocalizedString)
  },
  "customFareClassLabel": {
    object (LocalizedString)
  },
  "customConcessionCategoryLabel": {
    object (LocalizedString)
  },
  "customFareNameLabel": {
    object (LocalizedString)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "enableSingleLegItinerary": boolean,
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "activationOptions": {
    object (ActivationOptions)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideLogo": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
ช่อง
transitOperatorName

object (LocalizedString)

ชื่อผู้ให้บริการขนส่งสาธารณะ
transitType

enum (TransitType)

ต้องระบุ ประเภทของการขนส่งสาธารณะประเภทนี้ เช่น "รถประจำทาง"
watermark

object (Image)

รูปภาพลายน้ำที่จะแสดงในอุปกรณ์ของผู้ใช้
languageOverride

string

หากมีช่องนี้ ตั๋วโดยสารที่แสดงไปยังอุปกรณ์ของผู้ใช้จะแสดงเป็นภาษานี้เสมอ แสดงแท็กภาษา BCP 47 ค่าตัวอย่าง ได้แก่ "en-US", "en-GB", "de" หรือ "de-AT"
customTransitTerminusNameLabel

object (LocalizedString)

ป้ายกำกับที่กำหนดเองที่จะใช้กับค่าชื่อสถานีปลายทาง (transitObject.ticketLeg.transitTerminusName)
customTicketNumberLabel

object (LocalizedString)

ป้ายกำกับที่กำหนดเองที่จะใช้กับค่าหมายเลขตั๋ว (transitObject.ticketNumber)
customRouteRestrictionsLabel

object (LocalizedString)

ป้ายกํากับที่กําหนดเองเพื่อใช้กับค่าข้อจํากัดด้านเส้นทาง (transitObject.ticketRestrictions.routeRestrictions)
customRouteRestrictionsDetailsLabel

object (LocalizedString)

ป้ายกำกับที่กำหนดเองที่ใช้สำหรับค่ารายละเอียดของข้อจำกัดเส้นทาง (transitObject.ticketRestrictions.routeRestrictionsDetails)
customTimeRestrictionsLabel

object (LocalizedString)

ป้ายกํากับที่กําหนดเองสําหรับค่ารายละเอียดข้อจํากัดด้านเวลา (transitObject.ticketRestrictions.timeRestrictions)
customOtherRestrictionsLabel

object (LocalizedString)

ป้ายกำกับที่กำหนดเองที่จะใช้กับค่าข้อจำกัดอื่นๆ (transitObject.ticketRestrictions.otherRestrictions)
customPurchaseReceiptNumberLabel

object (LocalizedString)

ป้ายกำกับที่กำหนดเองที่จะใช้กับค่าของหมายเลขใบเสร็จการซื้อ (transitObject.purchaseDetails.purchaseReceiptNumber)
customConfirmationCodeLabel

object (LocalizedString)

ป้ายกำกับที่กำหนดเองที่ใช้สำหรับค่ารหัสยืนยัน (transitObject.purchaseDetails.confirmationCode)
customPurchaseFaceValueLabel

object (LocalizedString)

ป้ายกํากับที่กําหนดเองเพื่อใช้กับราคาซื้อหน้าตั๋ว (transitObject.purchaseDetails.ticketCost.faceValue)
customPurchasePriceLabel

object (LocalizedString)

ป้ายกำกับที่กำหนดเองที่ใช้สำหรับค่าราคาซื้อ (transitObject.purchaseDetails.ticketCost.purchasePrice)
customDiscountMessageLabel

object (LocalizedString)

ป้ายกำกับที่กำหนดเองเพื่อใช้กับค่าข้อความส่วนลดสำหรับขนส่งสาธารณะ (transitObject.purchaseDetails.ticketCost.discountMessage)
customCarriageLabel

object (LocalizedString)

ป้ายกํากับที่กําหนดเองเพื่อใช้กับค่าการนําส่ง (transitObject.ticketLeg.carriage)
customSeatLabel

object (LocalizedString)

ป้ายกำกับที่กำหนดเองที่จะใช้กับค่าตำแหน่งที่นั่ง (transitObject.ticketLeg.ticketSeat.seat)
customCoachLabel

object (LocalizedString)

ป้ายกำกับที่กำหนดเองที่จะใช้กับค่าโค้ช (transitObject.ticketLeg.ticketSeat.coach)
customPlatformLabel

object (LocalizedString)

ป้ายกำกับที่กำหนดเองที่จะใช้กับค่าของแพลตฟอร์มบอร์ดดิ้ง (transitObject.ticketLeg.platform)
customZoneLabel

object (LocalizedString)

ป้ายกำกับที่กำหนดเองเพื่อใช้กับค่าโซนขึ้นเครื่อง (transitObject.ticketLeg.zone)
customFareClassLabel

object (LocalizedString)

ป้ายกำกับที่กำหนดเองเพื่อใช้กับค่าชั้นโดยสาร (transitObject.ticketLeg.ticketSeat.fareClass)
customConcessionCategoryLabel

object (LocalizedString)

ป้ายกํากับที่กําหนดเองเพื่อใช้กับค่าหมวดหมู่ส่วนลดค่าโดยสาร (transitObject.concessionCategory)
customFareNameLabel

object (LocalizedString)

ป้ายกำกับที่กำหนดเองที่จะใช้กับค่าชื่อค่าโดยสารสำหรับขนส่งสาธารณะ (transitObject.ticketLeg.fareName)
classTemplateInfo

object (ClassTemplateInfo)

ข้อมูลเทมเพลตเกี่ยวกับวิธีการแสดงชั้นเรียน หากไม่ได้ตั้งค่า Google จะสำรองชุดฟิลด์เริ่มต้นที่จะแสดง
enableSingleLegItinerary

boolean

ควบคุมการแสดงแผนการเดินทางเที่ยวเดียวสำหรับชั้นเรียนนี้ โดยค่าเริ่มต้น แผนการเดินทางจะแสดงเฉพาะสำหรับการเดินทางหลายเที่ยว
id

string

ต้องระบุ ตัวระบุที่ไม่ซ้ำกันสำหรับชั้นเรียน รหัสนี้ต้องไม่ซ้ำกันในทุกคลาสจากผู้ออกบัตร ค่านี้ควรเป็นไปตามรูปแบบ issuer IDidentifierที่บัญชีแรกออกโดย Google และคุณเป็นผู้เลือกรายการหลัง ตัวระบุที่ไม่ซ้ำกันควรประกอบด้วยอักขระที่เป็นตัวอักษรและตัวเลขคละกัน, '.', '_' หรือ "-" เท่านั้น
version
(deprecated)

string (int64 format)

เลิกใช้
issuerName

string

ต้องระบุ ชื่อผู้ออกบัตร ความยาวสูงสุดที่แนะนำคือ 20 อักขระเพื่อให้แสดงสตริงทั้งหมดในหน้าจอขนาดเล็ก
messages[]

object (Message)

อาร์เรย์ของข้อความที่แสดงในแอป ผู้ใช้ทั้งหมดของออบเจ็กต์นี้จะได้รับข้อความที่เกี่ยวข้อง จำนวนช่องสูงสุดคือ 10 ช่อง
allowMultipleUsersPerObject
(deprecated)

boolean

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

object (Uri)

URI หน้าแรกของแอปพลิเคชัน การป้อนข้อมูล URI ในช่องนี้จะทําให้มีลักษณะการทำงานเหมือนกับการป้อนข้อมูล URI ใน linksModuleData (เมื่อแสดงผลออบเจ็กต์ ลิงก์ไปยังหน้าแรกจะแสดงในส่วนที่มักเรียกว่าส่วน linksModuleData ของออบเจ็กต์)
locations[]
(deprecated)

object (LatLongPoint)

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

enum (ReviewStatus)

ต้องระบุ สถานะของชั้นเรียน ช่องนี้สามารถตั้งค่าเป็น draft หรือ underReview โดยใช้การแทรก แพตช์ หรืออัปเดตการเรียก API เมื่อเปลี่ยนสถานะการตรวจสอบจาก draft แล้วจะเปลี่ยนกลับไปเป็น draft ไม่ได้

คุณควรเก็บฟิลด์นี้ไว้ใน draft เมื่อชั้นเรียนอยู่ระหว่างการพัฒนา ใช้คลาส draft เพื่อสร้างออบเจ็กต์ใดๆ ไม่ได้

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

เมื่ออัปเดตคลาส approved อยู่แล้ว คุณควรตั้งค่าช่องนี้เป็น underReview ต่อไป
review

object (Review)

ความคิดเห็นรีวิวที่แพลตฟอร์มตั้งค่าไว้เมื่อมีการทําเครื่องหมายชั้นเรียนเป็น approved หรือ rejected
infoModuleData
(deprecated)

object (InfoModuleData)

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

object (ImageModuleData)

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

object (TextModuleData)

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

string (int64 format)

ระบุว่าผู้ออกการแลกสิทธิ์รายใดแลกรับบัตรผ่านการแตะอัจฉริยะได้ ระบบจะระบุผู้ออกบัตรแลกสิทธิ์ด้วยรหัสผู้ออกบัตร ผู้ออกการแลกสิทธิ์ต้องกำหนดค่าคีย์การแตะอัจฉริยะอย่างน้อย 1 รายการ

ต้องตั้งค่าช่อง enableSmartTap และระดับวัตถุ smartTapRedemptionLevel ให้ถูกต้องเพื่อให้บัตรรองรับการแตะอัจฉริยะ
countryCode

string

รหัสประเทศที่ใช้เพื่อแสดงประเทศของการ์ด (เมื่อผู้ใช้ไม่ได้อยู่ในประเทศนั้น) รวมถึงเพื่อแสดงเนื้อหาที่แปลเป็นภาษาท้องถิ่นเมื่อเนื้อหาไม่พร้อมใช้งานในภาษาของผู้ใช้
heroImage

object (Image)

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

object (Image)

เลิกใช้งานแล้ว
enableSmartTap

boolean

ระบุว่าคลาสนี้รองรับการแตะอัจฉริยะหรือไม่ นอกจากนี้ คุณต้องตั้งค่าช่อง redemptionIssuers และsmartTapRedemptionLevel ระดับออบเจ็กต์อย่างถูกต้องเพื่อให้บัตรรองรับการแตะอัจฉริยะ
hexBackgroundColor

string

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

object (LocalizedString)

สตริงที่แปลแล้วสำหรับ issuerName ความยาวสูงสุดที่แนะนำคือ 20 อักขระเพื่อให้แสดงสตริงทั้งหมดในหน้าจอขนาดเล็ก
multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

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

object (CallbackOptions)

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

object (SecurityAnimation)

ข้อมูลที่ไม่บังคับเกี่ยวกับภาพเคลื่อนไหวด้านความปลอดภัย หากตั้งค่าไว้ ภาพเคลื่อนไหวเพื่อความปลอดภัยจะแสดงในรายละเอียดบัตร
activationOptions

object (ActivationOptions)

ตัวเลือกการเปิดใช้งานสำหรับตั๋วที่เปิดใช้งานได้
viewUnlockRequirement

enum (ViewUnlockRequirement)

ดูตัวเลือกข้อกำหนดในการปลดล็อกสำหรับตั๋วโดยสาร
notifyPreference

enum (NotificationSettingsForUpdates)

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

object (ValueAddedModuleData)

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

TransitType

Enum
TRANSIT_TYPE_UNSPECIFIED
BUS
bus

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

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

ชื่อแทนเดิมของ TRAM เลิกใช้งานแล้ว
FERRY
ferry

ชื่อแทนเดิมของ FERRY เลิกใช้งานแล้ว
OTHER
other

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

ActivationOptions

ตัวเลือกการเปิดใช้งานสำหรับชั้นเรียน

การแสดง JSON 
{
  "activationUrl": string,
  "allowReactivation": boolean
}
ช่อง
activationUrl

string

HTTPS URL ที่รองรับเซмантиกของ REST จะใช้เพื่อขอเปิดใช้งานจากพาร์ทเนอร์สำหรับเนื้อหาที่มีคุณค่าซึ่งทริกเกอร์โดยผู้ใช้
allowReactivation

boolean

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

เมธอด

addmessage

 เพิ่มข้อความไปยังชั้นโดยสารที่อ้างอิงตามรหัสคลาสที่ระบุ

get

 แสดงผลชั้นยานพาหนะที่มีรหัสชั้นที่ระบุ

insert

 แทรกชั้นโดยสารที่มีรหัสและพร็อพเพอร์ตี้ที่ระบุ

list

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

patch

 อัปเดตคลาสขนส่งสาธารณะที่อ้างอิงตามรหัสคลาสที่ระบุ

update

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