Method: attributes.list

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

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

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

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

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

पैरामीटर
parent

string

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

string

उपलब्ध एट्रिब्यूट को खोजने के लिए, मुख्य कैटगरी का स्थायी आईडी. फ़ॉर्मैट की कैटगरी/{category_id} में होनी चाहिए.
regionCode

string

उपलब्ध एट्रिब्यूट खोजने के लिए, ISO 3166-1 alpha-2 देश कोड.
languageCode

string

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

boolean

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

integer

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

string

अगर बताया गया है, तो एट्रिब्यूट मेटाडेटा का अगला पेज फिर से लाया जाता है.

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

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

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

AttributesService.ListAttributeMetadata के लिए रिस्पॉन्स.

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

जेएसओएन के काेड में दिखाना 
{
  "attributeMetadata": [
    {
      object (AttributeMetadata)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
attributeMetadata[]

object (AttributeMetadata)

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

string

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

अनुमति देने के दायरे

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

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

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

AttributeMetadata

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

जेएसओएन के काेड में दिखाना 
{
  "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

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

object (AttributeValueMetadata)

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

boolean

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

AttributeValueMetadata

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

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

value (Value format)

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

string

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

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