- Solicitud HTTP
- Parámetros de ruta de acceso
- Parámetros de consulta
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Alcances de la autorización
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 |
El nombre de la cuenta desde la que se recuperan las ubicaciones. Si |
Parámetros de consulta
Parámetros | |
---|---|
pageSize |
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 |
Si se especifica, recupera la siguiente |
filter |
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. |
languageCode |
Es el código de idioma BCP 47 en el que se deben mostrar las propiedades de ubicación. Si este idioma no está disponible, se proporcionará en el idioma de la ubicación. Si ninguno está disponible, se ofrecerán en inglés. Ya no está disponible. Después del 15 de agosto de 2020, ya no se aplicará este campo. Sin embargo, siempre se utilizará el idioma de la ubicación. |
orderBy |
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 locationName y storeCode. Por ejemplo: "locationName, storeCode desc" o "locationName" 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 ( |
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. |
Alcances de la autorización
Se necesita uno de los siguientes alcances 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.