REST Resource: offerclass

संसाधन: OfferClass

JSON के काेड में दिखाना 
{
  "kind": string,
  "title": string,
  "redemptionChannel": enum (RedemptionChannel),
  "provider": string,
  "titleImage": {
    object (Image)
  },
  "details": string,
  "finePrint": string,
  "helpUri": {
    object (Uri)
  },
  "localizedTitle": {
    object (LocalizedString)
  },
  "localizedProvider": {
    object (LocalizedString)
  },
  "localizedDetails": {
    object (LocalizedString)
  },
  "localizedFinePrint": {
    object (LocalizedString)
  },
  "shortTitle": string,
  "localizedShortTitle": {
    object (LocalizedString)
  },
  "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),
  "wideTitleImage": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ],
  "merchantLocations": [
    {
      object (MerchantLocation)
    }
  ]
}
फ़ील्ड
kind
(deprecated)

string

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

string

ज़रूरी है. ऑफ़र का टाइटल, जैसे कि "किसी भी टी-शर्ट पर 20% की छूट." हमारा सुझाव है कि स्ट्रिंग में ज़्यादा से ज़्यादा 60 वर्ण इस्तेमाल करें, ताकि छोटी स्क्रीन पर पूरी स्ट्रिंग दिखे.
redemptionChannel

enum (RedemptionChannel)

ज़रूरी है. इस ऑफ़र पर रिडीम करने के लिए उपलब्ध चैनल.
provider

string

ज़रूरी है. ऑफ़र देने वाली कंपनी (एग्रीगेटर का नाम या कारोबारी/कंपनी/कारोबारी का नाम). हमारा सुझाव है कि स्ट्रिंग में ज़्यादा से ज़्यादा 12 वर्ण इस्तेमाल करें, ताकि छोटी स्क्रीन पर पूरी स्ट्रिंग दिखे.
titleImage

object (Image)

ऑफ़र की टाइटल इमेज. यह इमेज, ऐप्लिकेशन की ज़्यादा जानकारी वाले व्यू और सूची वाले व्यू, दोनों में दिखती है.
details

string

ऑफ़र की जानकारी.
finePrint

string

ऑफ़र के बारे में ज़्यादा जानकारी या शर्तें, जैसे कि "Adam's Apparel पर किसी भी टी-शर्ट पर 20% की छूट."
helpUri

object (Uri)

ऑफ़र के लिए सहायता लिंक, जैसे कि http://myownpersonaldomain.com/help
localizedTitle

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

फ़ाइन प्रिंट के लिए अनुवाद की गई स्ट्रिंग.
shortTitle

string

ऑफ़र के टाइटल का छोटा वर्शन, जैसे कि "20% की छूट". यह ऑफ़र के कॉन्टेंट के बारे में तुरंत जानकारी देने के लिए, उपयोगकर्ताओं को दिखाया जाता है. हमारा सुझाव है कि आप 20 से ज़्यादा वर्ण इस्तेमाल न करें.
localizedShortTitle

object (LocalizedString)

छोटे टाइटल के लिए अनुवाद की गई स्ट्रिंग. हमारा सुझाव है कि आप 20 से ज़्यादा वर्ण इस्तेमाल न करें.
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[]
(deprecated)

object (LatLongPoint)

ध्यान दें: फ़िलहाल, इस फ़ील्ड का इस्तेमाल करके जगह की जानकारी वाली सूचनाएं ट्रिगर नहीं की जा सकतीं.
reviewStatus

enum (ReviewStatus)

ज़रूरी है. क्लास का स्टेटस. इस फ़ील्ड को draft या कक्षा की स्थिति पर सेट किया जा सकता है. इस फ़ील्ड को 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 और ऑब्जेक्ट लेवल smartTapRedemptionLevel फ़ील्ड को भी सही तरीके से सेट अप करना ज़रूरी है.
countryCode

string

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

object (Image)

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

object (Image)

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

boolean

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

ऑफ़र के लिए, अनलॉक करने की ज़रूरी शर्तों के विकल्प देखें.
wideTitleImage

object (Image)

ऑफ़र की चौड़ी टाइटल इमेज. अगर यह दिया गया है, तो इसका इस्तेमाल कार्ड व्यू में सबसे ऊपर बाईं ओर मौजूद टाइटल इमेज की जगह किया जाएगा.
notifyPreference

enum (NotificationSettingsForUpdates)

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

object (ValueAddedModuleData)

वैल्यू ऐडेड मॉड्यूल का डेटा, जोड़ना ज़रूरी नहीं है. कक्षा में ज़्यादा से ज़्यादा 10 छात्र-छात्राएं हो सकती हैं. किसी पास के लिए सिर्फ़ 10 आइटम दिखाए जाएंगे. इनमें, ऑब्जेक्ट से मिले आइटम को प्राथमिकता दी जाएगी.
merchantLocations[]

object (MerchantLocation)

कारोबारी या कंपनी की जगहें. क्लास में ज़्यादा से ज़्यादा 10 लोग शामिल हो सकते हैं. 10 से ज़्यादा MerchantLocations जोड़ने पर, उन्हें अस्वीकार कर दिया जाएगा. जब कोई उपयोगकर्ता, Google की तय की गई त्रिज्या के अंदर पहुंचेगा, तो इन जगहों पर सूचनाएं ट्रिगर हो जाएंगी. यह फ़ील्ड, अब काम न करने वाले LatLongPoints की जगह ले लेगा.

RedemptionChannel

Enums
REDEMPTION_CHANNEL_UNSPECIFIED
INSTORE
instore

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

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

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

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

तरीके

addmessage

 दिए गए क्लास आईडी से रेफ़र की गई ऑफ़र क्लास में मैसेज जोड़ता है.

get

 दिए गए क्लास आईडी के साथ ऑफ़र क्लास दिखाता है.

insert

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

list

 किसी जारीकर्ता आईडी के लिए, सभी ऑफ़र क्लास की सूची दिखाता है.

patch

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

update

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