@maxim_mazurok/gapi.client.sheets
    TypeScript icon, indicating that this package has built-in type declarations

    4.0.20211120 • Public • Published

    TypeScript typings for Google Sheets API v4

    Reads and writes Google Sheets. For detailed description please check documentation.

    Installing

    Install typings for Google Sheets API:

    npm install @types/gapi.client.sheets@v4 --save-dev
    

    Usage

    You need to initialize Google API client in your code:

    gapi.load('client', () => {
      // now we can use gapi.client
      // ...
    });

    Then load api client wrapper:

    gapi.client.load('sheets', 'v4', () => {
      // now we can use gapi.client.sheets
      // ...
    });

    Don't forget to authenticate your client before sending any request to resources:

    // declare client_id registered in Google Developers Console
    var client_id = '',
      scope = [ 
          // See, edit, create, and delete all of your Google Drive files
          'https://www.googleapis.com/auth/drive',
    
          // See, edit, create, and delete only the specific Google Drive files you use with this app
          'https://www.googleapis.com/auth/drive.file',
    
          // See and download all your Google Drive files
          'https://www.googleapis.com/auth/drive.readonly',
    
          // See, edit, create, and delete all your Google Sheets spreadsheets
          'https://www.googleapis.com/auth/spreadsheets',
    
          // See all your Google Sheets spreadsheets
          'https://www.googleapis.com/auth/spreadsheets.readonly',
        ],
        immediate = true;
    // ...
    
    gapi.auth.authorize(
      { client_id: client_id, scope: scope, immediate: immediate },
      authResult => {
        if (authResult && !authResult.error) {
            /* handle successful authorization */
        } else {
            /* handle authorization error */
        }
    });

    After that you can use Google Sheets API resources:

    /*
    Applies one or more updates to the spreadsheet. Each request is validated before being applied. If any request is not valid then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. The replies will mirror the requests. For example, if you applied 4 updates and the 3rd one had a reply, then the response will have 2 empty replies, the actual reply, and another empty reply, in that order. Due to the collaborative nature of spreadsheets, it is not guaranteed that the spreadsheet will reflect exactly your changes after this completes, however it is guaranteed that the updates in the request will be applied together atomically. Your changes may be altered with respect to collaborator changes. If there are no collaborators, the spreadsheet should reflect your changes.
    */
    await gapi.client.sheets.spreadsheets.batchUpdate({ spreadsheetId: "spreadsheetId",  });
    
    /*
    Creates a spreadsheet, returning the newly created spreadsheet.
    */
    await gapi.client.sheets.spreadsheets.create({  });
    
    /*
    Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids will not be returned. You can include grid data one of two ways: * Specify a field mask listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData URL parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, it is recommended to retrieve only the specific fields of the spreadsheet that you want. To retrieve only subsets of the spreadsheet, use the ranges URL parameter. Multiple ranges can be specified. Limiting the range will return only the portions of the spreadsheet that intersect the requested ranges. Ranges are specified using A1 notation.
    */
    await gapi.client.sheets.spreadsheets.get({ spreadsheetId: "spreadsheetId",  });
    
    /*
    Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. This method differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to return by specifying a dataFilters parameter. Multiple DataFilters can be specified. Specifying one or more data filters will return the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids will not be returned. You can include grid data one of two ways: * Specify a field mask listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, it is recommended to retrieve only the specific fields of the spreadsheet that you want.
    */
    await gapi.client.sheets.spreadsheets.getByDataFilter({ spreadsheetId: "spreadsheetId",  });

    Keywords

    none

    Install

    npm i @maxim_mazurok/gapi.client.sheets

    DownloadsWeekly Downloads

    1,867

    Version

    4.0.20211120

    License

    MIT

    Unpacked Size

    931 kB

    Total Files

    6

    Last publish

    Collaborators

    • maxim_mazurok