REST Resource: loyaltyclass

रिसॉर्स: LoyaltyClass

JSON के काेड में दिखाना
{
  "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)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
फ़ील्ड
kind
(deprecated)

string

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

programName

string

ज़रूरी है. प्रोग्राम का नाम, जैसे कि "Adam's Apparel". ऐप्लिकेशन, पहले 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)

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

secondaryRewardsTier

string

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

localizedSecondaryRewardsTier

object (LocalizedString)

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

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)

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

locations[]
(deprecated)

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, barcode.value, oraccountId` फ़ील्ड भी सही तरीके से सेट अप होने चाहिए, ताकि स्मार्ट टैप के साथ कोई पास काम कर सके.

countryCode

string

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

heroImage

object (Image)

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

wordMark
(deprecated)

object (Image)

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

enableSmartTap

boolean

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

hexBackgroundColor

string

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

localizedIssuerName

object (LocalizedString)

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

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

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

callbackOptions

object (CallbackOptions)

आखिरी उपयोगकर्ता के इस क्लास के लिए किसी ऑब्जेक्ट को सेव/मिटाने पर, कार्ड जारी करने वाली कंपनी को कॉल करने के लिए इस्तेमाल किए जाने वाले कॉलबैक के विकल्प. इस क्लास के सभी ऑब्जेक्ट पर कॉलबैक किया जा सकता है.

securityAnimation

object (SecurityAnimation)

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

viewUnlockRequirement

enum (ViewUnlockRequirement)

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

notifyPreference

enum (NotificationSettingsForUpdates)

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

valueAddedModuleData[]

object (ValueAddedModuleData)

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

DiscoverableProgram

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

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

object (DiscoverableProgramMerchantSignupInfo)

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

merchantSigninInfo

object (DiscoverableProgramMerchantSigninInfo)

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

state

enum (State)

'खोजे जा सकने वाले प्रोग्राम' की स्थिति.

DiscoverableProgramMerchantSignupInfo

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

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

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

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

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