Google Sheets

GOOGLESHEETS_UPDATE_SHEET_PROPERTIES

Tool to update properties of a sheet (worksheet) within a Google Spreadsheet, such as its title, index, visibility, tab color, or grid properties. Use this when you need to modify the metadata or appearance of a specific sheet.

Remote googlesheets

Other tools also called GOOGLESHEETS_UPDATE_SHEET_PROPERTIES? See providers with this name

Input Schema


            {
  "type": "object",
  "properties": {
    "spreadsheetId": {
      "type": "string",
      "description": "The ID of the spreadsheet containing the sheet to update."
    },
    "updateSheetProperties": {
      "type": "object",
      "required": [
        "fields",
        "properties"
      ],
      "properties": {
        "fields": {
          "type": "string",
          "description": "A comma-separated string specifying which properties to update. Uses FieldMask format. For example, to update the title and index, use \"title,index\". To update all mutable sheet properties, use \"*\"."
        },
        "properties": {
          "type": "object",
          "required": [
            "sheetId"
          ],
          "properties": {
            "index": {
              "anyOf": [
                {
                  "type": "integer"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "description": "The new zero-based index of the sheet."
            },
            "title": {
              "type": [
                "string",
                "null"
              ],
              "default": null,
              "description": "The new title of the sheet."
            },
            "hidden": {
              "type": [
                "boolean",
                "null"
              ],
              "default": null,
              "description": "Whether the sheet should be hidden (true) or visible (false)."
            },
            "sheetId": {
              "type": "integer",
              "description": "The ID of the sheet to update."
            },
            "tabColorStyle": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "rgbColor": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "red": {
                              "type": [
                                "number",
                                "null"
                              ],
                              "default": null,
                              "description": "The red component of the color, between 0.0 and 1.0."
                            },
                            "blue": {
                              "type": [
                                "number",
                                "null"
                              ],
                              "default": null,
                              "description": "The blue component of the color, between 0.0 and 1.0."
                            },
                            "alpha": {
                              "type": [
                                "number",
                                "null"
                              ],
                              "default": null,
                              "description": "The alpha component of the color, between 0.0 and 1.0."
                            },
                            "green": {
                              "type": [
                                "number",
                                "null"
                              ],
                              "default": null,
                              "description": "The green component of the color, between 0.0 and 1.0."
                            }
                          },
                          "additionalProperties": false
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "default": null,
                      "description": "Represents a color using RGB values."
                    },
                    "themeColor": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "default": null,
                      "description": "Represents a theme color type."
                    }
                  },
                  "additionalProperties": false
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "description": "The new tab color for the sheet."
            },
            "gridProperties": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "rowCount": {
                      "anyOf": [
                        {
                          "type": "integer"
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "default": null,
                      "description": "The number of rows in the sheet."
                    },
                    "columnCount": {
                      "anyOf": [
                        {
                          "type": "integer"
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "default": null,
                      "description": "The number of columns in the sheet."
                    },
                    "rightToLeft": {
                      "type": [
                        "boolean",
                        "null"
                      ],
                      "default": null,
                      "description": "True if the sheet is an RTL sheet."
                    },
                    "hideGridlines": {
                      "type": [
                        "boolean",
                        "null"
                      ],
                      "default": null,
                      "description": "True if gridlines are hidden."
                    },
                    "frozenRowCount": {
                      "anyOf": [
                        {
                          "type": "integer"
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "default": null,
                      "description": "The number of frozen rows."
                    },
                    "frozenColumnCount": {
                      "anyOf": [
                        {
                          "type": "integer"
                        },
                        {
                          "type": "null"
                        }
                      ],
                      "default": null,
                      "description": "The number of frozen columns."
                    }
                  },
                  "additionalProperties": false
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "description": "Properties of a grid sheet."
            }
          },
          "description": "The properties to update.",
          "additionalProperties": false
        }
      },
      "description": "The details of the sheet properties to update.",
      "additionalProperties": false
    }
  }
}