Attention: There will be major changes to the API soon that will require migration work. Please check our upcoming releases page and deprecation schedule frequently for updates. You may also sign up for our mailing list to receive updates.

Method: categories.list

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

Search only matches the front of a category name (that is, 'food' may return 'Food Court' but not 'Fast Food Restaurant').

HTTP request

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

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
regionCode

string

Required. The ISO 3166-1 alpha-2 country code.

languageCode

string

Required. The BCP 47 code of language.

filter

string

Optional. Filter string from user. The only field that supported is displayName. Eg: filter=displayName=foo.

pageSize

integer

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

pageToken

string

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

view

enum (CategoryView)

Required. 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:

Response message for BusinessCategories.ListCategories.

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

object (Category)

The matching categories based on the requested 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 the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.