Method: projects.databases.documents.batchGet

Получает несколько документов.

Документы, возвращаемые этим методом, не гарантированно возвращаются в том же порядке, в котором они были запрошены.

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
database

string

Необходимый. Имя базы данных. В формате: projects/{projectId}/databases/{databaseId} .

Тело запроса

Тело запроса содержит данные следующей структуры:

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

Имена документов, которые необходимо получить. В формате: projects/{projectId}/databases/{databaseId}/documents/{document_path} . Запрос не будет выполнен, если какой-либо документ не является дочерним ресурсом данной database . Повторяющиеся имена будут удалены.

mask

object ( DocumentMask )

Поля для возврата. Если не установлено, возвращает все поля.

Если в документе есть поле, которого нет в этой маске, это поле не будет возвращено в ответе.

Объединённое поле consistency_selector . Режим согласованности для этой транзакции. Если не установлено, по умолчанию используется строгая согласованность. consistency_selector может быть только одним из следующих:
transaction

string ( bytes format)

Считывает документы в транзакции.

Строка в кодировке Base64.

newTransaction

object ( TransactionOptions )

Начинает новую транзакцию и читает документы. По умолчанию используется транзакция только для чтения. Новый идентификатор транзакции будет возвращен в качестве первого ответа в потоке.

readTime

string ( Timestamp format)

Читает документы в том виде, в каком они были на данный момент.

Это должна быть временная метка с точностью до микросекунды за последний час или, если включено восстановление на определенный момент времени, дополнительно может быть временная метка с точностью до целой минуты за последние 7 дней.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

Тело ответа

Потоковый ответ для Firestore.BatchGetDocuments .

В случае успеха тело ответа содержит данные следующей структуры:

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 ( bytes format)

Транзакция, которая была запущена в рамках этого запроса. Будет установлено только в первом ответе и только в том случае, если в запросе был установлен BatchGetDocumentsRequest.new_transaction .

Строка в кодировке Base64.

readTime

string ( Timestamp format)

Время чтения документа. Оно может быть монотически возрастающим, в этом случае предыдущие документы в потоке результатов гарантированно не изменятся между их readTime и этим.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

result поля объединения. Единый результат. Это может быть пусто, если сервер просто возвращает транзакцию. result может быть только одним из следующих:
found

object ( Document )

Документ, который был запрошен.

missing

string

Имя документа, которое было запрошено, но не существует. В формате: projects/{projectId}/databases/{databaseId}/documents/{document_path} .

Области авторизации

Требуется одна из следующих областей OAuth:

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

Для получения дополнительной информации см. Обзор аутентификации .