Method: projects.databases.documents.patch

Обновляет или вставляет документ.

HTTP-запрос

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

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

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

Параметры
document.name

string

Имя ресурса документа, например projects/{projectId}/databases/{databaseId}/documents/{document_path} .

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

Параметры
updateMask

object ( DocumentMask )

Поля для обновления. Ни один из путей к полям в маске не может содержать зарезервированное имя.

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

mask

object ( DocumentMask )

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

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

currentDocument

object ( Precondition )

Необязательное предварительное условие в документе. Запрос завершится неудачей, если он установлен и не соответствует целевому документу.

Тело запроса

Тело запроса содержит экземпляр Document .

Тело ответа

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

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

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

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

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