REST Resource: genericobject

संसाधन: जेनेरिकऑब्जेक्ट

जेनरिक ऑब्जेक्ट

JSON के काेड में दिखाना
{
  "genericType": enum (GenericType),
  "cardTitle": {
    object (LocalizedString)
  },
  "subheader": {
    object (LocalizedString)
  },
  "header": {
    object (LocalizedString)
  },
  "logo": {
    object (Image)
  },
  "hexBackgroundColor": string,
  "notifications": {
    object (Notifications)
  },
  "id": string,
  "classId": string,
  "barcode": {
    object (Barcode)
  },
  "heroImage": {
    object (Image)
  },
  "validTimeInterval": {
    object (TimeInterval)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "smartTapRedemptionValue": string,
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "state": enum (State),
  "hasUsers": boolean,
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  }
}
फ़ील्ड
genericType

enum (GenericType)

बताएं कि कार्ड किस GenericType से जुड़ा है.

cardTitle

object (LocalizedString)

ज़रूरी है. पास का हेडर. आम तौर पर, यह कारोबार का नाम होता है, जैसे कि "XXX Gym", "AAA इंश्योरेंस". यह फ़ील्ड ज़रूरी है और पास के सबसे ऊपर, हेडर वाली लाइन में दिखता है.

subheader

object (LocalizedString)

पास का टाइटल लेबल, जैसे कि इस पास का इस्तेमाल कहां किया जा सकता है. पास की जानकारी वाले व्यू में, टाइटल की लाइन में टाइटल के ठीक ऊपर दिखता है.

header

object (LocalizedString)

ज़रूरी है. पास का टाइटल, जैसे कि "कूपन पर 50% की छूट" या "लाइब्रेरी कार्ड" या "वाउचर" जैसे शब्दों का इस्तेमाल करें. यह फ़ील्ड ज़रूरी है और यह पास की जानकारी वाले व्यू की टाइटल वाली लाइन में दिखता है.

hexBackgroundColor

string

कार्ड के बैकग्राउंड का रंग. इस नीति को सेट न करने पर, हीरो इमेज के लिए मुख्य रंग का इस्तेमाल किया जाता है. अगर कोई हीरो इमेज सेट नहीं है, तो लोगो के मुख्य रंग का इस्तेमाल किया जाता है. अगर लोगो सेट नहीं है, तो Google कोई रंग चुनेगा.

notifications

object (Notifications)

इस ऑब्जेक्ट के लिए चालू की गई सूचना सेटिंग.

id

string

ज़रूरी है. किसी ऑब्जेक्ट के लिए यूनीक आइडेंटिफ़ायर. यह आईडी, जारी करने वाले के सभी ऑब्जेक्ट के लिए अलग होना चाहिए. यह वैल्यू issuerID.identifier फ़ॉर्मैट के हिसाब से होनी चाहिए. इसमें issuerID को Google जारी करता है और identifier को चुनता है. यूनीक आइडेंटिफ़ायर में सिर्फ़ अक्षर और अंक, ., _ या - शामिल हो सकते हैं.

classId

string

ज़रूरी है. इस ऑब्जेक्ट से जुड़ी क्लास. क्लास, इस ऑब्जेक्ट की तरह की होनी चाहिए, पहले से मौजूद होनी चाहिए और स्वीकार की जानी चाहिए.

क्लास आईडी issuerID.identifier के फ़ॉर्मैट में होने चाहिए. इसमें issuerID को Google जारी करता है और identifier को चुनता है.

barcode

object (Barcode)

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

heroImage

object (Image)

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

validTimeInterval

object (TimeInterval)

इस ऑब्जेक्ट को उस समयावधि के दौरान ही मान्य या इस्तेमाल किया जा सकने वाला माना जाएगा. समयावधि बीत जाने के बाद यह माना जाएगा कि ऑब्जेक्ट की समयसीमा खत्म हो गई है. इससे उपयोगकर्ता के डिवाइसों पर रेंडरिंग पर असर पड़ेगा.

imageModulesData[]

object (ImageModuleData)

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

textModulesData[]

object (TextModuleData)

टेक्स्ट मॉड्यूल डेटा. अगर क्लास में textModulesData को भी तय किया गया है, तो दोनों दिखाए जाएंगे. क्लास में इन फ़ील्ड की ज़्यादा से ज़्यादा संख्या 10 और ऑब्जेक्ट से 10 हो सकती है.

groupingInfo

object (GroupingInfo)

वह जानकारी जो यह कंट्रोल करती है कि पास का ग्रुप कैसे बनाया जाता है.

smartTapRedemptionValue

string

इस ऑब्जेक्ट के लिए, एनएफ़सी पर स्मार्ट टैप से सर्टिफ़ाइड टर्मिनल को जो वैल्यू भेजी जाएगी. क्लास लेवल फ़ील्ड enableSmartTap और redemptionIssuers को भी सही तरीके से सेट अप करना ज़रूरी है, ताकि पास स्मार्ट टैप के साथ काम कर सके. सिर्फ़ ASCII वर्ण इस्तेमाल किए जा सकते हैं.

rotatingBarcode

object (RotatingBarcode)

घूमने वाले बारकोड की सेटिंग/जानकारी.

