Method: projects.databases.documents.get

Obtém um único documento.

Solicitação HTTP

GET https://firestore.googleapis.com/v1beta1/{name=projects/*/databases/*/documents/*/**}

A URL usa sintaxe de transcodificação gRPC .

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. O nome do recurso do Documento a ser obtido. No formato: projects/{projectId}/databases/{databaseId}/documents/{document_path} .

Parâmetros de consulta

Parâmetros
mask

object ( DocumentMask )

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

Caso o documento possua um campo que não esteja presente nesta 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 é consistência forte. consistency_selector pode ser apenas um dos seguintes:
transaction

string ( bytes format)

Lê o documento em uma transação.

Uma string codificada em base64.

readTime

string ( Timestamp format)

Lê a versão do documento no momento determinado.

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

Solicitar corpo

O corpo da solicitação deve estar vazio.

Corpo de resposta

Se for bem-sucedido, o corpo da resposta conterá uma instância de Document .

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .