REST Resource: offerclass

संसाधन: OfferClass

जेएसओएन के काेड में दिखाना 
{
  "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)
  }
}
फ़ील्ड
kind
(deprecated)

string

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

string

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

enum (RedemptionChannel)

ज़रूरी है. इस ऑफ़र पर लागू होने वाले रिडेम्शन चैनल.
provider

string

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

object (Image)

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

string

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

string

ऑफ़र की शर्तें या फ़ाइन प्रिंट, जैसे कि "रमेश के कपड़े पर किसी भी टी-शर्ट पर 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)

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

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 एक हेक्स आरजीबी ट्रिपलेट होता है, जैसे कि #ffcc00. आरजीबी ट्रिपलेट के शॉर्टहैंड वर्शन का भी इस्तेमाल किया जा सकता है, जो #rgb है, जैसे कि #fc0.
localizedIssuerName

object (LocalizedString)

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

enum (MultipleDevicesAndHoldersAllowedStatus)

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

object (CallbackOptions)

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

object (SecurityAnimation)

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

enum (ViewUnlockRequirement)

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

object (Image)

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

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

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