Method: categories.list

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

A pesquisa corresponde apenas à frente do nome de uma categoria (ou seja, 'comida' pode retornar 'Praça de Alimentação', mas não 'Restaurante fast food').

Solicitação HTTP

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

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

Parâmetros de consulta

Parâmetros
regionCode

string

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

languageCode

string

Obrigatório. O código de idioma BCP 47.

filter

string

Opcional. String de filtro do usuário. O único campo aceito é displayName. Por exemplo: filter=displayName=foo.

pageSize

integer

Opcional. 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

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

view

enum (CategoryView)

Obrigatório. 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

Mensagem de resposta para BusinessCategories.ListCategories.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

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

object (Category)

As categorias correspondentes com base nos parâmetros solicitados.

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 o seguinte escopo OAuth:

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

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