Method: projects.databases.documents.batchGet

Recebe vários documentos.

Não há garantia de que os documentos retornados por esse método sejam retornados na mesma ordem em que foram solicitados.

Solicitação HTTP

POST https://firestore.googleapis.com/v1beta1/{database=projects/*/databases/*}/documents:batchGet

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

Parâmetros de caminho

Parâmetros
database

string

Obrigatório. O nome do banco de dados. Use o formato: projects/{projectId}/databases/{databaseId}.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "documents": [
    string
  ],
  "mask": {
    object (DocumentMask)
  },

  // Union field consistency_selector can be only one of the following:
  "transaction": string,
  "newTransaction": {
    object (TransactionOptions)
  },
  "readTime": string
  // End of list of possible types for union field consistency_selector.
}
Campos
documents[]

string

Os nomes dos documentos a serem recuperados. Use o formato: projects/{projectId}/databases/{databaseId}/documents/{document_path}. A solicitação falhará se algum dos documentos não for um recurso filho do database especificado. Nomes duplicados serão ocultados.
mask

object (DocumentMask)

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.
Campo 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)

Lê documentos em uma transação.

Uma string codificada em base64.
newTransaction

object (TransactionOptions)

Inicia uma nova transação e lê os documentos. O padrão é uma transação somente leitura. O novo ID da transação vai ser retornado como a primeira resposta no fluxo.
readTime

string (Timestamp format)

Lê os documentos como estavam na época.

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 resposta

A resposta transmitida para Firestore.BatchGetDocuments.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "transaction": string,
  "readTime": string,

  // Union field result can be only one of the following:
  "found": {
    object (Document)
  },
  "missing": string
  // End of list of possible types for union field result.
}
Campos
transaction

string (bytes format)

A transação que foi iniciada como parte desta solicitação. Só será definido na primeira resposta, e apenas se BatchGetDocumentsRequest.new_transaction tiver sido definido na solicitação.

Uma string codificada em base64.
readTime

string (Timestamp format)

A hora em que o documento foi lido. Isso pode estar aumentando constantemente. Nesse caso, é garantido que os documentos anteriores no fluxo de resultados não serão alterados entre o readTime e o atual.

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".
Campo de união result. Um único resultado. Pode ficar vazio se o servidor estiver apenas retornando uma transação. result pode ser apenas de um dos tipos a seguir:
found

object (Document)

Um documento que foi solicitado.
missing

string

Um nome de documento que foi solicitado, mas não existe. Use o formato: projects/{projectId}/databases/{databaseId}/documents/{document_path}.

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.