Method: attributes.list

यह फ़ंक्शन, उन एट्रिब्यूट की सूची दिखाता है जो किसी जगह के लिए उपलब्ध होंगे. इसके लिए, जगह की प्राइमरी कैटगरी और देश की जानकारी देना ज़रूरी है.

एचटीटीपी अनुरोध

GET https://mybusinessbusinessinformation.googleapis.com/v1/attributes

यह यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

क्वेरी पैरामीटर

पैरामीटर
parent

string

ज़रूरी नहीं. उपलब्ध एट्रिब्यूट देखने के लिए, जगह का संसाधन नाम. अगर यह फ़ील्ड सेट है, तो categoryName, regionCode, languageCode, और showAll की ज़रूरत नहीं है. साथ ही, इन्हें सेट नहीं किया जाना चाहिए.

फ़ॉर्मैट: locations/{locationId} (जैसे, locations/1234567890).
categoryName

string

ज़रूरी नहीं. उपलब्ध एट्रिब्यूट ढूंढने के लिए, प्राइमरी कैटगरी का स्टेबल आईडी. यह categories/{category_id} फ़ॉर्मैट में होना चाहिए (उदाहरण के लिए, categories/gcid:restaurant). अगर parent सेट नहीं है और showAll की वैल्यू 'गलत' है, तो यह ज़रूरी है.
regionCode

string

ज़रूरी नहीं. उपलब्ध एट्रिब्यूट ढूंढने के लिए, ISO 3166-1 ऐल्फ़ा-2 देश का कोड. अगर parent को सेट नहीं किया गया है, तो यह ज़रूरी है.
languageCode

string

ज़रूरी नहीं. एट्रिब्यूट के डिसप्ले नेम पाने के लिए, भाषा का BCP 47 कोड. अगर यह भाषा उपलब्ध नहीं है, तो ये अंग्रेज़ी में उपलब्ध कराए जाएंगे.
showAll

boolean

ज़रूरी नहीं. अगर इसे 'सही है' पर सेट किया जाता है, तो parent और categoryName फ़ील्ड को अनदेखा करके, सभी उपलब्ध एट्रिब्यूट का मेटाडेटा दिखाया जाता है. showAll को 'सही है' पर सेट करने के बाद, languageCode और regionCode को सेट करना ज़रूरी है.
pageSize

integer

हर पेज पर कितने एट्रिब्यूट शामिल करने हैं. डिफ़ॉल्ट संख्या 200 है और कम से कम संख्या 1 है.
pageToken

string

अगर इसकी जानकारी दी गई है, तो एट्रिब्यूट के मेटाडेटा का अगला पेज वापस पाया जाता है.

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

AttributesService.ListAttributeMetadata के लिए जवाब.

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

JSON फ़ॉर्मैट में दिखाया गया है 
{
  "attributeMetadata": [
    {
      object (AttributeMetadata)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
attributeMetadata[]

object (AttributeMetadata)

उपलब्ध एट्रिब्यूट के लिए, एट्रिब्यूट मेटाडेटा का कलेक्शन.
nextPageToken

string

अगर एट्रिब्यूट की संख्या, अनुरोध किए गए पेज साइज़ से ज़्यादा है, तो इस फ़ील्ड में एक टोकन अपने-आप भर जाएगा. इससे attributes.list को किए जाने वाले अगले कॉल पर, एट्रिब्यूट के अगले पेज को फ़ेच किया जा सकेगा. अगर कोई और एट्रिब्यूट नहीं है, तो यह फ़ील्ड जवाब में मौजूद नहीं होगा.

अनुमति पाने के लिंक

नीचे दिए गए OAuth अनुमति की ज़रूरत हाेती है:

  • https://www.googleapis.com/auth/business.manage

ज़्यादा जानकारी के लिए, OAuth 2.0 Overview देखें.

AttributeMetadata

किसी एट्रिब्यूट का मेटाडेटा. इसमें एट्रिब्यूट के लिए डिसप्ले की जानकारी शामिल होती है. इसमें स्थानीय भाषा में नाम और मिलते-जुलते एट्रिब्यूट को एक साथ ग्रुप करने के लिए हेडिंग शामिल होती है.

JSON के काेड में दिखाना 
{
  "parent": string,
  "valueType": enum (AttributeValueType),
  "displayName": string,
  "groupDisplayName": string,
  "repeatable": boolean,
  "valueMetadata": [
    {
      object (AttributeValueMetadata)
    }
  ],
  "deprecated": boolean
}
फ़ील्ड
parent

string

एट्रिब्यूट के लिए यूनीक आइडेंटिफ़ायर.
valueType

enum (AttributeValueType)

एट्रिब्यूट के लिए वैल्यू का टाइप. सेट और वापस पाई गई वैल्यू, इस टाइप की होनी चाहिए.
displayName

string

अगर उपलब्ध हो, तो एट्रिब्यूट का स्थानीय भाषा में डिसप्ले नेम; अगर उपलब्ध न हो, तो अंग्रेज़ी में डिसप्ले नेम.
groupDisplayName

string

इस एट्रिब्यूट वाले ग्रुप का स्थानीय भाषा में डिसप्ले नेम, अगर उपलब्ध हो. ऐसा न होने पर, ग्रुप का नाम अंग्रेज़ी में दिखेगा. एक जैसे एट्रिब्यूट को एक ग्रुप में इकट्ठा किया जाता है. साथ ही, उन्हें यहां दी गई हेडिंग के तहत एक साथ दिखाया जाना चाहिए.
repeatable

boolean

अगर यह वैल्यू true है, तो एट्रिब्यूट के लिए एक से ज़्यादा वैल्यू इस्तेमाल की जा सकती हैं. अगर यह वैल्यू false है, तो सिर्फ़ एक वैल्यू दी जानी चाहिए.
valueMetadata[]

object (AttributeValueMetadata)

कुछ तरह के एट्रिब्यूट (उदाहरण के लिए, enum) के लिए, इस्तेमाल की जा सकने वाली वैल्यू और उनसे जुड़े डिसप्ले नेम की सूची दी जाती है.
deprecated

boolean

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

AttributeValueMetadata

इस्तेमाल की जा सकने वाली एट्रिब्यूट की वैल्यू के लिए मेटाडेटा.

JSON के काेड में दिखाना 
{
  "value": value,
  "displayName": string
}
फ़ील्ड
value

value (Value format)

एट्रिब्यूट की वैल्यू.
displayName

string

इस वैल्यू का डिसप्ले नेम. अगर उपलब्ध हो, तो स्थानीय भाषा में; नहीं तो अंग्रेज़ी में. वैल्यू के डिसप्ले नेम का इस्तेमाल, एट्रिब्यूट के डिसप्ले नेम के साथ किया जाता है.

उदाहरण के लिए, "वाई-फ़ाई" enum एट्रिब्यूट के लिए, इसमें "पैसे चुकाकर" शामिल हो सकता है. इससे पता चलता है कि वाई-फ़ाई की सुविधा के लिए पैसे चुकाने होंगे.