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)

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

localizedRewardsTier

object (LocalizedString)

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

secondaryRewardsTierLabel

string

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

localizedSecondaryRewardsTierLabel

object (LocalizedString)

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

secondaryRewardsTier

string

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

localizedSecondaryRewardsTier

object (LocalizedString)

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

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)

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

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)

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

DiscoverableProgram

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

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

object (DiscoverableProgramMerchantSignupInfo)

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

merchantSigninInfo

object (DiscoverableProgramMerchantSigninInfo)

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

state

enum (State)

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

DiscoverableProgramMerchantSignupInfo

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

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

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