gogol-sheets-0.3.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.Get

Contents

Description

Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. 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 URL 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. To retrieve only subsets of the spreadsheet, use the ranges URL parameter. Multiple ranges can be specified. Limiting the range will return only the portions of the spreadsheet that intersect the requested ranges. Ranges are specified using A1 notation.

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

Synopsis

REST Resource

type SpreadsheetsGetResource = "v4" :> ("spreadsheets" :> (Capture "spreadsheetId" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParams "ranges" Text :> (QueryParam "includeGridData" Bool :> (QueryParam "bearer_token" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] Spreadsheet)))))))))))) #

A resource alias for sheets.spreadsheets.get method which the SpreadsheetsGet request conforms to.

Creating a Request

spreadsheetsGet #

Creates a value of SpreadsheetsGet with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data SpreadsheetsGet #

Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. 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 URL 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. To retrieve only subsets of the spreadsheet, use the ranges URL parameter. Multiple ranges can be specified. Limiting the range will return only the portions of the spreadsheet that intersect the requested ranges. Ranges are specified using A1 notation.

See: spreadsheetsGet smart constructor.

Instances

Eq SpreadsheetsGet # 
Data SpreadsheetsGet # 

Methods

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

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

toConstr :: SpreadsheetsGet -> Constr #

dataTypeOf :: SpreadsheetsGet -> DataType #

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

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

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

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

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

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

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

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

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

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

Show SpreadsheetsGet # 
Generic SpreadsheetsGet # 
GoogleRequest SpreadsheetsGet # 
type Rep SpreadsheetsGet # 
type Scopes SpreadsheetsGet # 
type Scopes SpreadsheetsGet = (:) Symbol "https://www.googleapis.com/auth/drive" ((:) Symbol "https://www.googleapis.com/auth/drive.readonly" ((:) Symbol "https://www.googleapis.com/auth/spreadsheets" ((:) Symbol "https://www.googleapis.com/auth/spreadsheets.readonly" ([] Symbol))))
type Rs SpreadsheetsGet # 

Request Lenses

sgXgafv :: Lens' SpreadsheetsGet (Maybe Xgafv) #

V1 error format.

sgUploadProtocol :: Lens' SpreadsheetsGet (Maybe Text) #

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

sgPp :: Lens' SpreadsheetsGet Bool #

Pretty-print response.

sgAccessToken :: Lens' SpreadsheetsGet (Maybe Text) #

OAuth access token.

sgSpreadsheetId :: Lens' SpreadsheetsGet Text #

The spreadsheet to request.

sgUploadType :: Lens' SpreadsheetsGet (Maybe Text) #

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

sgRanges :: Lens' SpreadsheetsGet [Text] #

The ranges to retrieve from the spreadsheet.

sgIncludeGridData :: Lens' SpreadsheetsGet (Maybe Bool) #

True if grid data should be returned. This parameter is ignored if a field mask was set in the request.

sgBearerToken :: Lens' SpreadsheetsGet (Maybe Text) #

OAuth bearer token.