Method: projects.databases.documents.list

string

Wymagane. Nazwa zasobu nadrzędnego. W formacie projects/{projectId}/databases/{databaseId}/documents lub projects/{projectId}/databases/{databaseId}/documents/{document_path}.

Na przykład: projects/my-project/databases/my-database/documents lub projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

string

Opcjonalnie. Identyfikator kolekcji względem listy parent.

np. chatrooms lub messages.

Jest to opcjonalne. Jeśli jej nie podasz, Firestore wyświetli listę dokumentów ze wszystkich kolekcji w ramach podanego atrybutu parent.

integer

Opcjonalnie. Maksymalna liczba dokumentów zwracanych w jednej odpowiedzi.

Firestore może zwrócić mniej niż ta wartość.

string

Opcjonalnie. Token strony otrzymany z poprzedniej odpowiedzi documents.list.

Podaj je, aby pobrać kolejną stronę. Podczas podziału na strony wszystkie pozostałe parametry (z wyjątkiem pageSize) muszą odpowiadać wartościom ustawionym w żądaniu, które wygenerowało token strony.

string

Opcjonalnie. Opcjonalna kolejność zwracanych dokumentów.

Przykład: priority desc, __name__ desc.

Odzwierciedla to ORDER BY używane w zapytaniach Firestore, ale w postaci ciągu znaków. Jeśli go nie ma, dokumenty są uporządkowane na podstawie __name__ ASC.

object (DocumentMask)

Opcjonalnie. Pola do zwrócenia. Jeśli wartość nie jest ustawiona, zwraca wszystkie pola.

Jeśli dokument zawiera pole, którego nie ma w tej masce, nie zostanie ono zwrócone w odpowiedzi.

boolean

Czy lista powinna zawierać brakujące dokumenty?

Dokument, który nie istnieje, nie istnieje, ale znajdują się pod nim zagnieżdżone dokumenty podrzędne. Jeśli ma wartość true (prawda), takie brakujące dokumenty będą zwracane z kluczem, ale bez ustawionych pól createTime czy updateTime.

Żądania z atrybutem showMissing nie mogą mieć wartości where ani orderBy.

string (bytes format)

Przeprowadź odczyt w ramach aktywnej transakcji.

Ciąg zakodowany w standardzie base64.

string (Timestamp format)

Wykonaj odczyt o podanej godzinie.

Musi to być sygnatura czasowa precyzji określona w mikrosekundach z ostatniej godziny lub jeśli włączona jest funkcja odzyskiwania do określonego momentu, może to być dodatkowo sygnatura czasowa obejmująca całą minutę z ostatnich 7 dni.

Sygnatura czasowa w formacie „Zulu” RFC3339 UTC z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".