Method: projects.databases.collectionGroups.fields.list

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

Actualmente, FirestoreAdmin.ListFields solo admite campos de lista que se anularon de forma explícita. Para emitir esta consulta, llama a FirestoreAdmin.ListFields con el filtro configurado como indexConfig.usesAncestorConfig:false o ttlConfig:*.

Solicitud HTTP

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

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

Parámetros de ruta de acceso

Parámetros
parent

string

Obligatorio. Un nombre superior con el formato projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}

Parámetros de consulta

Parámetros
filter

string

El filtro que se aplica a los resultados de la lista. Actualmente, FirestoreAdmin.ListFields solo admite campos de lista que se anularon de forma explícita. Para emitir esta consulta, llama a FirestoreAdmin.ListFields con un filtro que incluya indexConfig.usesAncestorConfig:false o ttlConfig:*.
pageSize

integer

La cantidad de resultados que se mostrarán.
pageToken

string

Un token de página, que se muestra de una llamada anterior a FirestoreAdmin.ListFields, que se puede usar para obtener la siguiente página de resultados.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

La respuesta para FirestoreAdmin.ListFields.

Si se ejecuta correctamente, 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 usar para solicitar otra página de resultados. Si se deja en blanco, se trata de la última página.

Alcances de autorización

Se necesita uno de los siguientes permisos 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.