REST Resource: projects.databases.documents

リソース: ドキュメント

Firestore ドキュメント。

1 MiB - 4 バイトを超えてはなりません。

JSON表現
{
  "name": string,
  "fields": {
    string: {
      object (Value)
    },
    ...
  },
  "createTime": string,
  "updateTime": string
}
田畑
name

string

ドキュメントのリソース名 (例projects/{projectId}/databases/{databaseId}/documents/{document_path}

fields

map (key: string, value: object ( Value ))

"key": valueペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

createTime

string ( Timestamp format)

出力のみ。ドキュメントが作成された時刻。

この値は、ドキュメントが削除されてから再作成されると単調に増加します。また、他のドキュメントの値やクエリのreadTimeと比較することもできます。

RFC3339 UTC「Zulu」形式のタイムスタンプ。ナノ秒の分解能と最大 9 桁の小数点以下を備えています。例: "2014-10-02T15:01:23Z"および"2014-10-02T15:01:23.045123456Z"

updateTime

string ( Timestamp format)

出力のみ。ドキュメントが最後に変更された時刻。

この値は、最初はcreateTimeに設定され、ドキュメントが変更されるたびに単調に増加します。また、他のドキュメントの値やクエリのreadTimeと比較することもできます。

RFC3339 UTC「Zulu」形式のタイムスタンプ。ナノ秒の分解能と最大 9 桁の小数点以下を備えています。例: "2014-10-02T15:01:23Z"および"2014-10-02T15:01:23.045123456Z"

メソッド

batchGet

複数のドキュメントを取得します。

batchWrite

書き込み操作のバッチを適用します。

beginTransaction

新しいトランザクションを開始します。

commit

トランザクションをコミットし、必要に応じてドキュメントを更新します。

createDocument

新しいドキュメントを作成します。

delete

文書を削除します。

get

単一のドキュメントを取得します。

list

ドキュメントをリストします。

listCollectionIds

ドキュメントの下にあるすべてのコレクション ID をリストします。

listDocuments

ドキュメントをリストします。

partitionQuery

クエリを並列実行するために使用できるパーティション カーソルを返すことによって、クエリをパーティション化します。

patch

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

rollback

トランザクションをロールバックします。

runAggregationQuery

集計クエリを実行します。

runQuery

クエリを実行します。