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)

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

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)

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

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, shortcuts.value, oraccountId` फ़ील्ड भी सही तरीके से सेट अप करना ज़रूरी है, ताकि स्मार्ट टैप की सुविधा के साथ काम करने के लिए पास का इस्तेमाल किया जा सके.

countryCode

string

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

heroImage

object (Image)

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

wordMark
(deprecated)

object (Image)

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

enableSmartTap

boolean

यह पता लगाता है कि इस क्लास में स्मार्ट टैप की सुविधा काम करती है या नहीं. redemptionIssuers और ऑब्जेक्ट लेवल का एक smartTapRedemptionLevel, shortcuts.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)

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

merchantSigninInfo

object (DiscoverableProgramMerchantSigninInfo)

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

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

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