Method: projects.databases.collectionGroups.fields.list

Enumera la configuración de campo y los metadatos de esta base de datos.

Actualmente, FirestoreAdmin.ListFields solo admite campos de listado que se han anulado explícitamente. Para emitir esta consulta, llame a FirestoreAdmin.ListFields con el filtro configurado en indexConfig.usesAncestorConfig:false .

solicitud HTTP

GET https://firestore.googleapis.com/v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/fields

La URL utiliza la sintaxis de transcodificación gRPC .

Parámetros de ruta

Parámetros
parent

string

Un nombre principal del formulario projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}

Parámetros de consulta

Parámetros
filter

string

El filtro que se aplicará a los resultados de la lista. Actualmente, FirestoreAdmin.ListFields solo admite campos de listado que se han anulado explícitamente. Para emitir esta consulta, llame a FirestoreAdmin.ListFields con el filtro configurado en indexConfig.usesAncestorConfig:false .

pageSize

integer

El número de resultados que se devolverán.

pageToken

string

Un token de página, devuelto por una llamada anterior a FirestoreAdmin.ListFields , que puede usarse para obtener la siguiente página de resultados.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de respuesta

La respuesta para FirestoreAdmin.ListFields .

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

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

object ( Field )

Los campos solicitados.

nextPageToken

string

Un token de página que se puede utilizar para solicitar otra página de resultados. Si está en blanco, esta es la última página.

Á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 .