Method: projects.databases.documents.listDocuments

string

Obligatoire. Nom de la ressource parente. Format à respecter: projects/{projectId}/databases/{databaseId}/documents ou projects/{projectId}/databases/{databaseId}/documents/{document_path}.

(par exemple, projects/my-project/databases/my-database/documents ou projects/my-project/databases/my-database/documents/chatrooms/my-chatroom).

string

Facultatif. ID de collection de la liste (par rapport à parent).

Par exemple, chatrooms ou messages.

Cette option est facultative. Lorsqu'elle n'est pas fournie, Firestore affiche les documents de toutes les collections dans le parent fourni.

integer

Facultatif. Nombre maximal de documents à renvoyer par réponse.

Firestore peut renvoyer une valeur inférieure à cette valeur.

string

Facultatif. Jeton de page, provenant d'une réponse documents.list précédente.

Fournissez-le pour récupérer la page suivante. Lors de la pagination, tous les autres paramètres (à l'exception de pageSize) doivent correspondre aux valeurs définies dans la requête qui a généré le jeton de page.

string

Facultatif. Ordre facultatif des documents à renvoyer.

Exemple : priority desc, __name__ desc.

Cette valeur reflète la valeur ORDER BY utilisée dans les requêtes Firestore, mais sous la forme d'une représentation sous forme de chaîne. Si ce champ n'est pas renseigné, les documents sont classés en fonction de __name__ ASC.

object (DocumentMask)

Facultatif. Champs à renvoyer. Si ce champ n'est pas spécifié, tous les champs sont renvoyés.

Si un document comporte un champ qui n'est pas présent dans ce masque, ce champ n'est pas renvoyé dans la réponse.

boolean

Si la liste doit afficher des documents manquants

Un document est manquant s'il n'existe pas, mais des sous-documents sont imbriqués sous celui-ci. Lorsque la valeur est "true", ces documents manquants sont renvoyés avec une clé, mais sans champs, createTime ni updateTime définis.

Les requêtes avec showMissing ne peuvent pas spécifier where ni orderBy.

string (bytes format)

Effectuez la lecture dans le cadre d'une transaction déjà active.

Chaîne encodée en base64.

string (Timestamp format)

Effectuez la lecture au moment indiqué.

Il doit s'agir d'un horodatage de précision de l'ordre de la microseconde au cours de la dernière heure. Si la récupération à un moment précis est activée, il peut également s'agir d'un horodatage d'une minute entière datant des sept derniers jours.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres après la virgule. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".