Method: accounts.locations.list

Muestra una lista de las ubicaciones de la cuenta especificada.

Solicitud HTTP

GET https://mybusiness.googleapis.com/v4/{parent=accounts/*}/locations

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

Parámetros de ruta de acceso

Parámetros
parent

string

Es el nombre de la cuenta de la que se recuperarán las ubicaciones. Si la Account es de AccountType PERSONAL, solo se devuelven las Ubicaciones que son propiedad de la Cuenta de forma directa; de lo contrario, se devolverán todas las ubicaciones accesibles desde la Cuenta, ya sea directa o indirectamente.

Parámetros de consulta

Parámetros
pageSize

integer

Cantidad de ubicaciones para 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, recupera la siguiente page de ubicaciones. Las llamadas anteriores a locations.list muestran el token de página cuando había más ubicaciones de las que podían caber en el tamaño de página solicitado.
filter

string

Un filtro que restringe la devolución de las ubicaciones. La respuesta solo incluye entradas que coinciden con el filtro. Si filter está vacío, se aplican restricciones y se recuperan todas las ubicaciones (paginadas) de la cuenta solicitada.

Para obtener más información sobre los campos válidos y un ejemplo de uso, consulta la guía Trabaja con datos de ubicación.
languageCode
(deprecated)

string

Es el código de idioma BCP 47 para mostrar las propiedades de ubicación. Si este idioma no está disponible, se proporcionarán en el idioma de la ubicación. Si no están disponibles, se proporcionarán en inglés.

Obsoleta. Este campo dejará de aplicarse después del 15 de agosto de 2020. En cambio, siempre se usará el idioma de la ubicación.
orderBy

string

Orden de clasificación de la solicitud. Si hay varios campos, deben estar separados por comas, según la sintaxis de SQL. El orden predeterminado es ascendente. Para especificar el orden descendente, se debe agregar un sufijo " desc" que se debe agregar. Los campos válidos para orderBy son locationName y storeCode. Por ejemplo: “nombreubicación, códigotiendadesc” o "nombredeubicación" o "storeCode desc"

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Mensaje de respuesta para locations.ListLocations.

Representación JSON 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Campos
locations[]

object (Location)

Las ubicaciones.
nextPageToken

string

Si la cantidad de ubicaciones superó el tamaño de página solicitado, este campo se completa con un token para recuperar la página siguiente de ubicaciones en una llamada posterior a locations.list. Si no hay más ubicaciones, este campo no se mostrará en la respuesta.
totalSize

integer

Cantidad aproximada de ubicaciones en la lista, independientemente de la paginación.

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.