Method: projects.databases.documents.listDocuments

string

Obrigatório. O nome do recurso pai. Use o 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á 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 documents.list anterior.

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

string

Opcional. A ordem opcional dos documentos a serem retornados.

Por exemplo, priority desc, __name__ desc.

Isso espelha o ORDER BY usado nas consultas do Firestore, mas em uma representação de string. Na ausência, os documentos são ordenados com base em __name__ ASC.

object (DocumentMask)

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

Se um documento tiver um campo ausente nessa máscara, esse campo não será retornado na resposta.

boolean

Se a lista mostrar documentos ausentes.

Um documento está ausente 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)

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

Uma string codificada em base64.

string (Timestamp format)

Executa a leitura no momento fornecido.

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

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, 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".