Merge pull request #1008 from burnash/feature/list_protected_ranges

add method list protected ranges
burnash · Mar 9, 2022 · 6cce36c · 6cce36c
2 parents d9ffc30 + 8f76c8f
commit 6cce36c
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/gspread/spreadsheet.py b/gspread/spreadsheet.py
@@ -615,3 +615,18 @@ def update_locale(self, locale):
         }
 
         return self.batch_update(body)
+
+    def list_protected_ranges(self, sheetid):
+        """Lists the spreadsheet's protected named ranges"""
+        sheets = self.fetch_sheet_metadata(
+            params={"fields": "sheets.properties,sheets.protectedRanges"}
+        )["sheets"]
+
+        try:
+            sheet = finditem(
+                lambda sheet: sheet["properties"]["sheetId"] == sheetid, sheets
+            )
+
+            return sheet["protectedRanges"]
+        except (StopIteration, KeyError):
+            return []