REST Resource: projects.databases.documents

Resource: Document

A Firestore document.

Must not exceed 1 MiB - 4 bytes.

JSON representation 
{
  "name": string,
  "fields": {
    string: {
      object (Value)
    },
    ...
  },
  "createTime": string,
  "updateTime": string
}
Fields
name

string

The resource name of the document, for example projects/{projectId}/databases/{databaseId}/documents/{document_path}.
fields

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

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Output only. The time at which the document was created.

This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the readTime of a query.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The time at which the document was last changed.

This value is initially set to the createTime then increases monotonically with each change to the document. It can also be compared to values from other documents and the readTime of a query.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Methods

batchGet

 Gets multiple documents.

batchWrite

 Applies a batch of write operations.

beginTransaction

 Starts a new transaction.

commit

 Commits a transaction, while optionally updating documents.

createDocument

 Creates a new document.

delete

 Deletes a document.

get

 Gets a single document.

list

 Lists documents.

listCollectionIds

 Lists all the collection IDs underneath a document.

listDocuments

 Lists documents.

partitionQuery

 Partitions a query by returning partition cursors that can be used to run the query in parallel.

patch

 Updates or inserts a document.

rollback

 Rolls back a transaction.

runAggregationQuery

 Runs an aggregation query.

runQuery

 Runs a query.