- Solicitação HTTP
- Parâmetros de consulta
- Corpo da solicitação
- Corpo da resposta
- Escopos da autorização
Retorna uma lista de categorias de negócios. A pesquisa vai 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 |
O código de país ISO 3166-1 alfa-2. |
languageCode |
O código de idioma BCP 47. Se o idioma não estiver disponível, o padrão será o inglês. |
searchTerm |
String de filtro opcional do usuário. |
pageSize |
Quantas categorias serão buscadas por página. O padrão é 100, o mínimo é 1 e o tamanho máximo da página é 100. |
pageToken |
Se especificado, a próxima página de categorias será buscada. |
view |
Opcional. Especifica quais partes do recurso Category devem 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 ( |
Campos | |
---|---|
categories[] |
As categorias. As categorias são exibidas como BÁSICA. Eles não contêm informações de ServiceType. |
totalCategoryCount |
O número total de categorias para os parâmetros de solicitação. |
nextPageToken |
Se o número de categorias exceder o tamanho de página solicitado, esse campo será preenchido com um token para buscar a próxima página de categorias em uma chamada subsequente para |
Escopos de autorização
Requer um dos seguintes escopos do 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.