Method: categories.list

Retorna uma lista de categorias de negócios. A busca corresponderá ao nome da categoria, mas não ao ID dela.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de consulta

Parâmetros
regionCode

string

O código de país ISO 3166-1 alfa-2.

languageCode

string

O código de idioma BCP 47. Se o idioma não estiver disponível, o padrão será o inglês.

searchTerm

string

String de filtro opcional do usuário.

pageSize

integer

Quantas categorias precisam ser buscadas por página. O padrão é 100, o mínimo é 1, e o tamanho máximo da página é 100.

pageToken

string

Se especificado, a próxima página de categorias será buscada.

view

enum (CategoryView)

Opcional. Especifica quais partes do recurso Categoria precisam ser retornadas na resposta.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se bem-sucedido, o corpo da resposta exibirá os dados com a seguinte estrutura:

Representação JSON
{
  "categories": [
    {
      object (Category)
    }
  ],
  "totalCategoryCount": integer,
  "nextPageToken": string
}
Campos
categories[]

object (Category)

As categorias. As categorias são a visualização BÁSICA. Eles não contêm informações de ServiceType.

totalCategoryCount

integer

O número total de categorias dos parâmetros de solicitação.

nextPageToken

string

Se o número de categorias exceder o tamanho da página solicitado, esse campo será preenchido com um token para buscar a próxima página de categorias em uma chamada subsequente para categories.list.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.