Attention: v4.7 of the API has released! See change log. Posts related to COVID-19 are still temporarily permitted for chains.

Method: categories.list

Returns a list of business categories. Search will match the category name but not the category ID.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
regionCode

string

The ISO 3166-1 alpha-2 country code.

languageCode

string

The BCP 47 code of language. If the language is not available, it will default to English.

searchTerm

string

Optional filter string from user.

pageSize

integer

How many categories to fetch per page. Default is 100, minimum is 1, and maximum page size is 100.

pageToken

string

If specified, the next page of categories will be fetched.

view

enum (CategoryView)

Optional. Specifies which parts to the Category resource should be returned in the response.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{
  "categories": [
    {
      object (Category)
    }
  ],
  "totalCategoryCount": integer,
  "nextPageToken": string
}
Fields
categories[]

object (Category)

The categories. Categories are BASIC view. They don't contain any ServiceType information.

totalCategoryCount

integer

The total number of categories for the request parameters.

nextPageToken

string

If the number of categories exceeded the requested page size, this field will be populated with a token to fetch the next page of categories on a subsequent call to categories.list.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the OAuth 2.0 Overview.