Method: accounts.locations.list

Muestra una lista de las ubicaciones de la cuenta especificada.

Solicitud HTTP

GET https://mybusinessbusinessinformation.googleapis.com/v1/{parent=accounts/*}/locations

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

Parámetros de ruta de acceso

Parámetros
parent

string

Obligatorio. Es el nombre de la cuenta de la que se recuperarán las ubicaciones. Si el publicador superior [Account] [google.mybusiness.accountmanagement.v1.Account] es [AccountType]. [google.mybusiness.accountmanagement.v1.Account.AccountType] PERSONAL, solo se devuelven las Ubicaciones que pertenecen directamente a la Cuenta; de lo contrario, devolverá todas las ubicaciones a las que se puede acceder desde la Cuenta, ya sea directa o indirectamente.

Parámetros de consulta

Parámetros
pageSize

integer

Opcional. Cantidad de ubicaciones para recuperar por página El valor predeterminado es 10 si no se configura. El mínimo es 1 y el tamaño máximo de la página es 100.
pageToken

string

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

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

string

Opcional. 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 title y storeCode. Por ejemplo: “título, código de tienda; descripción” o "título" o "storeCode desc"
readMask

string (FieldMask format)

Obligatorio. Máscara de lectura para especificar qué campos se mostrarán en la respuesta.

Esta es una lista separada por comas de los nombres de campos totalmente calificados. Ejemplo: "user.displayName,photo".

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Mensaje de respuesta para locations.ListLocations.

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

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. Este campo solo se mostrará si se usa filter como parámetro de consulta.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

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