Se usó la API de Cloud Translation para traducir esta página.
Switch to English

Método: projects.databases.collectionGroups.fields.list

Enumera la configuración de campo y los metadatos para 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 establecido 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/{project_id}/databases/{database_id}/collectionGroups/{collectionId}

Parámetros de consulta

Parámetros
filter

string

El filtro para 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 establecido en indexConfig.usesAncestorConfig:false .

pageSize

integer

El número de resultados a devolver.

pageToken

string

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

Cuerpo de solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de respuesta

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

La respuesta para FirestoreAdmin.ListFields .

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

object ( Field )

Los campos solicitados.

nextPageToken

string

Un token de página que puede usarse 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 la Descripción general de la autenticación .