Field names matching the regular expression __.*__ are reserved. Reserved field names are forbidden except in certain documented contexts. The field names, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.
Field paths may be used in other contexts to refer to structured fields defined here. For mapValue, the field path is represented by a dot-delimited (.) string of segments. Each segment is either a simple field name (defined below) or a quoted field name. For example, the structured field "foo" : { mapValue: { "x&y" : { stringValue: "hello"
}}} would be represented by the field path foo.`x&y`.
A simple field name contains only characters a to z, A to Z, 0 to 9, or _, and must not start with 0 to 9. For example, foo_bar_17.
A quoted field name starts and ends with ` and may contain any character. Some characters, including `, must be escaped using a \. For example, `x&y` represents x&y and `bak\`tik` represents bak`tik.
An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
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.
Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
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.
Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-26 UTC."],[[["\u003cp\u003eFirestore documents are limited to a maximum size of 1 MiB - 4 bytes.\u003c/p\u003e\n"],["\u003cp\u003eEach document has a \u003ccode\u003ename\u003c/code\u003e string, \u003ccode\u003efields\u003c/code\u003e map, \u003ccode\u003ecreateTime\u003c/code\u003e, and \u003ccode\u003eupdateTime\u003c/code\u003e, representing its resource name, data fields, creation timestamp, and last update timestamp respectively.\u003c/p\u003e\n"],["\u003cp\u003eField names in the document's \u003ccode\u003efields\u003c/code\u003e map must be UTF-8, cannot exceed 1,500 bytes, and field names with \u003ccode\u003e__.*__\u003c/code\u003e are reserved.\u003c/p\u003e\n"],["\u003cp\u003eVarious methods are provided to interact with documents including \u003ccode\u003ebatchGet\u003c/code\u003e, \u003ccode\u003ebatchWrite\u003c/code\u003e, \u003ccode\u003ecommit\u003c/code\u003e, \u003ccode\u003ecreateDocument\u003c/code\u003e, \u003ccode\u003edelete\u003c/code\u003e, \u003ccode\u003eget\u003c/code\u003e, \u003ccode\u003elist\u003c/code\u003e, \u003ccode\u003epatch\u003c/code\u003e, and \u003ccode\u003erunQuery\u003c/code\u003e, allowing for retrieval, modification, and querying of documents.\u003c/p\u003e\n"],["\u003cp\u003eThe timestamps \u003ccode\u003ecreateTime\u003c/code\u003e and \u003ccode\u003eupdateTime\u003c/code\u003e are in RFC 3339 format and record the creation and last modification time, respectively, with these values being comparable to other documents and query read times.\u003c/p\u003e\n"]]],[],null,["# REST Resource: projects.databases.documents\n\nResource: Document\n------------------\n\nA Firestore document.\n\nMust not exceed 1 MiB - 4 bytes."]]