Method: categories.list

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

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

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

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

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

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

पैरामीटर
regionCode

string

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

string

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

string

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

integer

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

string

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

enum (CategoryView)

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

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

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

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

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

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

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

object (Category)

अनुरोध किए गए पैरामीटर पर आधारित मिलती-जुलती कैटगरी.
nextPageToken

string

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

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

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

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

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