- Solicitud HTTP
- Parámetros de ruta de acceso
- Parámetros de consulta
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
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 |
Obligatorio. El nombre de la cuenta desde la que se recuperan las ubicaciones. Si la cuenta principal de [Account] [google.mybusiness.accountmanagement.v1.Account] es [AccountType] [google.mybusiness.accountmanagement.v1.Account.AccountType] PERSONAL, solo se mostrarán las ubicaciones que son propiedad directa de la cuenta. De lo contrario, se mostrarán todas las ubicaciones a las que se pueda acceder desde la cuenta, ya sea de forma directa o indirecta. |
Parámetros de consulta
Parámetros | |
---|---|
pageSize |
Opcional. Cantidad de ubicaciones para recuperar por página. Si no se establece, el valor predeterminado es 10. El mínimo es 1 y el tamaño máximo de la página es 100. |
pageToken |
Opcional. Si se especifica, recupera la siguiente |
filter |
Opcional. Un filtro que restringe las ubicaciones que se mostrarán. La respuesta solo incluye entradas que coinciden con el filtro. Si Para obtener más información sobre los campos válidos y ejemplos de uso, consulta la Guía Trabajar con datos de ubicación. |
orderBy |
Opcional. Orden de clasificación para la solicitud. Los campos múltiples deben estar separados por comas, siguiendo la sintaxis 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" o "title" o "storeCode desc" |
readMask |
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 completamente calificados. Ejemplo: |
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 ( |
Campos | |
---|---|
locations[] |
Las ubicaciones. |
nextPageToken |
Si la cantidad de ubicaciones superó el tamaño de la página solicitada, este campo se propaga con un token para recuperar la página de ubicaciones siguiente en una llamada posterior a |
totalSize |
La cantidad aproximada de ubicaciones de la lista, sin importar la paginación. Este campo solo se mostrará si se usa |
Permisos 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.