REST Resource: loyaltyclass

संसाधन: लॉयल्टी क्लास

जेएसओएन के काेड में दिखाना
{
  "kind": string,
  "programName": string,
  "programLogo": {
    object (Image)
  },
  "accountNameLabel": string,
  "accountIdLabel": string,
  "rewardsTierLabel": string,
  "rewardsTier": string,
  "localizedProgramName": {
    object (LocalizedString)
  },
  "localizedAccountNameLabel": {
    object (LocalizedString)
  },
  "localizedAccountIdLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTierLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTier": {
    object (LocalizedString)
  },
  "secondaryRewardsTierLabel": string,
  "localizedSecondaryRewardsTierLabel": {
    object (LocalizedString)
  },
  "secondaryRewardsTier": string,
  "localizedSecondaryRewardsTier": {
    object (LocalizedString)
  },
  "discoverableProgram": {
    object (DiscoverableProgram)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideProgramLogo": {
    object (Image)
  }
}
फ़ील्ड
kind
(deprecated)

string

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

programName

string

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

accountNameLabel

string

खाते के नाम का लेबल, जैसे कि "सदस्य का नाम." छोटी स्क्रीन पर पूरी स्ट्रिंग दिखाने के लिए, ज़्यादा से ज़्यादा 15 वर्ण इस्तेमाल करने का सुझाव दिया जाता है.

accountIdLabel

string

खाता आईडी लेबल, जैसे कि "सदस्य का आईडी." छोटी स्क्रीन पर पूरी स्ट्रिंग दिखाने के लिए, ज़्यादा से ज़्यादा 15 वर्ण इस्तेमाल करने का सुझाव दिया जाता है.

rewardsTierLabel

string

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

rewardsTier

string

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

localizedProgramName

object (LocalizedString)

programName के लिए अनुवाद की गई स्ट्रिंग. छोटी स्क्रीन पर पूरी स्ट्रिंग दिखे, इसके लिए ऐप्लिकेशन पहले 20 वर्णों के बाद एलिप्सिस दिखा सकता है.

localizedAccountNameLabel

object (LocalizedString)

accountNameLabel के लिए अनुवाद की गई स्ट्रिंग. छोटी स्क्रीन पर पूरी स्ट्रिंग दिखाने के लिए, ज़्यादा से ज़्यादा 15 वर्ण इस्तेमाल करने का सुझाव दिया जाता है.

localizedAccountIdLabel

object (LocalizedString)

accountIdLabel के लिए अनुवाद की गई स्ट्रिंग. छोटी स्क्रीन पर पूरी स्ट्रिंग दिखाने के लिए, ज़्यादा से ज़्यादा 15 वर्ण इस्तेमाल करने का सुझाव दिया जाता है.

localizedRewardsTierLabel

object (LocalizedString)

इनामों के TierLabel के लिए अनुवाद की गई स्ट्रिंग. छोटी स्क्रीन पर पूरी स्ट्रिंग दिखाने के लिए, ज़्यादा से ज़्यादा नौ वर्ण इस्तेमाल करने का सुझाव दिया जाता है.

localizedRewardsTier

object (LocalizedString)

इनामों के टियर के लिए अनुवाद की गई स्ट्रिंग. छोटी स्क्रीन पर पूरी स्ट्रिंग दिखाने के लिए, ज़्यादा से ज़्यादा सात वर्ण इस्तेमाल करने का सुझाव दिया जाता है.

secondaryRewardsTierLabel

string

इनाम का दूसरा टीयर लेबल, जैसे कि "इनाम का टियर."

localizedSecondaryRewardsTierLabel

object (LocalizedString)

सेकंडरी इनामों के टीयर लेबल के लिए अनुवाद की गई स्ट्रिंग.

secondaryRewardsTier

string

इनाम का दूसरा लेवल, जैसे कि "गोल्ड" या "प्लैटिनम".

localizedSecondaryRewardsTier

object (LocalizedString)

सेकंडरी इनामों के टीयर के लिए अनुवाद की गई स्ट्रिंग.

discoverableProgram

object (DiscoverableProgram)

यह जानकारी कि Google Pay ऐप्लिकेशन में क्लास को कैसे खोजा और इंस्टैंशिएट किया जा सकता है.

classTemplateInfo

object (ClassTemplateInfo)

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

id

string

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

version
(deprecated)

string (int64 format)

बहिष्कृत

issuerName

string

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

messages[]

object (Message)

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

allowMultipleUsersPerObject
(deprecated)

boolean

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

homepageUri

object (Uri)

