Method: categories.list

कारोबार की कैटगरी की सूची दिखाता है. खोज, कैटगरी के नाम से मैच होगी, लेकिन कैटगरी आईडी से नहीं.

खोज सिर्फ़ कैटगरी के नाम के सामने वाले हिस्से से मेल खाती है. इसका मतलब है कि 'फ़ूड' में 'फ़ूड कोर्ट' दिख सकता है, लेकिन 'फ़ास्ट फ़ूड रेस्टोरेंट' नहीं.

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

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

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

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

पैरामीटर
regionCode

string

ज़रूरी है. ISO 3166-1 ऐल्फ़ा-2 देश का कोड.
languageCode

string

ज़रूरी है. भाषा का BCP 47 कोड.
filter

string

ज़रूरी नहीं. उपयोगकर्ता से मिली स्ट्रिंग को फ़िल्टर करें. सिर्फ़ displayName फ़ील्ड का इस्तेमाल किया जा सकता है. उदाहरण: filter=displayName=foo.
pageSize

integer

ज़रूरी नहीं. हर पेज पर कितनी कैटगरी फ़ेच की जा सकती हैं. डिफ़ॉल्ट वैल्यू 100, कम से कम वैल्यू, और ज़्यादा से ज़्यादा साइज़ 100 है.
pageToken

string

ज़रूरी नहीं. अगर बताया गया, तो कैटगरी का अगला पेज फ़ेच किया जाएगा.
view

enum (CategoryView)

ज़रूरी है. इससे पता चलता है कि रिस्पॉन्स में कैटगरी रिसॉर्स के कौनसे हिस्से दिखाए जाने चाहिए.

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

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

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

Businessकैटगरी.Listकैटगरी के लिए जवाब देने वाला मैसेज.

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

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

object (Category)

अनुरोध किए गए पैरामीटर के आधार पर मैच करने वाली कैटगरी.
nextPageToken

string

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

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

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

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

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