REST Resource: genericobject

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

जेनरिक ऑब्जेक्ट अगला आईडी: 121

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

enum (GenericType)

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

cardTitle

object (LocalizedString)

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

subheader

object (LocalizedString)

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

header

object (LocalizedString)

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

hexBackgroundColor

string

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

notifications

object (Notifications)

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

id

string

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

classId

string

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

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

barcode

object (Barcode)

बारकोड का टाइप और वैल्यू. अगर पास में बारकोड नहीं है, तो हम जारी करने वाले को Barcode.alternate_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)

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

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सूचनाएं/आने वाली सूचना में से सिर्फ़ एक के लिए सहायता उपलब्ध कराते हैं. expiryNotification को upcomingNotification की जगह प्राथमिकता दी जाती है. दूसरे शब्दों में, अगर expiryNotification सेट है, तो हम upcomingNotification फ़ील्ड को अनदेखा कर देते हैं.

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

object (ExpiryNotification)

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

upcomingNotification

object (UpcomingNotification)

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

ExpiryNotification

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

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

boolean

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

UpcomingNotification

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

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

boolean

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

तरीके

get

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

insert

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

list

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

patch

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

update

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