Stay organized with collections
Save 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 a Document, and takes in account the dynamic nature of Value.
JSON representation
{"fieldPaths": [string]}
Fields
fieldPaths[]
string
The list of field paths in the mask. See Document.fields for a field path syntax reference.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-20 UTC."],[],[],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](/docs/firestore/reference/rest/v1beta1/projects.databases.documents#Document), and takes in account the dynamic nature of `Value`.\n\n| JSON representation |\n|--------------------------------------|\n| ``` { \"fieldPaths\": [ string ] } ``` |\n\n| Fields ||\n|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `fieldPaths[]` | `string` The list of field paths in the mask. See [Document.fields](/docs/firestore/reference/rest/v1beta1/projects.databases.documents#Document.FIELDS.fields) for a field path syntax reference. |"]]
