copyTo method

Future<SheetProperties> copyTo(CopySheetToAnotherSpreadsheetRequest request, String spreadsheetId, int sheetId, { String? $fields, })

Copies a single sheet from a spreadsheet to another spreadsheet.

Returns the properties of the newly created sheet.

request - The metadata request object.

Request parameters:

spreadsheetId - The ID of the spreadsheet containing the sheet to copy.

sheetId - The ID of the sheet to copy.

$fields - Selector specifying which fields to include in a partial response.

Completes with a SheetProperties.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<SheetProperties> copyTo(
  CopySheetToAnotherSpreadsheetRequest request,
  core.String spreadsheetId,
  core.int sheetId, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v4/spreadsheets/' +
      commons.escapeVariable('$spreadsheetId') +
      '/sheets/' +
      commons.escapeVariable('$sheetId') +
      ':copyTo';

  final response_ = await _requester.request(
    url_,
    'POST',
    body: body_,
    queryParams: queryParams_,
  );
  return SheetProperties.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}