Method: projects.databases.documents.list

Muestra una lista de documentos.

Solicitud HTTP

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

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

Parámetros de ruta de acceso

Parámetros
parent

string

Obligatorio. El nombre del recurso superior. 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.
collectionId

string

Opcional. El ID de colección, en relación con parent, para la lista.

Por ejemplo, chatrooms o messages.

Esto es opcional y, cuando no se proporcione, Firestore mostrará una lista de los documentos de todas las colecciones en el parent proporcionado.

Parámetros de consulta

Parámetros
pageSize

integer

Opcional. La cantidad máxima de documentos que se mostrarán en una sola respuesta.

Firestore puede mostrar menos que este valor.
pageToken

string

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

Proporciona esto para recuperar la página siguiente. Cuando se realiza la paginación, todos los demás parámetros (excepto pageSize) deben coincidir con los valores establecidos en la solicitud que generó el token de la página.
orderBy

string

Opcional. El orden opcional de los documentos que se mostrarán.

Por ejemplo: priority desc, __name__ desc.

Esto duplica el ORDER BY que se usa en las consultas de Firestore, pero en una representación de string. Cuando está ausente, los documentos se ordenan según __name__ ASC.
mask

object (DocumentMask)

Opcional. Los campos que se deben mostrar. Si no se configura, muestra todos los campos.

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

boolean

Si la lista debe mostrar los documentos que faltan.

Falta un documento si no existe, pero hay subdocumentos anidados debajo. Si es verdadero, los documentos faltantes se mostrarán con una clave, pero no tendrán campos ni campos createTime ni updateTime configurados.

Las solicitudes con showMissing no pueden especificar where ni orderBy.
Es el parámetro de unión consistency_selector. El modo de coherencia para esta transacción. Si no está configurado, se establece de forma predeterminada para una coherencia sólida. Las direcciones (consistency_selector) solo pueden ser una de las siguientes opciones:
transaction

string (bytes format)

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

String codificada en base64.
readTime

string (Timestamp format)

Realiza la lectura en el momento indicado.

Debe ser una marca de tiempo con precisión de microsegundos dentro de la última hora o, si está habilitada la recuperación de un momento determinado, 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 “Zulú”, con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de ListDocumentsResponse.

Permisos de autorización

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