Esta página foi traduzida pela API Cloud Translation.

Method: projects.databases.documents.batchGet

Obtém vários documentos.

Não há garantia de que os documentos devolvidos por este método serão devolvidos na mesma ordem em que foram solicitados.

Solicitação HTTP

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

A URL usa sintaxe de transcodificação gRPC .

Parâmetros de caminho

Parâmetros

Parâmetros
`database`	`string` Obrigatório. O nome do banco de dados. No formato: `projects/{projectId}/databases/{databaseId}` .

database

string

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

Solicitar corpo

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

Representação JSON

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`. }

{
  "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. No formato: `projects/{projectId}/databases/{databaseId}/documents/{document_path}` . A solicitação falhará se algum documento não for um recurso filho do `database` determinado. Nomes duplicados serão eliminados.
`mask`	`object ( DocumentMask )` Os campos a serem retornados. Se não for definido, retorna todos os campos. Caso um documento possua um campo que não esteja presente nesta 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 é consistência forte. `consistency_selector` pode ser apenas um dos seguintes:
`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 será retornado como a primeira resposta no stream.
`readTime`	`string ( Timestamp format)` Lê documentos como eles estavam 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"` .

Corpo de resposta

A resposta transmitida para Firestore.BatchGetDocuments .

Se for bem-sucedido, o corpo da resposta conterá dados com a seguinte estrutura:

Representação JSON

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`. }

{
  "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 somente 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 aumentar monoticamente, neste caso é garantido que os documentos anteriores no fluxo de resultados não foram alterados entre seu readTime e este. 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"` .
`result` do campo de união. Um único resultado. Pode ficar vazio se o servidor estiver apenas retornando uma transação. `result` pode ser apenas um dos seguintes:
`found`	`object ( Document )` Um documento que foi solicitado.
`missing`	`string` Um nome de documento que foi solicitado, mas não existe. No formato: `projects/{projectId}/databases/{databaseId}/documents/{document_path}` .

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 .