संसाधन: OfferObject
JSON के काेड में दिखाना |
---|
{ "kind": string, "classReference": { object ( |
फ़ील्ड | |
---|---|
kind |
यह बताता है कि यह किस तरह का संसाधन है. वैल्यू: तय की गई स्ट्रिंग |
classReference |
पैरंट क्लास के इनहेरिट किए गए फ़ील्ड की कॉपी. ये फ़ील्ड, GET के दौरान वापस लाए जाते हैं. |
id |
ज़रूरी है. किसी ऑब्जेक्ट का यूनीक आइडेंटिफ़ायर. यह आईडी, जारी करने वाले के सभी ऑब्जेक्ट के लिए यूनीक होना चाहिए. यह वैल्यू issuer ID फ़ॉर्मैट में होनी चाहिए.identifier, जहां पहला कोड Google जारी करता है और दूसरा कोड आप चुनते हैं. यूनीक आइडेंटिफ़ायर में सिर्फ़ अक्षर, अंक, '.', '_' या '-' होने चाहिए. |
classId |
ज़रूरी है. इस ऑब्जेक्ट से जुड़ी क्लास. क्लास, इस ऑब्जेक्ट के टाइप की ही होनी चाहिए. साथ ही, यह पहले से मौजूद होनी चाहिए और इसकी मंज़ूरी होनी चाहिए. क्लास आईडी, issuer ID फ़ॉर्मैट में होने चाहिए.identifier, जहां पहला कोड Google जारी करता है और दूसरा कोड आप चुनते हैं. |
version |
बहिष्कृत |
state |
ज़रूरी है. ऑब्जेक्ट की स्थिति. इस फ़ील्ड का इस्तेमाल यह तय करने के लिए किया जाता है कि ऐप्लिकेशन में कोई ऑब्जेक्ट कैसे दिखेगा. उदाहरण के लिए, |
barcode |
बारकोड का टाइप और वैल्यू. |
messages[] |
ऐप्लिकेशन में दिखाए जाने वाले मैसेज का कलेक्शन. इस ऑब्जेक्ट के सभी उपयोगकर्ताओं को इससे जुड़े मैसेज मिलेंगे. इन फ़ील्ड की ज़्यादा से ज़्यादा संख्या 10 हो सकती है. |
validTimeInterval |
इस ऑब्जेक्ट की समयावधि |
locations[] |
ध्यान दें: फ़िलहाल, इस फ़ील्ड का इस्तेमाल करके जगह की जानकारी वाली सूचनाएं ट्रिगर नहीं की जा सकतीं. |
hasUsers |
इससे पता चलता है कि ऑब्जेक्ट के उपयोगकर्ता हैं या नहीं. यह फ़ील्ड, प्लैटफ़ॉर्म सेट करता है. |
smartTapRedemptionValue |
इस ऑब्जेक्ट के लिए, एनएफ़सी के ज़रिए स्मार्ट टैप सर्टिफ़ाइड टर्मिनल पर भेजी जाने वाली वैल्यू. पास में स्मार्ट टैप की सुविधा काम करे, इसके लिए क्लास लेवल के फ़ील्ड |
hasLinkedDevice |
क्या यह ऑब्जेक्ट फ़िलहाल किसी एक डिवाइस से लिंक है. जब कोई उपयोगकर्ता किसी ऑब्जेक्ट को अपने डिवाइस से लिंक करके सेव करता है, तब प्लैटफ़ॉर्म यह फ़ील्ड सेट करता है. इसे चुनिंदा पार्टनर के लिए बनाया गया है. ज़्यादा जानकारी के लिए, सहायता टीम से संपर्क करें. |
disableExpirationNotification |
इससे पता चलता है कि सूचनाओं को साफ़ तौर पर दबाया जाना चाहिए या नहीं. अगर यह फ़ील्ड 'सही है' पर सेट है, तो फ़िलहाल, इसे सिर्फ़ ऑफ़र के लिए सेट किया जा सकता है. |
infoModuleData |
समर्थन नहीं होना या रुकना. इसके बजाय, textModulesData का इस्तेमाल करें. |
imageModulesData[] |
इमेज मॉड्यूल का डेटा. ऑब्जेक्ट लेवल पर, इन फ़ील्ड की ज़्यादा से ज़्यादा संख्या एक और क्लास ऑब्जेक्ट लेवल पर एक होती है. |
textModulesData[] |
टेक्स्ट मॉड्यूल का डेटा. अगर क्लास में टेक्स्ट मॉड्यूल का डेटा भी तय किया गया है, तो दोनों दिखेंगे. ऑब्जेक्ट से ज़्यादा से ज़्यादा 10 और क्लास से 10 फ़ील्ड दिखाए जा सकते हैं. |
linksModuleData |
मॉड्यूल का डेटा लिंक करता है. अगर क्लास में लिंक मॉड्यूल का डेटा भी तय किया गया है, तो दोनों दिखेंगे. |
appLinkData |
ऐप्लिकेशन या वेबसाइट का वैकल्पिक लिंक, जो पास के सामने बटन के तौर पर दिखेगा. अगर उसी क्लास के लिए AppLinkData दिया गया है, तो सिर्फ़ ऑब्जेक्ट का AppLinkData दिखेगा. |
rotatingBarcode |
घूमने वाले बारकोड का टाइप और वैल्यू. |
heroImage |
कार्ड के सामने वाले हिस्से पर दिखने वाली बैनर इमेज. हालांकि, यह ज़रूरी नहीं है. अगर कोई भी इमेज मौजूद नहीं है, तो क्लास की हीरो इमेज (अगर मौजूद हो) दिखाई जाएगी. अगर क्लास की हीरो इमेज भी मौजूद नहीं है, तो कुछ भी नहीं दिखेगा. |
groupingInfo |
इस जानकारी से यह कंट्रोल होता है कि पास को एक साथ कैसे ग्रुप किया जाए. |
passConstraints |
ऑब्जेक्ट के लिए पाबंदियां पास करें. इसमें एनएफ़सी और स्क्रीनशॉट की सुविधा को सीमित करना भी शामिल है. |
saveRestrictions |
पासवर्ड सेव करने से पहले, उस ऑब्जेक्ट की पाबंदियों की पुष्टि करना ज़रूरी है. ध्यान दें कि यह पाबंदी सिर्फ़ सेव करने के समय लागू होगी. अगर उपयोगकर्ता ने पासवर्ड सेव करने के बाद पाबंदियों में बदलाव किया है, तो नई पाबंदियां पहले से सेव किए गए पासवर्ड पर लागू नहीं होंगी. |
linkedObjectIds[] |
linkedObjectIds, अन्य ऑब्जेक्ट की सूची होती है. जैसे, इवेंट का टिकट, लॉयल्टी, ऑफ़र, सामान्य, उपहार कार्ड, बस, मेट्रो वगैरह के लिए कार्ड, और बोर्डिंग पास. ये ऑब्जेक्ट, इस ऑफ़र ऑब्जेक्ट से अपने-आप जुड़ जाने चाहिए. अगर किसी उपयोगकर्ता ने इस ऑफ़र को सेव किया है, तो ये लिंक किए गए आइडेंटिफ़ायर, उपयोगकर्ता के वॉलेट में अपने-आप भेज दिए जाएंगे. ऐसा तब तक होगा, जब तक उपयोगकर्ता ने लिंक किए गए ऐसे पास पाने की सेटिंग बंद नहीं कर दी है. पक्का करें कि linkedObjectIds में मौजूद ऑब्जेक्ट पहले से ही डाले गए हों. ऐसा न होने पर, कॉल पूरा नहीं हो पाएगा. लिंक करने के बाद, लिंक किए गए ऑब्जेक्ट को अनलिंक नहीं किया जा सकता. किसी दूसरे जारीकर्ता के ऑब्जेक्ट लिंक नहीं किए जा सकते. किसी एक ऑब्जेक्ट से लिंक किए जा सकने वाले ऑब्जेक्ट की संख्या सीमित होती है. सीमा पूरी होने के बाद, कॉल में लिंक किए गए नए ऑब्जेक्ट को अनदेखा कर दिया जाएगा. ऑब्जेक्ट आईडी, issuer ID फ़ॉर्मैट में होने चाहिए.identifier, जहां पहला कोड Google जारी करता है और दूसरा कोड आप चुनते हैं. |
notifyPreference |
इस ऑब्जेक्ट के फ़ील्ड में होने वाले अपडेट से सूचनाएं ट्रिगर होनी चाहिए या नहीं. सूचना देने के लिए सेट करने पर, हम उपयोगकर्ताओं को फ़ील्ड अपडेट की सूचना देने की कोशिश करेंगे. ये सूचनाएं सिर्फ़ तब उपयोगकर्ताओं को भेजी जाएंगी, जब फ़ील्ड किसी अनुमति वाली सूची का हिस्सा हो. अगर इसकी वैल्यू DO_NOT_NOTIFY या NOTIFICATION_SETTINGS_UNSPECIFIED पर सेट है, तो कोई सूचना ट्रिगर नहीं होगी. यह सेटिंग कुछ समय के लिए ही सेट रहती है. इसे हर PATCH या UPDATE अनुरोध के साथ सेट करना ज़रूरी है. ऐसा न करने पर, सूचना ट्रिगर नहीं होगी. |
valueAddedModuleData[] |
वैल्यू ऐडेड मॉड्यूल का डेटा, जोड़ना ज़रूरी नहीं है. ऑब्जेक्ट पर ज़्यादा से ज़्यादा 10 एलिमेंट हो सकते हैं. |
तरीके |
|
---|---|
|
दिए गए ऑब्जेक्ट आईडी से रेफ़र किए गए ऑफ़र ऑब्जेक्ट में मैसेज जोड़ता है. |
|
दिए गए ऑब्जेक्ट आईडी के साथ ऑफ़र ऑब्जेक्ट दिखाता है. |
|
दिए गए आईडी और प्रॉपर्टी के साथ ऑफ़र ऑब्जेक्ट डालता है. |
|
यह किसी दिए गए जारीकर्ता आईडी के लिए, सभी ऑफ़र ऑब्जेक्ट की सूची दिखाता है. |
|
दिए गए ऑब्जेक्ट आईडी से रेफ़र किए गए ऑफ़र ऑब्जेक्ट को अपडेट करता है. |
|
दिए गए ऑब्जेक्ट आईडी से रेफ़र किए गए ऑफ़र ऑब्जेक्ट को अपडेट करता है. |