gogol-sheets-0.4.0: Google Sheets SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.Sheets.Spreadsheets.GetByDataFilter

Contents

Description

Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. This method differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to return by specifying a dataFilters parameter. Multiple DataFilters can be specified. Specifying one or more data filters will return the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids will not be returned. You can include grid data one of two ways: * Specify a field mask listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, it is recommended to retrieve only the specific fields of the spreadsheet that you want.

See: Google Sheets API Reference for sheets.spreadsheets.getByDataFilter.

Synopsis

REST Resource

type SpreadsheetsGetByDataFilterResource = "v4" :> ("spreadsheets" :> (CaptureMode "spreadsheetId" "getByDataFilter" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] GetSpreadsheetByDataFilterRequest :> Post '[JSON] Spreadsheet))))))))) Source #

A resource alias for sheets.spreadsheets.getByDataFilter method which the SpreadsheetsGetByDataFilter request conforms to.

Creating a Request

data SpreadsheetsGetByDataFilter Source #

Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. This method differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to return by specifying a dataFilters parameter. Multiple DataFilters can be specified. Specifying one or more data filters will return the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids will not be returned. You can include grid data one of two ways: * Specify a field mask listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, it is recommended to retrieve only the specific fields of the spreadsheet that you want.

See: spreadsheetsGetByDataFilter smart constructor.

Instances
Eq SpreadsheetsGetByDataFilter Source # 
Instance details

Defined in Network.Google.Resource.Sheets.Spreadsheets.GetByDataFilter

Data SpreadsheetsGetByDataFilter Source # 
Instance details

Defined in Network.Google.Resource.Sheets.Spreadsheets.GetByDataFilter

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SpreadsheetsGetByDataFilter -> c SpreadsheetsGetByDataFilter #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SpreadsheetsGetByDataFilter #

toConstr :: SpreadsheetsGetByDataFilter -> Constr #

dataTypeOf :: SpreadsheetsGetByDataFilter -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SpreadsheetsGetByDataFilter) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SpreadsheetsGetByDataFilter) #

gmapT :: (forall b. Data b => b -> b) -> SpreadsheetsGetByDataFilter -> SpreadsheetsGetByDataFilter #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SpreadsheetsGetByDataFilter -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SpreadsheetsGetByDataFilter -> r #

gmapQ :: (forall d. Data d => d -> u) -> SpreadsheetsGetByDataFilter -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SpreadsheetsGetByDataFilter -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SpreadsheetsGetByDataFilter -> m SpreadsheetsGetByDataFilter #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SpreadsheetsGetByDataFilter -> m SpreadsheetsGetByDataFilter #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SpreadsheetsGetByDataFilter -> m SpreadsheetsGetByDataFilter #

Show SpreadsheetsGetByDataFilter Source # 
Instance details

Defined in Network.Google.Resource.Sheets.Spreadsheets.GetByDataFilter

Generic SpreadsheetsGetByDataFilter Source # 
Instance details

Defined in Network.Google.Resource.Sheets.Spreadsheets.GetByDataFilter

Associated Types

type Rep SpreadsheetsGetByDataFilter :: Type -> Type #

GoogleRequest SpreadsheetsGetByDataFilter Source # 
Instance details

Defined in Network.Google.Resource.Sheets.Spreadsheets.GetByDataFilter

type Rep SpreadsheetsGetByDataFilter Source # 
Instance details

Defined in Network.Google.Resource.Sheets.Spreadsheets.GetByDataFilter

type Rep SpreadsheetsGetByDataFilter = D1 (MetaData "SpreadsheetsGetByDataFilter" "Network.Google.Resource.Sheets.Spreadsheets.GetByDataFilter" "gogol-sheets-0.4.0-DWkMVDpj7ZbHiXYeCjugGu" False) (C1 (MetaCons "SpreadsheetsGetByDataFilter'" PrefixI True) ((S1 (MetaSel (Just "_sgbdfXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_sgbdfUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_sgbdfAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_sgbdfSpreadsheetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_sgbdfUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_sgbdfPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 GetSpreadsheetByDataFilterRequest) :*: S1 (MetaSel (Just "_sgbdfCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes SpreadsheetsGetByDataFilter Source # 
Instance details

Defined in Network.Google.Resource.Sheets.Spreadsheets.GetByDataFilter

type Scopes SpreadsheetsGetByDataFilter = "https://www.googleapis.com/auth/drive" ': ("https://www.googleapis.com/auth/drive.file" ': ("https://www.googleapis.com/auth/spreadsheets" ': ([] :: [Symbol])))
type Rs SpreadsheetsGetByDataFilter Source # 
Instance details

Defined in Network.Google.Resource.Sheets.Spreadsheets.GetByDataFilter

Request Lenses

sgbdfUploadProtocol :: Lens' SpreadsheetsGetByDataFilter (Maybe Text) Source #

Upload protocol for media (e.g. "raw", "multipart").

sgbdfUploadType :: Lens' SpreadsheetsGetByDataFilter (Maybe Text) Source #

Legacy upload protocol for media (e.g. "media", "multipart").