Provider Hub
Google
gsheets
Get Sheet Name

L2 Construct: get_sheet_name

sheets google

Description

GetSheetName returns the name of a sheet in a spreadsheet.

This function is useful for getting the name of a sheet in a spreadsheet, which can be used to copy data from one sheet to another.

It can also be used to get the name of a sheet in a spreadsheet, which can be used to copy data from one sheet to another.

L2 Data

  1. Provider: google
  2. Module: gsheets
  3. Action: get_sheet_name

Example Step

{
  "name": "insert-your-step-name",
  "type": "l2",
  "l2_data": {
    "provider": "google",
    "module": "gsheets",
    "action": "get_sheet_name",
    "metadata": {}
  }
}

Input

Example

{
  "spreadsheet_id": "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
  "sheet_id": "1"
}

Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://pontus.bpa/pkgs/l2/google/gsheets/get-sheet-name-input",
  "$ref": "#/$defs/GetSheetNameInput",
  "$defs": {
    "GetSheetNameInput": {
      "properties": {
        "spreadsheet_id": {
          "type": "string"
        },
        "sheet_id": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": ["spreadsheet_id", "sheet_id"]
    }
  }
}

Output

Example

{
  "sheet_name": "Sheet1",
  "error": {
    "is_error": false
  }
}

Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://pontus.bpa/pkgs/l2/google/gsheets/get-sheet-name-output",
  "$ref": "#/$defs/GetSheetNameOutput",
  "$defs": {
    "GetSheetNameOutput": {
      "properties": {
        "sheet_name": {
          "type": "string"
        },
        "error": {
          "$ref": "#/$defs/HandlerError"
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": ["sheet_name", "error"]
    },
    "HandlerError": {
      "properties": {
        "is_error": {
          "type": "boolean"
        },
        "errors": {
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": ["is_error"]
    }
  }
}
Get SheetGet Spreadsheet