REST Resource: giftcardobject

रिसॉर्स: GiftCardObject

JSON के काेड में दिखाना
{
  "kind": string,
  "classReference": {
    object (GiftCardClass)
  },
  "cardNumber": string,
  "pin": string,
  "balance": {
    object (Money)
  },
  "balanceUpdateTime": {
    object (DateTime)
  },
  "eventNumber": string,
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
फ़ील्ड
kind
(deprecated)

string

यह बताता है कि यह किस तरह का संसाधन है. वैल्यू: तय की गई स्ट्रिंग "walletobjects#giftCardObject".

classReference

object (GiftCardClass)

पैरंट क्लास के इनहेरिट किए गए फ़ील्ड की कॉपी. ये फ़ील्ड, जीईटी के दौरान वापस लाए जाते हैं.

cardNumber

string

ज़रूरी है. कार्ड का नंबर.

pin

string

कार्ड का पिन.

balance

object (Money)

कार्ड का बैलेंस.

balanceUpdateTime

object (DateTime)

बैलेंस को आखिरी बार अपडेट किए जाने की तारीख और समय.

ऑफ़सेट डालना ज़रूरी है.

अगर बैलेंस अपडेट किया गया है और यह प्रॉपर्टी नहीं दी गई है, तो सिस्टम डिफ़ॉल्ट रूप से मौजूदा समय का इस्तेमाल करेगा.

eventNumber

string

कार्ड का इवेंट नंबर. यह एक वैकल्पिक फ़ील्ड है, जिसका इस्तेमाल कुछ उपहार कार्ड करते हैं.

id

string

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

classId

string

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

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

version
(deprecated)

string (int64 format)

बहिष्कृत

state

enum (State)

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

barcode

object (Barcode)

बारकोड का टाइप और वैल्यू.

messages[]

object (Message)

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

validTimeInterval

object (TimeInterval)

इस ऑब्जेक्ट की समयावधि active होगी और ऑब्जेक्ट का इस्तेमाल किया जा सकता है. यह समयसीमा खत्म होने के बाद, ऑब्जेक्ट का स्टेटस expired में बदल जाएगा.

locations[]
(deprecated)

object (LatLongPoint)

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

hasUsers

boolean

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

smartTapRedemptionValue

string

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

hasLinkedDevice

boolean

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

disableExpirationNotification

boolean

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

फ़िलहाल, इसे सिर्फ़ ऑफ़र के लिए सेट किया जा सकता है.

infoModuleData

object (InfoModuleData)

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

imageModulesData[]

object (ImageModuleData)

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

textModulesData[]

object (TextModuleData)

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

rotatingBarcode

object (RotatingBarcode)

घूमने वाले बारकोड का टाइप और वैल्यू.

heroImage

object (Image)

कार्ड के सामने दिखाई जाने वाली वैकल्पिक बैनर इमेज. अगर कोई भी इमेज मौजूद नहीं है, तो क्लास की हीरो इमेज (अगर मौजूद हो) दिखाई जाएगी. अगर क्लास की हीरो इमेज भी मौजूद नहीं है, तो कुछ भी नहीं दिखेगा.

groupingInfo

object (GroupingInfo)

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

passConstraints

object (PassConstraints)

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

saveRestrictions

object (SaveRestrictions)

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

linkedObjectIds[]

string

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

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

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

notifyPreference

enum (NotificationSettingsForUpdates)

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

valueAddedModuleData[]

object (ValueAddedModuleData)

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

तरीके

addmessage

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

get

दिए गए ऑब्जेक्ट आईडी के साथ उपहार कार्ड ऑब्जेक्ट दिखाता है.

insert

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

list

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

patch

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

update

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