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

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

createDocument

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

delete

ドキュメントを削除します。

get

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

list

ドキュメントを一覧表示します。

listCollectionIds

ドキュメントのすべてのコレクション ID を一覧表示します。

listDocuments

ドキュメントを一覧表示します。

partitionQuery

クエリの並列実行に使用できるパーティション カーソルを返すことで、クエリをパーティショニングします。

patch

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

rollback

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

runAggregationQuery

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

runQuery

クエリを実行します。