REST Resource: loyaltyobject

रिसॉर्स: LoyaltyObject

JSON के काेड में दिखाना 
{
  "kind": string,
  "classReference": {
    object (LoyaltyClass)
  },
  "accountName": string,
  "accountId": string,
  "loyaltyPoints": {
    object (LoyaltyPoints)
  },
  "linkedOfferIds": [
    string
  ],
  "secondaryLoyaltyPoints": {
    object (LoyaltyPoints)
  },
  "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#loyaltyObject".
classReference

object (LoyaltyClass)

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

string

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

string

लॉयल्टी खाते का आइडेंटिफ़ायर. हमारा सुझाव है कि आप 20 से ज़्यादा वर्ण इस्तेमाल न करें.
loyaltyPoints

object (LoyaltyPoints)

लॉयल्टी इनाम पॉइंट का लेबल, बैलेंस, और टाइप.
linkedOfferIds[]

string

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

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

object (LoyaltyPoints)

लॉयल्टी प्रोग्राम के इनाम के लिए दूसरा पॉइंट लेबल, बैलेंस, और टाइप. यह मुख्य लॉयल्टी पॉइंट के अलावा दिखता है.
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 वर्ण इस्तेमाल किए जा सकते हैं.

अगर यह वैल्यू सेट नहीं है, लेकिन क्लास लेवल के फ़ील्ड enableSmartTap और redemptionIssuers सही तरीके से सेट अप किए गए हैं, तो barcode.value या accountId फ़ील्ड का इस्तेमाल फ़ॉलबैक के तौर पर किया जाता है.
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.

LoyaltyPoints

JSON के काेड में दिखाना 
{
  "label": string,
  "balance": {
    object (LoyaltyPointsBalance)
  },
  "localizedLabel": {
    object (LocalizedString)
  }
}
फ़ील्ड
label

string

लॉयल्टी पॉइंट का लेबल, जैसे कि "Points". ज़्यादा से ज़्यादा नौ वर्ण इस्तेमाल करने का सुझाव दिया जाता है.
balance

object (LoyaltyPointsBalance)

खाते के मालिक के लॉयल्टी पॉइंट का बैलेंस, जैसे कि "500" या "10.00 डॉलर". ज़्यादा से ज़्यादा सात वर्ण इस्तेमाल करने का सुझाव दिया जाता है. यह loyaltyPoints और secondaryLoyaltyPoints के लिए ज़रूरी फ़ील्ड है.
localizedLabel

object (LocalizedString)

लेबल के लिए अनुवाद की गई स्ट्रिंग. ज़्यादा से ज़्यादा नौ वर्ण इस्तेमाल करें.

LoyaltyPointsBalance

JSON के काेड में दिखाना 
{
  "string": string,
  "int": integer,
  "double": number,
  "money": {
    object (Money)
  }
}
फ़ील्ड
string

string

बैलेंस की जानकारी देने वाली स्ट्रिंग. इनमें से सिर्फ़ एक सब-टाइप (स्ट्रिंग, int, डबल, मनी) को पॉप्युलेट किया जाना चाहिए.
int

integer

बैलेंस का पूर्णांक फ़ॉर्म. इनमें से सिर्फ़ एक सब-टाइप (स्ट्रिंग, int, डबल, मनी) को पॉप्युलेट किया जाना चाहिए.
double

number

बैलेंस का डबल फ़ॉर्म. इनमें से सिर्फ़ एक सब-टाइप (स्ट्रिंग, int, डबल, मनी) को पॉप्युलेट किया जाना चाहिए.
money

object (Money)

बैलेंस का मुद्रा फ़ॉर्म. इनमें से सिर्फ़ एक सब-टाइप (स्ट्रिंग, इंटेज, डबल, मनी) में जानकारी भरी जानी चाहिए.

तरीके

addmessage

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

get

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

insert

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

list

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

modifylinkedofferobjects

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

patch

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

update

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