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.Values.Get

Contents

REST Resource
Creating a Request
Request Lenses

Description

Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range.

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

Synopsis

type SpreadsheetsValuesGetResource = "v4" :> ("spreadsheets" :> (Capture "spreadsheetId" Text :> ("values" :> (Capture "range" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "valueRenderOption" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "dateTimeRenderOption" Text :> (QueryParam "majorDimension" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ValueRange)))))))))))))
spreadsheetsValuesGet :: Text -> Text -> SpreadsheetsValuesGet
data SpreadsheetsValuesGet
svgXgafv :: Lens' SpreadsheetsValuesGet (Maybe Xgafv)
svgValueRenderOption :: Lens' SpreadsheetsValuesGet (Maybe Text)
svgUploadProtocol :: Lens' SpreadsheetsValuesGet (Maybe Text)
svgAccessToken :: Lens' SpreadsheetsValuesGet (Maybe Text)
svgSpreadsheetId :: Lens' SpreadsheetsValuesGet Text
svgUploadType :: Lens' SpreadsheetsValuesGet (Maybe Text)
svgRange :: Lens' SpreadsheetsValuesGet Text
svgDateTimeRenderOption :: Lens' SpreadsheetsValuesGet (Maybe Text)
svgMajorDimension :: Lens' SpreadsheetsValuesGet (Maybe Text)
svgCallback :: Lens' SpreadsheetsValuesGet (Maybe Text)

REST Resource

type SpreadsheetsValuesGetResource = "v4" :> ("spreadsheets" :> (Capture "spreadsheetId" Text :> ("values" :> (Capture "range" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "valueRenderOption" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "dateTimeRenderOption" Text :> (QueryParam "majorDimension" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ValueRange))))))))))))) Source #

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

Creating a Request

spreadsheetsValuesGet Source #

Arguments

:: Text	`svgSpreadsheetId`
-> Text	`svgRange`
-> SpreadsheetsValuesGet

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

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

data SpreadsheetsValuesGet Source #

Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range.

See: spreadsheetsValuesGet smart constructor.

Instances

Eq SpreadsheetsValuesGet Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.Values.Get Methods (==) :: SpreadsheetsValuesGet -> SpreadsheetsValuesGet -> Bool # (/=) :: SpreadsheetsValuesGet -> SpreadsheetsValuesGet -> Bool #
Data SpreadsheetsValuesGet Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.Values.Get Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SpreadsheetsValuesGet -> c SpreadsheetsValuesGet # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SpreadsheetsValuesGet # toConstr :: SpreadsheetsValuesGet -> Constr # dataTypeOf :: SpreadsheetsValuesGet -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SpreadsheetsValuesGet) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SpreadsheetsValuesGet) # gmapT :: (forall b. Data b => b -> b) -> SpreadsheetsValuesGet -> SpreadsheetsValuesGet # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SpreadsheetsValuesGet -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SpreadsheetsValuesGet -> r # gmapQ :: (forall d. Data d => d -> u) -> SpreadsheetsValuesGet -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SpreadsheetsValuesGet -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SpreadsheetsValuesGet -> m SpreadsheetsValuesGet # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SpreadsheetsValuesGet -> m SpreadsheetsValuesGet # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SpreadsheetsValuesGet -> m SpreadsheetsValuesGet #
Show SpreadsheetsValuesGet Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.Values.Get Methods showsPrec :: Int -> SpreadsheetsValuesGet -> ShowS # show :: SpreadsheetsValuesGet -> String # showList :: [SpreadsheetsValuesGet] -> ShowS #
Generic SpreadsheetsValuesGet Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.Values.Get Associated Types type Rep SpreadsheetsValuesGet :: Type -> Type # Methods from :: SpreadsheetsValuesGet -> Rep SpreadsheetsValuesGet x # to :: Rep SpreadsheetsValuesGet x -> SpreadsheetsValuesGet #
GoogleRequest SpreadsheetsValuesGet Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.Values.Get Associated Types type Rs SpreadsheetsValuesGet :: Type # type Scopes SpreadsheetsValuesGet :: [Symbol] # Methods requestClient :: SpreadsheetsValuesGet -> GClient (Rs SpreadsheetsValuesGet) #
type Rep SpreadsheetsValuesGet Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.Values.Get type Rep SpreadsheetsValuesGet = D1 (MetaData "SpreadsheetsValuesGet" "Network.Google.Resource.Sheets.Spreadsheets.Values.Get" "gogol-sheets-0.4.0-DWkMVDpj7ZbHiXYeCjugGu" False) (C1 (MetaCons "SpreadsheetsValuesGet'" PrefixI True) (((S1 (MetaSel (Just "_svgXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: S1 (MetaSel (Just "_svgValueRenderOption") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_svgUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_svgAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_svgSpreadsheetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))) :: ((S1 (MetaSel (Just "_svgUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_svgRange") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :: (S1 (MetaSel (Just "_svgDateTimeRenderOption") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_svgMajorDimension") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_svgCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))
type Scopes SpreadsheetsValuesGet Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.Values.Get type Scopes SpreadsheetsValuesGet = "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 SpreadsheetsValuesGet Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.Values.Get type Rs SpreadsheetsValuesGet = ValueRange

Request Lenses

svgXgafv :: Lens' SpreadsheetsValuesGet (Maybe Xgafv) Source #

V1 error format.

svgValueRenderOption :: Lens' SpreadsheetsValuesGet (Maybe Text) Source #

How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.

svgUploadProtocol :: Lens' SpreadsheetsValuesGet (Maybe Text) Source #

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

svgAccessToken :: Lens' SpreadsheetsValuesGet (Maybe Text) Source #

OAuth access token.

svgSpreadsheetId :: Lens' SpreadsheetsValuesGet Text Source #

The ID of the spreadsheet to retrieve data from.

svgUploadType :: Lens' SpreadsheetsValuesGet (Maybe Text) Source #

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

svgRange :: Lens' SpreadsheetsValuesGet Text Source #

The A1 notation of the values to retrieve.

svgDateTimeRenderOption :: Lens' SpreadsheetsValuesGet (Maybe Text) Source #

How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].

svgMajorDimension :: Lens' SpreadsheetsValuesGet (Maybe Text) Source #

The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`.

svgCallback :: Lens' SpreadsheetsValuesGet (Maybe Text) Source #

JSONP