REST Resource: genericobject

रिसॉर्स: GenericObject

सामान्य ऑब्जेक्ट

JSON के काेड में दिखाना
{
  "genericType": enum (GenericType),
  "cardTitle": {
    object (LocalizedString)
  },
  "subheader": {
    object (LocalizedString)
  },
  "header": {
    object (LocalizedString)
  },
  "logo": {
    object (Image)
  },
  "hexBackgroundColor": string,
  "notifications": {
    object (Notifications)
  },
  "id": string,
  "classId": string,
  "barcode": {
    object (Barcode)
  },
  "heroImage": {
    object (Image)
  },
  "validTimeInterval": {
    object (TimeInterval)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "smartTapRedemptionValue": string,
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "state": enum (State),
  "hasUsers": boolean,
  "messages": [
    {
      object (Message)
    }
  ],
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ],
  "linkedObjectIds": [
    string
  ]
}
फ़ील्ड
genericType

enum (GenericType)

बताएं कि कार्ड किस GenericType से जुड़ा है.

cardTitle

object (LocalizedString)

ज़रूरी है. पास का हेडर. आम तौर पर, यह कारोबार का नाम होता है, जैसे कि "XXX Gym", "AAA Insurance". यह फ़ील्ड ज़रूरी है और यह पास के सबसे ऊपर हेडर लाइन में दिखता है.

subheader

object (LocalizedString)

पास का टाइटल लेबल. जैसे, वह जगह जहां इस पास का इस्तेमाल किया जा सकता है. पास की ज़्यादा जानकारी वाले व्यू में, टाइटल लाइन में टाइटल के ठीक ऊपर दिखता है.

header

object (LocalizedString)

ज़रूरी है. पास का टाइटल, जैसे कि "50% की छूट वाला कूपन" या "लाइब्रेरी कार्ड" या "वाउचर". यह फ़ील्ड भरना ज़रूरी है. यह पास की ज़्यादा जानकारी वाले व्यू की टाइटल लाइन में दिखता है.

hexBackgroundColor

string

कार्ड के बैकग्राउंड का रंग. अगर यह सेट नहीं किया गया है, तो हीरो इमेज के मुख्य रंग का इस्तेमाल किया जाता है. अगर कोई हीरो इमेज सेट नहीं की गई है, तो लोगो के मुख्य रंग का इस्तेमाल किया जाता है. अगर लोगो सेट नहीं किया गया है, तो Google कोई रंग चुन लेगा.

notifications

object (Notifications)

इस ऑब्जेक्ट के लिए सूचना की सेटिंग, जो चालू हैं.

id

string

ज़रूरी है. किसी ऑब्जेक्ट का यूनीक आइडेंटिफ़ायर. यह आईडी, जारी करने वाले के सभी ऑब्जेक्ट के लिए यूनीक होना चाहिए. यह वैल्यू, issuerID.identifier फ़ॉर्मैट में होनी चाहिए. इसमें issuerID को Google जारी करता है और identifier को आप चुनते हैं. यूनीक आइडेंटिफ़ायर में सिर्फ़ अक्षर, अंक, ., _ या - शामिल किए जा सकते हैं.

classId

string

ज़रूरी है. इस ऑब्जेक्ट से जुड़ी क्लास. क्लास, इस ऑब्जेक्ट के टाइप की ही होनी चाहिए. साथ ही, यह पहले से मौजूद होनी चाहिए और इसकी मंज़ूरी होनी चाहिए.

क्लास आईडी, issuerID.identifier फ़ॉर्मैट में होने चाहिए. इसमें issuerID को Google जारी करता है और identifier को आप चुनते हैं.

barcode

object (Barcode)

बारकोड का टाइप और वैल्यू. अगर पास में बारकोड नहीं है, तो हम पास जारी करने वाले को Barcode.alternate_text सेट करने और सिर्फ़ उसे दिखाने की अनुमति दे सकते हैं.

heroImage

object (Image)

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

validTimeInterval

object (TimeInterval)

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

imageModulesData[]

object (ImageModuleData)

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

textModulesData[]

object (TextModuleData)

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

groupingInfo

object (GroupingInfo)

इस जानकारी से यह कंट्रोल होता है कि पास को एक साथ कैसे ग्रुप किया जाए.

smartTapRedemptionValue

string

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

rotatingBarcode

object (RotatingBarcode)

बारकोड की सेटिंग/जानकारी, जो घूमती रहती है.

state

enum (State)

ऑब्जेक्ट की स्थिति. इस फ़ील्ड का इस्तेमाल यह तय करने के लिए किया जाता है कि ऐप्लिकेशन में कोई ऑब्जेक्ट कैसे दिखेगा. उदाहरण के लिए, inactive ऑब्जेक्ट को "समयसीमा खत्म हो चुके पास" सेक्शन में ले जाया जाता है. अगर यह नहीं दिया गया है, तो ऑब्जेक्ट को ACTIVE माना जाएगा.

hasUsers

boolean

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

messages[]

object (Message)

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

passConstraints

object (PassConstraints)

ऑब्जेक्ट के लिए पाबंदियां पास करें. इसमें एनएफ़सी और स्क्रीनशॉट की सुविधा को सीमित करना भी शामिल है.

saveRestrictions

object (SaveRestrictions)

