Method: projects.locations.list

Muestra información sobre las ubicaciones admitidas para este servicio.

solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación gRPC .

Parámetros de ruta

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 está documentado con más detalle en AIP-160 .

pageSize

integer

El número máximo de resultados que se devolverán. Si no se establece, el servicio selecciona un valor predeterminado.

pageToken

string

Un token de página recibido del campo nextPageToken en la respuesta. Envíe 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 respuesta

El mensaje de respuesta para Locations.ListLocations .

Si tiene éxito, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string
}
Campos
locations[]

object ( Location )

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

nextPageToken

string

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

Ámbitos de autorización

Requiere uno de los siguientes ámbitos de OAuth:

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

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