आपके ऐप्लिकेशन के होम पेज का यूआरआई. इस फ़ील्ड में यूआरआई को भरने पर भी बिलकुल वैसा ही व्यवहार होता है जैसा लिंक मॉड्यूल डेटा में यूआरआई को भरने के लिए होता है (जब कोई ऑब्जेक्ट रेंडर होता है, तो होम पेज का लिंक उस जगह दिखता है जिसे आम तौर पर ऑब्जेक्ट के लिंक मॉड्यूल डेटा सेक्शन के तौर पर माना जाता है).

locations[]

object (LatLongPoint)

ध्यान दें: यह फ़ील्ड फ़िलहाल भौगोलिक नोटिफ़िकेशन ट्रिगर करने के लिए समर्थित नहीं है.

reviewStatus

enum (ReviewStatus)

ज़रूरी है. क्लास की स्थिति. इंसर्ट, पैच या अपडेट एपीआई कॉल का इस्तेमाल करके, इस फ़ील्ड को draft या underReview पर सेट किया जा सकता है. समीक्षा की स्थिति को draft से बदलने के बाद, हो सकता है कि इसे वापस draft में न बदला जाए.

जब क्लास डेवलप हो रही हो, तो आपको इस फ़ील्ड को draft पर रखना चाहिए. किसी भी ऑब्जेक्ट को बनाने के लिए, draft क्लास का इस्तेमाल नहीं किया जा सकता.

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

पहले से मौजूद approved क्लास को अपडेट करते समय, आपको इस फ़ील्ड को underReview पर सेट करना चाहिए.

review

object (Review)

क्लास को approved या rejected के तौर पर मार्क किए जाने पर, प्लैटफ़ॉर्म से सेट की गई समीक्षा की टिप्पणियां.

infoModuleData
(deprecated)

object (InfoModuleData)

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

imageModulesData[]

object (ImageModuleData)

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

textModulesData[]

object (TextModuleData)

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

redemptionIssuers[]

string (int64 format)

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

enableSmartTap और ऑब्जेक्ट लेवल smartTapRedemptionValue में से एक, बारकोड.value, oraccountId` फ़ील्ड भी सही तरीके से सेट अप किए जाने चाहिए, ताकि स्मार्ट टैप की सुविधा के साथ काम करने वाला पास मिल सके.

countryCode

string

देश का कोड, यह दिखाने के लिए इस्तेमाल किया जाता है कि कार्ड किस देश में है (जब उपयोगकर्ता उस देश में न हो). साथ ही, इसका इस्तेमाल स्थानीय भाषा में कॉन्टेंट दिखाने के लिए भी किया जाता है, जब कॉन्टेंट उपयोगकर्ता की स्थान-भाषा में उपलब्ध न हो.

heroImage

object (Image)

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

wordMark
(deprecated)

object (Image)

समर्थन नहीं होना या रुकना.

enableSmartTap

boolean

यह पता लगाता है कि इस क्लास में स्मार्ट टैप की सुविधा है या नहीं. redemptionIssuers और ऑब्जेक्ट लेवल smartTapRedemptionLevel में से एक, बारकोड.value, or accountId` फ़ील्ड भी सही तरीके से सेट अप किए जाने चाहिए, ताकि स्मार्ट टैप की सुविधा के साथ काम करने वाला पास मिल सके.

hexBackgroundColor

string

कार्ड के बैकग्राउंड का रंग. अगर हीरो इमेज के लिए मुख्य रंग सेट नहीं किया गया है और कोई हीरो इमेज सेट नहीं की गई है, तो लोगो के मुख्य रंग का इस्तेमाल किया जाता है. फ़ॉर्मैट #rrggbb है, जहां rrggbb एक हेक्स आरजीबी ट्रिपलेट है, जैसे कि #ffcc00. #rgb वाले आरजीबी ट्रिपलेट के शॉर्टहैंड वर्शन का भी इस्तेमाल किया जा सकता है, जैसे कि #fc0.

localizedIssuerName

object (LocalizedString)

providerName के लिए अनुवाद की गई स्ट्रिंग. छोटी स्क्रीन पर पूरी स्ट्रिंग दिखाने के लिए, ज़्यादा से ज़्यादा 20 वर्ण इस्तेमाल करने का सुझाव दिया जाता है.

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

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

callbackOptions

object (CallbackOptions)

असली उपयोगकर्ता इस क्लास के लिए किसी ऑब्जेक्ट को सेव करने या मिटाने पर, उसे जारी करने वाले को वापस कॉल करने के लिए कॉलबैक के विकल्पों का इस्तेमाल करे. इस क्लास के सभी ऑब्जेक्ट, कॉलबैक की ज़रूरी शर्तों को पूरा करते हैं.