पासवर्ड सेव करने से पहले, उस ऑब्जेक्ट की पाबंदियों की पुष्टि करना ज़रूरी है. ध्यान दें कि यह पाबंदी सिर्फ़ सेव करने के समय लागू होगी. अगर उपयोगकर्ता ने पासवर्ड सेव करने के बाद पाबंदियों में बदलाव किया है, तो नई पाबंदियां पहले से सेव किए गए पासवर्ड पर लागू नहीं होंगी.

valueAddedModuleData[]

object (ValueAddedModuleData)

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

linkedObjectIds[]

string

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

पक्का करें कि linkedObjectIds में मौजूद ऑब्जेक्ट पहले से ही डाले गए हों. ऐसा न होने पर, कॉल पूरा नहीं हो पाएगा. लिंक करने के बाद, लिंक किए गए ऑब्जेक्ट को अनलिंक नहीं किया जा सकता. किसी दूसरे जारीकर्ता के ऑब्जेक्ट लिंक नहीं किए जा सकते. किसी एक ऑब्जेक्ट से लिंक किए जा सकने वाले ऑब्जेक्ट की संख्या सीमित होती है. सीमा पूरी होने के बाद, कॉल में लिंक किए गए नए ऑब्जेक्ट को अनदेखा कर दिया जाएगा.

ऑब्जेक्ट आईडी, issuer ID फ़ॉर्मैट में होने चाहिए.identifier, जहां पहला कोड Google जारी करता है और दूसरा कोड आप चुनते हैं.

GenericType

सामान्य कार्ड का टाइप.

Enums
GENERIC_TYPE_UNSPECIFIED जेनरिक टाइप की जानकारी नहीं है.
GENERIC_SEASON_PASS सीज़न पास
GENERIC_UTILITY_BILLS बिजली, पानी जैसी सुविधाओं के बिल
GENERIC_PARKING_PASS पार्किंग पास
GENERIC_VOUCHER वाउचर
GENERIC_GYM_MEMBERSHIP जिम की सदस्यता के कार्ड
GENERIC_LIBRARY_MEMBERSHIP लाइब्रेरी की सदस्यता के कार्ड
GENERIC_RESERVATIONS बुकिंग
GENERIC_AUTO_INSURANCE वाहन के बीमा के कार्ड
GENERIC_HOME_INSURANCE घर के बीमा के कार्ड
GENERIC_ENTRY_TICKET एंट्री टिकट
GENERIC_RECEIPT रसीदें
GENERIC_LOYALTY_CARD लॉयल्टी कार्ड. कृपया ध्यान दें कि इस सामान्य टाइप के बजाय, लॉयल्टी कार्ड पास के लिए खास टाइप का इस्तेमाल करना बेहतर होता है. लॉयल्टी कार्ड के लिए खास तौर पर बनाए गए पास टाइप में, सामान्य पास टाइप की तुलना में ज़्यादा सुविधाएं और फ़ंक्शन मिलते हैं.
GENERIC_OTHER अन्य टाइप

सूचनाएं

इससे पता चलता है कि ऑब्जेक्ट के लिए सूचनाएं चालू करनी हैं या नहीं. हम ExpiryNotification/UpcomingNotification में से सिर्फ़ एक का इस्तेमाल कर सकते हैं. expiryNotification को upcomingNotification से ज़्यादा प्राथमिकता दी जाती है. दूसरे शब्दों में, अगर expiryNotification सेट है, तो हम upcomingNotification फ़ील्ड को अनदेखा कर देते हैं.

JSON के काेड में दिखाना
{
  "expiryNotification": {
    object (ExpiryNotification)
  },
  "upcomingNotification": {
    object (UpcomingNotification)
  }
}
फ़ील्ड
expiryNotification

object (ExpiryNotification)

कार्ड की समयसीमा खत्म होने से पहले, आपको एक तय समय पर सूचना मिलेगी.

upcomingNotification

object (UpcomingNotification)

कार्ड इस्तेमाल करने से पहले, आपको एक तय समय पर सूचना मिलेगी.

ExpiryNotification

इससे पता चलता है कि कार्ड जारी करने वाली कंपनी चाहती है कि Google Wallet, कार्ड की समयसीमा खत्म होने से दो दिन पहले इसकी सूचनाएं भेजे.

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

boolean

इससे पता चलता है कि ऑब्जेक्ट के लिए, समयसीमा खत्म होने की सूचना चालू करनी है या नहीं.

UpcomingNotification

इससे पता चलता है कि कार्ड जारी करने वाली कंपनी चाहती है कि कार्ड मान्य होने/इस्तेमाल किए जाने से एक दिन पहले, Google Wallet कार्ड की समयसीमा खत्म होने की सूचना भेजे.

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

boolean

इससे पता चलता है कि ऑब्जेक्ट के लिए, आने वाली सूचना की सुविधा चालू होनी चाहिए या नहीं.

तरीके

addmessage

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

get

दिए गए ऑब्जेक्ट आईडी के साथ सामान्य ऑब्जेक्ट दिखाता है.

insert

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

list

किसी दिए गए जारीकर्ता आईडी के लिए, सभी सामान्य ऑब्जेक्ट की सूची दिखाता है.

patch

दिए गए ऑब्जेक्ट आईडी से रेफ़र किए गए सामान्य ऑब्जेक्ट को अपडेट करता है.

update

दिए गए ऑब्जेक्ट आईडी से रेफ़र किए गए सामान्य ऑब्जेक्ट को अपडेट करता है.