Method fetch_sheet_metadata

gspread/spreadsheet.py:218–230

Similar to :method spreadsheets_get:`gspread.http_client.spreadsheets_get`, get the spreadsheet form the API but by default **does not get the cells data**. It only retrieve the the metadata from the spreadsheet. :param dict params: (optional) the HTTP params for the GET req

(
        self, params: Optional[ParamsType] = None
    )

        )

    def fetch_sheet_metadata(
        self, params: Optional[ParamsType] = None
    ) -> Mapping[str, Any]:
        """Similar to :method spreadsheets_get:`gspread.http_client.spreadsheets_get`,
        get the spreadsheet form the API but by default **does not get the cells data**.
        It only retrieve the the metadata from the spreadsheet.

        :param dict params: (optional) the HTTP params for the GET request.
            By default sets the parameter ``includeGridData`` to ``false``.
        :returns: The raw spreadsheet
        :rtype: dict
        """
        return self.client.fetch_sheet_metadata(self.id, params=params)

    def get_worksheet(self, index: int) -> Worksheet:
        """Returns a worksheet with specified `index`.