このページは Cloud Translation API によって翻訳されました。
Switch to English

Write

ドキュメントへの書き込み。

JSON表現
{
  "updateMask": {
    object (DocumentMask)
  },
  "updateTransforms": [
    {
      object (FieldTransform)
    }
  ],
  "currentDocument": {
    object (Precondition)
  },

  // Union field operation can be only one of the following:
  "update": {
    object (Document)
  },
  "delete": string,
  "transform": {
    object (DocumentTransform)
  }
  // End of list of possible types for union field operation.
}
田畑
updateMask

object ( DocumentMask )

この書き込みで更新するフィールド。

このフィールドは、操作がupdate場合にのみ設定できます。 updateマスクが設定されておらず、ドキュメントが存在する場合、既存のデータは上書きされます。マスクが設定されていて、サーバー上のドキュメントにマスクでカバーされていないフィールドがある場合、それらは変更されません。マスクで参照されているが、入力ドキュメントには存在しないフィールドは、サーバー上のドキュメントから削除されます。このマスクのフィールドパスには、予約済みのフィールド名を含めることはできません。

updateTransforms[]

object ( FieldTransform )

更新後に実行する変換。

このフィールドは、操作がupdate場合にのみ設定できます。存在する場合、この書き込みは、同じドキュメントへのupdatetransformをアトミックかつ順番に実行updateことと同等です。

currentDocument

object ( Precondition )

ドキュメントのオプションの前提条件。

これが設定されていて、ターゲットドキュメントで満たされていない場合、書き込みは失敗します。

ユニオンフィールドoperation 。実行する操作。 operationは、次のいずれかになります。
update

object ( Document )

書き込むドキュメント。

delete

string

削除するドキュメント名。形式: projects/{project_id}/databases/{database_id}/documents/{document_path}

transform

object ( DocumentTransform )

ドキュメントに変換を適用します。

DocumentTransform

ドキュメントの変換。

JSON表現
{
  "document": string,
  "fieldTransforms": [
    {
      object (FieldTransform)
    }
  ]
}
田畑
document

string

変換するドキュメントの名前。

fieldTransforms[]

object ( FieldTransform )

ドキュメントのフィールドに順番に適用する変換のリスト。これは空であってはなりません。

FieldTransform

ドキュメントのフィールドの変換。

JSON表現
{
  "fieldPath": string,

  // Union field transform_type can be only one of the following:
  "setToServerValue": enum (ServerValue),
  "increment": {
    object (Value)
  },
  "maximum": {
    object (Value)
  },
  "minimum": {
    object (Value)
  },
  "appendMissingElements": {
    object (ArrayValue)
  },
  "removeAllFromArray": {
    object (ArrayValue)
  }
  // End of list of possible types for union field transform_type.
}
田畑
fieldPath

string

フィールドのパス。フィールドパス構文のリファレンスについては、 Document.fieldsを参照してください。

Unionフィールドtransform_type 。フィールドに適用する変換。 transform_typeは、次のいずれかになります。
setToServerValue

enum ( ServerValue )

フィールドを指定されたサーバー値に設定します。

increment

object ( Value )

指定された値をフィールドの現在の値に追加します。

これは整数またはdouble値でなければなりません。フィールドが整数でもdoubleでもない場合、またはフィールドがまだ存在しない場合、変換はフィールドを指定された値に設定します。指定された値または現在のフィールド値のいずれかがdoubleの場合、両方の値がdoubleとして解釈されます。二重演算と二重値の表現は、IEEE 754セマンティクスに従います。正/負の整数オーバーフローがある場合、フィールドは最大の大きさの正/負の整数に解決されます。

maximum

object ( Value )

フィールドを現在の値と指定された値の最大値に設定します。

これは整数またはdouble値でなければなりません。フィールドが整数でもdoubleでもない場合、またはフィールドがまだ存在しない場合、変換はフィールドを指定された値に設定します。フィールドと入力値が混合型(つまり、1つは整数で1つは倍数)である最大演算が適用される場合、フィールドはより大きなオペランドの型になります。オペランドが等しい場合(3と3.0など)、フィールドは変更されません。 0、0.0、および-0.0はすべてゼロです。ゼロの保管値とゼロの入力値の最大値は、常に保管値です。数値xとNaNの最大値はNaNです。

minimum

object ( Value )

フィールドを現在の値と指定された値の最小値に設定します。

これは整数またはdouble値でなければなりません。フィールドが整数またはdoubleではない場合、またはフィールドがまだ存在しない場合、変換はフィールドを入力値に設定します。フィールドと入力値が混合型(つまり、1つは整数で1つは倍数)である最小演算が適用される場合、フィールドは小さい方のオペランドの型になります。オペランドが等しい場合(3と3.0など)、フィールドは変更されません。 0、0.0、および-0.0はすべてゼロです。ゼロの保管値とゼロの入力値の最小値は、常に保管値です。数値xとNaNの最小値はNaNです。

appendMissingElements

object ( ArrayValue )

指定された要素が現在のフィールド値に存在しない場合は、順番に追加します。フィールドが配列でない場合、またはフィールドがまだ存在しない場合は、最初に空の配列に設定されます。

値が欠落しているかどうかをチェックする場合、異なるタイプ(3Lと3.0など)の同等の数は等しいと見なされます。 NaNはNaNと等しく、NullはNullと等しくなります。入力に複数の同等の値が含まれている場合、最初の値のみが考慮されます。

対応するtransform_resultはnull値になります。

removeAllFromArray

object ( ArrayValue )

フィールドの配列から指定されたすべての要素を削除します。フィールドが配列でない場合、またはフィールドがまだ存在しない場合は、空の配列に設定されます。

要素を削除するかどうかを決定するとき、異なるタイプ(3Lと3.0など)の同等の数は等しいと見なされます。 NaNはNaNと等しく、NullはNullと等しくなります。これにより、重複がある場合、同等の値がすべて削除されます。

対応するtransform_resultはnull値になります。

ServerValue

サーバーによって計算される値。

列挙型
SERVER_VALUE_UNSPECIFIED 不特定。この値は使用しないでください。
REQUEST_TIME サーバーがミリ秒の精度でリクエストを処理した時刻。トランザクションの複数のフィールド(同じまたは異なるドキュメント)で使用される場合、すべてのフィールドは同じサーバーのタイムスタンプを取得します。