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.BatchGet

Contents

REST Resource
Creating a Request
Request Lenses

Description

Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges.

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

Synopsis

type SpreadsheetsValuesBatchGetResource = "v4" :> ("spreadsheets" :> (Capture "spreadsheetId" Text :> ("values:batchGet" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "valueRenderOption" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParams "ranges" Text :> (QueryParam "dateTimeRenderOption" Text :> (QueryParam "majorDimension" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] BatchGetValuesResponse)))))))))))))
spreadsheetsValuesBatchGet :: Text -> SpreadsheetsValuesBatchGet
data SpreadsheetsValuesBatchGet
svbgXgafv :: Lens' SpreadsheetsValuesBatchGet (Maybe Xgafv)
svbgValueRenderOption :: Lens' SpreadsheetsValuesBatchGet (Maybe Text)
svbgUploadProtocol :: Lens' SpreadsheetsValuesBatchGet (Maybe Text)
svbgAccessToken :: Lens' SpreadsheetsValuesBatchGet (Maybe Text)
svbgSpreadsheetId :: Lens' SpreadsheetsValuesBatchGet Text
svbgUploadType :: Lens' SpreadsheetsValuesBatchGet (Maybe Text)
svbgRanges :: Lens' SpreadsheetsValuesBatchGet [Text]
svbgDateTimeRenderOption :: Lens' SpreadsheetsValuesBatchGet (Maybe Text)
svbgMajorDimension :: Lens' SpreadsheetsValuesBatchGet (Maybe Text)
svbgCallback :: Lens' SpreadsheetsValuesBatchGet (Maybe Text)

REST Resource

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

A resource alias for sheets.spreadsheets.values.batchGet method which the SpreadsheetsValuesBatchGet request conforms to.

Creating a Request

spreadsheetsValuesBatchGet Source #

Arguments

:: Text	`svbgSpreadsheetId`
-> SpreadsheetsValuesBatchGet

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

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

data SpreadsheetsValuesBatchGet Source #

Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges.

See: spreadsheetsValuesBatchGet smart constructor.

Instances

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

Request Lenses

svbgXgafv :: Lens' SpreadsheetsValuesBatchGet (Maybe Xgafv) Source #

V1 error format.

svbgValueRenderOption :: Lens' SpreadsheetsValuesBatchGet (Maybe Text) Source #

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

svbgUploadProtocol :: Lens' SpreadsheetsValuesBatchGet (Maybe Text) Source #

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

svbgAccessToken :: Lens' SpreadsheetsValuesBatchGet (Maybe Text) Source #

OAuth access token.

svbgSpreadsheetId :: Lens' SpreadsheetsValuesBatchGet Text Source #

The ID of the spreadsheet to retrieve data from.

svbgUploadType :: Lens' SpreadsheetsValuesBatchGet (Maybe Text) Source #

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

svbgRanges :: Lens' SpreadsheetsValuesBatchGet [Text] Source #

The A1 notation of the values to retrieve.

svbgDateTimeRenderOption :: Lens' SpreadsheetsValuesBatchGet (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].

svbgMajorDimension :: Lens' SpreadsheetsValuesBatchGet (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]]`.

svbgCallback :: Lens' SpreadsheetsValuesBatchGet (Maybe Text) Source #

JSONP