Method: googleapis.sheets.v4.spreadsheets.sheets.copyTo

Copies a single sheet from a spreadsheet to another spreadsheet. Returns the properties of the newly created sheet.

Arguments

Parameters
sheetId

integer (int32 format)

Required. The ID of the sheet to copy.

spreadsheetId

string

Required. The ID of the spreadsheet containing the sheet to copy.

body

object (CopySheetToAnotherSpreadsheetRequest)

Required.

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of SheetProperties.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- copyTo:
    call: googleapis.sheets.v4.spreadsheets.sheets.copyTo
    args:
        sheetId: ...
        spreadsheetId: ...
        body:
            destinationSpreadsheetId: ...
    result: copyToResult

JSON

[
  {
    "copyTo": {
      "call": "googleapis.sheets.v4.spreadsheets.sheets.copyTo",
      "args": {
        "sheetId": "...",
        "spreadsheetId": "...",
        "body": {
          "destinationSpreadsheetId": "..."
        }
      },
      "result": "copyToResult"
    }
  }
]