Dart

Google Sheets - Create a New Spreadsheet

See more Google Sheets Examples

Demonstrates how to create a new and empty spreadsheet. Dart

import 'package:chilkat/chilkat.dart';

void main() {
  // This example requires the Chilkat API to have been previously unlocked.
  // See Global Unlock Sample for sample code.

  // This example uses a previously obtained access token having permission for the 
  // Google Sheets scope.

  // In this example, Get Google Sheets OAuth2 Access Token, the access
  // token was saved to a JSON file.  This example fetches the access token from the file..
  final jsonToken = CkJsonObject();
  jsonToken.loadFile('qa_data/tokens/googleSheets.json');
  if (!jsonToken.hasMember('access_token')) {
    print('No access token found.');
    return;
  }

  final http = CkHttp();
  http.authToken = jsonToken.stringOf('access_token');

  // Create the following JSON:
  // The JSON code can be generated using this online tool:  Generate JSON create code
  // {
  //   "sheets": [
  //     {
  //       "properties": {
  //         "title": "Sample Tab"
  //       }
  //     }
  //   ],
  //   "properties": {
  //     "title": "Create Spreadsheet using Sheets API v4"
  //   }
  // }

  // This code generates the above JSON:
  final json = CkJsonObject();
  json.updateString('sheets[0].properties.title', 'Sample Tab');
  json.updateString('properties.title', 'Create Spreadsheet using Sheets API v4');

  // Send the POST to create the new Google spreadsheet.
  final resp = CkHttpResponse();
  try {
    http.httpJson('POST', 'https://sheets.googleapis.com/v4/spreadsheets', json, 'application/json', resp);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  print('response status code = ${resp.statusCode}');
  print('response JSON:');

  json.load(resp.bodyStr);
  json.emitCompact = false;
  print(json.emit());

  // A sample response is shown below.
  // To generate the parsing source code for a JSON response, paste
  // the JSON into this online tool: Generate JSON parsing code

  // {
  //   "spreadsheetId": "1ueEQu3WDBkIAOUhzLnY4zr6JO5SrJx0dQ-YkQlUVYD0",
  //   "properties": {
  //     "title": "Create Spreadsheet using Sheets API v4",
  //     "locale": "en_US",
  //     "autoRecalc": "ON_CHANGE",
  //     "timeZone": "Etc/GMT",
  //     "defaultFormat": {
  //       "backgroundColor": {
  //         "red": 1,
  //         "green": 1,
  //         "blue": 1
  //       },
  //       "padding": {
  //         "top": 2,
  //         "right": 3,
  //         "bottom": 2,
  //         "left": 3
  //       },
  //       "verticalAlignment": "BOTTOM",
  //       "wrapStrategy": "OVERFLOW_CELL",
  //       "textFormat": {
  //         "foregroundColor": {},
  //         "fontFamily": "arial,sans,sans-serif",
  //         "fontSize": 10,
  //         "bold": false,
  //         "italic": false,
  //         "strikethrough": false,
  //         "underline": false
  //       }
  //     }
  //   },
  //   "sheets": [
  //     {
  //       "properties": {
  //         "sheetId": 1629642057,
  //         "title": "Sample Tab",
  //         "index": 0,
  //         "sheetType": "GRID",
  //         "gridProperties": {
  //           "rowCount": 1000,
  //           "columnCount": 26
  //         }
  //       }
  //     }
  //   ],
  //   "spreadsheetUrl": "https://docs.google.com/spreadsheets/d/1ueEQu3WDBkIAOUhzLnY4zr6JO5SrJx0dQ-YkQlUVYD0/edit"
  // }
  // 

  var i = 0;

  final spreadsheetId = json.stringOf('spreadsheetId');
  var propertiesTitle = json.stringOf('properties.title');
  final propertiesLocale = json.stringOf('properties.locale');
  final propertiesAutoRecalc = json.stringOf('properties.autoRecalc');
  final propertiesTimeZone = json.stringOf('properties.timeZone');
  final propertiesDefaultFormatBackgroundColorRed = json.intOf('properties.defaultFormat.backgroundColor.red');
  final propertiesDefaultFormatBackgroundColorGreen = json.intOf('properties.defaultFormat.backgroundColor.green');
  final propertiesDefaultFormatBackgroundColorBlue = json.intOf('properties.defaultFormat.backgroundColor.blue');
  final propertiesDefaultFormatPaddingTop = json.intOf('properties.defaultFormat.padding.top');
  final propertiesDefaultFormatPaddingRight = json.intOf('properties.defaultFormat.padding.right');
  final propertiesDefaultFormatPaddingBottom = json.intOf('properties.defaultFormat.padding.bottom');
  final propertiesDefaultFormatPaddingLeft = json.intOf('properties.defaultFormat.padding.left');
  final propertiesDefaultFormatVerticalAlignment = json.stringOf('properties.defaultFormat.verticalAlignment');
  final propertiesDefaultFormatWrapStrategy = json.stringOf('properties.defaultFormat.wrapStrategy');
  final propertiesDefaultFormatTextFormatFontFamily = json.stringOf('properties.defaultFormat.textFormat.fontFamily');
  final propertiesDefaultFormatTextFormatFontSize = json.intOf('properties.defaultFormat.textFormat.fontSize');
  final spreadsheetUrl = json.stringOf('spreadsheetUrl');
  i = 0;
  final countI = json.sizeOfArray('sheets');
  while (i < countI) {
    json.i = i;
    final propertiesSheetId = json.intOf('sheets[i].properties.sheetId');
    propertiesTitle = json.stringOf('sheets[i].properties.title');
    final propertiesIndex = json.intOf('sheets[i].properties.index');
    final propertiesSheetType = json.stringOf('sheets[i].properties.sheetType');
    final propertiesGridPropertiesRowCount = json.intOf('sheets[i].properties.gridProperties.rowCount');
    final propertiesGridPropertiesColumnCount = json.intOf('sheets[i].properties.gridProperties.columnCount');
    i++;
  }
}