Google Sheets

GOOGLESHEETS_GET_SPREADSHEET_BY_DATA_FILTER

Returns the spreadsheet at the given ID, filtered by the specified data filters. Use this tool when you need to retrieve specific subsets of data from a Google Sheet based on criteria like A1 notation, developer metadata, or grid ranges.

Remote googlesheets

Other tools also called GOOGLESHEETS_GET_SPREADSHEET_BY_DATA_FILTER? See providers with this name

Input Schema


            {
  "type": "object",
  "properties": {
    "dataFilters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "a1Range": {
            "type": [
              "string",
              "null"
            ],
            "default": null,
            "description": "Selects data that matches the specified A1 range.\nExample: \"Sheet1!A1:B2\""
          },
          "gridRange": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "sheetId": {
                    "anyOf": [
                      {
                        "type": "integer"
                      },
                      {
                        "type": "null"
                      }
                    ],
                    "default": null,
                    "description": "The ID of the sheet this range is on.\nExample: 0"
                  },
                  "endRowIndex": {
                    "anyOf": [
                      {
                        "type": "integer",
                        "exclusiveMinimum": 0
                      },
                      {
                        "type": "null"
                      }
                    ],
                    "default": null,
                    "description": "The end row (0-based, exclusive) of the range.\nExample: 10"
                  },
                  "startRowIndex": {
                    "anyOf": [
                      {
                        "type": "integer",
                        "minimum": 0
                      },
                      {
                        "type": "null"
                      }
                    ],
                    "default": null,
                    "description": "The start row (0-based, inclusive) of the range.\nExample: 0"
                  },
                  "endColumnIndex": {
                    "anyOf": [
                      {
                        "type": "integer",
                        "exclusiveMinimum": 0
                      },
                      {
                        "type": "null"
                      }
                    ],
                    "default": null,
                    "description": "The end column (0-based, exclusive) of the range.\nExample: 5"
                  },
                  "startColumnIndex": {
                    "anyOf": [
                      {
                        "type": "integer",
                        "minimum": 0
                      },
                      {
                        "type": "null"
                      }
                    ],
                    "default": null,
                    "description": "The start column (0-based, inclusive) of the range.\nExample: 0"
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "description": "Selects data that matches the range described by the GridRange."
          },
          "developerMetadataLookup": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "metadataId": {
                    "anyOf": [
                      {
                        "type": "integer"
                      },
                      {
                        "type": "null"
                      }
                    ],
                    "default": null,
                    "description": "Filter by metadata ID.\nExample: 123"
                  },
                  "visibility": {
                    "anyOf": [
                      {
                        "enum": [
                          "DOCUMENT",
                          "PROJECT"
                        ],
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ],
                    "default": null,
                    "description": "Metadata visibility."
                  },
                  "metadataKey": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "default": null,
                    "description": "Filter by metadata key.\nExample: \"project_id\""
                  },
                  "locationType": {
                    "anyOf": [
                      {
                        "enum": [
                          "ROW",
                          "COLUMN",
                          "SHEET",
                          "SPREADSHEET",
                          "OBJECT"
                        ],
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ],
                    "default": null,
                    "description": "Location type of metadata."
                  },
                  "metadataValue": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "default": null,
                    "description": "Filter by metadata value.\nExample: \"alpha\""
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "null"
              }
            ],
            "default": null,
            "description": "Selects data associated with developer metadata."
          }
        },
        "description": "DataFilter",
        "additionalProperties": false
      },
      "description": "The DataFilters used to select which ranges to retrieve."
    },
    "spreadsheetId": {
      "type": "string",
      "description": "The ID of the spreadsheet to request.\nExample: \"abc123xyz789\""
    },
    "includeGridData": {
      "type": [
        "boolean",
        "null"
      ],
      "default": null,
      "description": "True if grid data should be returned. Ignored if a field mask is set.\nExample: true"
    },
    "excludeTablesInBandedRanges": {
      "type": [
        "boolean",
        "null"
      ],
      "default": null,
      "description": "True if tables should be excluded in the banded ranges. False if not set.\nExample: false"
    }
  }
}