state

enum (State)

ऑब्जेक्ट की स्थिति. इस फ़ील्ड का इस्तेमाल यह तय करने के लिए किया जाता है कि ऐप्लिकेशन में कोई ऑब्जेक्ट किस तरह दिखेगा. उदाहरण के लिए, inactive ऑब्जेक्ट को "वे पास जिनकी समयसीमा खत्म हो चुकी है" में ले जाया जाता है सेक्शन में जाएं. अगर यह नहीं दिया गया है, तो ऑब्जेक्ट को ACTIVE माना जाएगा.

hasUsers

boolean

यह बताता है कि ऑब्जेक्ट में उपयोगकर्ता हैं या नहीं. यह फ़ील्ड, प्लैटफ़ॉर्म से सेट की जाती है.

passConstraints

object (PassConstraints)

ऑब्जेक्ट के लिए कंस्ट्रेंट पास करें. इसमें एनएफ़सी और स्क्रीनशॉट को सीमित तौर पर इस्तेमाल करने की सुविधा शामिल है.

saveRestrictions

object (SaveRestrictions)

उस ऑब्जेक्ट पर लगी पाबंदियां जिसकी पुष्टि करने की ज़रूरत होती है. उपयोगकर्ता के पास को सेव करने की कोशिश करने से पहले ऐसा होता है. ध्यान दें कि ये पाबंदियां, समय बचाने के दौरान ही लागू होंगी. अगर किसी व्यक्ति के पास को सेव करने के बाद, पाबंदियों में बदलाव होता है, तो नई पाबंदियां पहले से सेव किए गए पास पर लागू नहीं होंगी.

GenericType

जेनरिक कार्ड का टाइप.

Enums
GENERIC_TYPE_UNSPECIFIED सामान्य टाइप की जानकारी नहीं है.
GENERIC_SEASON_PASS सीज़न पास
GENERIC_UTILITY_BILLS बिजली, पानी जैसी सुविधाओं के बिल
GENERIC_PARKING_PASS पार्किंग पास
GENERIC_VOUCHER वाउचर
GENERIC_GYM_MEMBERSHIP जिम की सदस्यता के कार्ड
GENERIC_LIBRARY_MEMBERSHIP लाइब्रेरी की सदस्यता वाले कार्ड
GENERIC_RESERVATIONS बुकिंग
GENERIC_AUTO_INSURANCE वाहन के बीमा कार्ड
GENERIC_HOME_INSURANCE घर का बीमा कार्ड
GENERIC_ENTRY_TICKET एंट्री टिकट
GENERIC_RECEIPT रसीदें
GENERIC_OTHER दूसरी तरह का

सूचनाएं

यह बताता है कि ऑब्जेक्ट को सूचना चालू करने की ज़रूरत है या नहीं. हम Expiryसूचना/ActionNotification में से सिर्फ़ एक की सुविधा देते हैं. expiryNotification को upcomingNotification से ज़्यादा प्राथमिकता दी जाती है. दूसरे शब्दों में, अगर expiryNotification सेट है, तो हम upcomingNotification फ़ील्ड को अनदेखा कर देते हैं.

JSON के काेड में दिखाना
{
  "expiryNotification": {
    object (ExpiryNotification)
  },
  "upcomingNotification": {
    object (UpcomingNotification)
  }
}
फ़ील्ड
expiryNotification

object (ExpiryNotification)

कार्ड की समयसीमा खत्म होने से पहले, सूचना एक तय समय पर ट्रिगर होगी.

upcomingNotification

object (UpcomingNotification)

कार्ड का इस्तेमाल करने लायक होने से पहले, एक खास समय पर एक सूचना ट्रिगर होगी.

ExpiryNotification

यह बताता है कि कार्ड जारी करने वाला बैंक चाहता है कि Google Wallet, कार्ड की समयसीमा खत्म होने से दो दिन पहले उसकी समयसीमा खत्म होने की सूचनाएं भेजे.

JSON के काेड में दिखाना
{
  "enableNotification": boolean
}
फ़ील्ड
enableNotification

boolean

यह बताता है कि ऑब्जेक्ट की समयसीमा खत्म होने की सूचना पाने की सुविधा को चालू करने की ज़रूरत है या नहीं.

UpcomingNotification

यह बताता है कि कार्ड जारी करने वाला बैंक चाहता है कि Google Wallet, कार्ड की समयसीमा खत्म होने से एक दिन पहले, कार्ड की समयसीमा के बारे में सूचना भेजे.

JSON के काेड में दिखाना
{
  "enableNotification": boolean
}
फ़ील्ड
enableNotification

boolean

यह बताता है कि ऑब्जेक्ट को आने वाली सूचना को चालू करने की ज़रूरत है या नहीं.

तरीके

addmessage

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

get

दिए गए ऑब्जेक्ट आईडी के साथ जेनरिक ऑब्जेक्ट दिखाता है.

insert

दिए गए आईडी और प्रॉपर्टी के साथ एक सामान्य ऑब्जेक्ट शामिल करता है.

list

दिए गए जारी करने वाले के आईडी के लिए, सभी सामान्य ऑब्जेक्ट की सूची दिखाता है.

patch

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

update

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