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)
  }
}
ช่อง
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 ใน linkedModuleData (เมื่อแสดงผลออบเจ็กต์ ลิงก์ไปยังหน้าแรกจะแสดงในสิ่งที่มักเรียกว่าส่วน linkModuleData ของออบเจ็กต์)
locations[]

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)

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

string (int64 format)

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

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

string

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

object (Image)

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

object (Image)

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

boolean

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

string

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

object (LocalizedString)

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

enum (MultipleDevicesAndHoldersAllowedStatus)

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

object (CallbackOptions)

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

object (SecurityAnimation)

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

object (ActivationOptions)

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

enum (ViewUnlockRequirement)

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

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

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

วิธีการ

addmessage

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

get

 แสดงผลคลาสขนส่งสาธารณะที่มีรหัสคลาสที่ระบุ

insert

 แทรกคลาสการขนส่งที่มีรหัสและพร็อพเพอร์ตี้ที่ระบุ

list

 แสดงรายการชั้นโดยสารทั้งหมดสำหรับรหัสผู้ออกบัตรที่ระบุ

patch

 อัปเดตชั้นโดยสารที่อ้างอิงถึงรหัสคลาสที่ระบุ

update

 อัปเดตชั้นโดยสารที่อ้างอิงถึงรหัสคลาสที่ระบุ