REST Resource: transitclass

संसाधन: TransitClass

जेएसओएन के काेड में दिखाना
{
  "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 ID फ़ॉर्मैट के हिसाब से होनी चाहिए.identifier को वहां जारी किया जाता है, जहां Google ने पहली वाली सेवा जारी की है और बाद वाले वर्शन को आपने चुना है. आपके यूनीक आइडेंटिफ़ायर में सिर्फ़ अक्षर और अंक, '.', '_' या '-' शामिल होने चाहिए.

version
(deprecated)

string (int64 format)

बहिष्कृत

issuerName

string

ज़रूरी है. जारी करने वाले का नाम. छोटी स्क्रीन पर पूरी स्ट्रिंग दिखाने के लिए, ज़्यादा से ज़्यादा 20 वर्णों का सुझाव दिया जाता है.

messages[]

object (Message)

ऐप्लिकेशन में दिखाए गए मैसेज का कलेक्शन. इस ऑब्जेक्ट के सभी उपयोगकर्ताओं को इससे जुड़े मैसेज मिलेंगे. इन फ़ील्ड की ज़्यादा से ज़्यादा संख्या 10 है.

allowMultipleUsersPerObject
(deprecated)

boolean

समर्थन नहीं होना या रुकना. इसके बजाय, multipleDevicesAndHoldersAllowedStatus का इस्तेमाल करें.

homepageUri

object (Uri)

आपके ऐप्लिकेशन के होम पेज का यूआरआई. इस फ़ील्ड में यूआरआई को भरने का नतीजा ठीक उसी तरह काम करने वाला होता है जैसा लिंक मॉड्यूलडेटा में यूआरआई को भरने के लिए होता है (जब कोई ऑब्जेक्ट रेंडर होता है, तो होम पेज का लिंक वही दिखता है जिसे आम तौर पर ऑब्जेक्ट के लिंक मॉड्यूलडेटा सेक्शन के तौर पर माना जाता है).

locations[]

object (LatLongPoint)

ध्यान दें: फ़िलहाल, यह फ़ील्ड भौगोलिक सूचनाएं ट्रिगर करने के लिए काम नहीं करता.

reviewStatus

enum (ReviewStatus)

ज़रूरी है. क्लास का स्टेटस. इंसर्ट, पैच या अपडेट एपीआई कॉल का इस्तेमाल करके इस फ़ील्ड को draft या underReview पर सेट किया जा सकता है. समीक्षा की स्थिति draft से बदलने के बाद, शायद इसे वापस draft में न बदला जा सके.

जब क्लास डेवलपमेंट चल रही हो, तब आपको इस फ़ील्ड को draft पर रखना चाहिए. किसी भी ऑब्जेक्ट को बनाने के लिए, draft क्लास का इस्तेमाल नहीं किया जा सकता.

अगर आपको लगता है कि क्लास इस्तेमाल के लिए तैयार है, तो आपको इस फ़ील्ड को underReview पर सेट करना चाहिए. प्लैटफ़ॉर्म, इस फ़ील्ड को अपने-आप approved पर सेट कर देगा. साथ ही, ऑब्जेक्ट बनाने या माइग्रेट करने के लिए, इसका इस्तेमाल तुरंत किया जा सकता है.

पहले से मौजूद approved क्लास को अपडेट करते समय, आपको इस फ़ील्ड को underReview पर सेट करना चाहिए.

review

object (Review)

किसी क्लास को approved या rejected के तौर पर मार्क किए जाने पर, प्लैटफ़ॉर्म से समीक्षा के लिए की गई टिप्पणियां सेट की जाती हैं.

infoModuleData
(deprecated)

object (InfoModuleData)

समर्थन नहीं होना या रुकना. इसके बजाय, textModulesData का इस्तेमाल करें.

imageModulesData[]

object (ImageModuleData)

इमेज मॉड्यूल का डेटा. इनमें से ज़्यादा से ज़्यादा फ़ील्ड, ऑब्जेक्ट लेवल के लिए एक और क्लास के ऑब्जेक्ट लेवल के लिए एक-एक फ़ील्ड दिखाए जा सकते हैं.

textModulesData[]

object (TextModuleData)

टेक्स्ट मॉड्यूल डेटा. अगर क्लास पर टेक्स्ट मॉड्यूल का डेटा भी तय किया गया है, तो दोनों दिखाए जाएंगे. आप ऑब्जेक्ट से 10 फ़ील्ड और क्लास से 10 फ़ील्ड ज़्यादा से ज़्यादा दिखा सकते हैं.

redemptionIssuers[]

string (int64 format)

इससे यह पता चलता है कि ऑफ़र रिडीम करने वाले कौनसे बैंक, स्मार्ट टैप पर पास को रिडीम कर सकते हैं. रिडेंप्शन जारी करने वालों की पहचान, उनके जारी करने वाले आईडी से की जाती है. रिडेंप्शन जारी करने वालों के पास, कम से कम एक स्मार्ट टैप बटन कॉन्फ़िगर होना चाहिए.

enableSmartTap और ऑब्जेक्ट लेवल smartTapRedemptionLevel फ़ील्ड भी सही तरीके से सेट अप होने चाहिए, ताकि स्मार्ट टैप की सुविधा के साथ काम करने वाला पास काम कर सके.

countryCode

string

देश का कोड यह दिखाने के लिए इस्तेमाल किया जाता है कि कार्ड किस देश में है (जब उपयोगकर्ता उस देश में न हो). साथ ही, उपयोगकर्ता की स्थान-भाषा में कॉन्टेंट उपलब्ध न होने पर, स्थानीय भाषा में बनाया गया कॉन्टेंट दिखाने के लिए भी देश का कोड इस्तेमाल किया जाता है.

heroImage

object (Image)

कार्ड के सामने बैनर इमेज का इस्तेमाल करना ज़रूरी नहीं है. अगर कोई भी मौजूद नहीं है, तो कुछ भी नहीं दिखाया जाएगा. इमेज 100% चौड़ाई में दिखेगी.

wordMark
(deprecated)

object (Image)

समर्थन नहीं होना या रुकना.

enableSmartTap

boolean

यह पता लगाता है कि इस क्लास में स्मार्ट टैप की सुविधा काम करती है या नहीं. redemptionIssuers और ऑब्जेक्ट लेवल smartTapRedemptionLevel फ़ील्ड भी सही तरीके से सेट अप होने चाहिए, ताकि स्मार्ट टैप की सुविधा के साथ काम करने वाला पास काम कर सके.

hexBackgroundColor

string

कार्ड के बैकग्राउंड का रंग. अगर हीरो इमेज के मुख्य रंग को सेट नहीं किया गया है और कोई हीरो इमेज सेट नहीं की गई है, तो लोगो के लिए मुख्य रंग का इस्तेमाल किया गया है. इसका फ़ॉर्मैट #rrggbb है, जहां rrggbb एक हेक्स आरजीबी ट्रिपलेट होता है, जैसे कि #ffcc00. आरजीबी ट्रिपलेट के शॉर्टहैंड वर्शन का भी इस्तेमाल किया जा सकता है, जो #rgb है, जैसे कि #fc0.

localizedIssuerName

object (LocalizedString)

providerName के लिए अनुवाद की गई स्ट्रिंग. छोटी स्क्रीन पर पूरी स्ट्रिंग दिखाने के लिए, ज़्यादा से ज़्यादा 20 वर्णों का सुझाव दिया जाता है.

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

यह पता लगाता है कि कई उपयोगकर्ता और डिवाइस, इस क्लास से जुड़े ऑब्जेक्ट को सेव करेंगे या नहीं.

callbackOptions

object (CallbackOptions)

कॉलबैक के विकल्पों का इस्तेमाल, ताकि असली उपयोगकर्ता इस क्लास के लिए किसी ऑब्जेक्ट को हर बार सेव करने/मिटाने पर, जारी करने वाले को कॉल कर सकें. इस क्लास के सभी ऑब्जेक्ट, कॉलबैक की ज़रूरी शर्तें पूरी करते हैं.

securityAnimation

object (SecurityAnimation)

सुरक्षा ऐनिमेशन के बारे में वैकल्पिक जानकारी. अगर इसे सेट किया जाता है, तो पास की जानकारी में सुरक्षा से जुड़ा ऐनिमेशन दिखाया जाएगा.

activationOptions

object (ActivationOptions)

चालू किए जा सकने वाले टिकट को चालू करने के विकल्प.

viewUnlockRequirement

enum (ViewUnlockRequirement)

बस, मेट्रो वगैरह के टिकट के लिए अनलॉक करने की ज़रूरत के विकल्प देखें.

TransitType

Enums
TRANSIT_TYPE_UNSPECIFIED
BUS
bus

BUS के लिए लेगसी उपनाम. समर्थन नहीं होना या रुकना.

RAIL
rail

RAIL के लिए लेगसी उपनाम. समर्थन नहीं होना या रुकना.

TRAM
tram

TRAM के लिए लेगसी उपनाम. समर्थन नहीं होना या रुकना.

FERRY
ferry

FERRY के लिए लेगसी उपनाम. समर्थन नहीं होना या रुकना.

OTHER
other

OTHER के लिए लेगसी उपनाम. समर्थन नहीं होना या रुकना.

ActivationOptions

वर्ग के लिए ऐक्टिवेशनOptions

जेएसओएन के काेड में दिखाना
{
  "activationUrl": string,
  "allowReactivation": boolean
}
फ़ील्ड
activationUrl

string

एचटीटीपीएस यूआरएल, जो REST सिमैंटिक के साथ काम करता है. इसका इस्तेमाल, उपयोगकर्ताओं से ट्रिगर किए गए किसी अहम कॉन्टेंट को चालू करने के लिए, पार्टनर से अनुरोध करने के लिए किया जाएगा.

allowReactivation

boolean

उपयोगकर्ताओं को किसी दूसरे डिवाइस से ऐक्टिवेशन कॉल करने की अनुमति देने के लिए फ़्लैग करें. इससे, चालू किए गए डिवाइस पर ऐक्टिवेशन बटन चालू होने पर भी क्लाइंट को उसे रेंडर करने की सुविधा मिलती है. ऐसा तब भी किया जा सकता है, जब चालू किया गया डिवाइस चालू हो, लेकिन अनुरोध किया गया डिवाइस, मौजूदा डिवाइस से अलग हो.

तरीके

addmessage

दिए गए क्लास आईडी से रेफ़र किए गए ट्रांज़िट क्लास में एक मैसेज जोड़ता है.

get

दिए गए क्लास आईडी वाली ट्रांज़िट क्लास की जानकारी देता है.

insert

दिए गए आईडी और प्रॉपर्टी के साथ ट्रांज़िट क्लास डालता है.

list

यह फ़ंक्शन किसी जारी करने वाले आईडी के लिए, सभी ट्रांज़िट क्लास की सूची दिखाता है.

patch

दिए गए क्लास आईडी से जुड़ी ट्रांज़िट क्लास को अपडेट करता है.

update

दिए गए क्लास आईडी से जुड़ी ट्रांज़िट क्लास को अपडेट करता है.