Method: projects.databases.documents.listDocuments

string

Requerido. El nombre del recurso principal. En el formato: projects/{projectId}/databases/{databaseId}/documents o projects/{projectId}/databases/{databaseId}/documents/{document_path} .

Por ejemplo: projects/my-project/databases/my-database/documents o projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

string

Opcional. El ID de la colección, relativo al parent , para enumerar.

Por ejemplo: chatrooms o messages .

Esto es opcional y, cuando no se proporciona, Firestore enumerará los documentos de todas las colecciones bajo el parent proporcionado.

integer

Opcional. El número máximo de documentos a devolver en una sola respuesta.

Firestore puede devolver menos que este valor.

string

Opcional. Un token de página, recibido de una respuesta anterior documents.list .

Proporcione esto para recuperar la página siguiente. Al paginar, todos los demás parámetros (con excepción de pageSize ) deben coincidir con los valores establecidos en la solicitud que generó el token de página.

string

Opcional. La ordenación facultativa de los documentos a devolver.

Por ejemplo: priority desc, __name__ desc .

Esto refleja el ORDER BY utilizado en las consultas de Firestore pero en una representación de cadena. Cuando están ausentes, los documentos se ordenan según __name__ ASC .

object ( DocumentMask )

Opcional. Los campos a devolver. Si no se establece, devuelve todos los campos.

Si un documento tiene un campo que no está presente en esta máscara, ese campo no se devolverá en la respuesta.

boolean

Si la lista muestra documentos faltantes.

Falta un documento si no existe, pero hay subdocumentos anidados debajo de él. Cuando sea verdadero, dichos documentos faltantes se devolverán con una clave, pero no tendrán campos, createTime o updateTime establecidos.

Es posible que las solicitudes con showMissing no especifiquen where ni orderBy .

string ( bytes format)

Realice la lectura como parte de una transacción ya activa.

Una cadena codificada en base64.

string ( Timestamp format)

Realice la lectura a la hora indicada.

Debe ser una marca de tiempo con precisión de microsegundos dentro de la última hora o, si la recuperación de un punto en el tiempo está habilitada, también puede ser una marca de tiempo de un minuto completo dentro de los últimos 7 días.

Una marca de tiempo en formato RFC3339 UTC "Zulu", con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z" .