Method: projects.databases.documents.listDocuments

Elenca i documenti.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatoria. Il nome della risorsa padre. Nel formato: projects/{projectId}/databases/{databaseId}/documents o projects/{projectId}/databases/{databaseId}/documents/{document_path}.

Ad esempio: projects/my-project/databases/my-database/documents o projects/my-project/databases/my-database/documents/chatrooms/my-chatroom
collectionId

string

Campo facoltativo. L'ID raccolta, relativo a parent, dell'elenco.

Ad esempio: chatrooms o messages.

Questo campo è facoltativo e, se non viene fornito, Firestore elencherà i documenti di tutte le raccolte che rientrano nell'attributo parent fornito.

Parametri di ricerca

Parametri
pageSize

integer

Campo facoltativo. Il numero massimo di documenti da restituire in una singola risposta.

Firestore potrebbe restituire un numero inferiore a questo valore.
pageToken

string

Campo facoltativo. Un token di pagina, ricevuto da una precedente risposta documents.list.

Specifica questo valore per recuperare la pagina successiva. Durante l'impaginazione, tutti gli altri parametri (ad eccezione di pageSize) devono corrispondere ai valori impostati nella richiesta che ha generato il token della pagina.
orderBy

string

Campo facoltativo. L'ordine facoltativo dei documenti da restituire.

Ad esempio: priority desc, __name__ desc.

Questo rispecchia il valore ORDER BY utilizzato nelle query di Firestore, ma in una rappresentazione stringa. Se non sono presenti, i documenti vengono ordinati in base a __name__ ASC.
mask

object (DocumentMask)

Campo facoltativo. I campi da restituire. Se non viene configurato, restituisce tutti i campi.

Se un documento ha un campo che non è presente in questa maschera, quel campo non verrà restituito nella risposta.
showMissing

boolean

Indica se nell'elenco devono essere presenti documenti mancanti.

Un documento non esiste se non esiste, ma sono presenti documenti secondari nidificati. Se il valore è true, i documenti mancanti verranno restituiti con una chiave, ma non avranno campi, createTime o updateTime impostati.

Le richieste con showMissing non possono specificare where o orderBy.
Parametro di unione consistency_selector. La modalità di coerenza per questa transazione. Se non viene configurato, il valore predefinito è elevata coerenza. consistency_selector può essere solo uno dei seguenti:
transaction

string (bytes format)

Esegui la lettura come parte di una transazione già attiva.

Una stringa con codifica Base64.
readTime

string (Timestamp format)

Esegui la lettura all'ora indicata.

Deve essere un timestamp con precisione in microsecondi risalente all'ultima ora oppure, se il recupero point-in-time è abilitato, può essere anche un timestamp di un minuto intero compreso negli ultimi 7 giorni.

Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di ListDocumentsResponse.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Per ulteriori informazioni, consulta la Panoramica dell'autenticazione.