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"]],[["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\u003eField masks define a subset of fields within a document for get or update operations.\u003c/p\u003e\n"],["\u003cp\u003eThey are specifically scoped to a single document and handle dynamic values.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003efieldPaths\u003c/code\u003e array, which contains the string representations of each field path, is the list of fields that compose the mask.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eDocument.fields\u003c/code\u003e syntax is used as a reference for defining each \u003ccode\u003efieldPaths\u003c/code\u003e value.\u003c/p\u003e\n"]]],[],null,[]]
