Fetch developer metadata by Id and create for columns, rows and sheets

Author: darraghmckay

lib/GoogleSpreadsheet.js

@@ -332,6 +332,52 @@ class GoogleSpreadsheet {
     });
   }
 
+  async getMetadataById(metadataId) {
+    // Request type = `developerMetadata`
+    // https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.developerMetadata/get
+    return this.axios
+      .get(`/developerMetadata/${metadataId}`)
+      .then((response) => response.data);
+  }
+
+  async _createDeveloperMetadata(metadataKey, metadataValue, location, visibility, metadataId) {
+    // Request type = `createDeveloperMetadata`
+    // https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.developerMetadata#DeveloperMetadata
+    return this._makeSingleUpdateRequest('createDeveloperMetadata', {
+      developerMetadata: {
+        metadataKey,
+        metadataValue,
+        location,
+        visibility: visibility || 'PROJECT',
+        metadataId,
+      },
+    }).then((data) => data.developerMetadata);
+  }
+
+  async createSheetDeveloperMetadata(metadataKey, metadataValue, sheetId, visibility, metadataId) {
+    return this._createDeveloperMetadata(
+      metadataKey,
+      metadataValue,
+      {
+        sheetId: sheetId || 0,
+      },
+      visibility,
+      metadataId
+    );
+  }
+
+  async createRangeDeveloperMetadata(metadataKey, metadataValue, range, visibility, metadataId) {
+    return this._createDeveloperMetadata(
+      metadataKey,
+      metadataValue,
+      {
+        dimensionRange: range,
+      },
+      visibility,
+      metadataId
+    );
+  }
+
   async deleteNamedRange(namedRangeId) {
     return this._makeSingleUpdateRequest('deleteNamedRange', { namedRangeId });
   }

lib/GoogleSpreadsheetCell.js

@@ -174,6 +174,21 @@ class GoogleSpreadsheetCell {
     await this._sheet.saveUpdatedCells([this]);
   }
 
+  async createDeveloperMetadata(metadataKey, metadataValue, visibility, metadataId) {
+    return this._sheet._spreadsheet.createRangeDeveloperMetadata(
+      metadataKey,
+      metadataValue,
+      {
+        dimension: 'COLUMNS',
+        sheetId: this._sheet.sheetId,
+        startIndex: this._column,
+        endIndex: this._column + 1,
+      },
+      visibility,
+      metadataId
+    );
+  }
+
   // used by worksheet when saving cells
   // returns an individual batchUpdate request to update the cell
   _getUpdateRequest() {

lib/GoogleSpreadsheetRow.js

@@ -67,6 +67,21 @@ class GoogleSpreadsheetRow {
     return result;
   }
   async del() { return this.delete(); } // alias to mimic old version of this module
+
+  async createDeveloperMetadata(metadataKey, metadataValue, visibility, metadataId) {
+    return this._sheet._spreadsheet.createRangeDeveloperMetadata(
+      metadataKey,
+      metadataValue,
+      {
+        dimension: 'ROWS',
+        sheetId: this._sheet.sheetId,
+        startIndex: this._rowNumber,
+        endIndex: this._rowNumber + 1,
+      },
+      visibility,
+      metadataId
+    );
+  }
 }
 
 module.exports = GoogleSpreadsheetRow;

lib/GoogleSpreadsheetWorksheet.js

@@ -782,9 +782,12 @@ class GoogleSpreadsheetWorksheet {
     // https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/request#DeleteBandingRequest
   }
 
-  async createDeveloperMetadata() {
+  async createDeveloperMetadata(metadataKey, metadataValue, visibility, metadataId) {
     // Request type = `createDeveloperMetadata`
     // https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/request#CreateDeveloperMetadataRequest
+    return this._spreadsheet.createSheetDeveloperMetadata(
+      metadataKey, metadataValue, this.sheetId, visibility, metadataId
+    );
   }
 
   async updateDeveloperMetadata() {