Method: projects.databases.documents.get

Получает один документ.

HTTP-запрос

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

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

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

Параметры
name

string

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

Параметры запроса

Параметры
mask

object ( DocumentMask )

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

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

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

string ( bytes format)

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

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

readTime

string ( Timestamp format)

Считывает версию документа в данный момент.

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

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

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

В случае успеха тело ответа содержит экземпляр Document .

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

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

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

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