Method: projects.databases.documents.patch

ドキュメントを更新または挿入します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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

詳細については、認証の概要をご覧ください。