Stay organized with collectionsSave and categorize content based on your preferences.
A set of field paths on a document. Used to restrict a get or update operation on a document to a subset of its fields. This is different from standard field masks, as this is always scoped to aDocument, and takes in account the dynamic nature ofValue.
JSON representation
{"fieldPaths":[string]}
Fields
fieldPaths[]
string
The list of field paths in the mask. SeeDocument.fieldsfor a field path syntax reference.
[[["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-06-02 UTC."],[[["\u003cp\u003eThis defines a set of field paths used to restrict get or update operations on a document to a specific subset of its fields.\u003c/p\u003e\n"],["\u003cp\u003eIt differs from standard field masks by being scoped to a specific document and considering the dynamic nature of \u003ccode\u003eValue\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003efieldPaths\u003c/code\u003e array contains a list of strings, each representing a field path within the document.\u003c/p\u003e\n"],["\u003cp\u003eThe syntax reference of field paths can be found in the \u003ccode\u003eDocument.fields\u003c/code\u003e section.\u003c/p\u003e\n"]]],[],null,["# DocumentMask\n\nA set of field paths on a document. Used to restrict a get or update operation on a document to a subset of its fields. This is different from standard field masks, as this is always scoped to a [Document](/firestore/docs/reference/rest/v1beta1/projects.databases.documents#Document), and takes in account the dynamic nature of `Value`."]]
