Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。
このページは Cloud Translation API によって翻訳されました。
Switch to English

Method: projects.databases.documents.patch

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

HTTPリクエスト

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

URLはgRPCトランスコーディング構文を使用します。

パスパラメータ

パラメーター
document.name

string

ドキュメントのリソース名。たとえば、 projects/{project_id}/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

詳細については、認証の概要を参照してください。