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)

पैरंट क्लास के इनहेरिट किए गए फ़ील्ड की कॉपी. ये फ़ील्ड 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[]

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)

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

लॉयल्टी पॉइंट

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

string

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

balance

object (LoyaltyPointsBalance)

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

localizedLabel

object (LocalizedString)

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

लॉयल्टी पॉइंट बैलेंस

जेएसओएन के काेड में दिखाना
{
  "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

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