Copyright	(c) 2015-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.Google.Resource.Sheets.Spreadsheets.Get

Contents

REST Resource
Creating a Request
Request Lenses

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

type SpreadsheetsGetResource = "v4" :> ("spreadsheets" :> (Capture "spreadsheetId" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParams "ranges" Text :> (QueryParam "includeGridData" Bool :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] Spreadsheet))))))))))
spreadsheetsGet :: Text -> SpreadsheetsGet
data SpreadsheetsGet
sgXgafv :: Lens' SpreadsheetsGet (Maybe Xgafv)
sgUploadProtocol :: Lens' SpreadsheetsGet (Maybe Text)
sgAccessToken :: Lens' SpreadsheetsGet (Maybe Text)
sgSpreadsheetId :: Lens' SpreadsheetsGet Text
sgUploadType :: Lens' SpreadsheetsGet (Maybe Text)
sgRanges :: Lens' SpreadsheetsGet [Text]
sgIncludeGridData :: Lens' SpreadsheetsGet (Maybe Bool)
sgCallback :: Lens' SpreadsheetsGet (Maybe Text)

REST Resource

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

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

Creating a Request

spreadsheetsGet Source #

Arguments

:: Text	`sgSpreadsheetId`
-> 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 Source #

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 Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.Get Methods (==) :: SpreadsheetsGet -> SpreadsheetsGet -> Bool # (/=) :: SpreadsheetsGet -> SpreadsheetsGet -> Bool #
Data SpreadsheetsGet Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.Get 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 Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.Get Methods showsPrec :: Int -> SpreadsheetsGet -> ShowS # show :: SpreadsheetsGet -> String # showList :: [SpreadsheetsGet] -> ShowS #
Generic SpreadsheetsGet Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.Get Associated Types type Rep SpreadsheetsGet :: Type -> Type # Methods from :: SpreadsheetsGet -> Rep SpreadsheetsGet x # to :: Rep SpreadsheetsGet x -> SpreadsheetsGet #
GoogleRequest SpreadsheetsGet Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.Get Associated Types type Rs SpreadsheetsGet :: Type # type Scopes SpreadsheetsGet :: [Symbol] # Methods requestClient :: SpreadsheetsGet -> GClient (Rs SpreadsheetsGet) #
type Rep SpreadsheetsGet Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.Get type Rep SpreadsheetsGet = D1 (MetaData "SpreadsheetsGet" "Network.Google.Resource.Sheets.Spreadsheets.Get" "gogol-sheets-0.4.0-DWkMVDpj7ZbHiXYeCjugGu" False) (C1 (MetaCons "SpreadsheetsGet'" PrefixI True) (((S1 (MetaSel (Just "_sgXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: S1 (MetaSel (Just "_sgUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_sgAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_sgSpreadsheetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :: ((S1 (MetaSel (Just "_sgUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_sgRanges") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 (MetaSel (Just "_sgIncludeGridData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_sgCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes SpreadsheetsGet Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.Get type Scopes SpreadsheetsGet = "https://www.googleapis.com/auth/drive" ': ("https://www.googleapis.com/auth/drive.file" ': ("https://www.googleapis.com/auth/drive.readonly" ': ("https://www.googleapis.com/auth/spreadsheets" ': ("https://www.googleapis.com/auth/spreadsheets.readonly" ': ([] :: [Symbol])))))
type Rs SpreadsheetsGet Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.Get type Rs SpreadsheetsGet = Spreadsheet

Request Lenses

sgXgafv :: Lens' SpreadsheetsGet (Maybe Xgafv) Source #

V1 error format.

sgUploadProtocol :: Lens' SpreadsheetsGet (Maybe Text) Source #

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

sgAccessToken :: Lens' SpreadsheetsGet (Maybe Text) Source #

OAuth access token.

sgSpreadsheetId :: Lens' SpreadsheetsGet Text Source #

The spreadsheet to request.

sgUploadType :: Lens' SpreadsheetsGet (Maybe Text) Source #

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

sgRanges :: Lens' SpreadsheetsGet [Text] Source #

The ranges to retrieve from the spreadsheet.

sgIncludeGridData :: Lens' SpreadsheetsGet (Maybe Bool) Source #

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

sgCallback :: Lens' SpreadsheetsGet (Maybe Text) Source #

JSONP