Method: projects.databases.documents.list

Lista os documentos.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

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.
collectionId

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.

Parâmetros de consulta

Parâmetros
pageSize

integer

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

O Firestore pode retornar menos que esse valor.
pageToken

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.
orderBy

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.
mask

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.
showMissing

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.
Parâmetro de união consistency_selector. O modo de consistência para esta transação. Se não for definido, o padrão é a consistência forte. consistency_selector pode ser apenas de um dos tipos a seguir:
transaction

string (bytes format)

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

Uma string codificada em base64.
readTime

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".

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de ListDocumentsResponse.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.