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

Método: projects.databases.documents.list

Listas de documentos.

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación gRPC .

Parámetros de ruta

Parámetros
parent

string

Necesario. El nombre del recurso principal. En el formato: projects/{project_id}/databases/{database_id}/documents o projects/{project_id}/databases/{database_id}/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

Necesario. El ID de la colección, relativo al parent , a la lista. Por ejemplo: chatrooms o messages .

Parámetros de consulta

Parámetros
pageSize

integer

El número máximo de documentos a devolver.

pageToken

string

El valor nextPageToken devuelto de una solicitud de Lista anterior, si existe.

orderBy

string

El orden para ordenar los resultados. Por ejemplo: priority desc, name .

mask

object ( DocumentMask )

Los campos para volver. 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.

showMissing

boolean

Si la lista muestra documentos faltantes. Un documento que falta es un documento que no existe pero que tiene subdocumentos. Estos documentos se devolverán con una clave pero no tendrán campos, Document.create_time o Document.update_time establecidos.

Las solicitudes con showMissing pueden no especificar where u orderBy .

Parámetro de unión consistency_selector . El modo de coherencia para esta transacción. Si no se establece, el valor predeterminado es una consistencia fuerte. consistency_selector puede ser solo uno de los siguientes:
transaction

string ( bytes format)

Lee documentos en una transacción.

Una cadena codificada en base64.

readTime

string ( Timestamp format)

Lee los documentos tal como estaban en el momento dado. Esto no puede ser anterior a 270 segundos.

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

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 Firestore.ListDocuments .

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

object ( Document )

Los documentos encontrados.

nextPageToken

string

El token de la página siguiente.

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