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 के लिए जवाब दिया गया है.

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

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

object (AttributeMetadata)

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

string

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

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

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

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

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

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

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

object (AttributeValueMetadata)

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

boolean

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

AttributeValueMetadata

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

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

value (Value format)

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

string

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

उदाहरण के लिए, "वाई-फ़ाई" के लिए enum विशेषता शामिल है, इसमें "भुगतान किया गया" हो सकता है का इस्तेमाल करें.