Method: categories.list

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

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

GET https://mybusiness.googleapis.com/v4/categories

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

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

पैरामीटर
regionCode

string

आईएसओ 3166-1 ऐल्फ़ा-2 देश का कोड.

languageCode

string

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

searchTerm

string

उपयोगकर्ता से मिली वैकल्पिक फ़िल्टर स्ट्रिंग.

pageSize

integer

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

pageToken

string

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

view

enum (CategoryView)

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

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

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

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

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

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

object (Category)

कैटगरी. कैटगरी, BASIC व्यू के तौर पर उपलब्ध हैं. उसमें ServiceType से जुड़ी कोई जानकारी नहीं है.

totalCategoryCount

integer

अनुरोध पैरामीटर के लिए कैटगरी की कुल संख्या.

nextPageToken

string

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

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

इनमें से कोई एक OAuth स्कोप ज़रूरी है:

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

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