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

version
(deprecated)

string (int64 format)

बहिष्कृत

issuerName

string

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

messages[]

object (Message)

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

allowMultipleUsersPerObject
(deprecated)

boolean

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

homepageUri

object (Uri)

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

locations[]
(deprecated)

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 एक हेक्स RGB ट्रिपलेट है, जैसे कि #ffcc00. आरजीबी ट्रिपलेट के शॉर्टहैंड वर्शन का भी इस्तेमाल किया जा सकता है. जैसे, #rgb, #fc0.

localizedIssuerName

object (LocalizedString)

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

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

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

callbackOptions

object (CallbackOptions)

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

securityAnimation

object (SecurityAnimation)

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

activationOptions

object (ActivationOptions)

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

viewUnlockRequirement

enum (ViewUnlockRequirement)

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

notifyPreference

enum (NotificationSettingsForUpdates)

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

valueAddedModuleData[]

object (ValueAddedModuleData)

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

TransitType

Enums
TRANSIT_TYPE_UNSPECIFIED
BUS
bus

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

RAIL
rail

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

TRAM
tram

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

FERRY
ferry

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

OTHER
other

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

ActivationOptions

क्लास के लिए ActivationOptions

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

string

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

allowReactivation

boolean

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

तरीके

addmessage

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

get

दिए गए क्लास आईडी के साथ बस, मेट्रो वगैरह की क्लास दिखाता है.

insert

दिए गए आईडी और प्रॉपर्टी के साथ, बस, मेट्रो वगैरह की कैटगरी डालता है.

list

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

patch

दिए गए क्लास आईडी से रेफ़र की गई बस, मेट्रो वगैरह की क्लास को अपडेट करता है.

update

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