Recebe um único documento.
Solicitação HTTP
GET https://firestore.googleapis.com/v1/{name=projects/*/databases/*/documents/*/**}
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
| Parâmetros | |
|---|---|
name |
Obrigatório. O nome do recurso do documento a ser recebido. Use o formato: |
Parâmetros de consulta
| Parâmetros | |
|---|---|
mask |
Os campos a serem retornados. Se não definido, retorna todos os campos. Se o documento tiver um campo ausente nessa máscara, esse campo não será retornado na resposta. |
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 |
Lê o documento em uma transação. Uma string codificada em base64. |
readTime |
Lê a versão do documento no momento especificado. 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: |
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 Document.
Escopos de autorização
Requer um dos seguintes escopos de OAuth:
https://www.googleapis.com/auth/datastorehttps://www.googleapis.com/auth/cloud-platform
Para saber mais, consulte a Visão geral da autenticação.