Method: projects.databases.documents.list

string

Obrigatório. O nome do recurso pai. No formato: projects/{projectId}/databases/{databaseId}/documents ou projects/{projectId}/databases/{databaseId}/documents/{document_path} .

Por exemplo: projects/my-project/databases/my-database/documents ou projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

string

Opcional. O ID da coleção, relativo a parent , a ser listado.

Por exemplo: chatrooms ou messages .

Isso é opcional e, quando não fornecido, o Firestore listará os documentos de todas as coleções no parent fornecido.

integer

Opcional. O número máximo de documentos a serem retornados em uma única resposta.

O Firestore pode retornar menos que esse valor.

string

Opcional. Um token de página, recebido de uma resposta anterior documents.list .

Forneça isso para recuperar a página subsequente. Ao paginar, todos os outros parâmetros (com exceção de pageSize ) devem corresponder aos valores definidos na solicitação que gerou o token da página.

string

Opcional. A ordenação facultativa dos documentos a devolver.

Por exemplo: priority desc, __name__ desc .

Isso reflete o ORDER BY usado nas consultas do Firestore, mas em uma representação de string. Quando ausentes, os documentos são ordenados com base em __name__ ASC .

object ( DocumentMask )

Opcional. Os campos a serem retornados. Se não for definido, retorna todos os campos.

Caso um documento possua um campo que não esteja presente nesta máscara, esse campo não será retornado na resposta.

boolean

Se a lista mostrar documentos faltantes.

Um documento está faltando se não existir, mas há subdocumentos aninhados abaixo dele. Quando verdadeiro, esses documentos ausentes serão retornados com uma chave, mas não terão campos createTime ou updateTime definidos.

Solicitações com showMissing não podem especificar where ou orderBy .

string ( bytes format)

Execute a leitura como parte de uma transação já ativa.

Uma string codificada em base64.

string ( Timestamp format)

Execute a leitura no horário fornecido.

Deve ser um carimbo de data/hora com precisão de microssegundos da última hora ou, se a recuperação pontual estiver ativada, também pode ser um carimbo de hora de um minuto inteiro dos últimos 7 dias.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z" .