REST Resource: loyaltyobject

संसाधन: लॉयल्टीऑब्जेक्ट

जेएसओएन के काेड में दिखाना
{
  "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)
  }
}
फ़ील्ड
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)

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

LoyaltyPoints

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

string

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

balance

object (LoyaltyPointsBalance)

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

localizedLabel

object (LocalizedString)

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

LoyaltyPointsBalance

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

string

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

int

integer

बैलेंस का पूर्णांक. इनमें से सिर्फ़ एक सब-टाइप (string, int, double, money) में अपने-आप जानकारी भरी जानी चाहिए.

double

number

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

money

object (Money)

पैसे का बैलेंस. इनमें से सिर्फ़ एक सब-टाइप (string, int, double, money) में अपने-आप जानकारी भरी जानी चाहिए.

तरीके

addmessage

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

get

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

insert

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

list

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

modifylinkedofferobjects

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

patch

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

update

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