Method: projects.locations.list

Permite mostrar una lista con información sobre las ubicaciones compatibles con este servicio.

Solicitud HTTP

GET https://firestore.googleapis.com/v1/{name=projects/*}/locations

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

Parámetros de ruta de acceso

Parámetros
name

string

El recurso propietario de la colección de ubicaciones, si corresponde.

Parámetros de consulta

Parámetros
filter

string

Un filtro para limitar los resultados a un subconjunto preferido. El lenguaje de filtrado acepta cadenas como "displayName=tokyo" y se documenta con más detalle en AIP-160.
pageSize

integer

La cantidad máxima de resultados que se mostrarán. Si no la estableces, el servicio seleccionará un valor predeterminado.
pageToken

string

Un token de página recibido del campo nextPageToken de la respuesta. Envía ese token de página para recibir la página siguiente.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

El 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
}
Campos
locations[]

object (Location)

Una lista de ubicaciones que coincide con el filtro especificado en la solicitud.
nextPageToken

string

El token de página siguiente de lista estándar.

Permisos de autorización

Se necesita uno de los siguientes alcances de OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Descripción general de la autenticación.