securityAnimation

object (SecurityAnimation)

सुरक्षा ऐनिमेशन के बारे में वैकल्पिक जानकारी. अगर इसे सेट किया जाता है, तो पास की जानकारी में सुरक्षा से जुड़ा ऐनिमेशन दिखाया जाएगा.

viewUnlockRequirement

enum (ViewUnlockRequirement)

लॉयल्टी कार्ड के लिए, अनलॉक करने की ज़रूरी शर्तों के विकल्प देखें.

डिस्कवर करने लायक प्रोग्राम

Android Pay ऐप्लिकेशन में किसी क्लास को खोजने और उसे इंस्टैंशिएट करने के तरीके के बारे में जानकारी. इसके लिए, लॉयल्टी या उपहार कार्ड प्रोग्राम को खोजकर उसे स्कैन किया जा सकता है या मैन्युअल तरीके से डाला जा सकता है.

जेएसओएन के काेड में दिखाना
{
  "merchantSignupInfo": {
    object (DiscoverableProgramMerchantSignupInfo)
  },
  "merchantSigninInfo": {
    object (DiscoverableProgramMerchantSigninInfo)
  },
  "state": enum (State)
}
फ़ील्ड
merchantSignupInfo

object (DiscoverableProgramMerchantSignupInfo)

व्यापारी/कंपनी की साइट के ज़रिए, इस प्रोग्राम के लिए साइन अप करने और ज़रूरी सामान जोड़ने की सुविधा के बारे में जानकारी. व्यापार_प्लेसमेंट_संगठन चालू होने पर इसका इस्तेमाल किया जाता है.

merchantSigninInfo

object (DiscoverableProgramMerchantSigninInfo)

व्यापारी/कंपनी की साइट के ज़रिए साइन इन करने और इस कार्यक्रम के लिए अहम जानकारी जोड़ने की सुविधा की जानकारी. {8}_प्लेसमेंट_MDO सक्षम होने पर इसका उपयोग किया जाता है.

state

enum (State)

खोजे जाने लायक प्रोग्राम की दृश्यता स्थिति.

Discoverable ProgramsMerchantसाइनअप जानकारी

किसी प्रोग्राम के लिए, व्यापारी या कंपनी के होस्ट किए गए साइन अप फ़्लो की जानकारी.

जेएसओएन के काेड में दिखाना
{
  "signupWebsite": {
    object (Uri)
  },
  "signupSharedDatas": [
    enum (SharedDataType)
  ]
}
फ़ील्ड
signupWebsite

object (Uri)

व्यापारी/कंपनी की साइन अप साइट पर, उपयोगकर्ता को ले जाने के लिए यूआरएल.

signupSharedDatas[]

enum (SharedDataType)

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

SharedDataType

Enums
SHARED_DATA_TYPE_UNSPECIFIED
FIRST_NAME
LAST_NAME
STREET_ADDRESS एक लाइन वाला पता फ़ील्ड
ADDRESS_LINE_1 एक से ज़्यादा लाइन वाले पते वाले फ़ील्ड
ADDRESS_LINE_2
ADDRESS_LINE_3
CITY
STATE
ZIPCODE
COUNTRY
EMAIL
PHONE

DiscoverableProgramMerchantSigninInfo

किसी कार्यक्रम के लिए, व्यापारी की ओर से होस्ट किए गए साइन इन फ़्लो की जानकारी.

जेएसओएन के काेड में दिखाना
{
  "signinWebsite": {
    object (Uri)
  }
}
फ़ील्ड
signinWebsite

object (Uri)

व्यापारी/कंपनी की साइन इन साइट पर ले जाने वाला यूआरएल. उपयोगकर्ता को इस पेज पर भेजा जा सकता है.

स्थिति

Enums
STATE_UNSPECIFIED
TRUSTED_TESTERS यह सिर्फ़ उन टेस्टर को दिखेगा जिनके पास जारी करने वाले के खाते का ऐक्सेस है.
trustedTesters

TRUSTED_TESTERS के लिए लेगसी उपनाम. समर्थन नहीं होना या रुकना.

LIVE सभी को दिखता है.
live

LIVE के लिए लेगसी उपनाम. समर्थन नहीं होना या रुकना.

DISABLED नहीं दिख रहा है.
disabled

DISABLED के लिए लेगसी उपनाम. समर्थन नहीं होना या रुकना.

तरीके

addmessage

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

get

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

insert

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

list

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

patch

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

update

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