Search code examples
javascriptgoogle-apps-scriptgoogle-apps-script-addon

Getting Developer Metadata using Google Script API on Google Apps Script


I am trying to get the developer metadata about a spreadsheet using the Google Script API, as found on this website.

https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.developerMetadata/search

I have tried the following, however I am getting no response back? Can anyone see where I am going wrong?

    var ss = SpreadsheetApp.getActiveSpreadsheet();
    var fileId = ss.getId();
    var token = ScriptApp.getOAuthToken();

    var paramsPost = {
        method: 'post',
        headers: {
            Authorization: 'Bearer ' + token
        },
        muteHttpExceptions: true,
        contentType: 'application/json',
        payload: JSON.stringify({
            dataFilters: [{
                developerMetadataLookup: {
                    locationType: 'COLUMN'
                }
            }]
        })
    };

    var url = 'https://sheets.googleapis.com/v4/spreadsheets/' + fileId + '?developerMetadata:search';
    var res = UrlFetchApp.fetch(url, paramsPost);
    var data = JSON.parse(res.getContentText());

Solution

  • In order to use the method of spreadsheets.developerMetadata.search of Sheets API, please modify the endpoint as follows.

    From:

    var url = 'https://sheets.googleapis.com/v4/spreadsheets/' + fileId + '?developerMetadata:search';
    

    To:

    var url = 'https://sheets.googleapis.com/v4/spreadsheets/' + fileId + '/developerMetadata:search';
    
    • ? of '?developerMetadata:search' is /.

    Reference: