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

Parámetros
parent

string

Obligatorio. Es el nombre de la cuenta de la que se recuperarán las ubicaciones.

  • ID de cuenta específico: Si la cuenta es del tipo AccountType.PERSONAL, la respuesta solo devuelve las ubicaciones que pertenecen directamente a esa cuenta. Para todos los demás tipos (p.ej., AccountType.LOCATION_GROUP), devuelve todas las ubicaciones accesibles.

  • Comodín (-): El uso de accounts/- identifica al usuario autenticado. Este alcance se establece de forma predeterminada en AccountType.PERSONAL, pero incluye las ubicaciones de propiedad directa e indirecta (p.ej., aquellas a las que se puede acceder a través de grupos de miembros).

Parámetros de consulta

Parámetros
pageSize

integer

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

string

Opcional. Si se especifica, recupera el siguiente page de ubicaciones. Las llamadas anteriores a locations.list devuelven el token de página cuando hay más ubicaciones de las que caben en el tamaño de página solicitado.
filter

string

Opcional. Es un filtro que restringe las ubicaciones que se mostrarán. La respuesta solo incluye las 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 ejemplos de uso, consulta la guía para trabajar con datos de ubicación.
orderBy

string

Opcional. Es el orden de clasificación de la solicitud. Si hay varios campos, deben estar separados por comas, según la sintaxis de SQL. El orden de clasificación predeterminado es ascendente. Para especificar el orden descendente, se debe agregar el sufijo " desc". Los campos válidos para orderBy son title y storeCode. Por ejemplo: "title, storeCode desc", "title" o "storeCode desc"
readMask

string (FieldMask format)

Obligatorio. Es la 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 supera el tamaño de página solicitado, este campo se propaga con un token para recuperar la siguiente página de ubicaciones en una llamada posterior a locations.list. Si no hay más ubicaciones, este campo no está presente en la respuesta.
totalSize

integer

Es la cantidad aproximada de ubicaciones en la lista, independientemente de la paginación. Este campo solo se devolverá si se usa filter como parámetro de consulta.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

Para obtener más información, consulta OAuth 2.0 Overview.