Method: categories.list

Muestra una lista de categorías de empresa. La búsqueda coincidirá con el nombre de la categoría, pero no con el ID de la categoría.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de consulta

Parámetros
regionCode

string

Es el código de país ISO 3166-1 alpha-2.

languageCode

string

Es el código de lenguaje BCP 47. Si el idioma no está disponible, se usará el inglés de forma predeterminada.

searchTerm

string

Es la cadena de filtro opcional del usuario.

pageSize

integer

La cantidad de categorías que se deben recuperar por página El valor predeterminado es 100, el mínimo es 1 y el tamaño máximo de la página es 100.

pageToken

string

Si se especifica, se recuperará la siguiente página de categorías.

view

enum (CategoryView)

Opcional. Especifica qué partes del recurso Category se deben mostrar en la respuesta.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si el proceso es satisfactorio, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON
{
  "categories": [
    {
      object (Category)
    }
  ],
  "totalCategoryCount": integer,
  "nextPageToken": string
}
Campos
categories[]

object (Category)

Las categorías. Las categorías son la vista BÁSICA. No contienen información de ServiceType.

totalCategoryCount

integer

La cantidad total de categorías para los parámetros de la solicitud.

nextPageToken

string

Si la cantidad de categorías superó el tamaño de página solicitado, este campo se completará con un token para recuperar la página siguiente de categorías en una llamada posterior a categories.list.

Alcances de la autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.