REST Resource: giftcardclass

संसाधन: गिफ़्ट कार्डक्लास

JSON के काेड में दिखाना
{
  "kind": string,
  "merchantName": string,
  "programLogo": {
    object (Image)
  },
  "pinLabel": string,
  "eventNumberLabel": string,
  "allowBarcodeRedemption": boolean,
  "localizedMerchantName": {
    object (LocalizedString)
  },
  "localizedPinLabel": {
    object (LocalizedString)
  },
  "localizedEventNumberLabel": {
    object (LocalizedString)
  },
  "cardNumberLabel": string,
  "localizedCardNumberLabel": {
    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),
  "wideProgramLogo": {
    object (Image)
  },
  "appLinkData": {
    object (AppLinkData)
  }
}
फ़ील्ड
kind
(deprecated)

string

इससे पता चलता है कि यह किस तरह का संसाधन है. वैल्यू: तय स्ट्रिंग "walletobjects#giftCardClass".

merchantName

string

कारोबारी का नाम, जैसे कि "Adam's Apparel". ऐप्लिकेशन के पहले 20 वर्णों के बाद, एलिप्सिस दिख सकता है, ताकि यह पक्का किया जा सके कि पूरी स्ट्रिंग छोटी स्क्रीन पर दिखे.

pinLabel

string

पिन के लिए दिखने वाला लेबल, जैसे कि "चार अंकों का पिन".

eventNumberLabel

string

इवेंट नंबर के लिए दिखाया जाने वाला लेबल, जैसे कि "टारगेट इवेंट #".

allowBarcodeRedemption

boolean

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

localizedMerchantName

object (LocalizedString)

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

localizedPinLabel

object (LocalizedString)

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

localizedEventNumberLabel

object (LocalizedString)

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

cardNumberLabel

string

कार्ड नंबर के लिए दिखने वाला लेबल, जैसे कि "कार्ड नंबर".

localizedCardNumberLabel

object (LocalizedString)

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

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[]

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 और ऑब्जेक्ट लेवल 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)

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

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

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

callbackOptions

object (CallbackOptions)

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

securityAnimation

object (SecurityAnimation)

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

viewUnlockRequirement

enum (ViewUnlockRequirement)

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

तरीके

addmessage

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

get

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

insert

दिए गए आईडी और प्रॉपर्टी वाली उपहार कार्ड क्लास शामिल करता है.

list

किसी दिए गए जारी करने वाले के आईडी के लिए, उपहार कार्ड की सभी क्लास की सूची दिखाता है.

patch

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

update

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