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)
  }
}
फ़ील्ड
kind
(deprecated)

string

इससे पता चलता है कि यह किस तरह का संसाधन है. वैल्यू: तय स्ट्रिंग "walletobjects#loyaltyObject".

classReference

object (LoyaltyClass)

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

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[]

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)

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

LoyaltyPoints

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

string

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

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

integer

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

double

number

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

money

object (Money)

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

तरीके

addmessage

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

get

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

insert

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

list

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

modifylinkedofferobjects

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

patch

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

update

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