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

Contents

REST Resource
Creating a Request
Request Lenses

Description

Applies one or more updates to the spreadsheet. Each request is validated before being applied. If any request is not valid then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. The replies will mirror the requests. For example, if you applied 4 updates and the 3rd one had a reply, then the response will have 2 empty replies, the actual reply, and another empty reply, in that order. Due to the collaborative nature of spreadsheets, it is not guaranteed that the spreadsheet will reflect exactly your changes after this completes, however it is guaranteed that the updates in the request will be applied together atomically. Your changes may be altered with respect to collaborator changes. If there are no collaborators, the spreadsheet should reflect your changes.

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

Synopsis

type SpreadsheetsBatchUpdateResource = "v4" :> ("spreadsheets" :> (CaptureMode "spreadsheetId" "batchUpdate" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] BatchUpdateSpreadsheetRequest :> Post '[JSON] BatchUpdateSpreadsheetResponse)))))))))
spreadsheetsBatchUpdate :: Text -> BatchUpdateSpreadsheetRequest -> SpreadsheetsBatchUpdate
data SpreadsheetsBatchUpdate
sbuXgafv :: Lens' SpreadsheetsBatchUpdate (Maybe Xgafv)
sbuUploadProtocol :: Lens' SpreadsheetsBatchUpdate (Maybe Text)
sbuAccessToken :: Lens' SpreadsheetsBatchUpdate (Maybe Text)
sbuSpreadsheetId :: Lens' SpreadsheetsBatchUpdate Text
sbuUploadType :: Lens' SpreadsheetsBatchUpdate (Maybe Text)
sbuPayload :: Lens' SpreadsheetsBatchUpdate BatchUpdateSpreadsheetRequest
sbuCallback :: Lens' SpreadsheetsBatchUpdate (Maybe Text)

REST Resource

type SpreadsheetsBatchUpdateResource = "v4" :> ("spreadsheets" :> (CaptureMode "spreadsheetId" "batchUpdate" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] BatchUpdateSpreadsheetRequest :> Post '[JSON] BatchUpdateSpreadsheetResponse))))))))) Source #

A resource alias for sheets.spreadsheets.batchUpdate method which the SpreadsheetsBatchUpdate request conforms to.

Creating a Request

spreadsheetsBatchUpdate Source #

Arguments

:: Text	`sbuSpreadsheetId`
-> BatchUpdateSpreadsheetRequest	`sbuPayload`
-> SpreadsheetsBatchUpdate

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

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

data SpreadsheetsBatchUpdate Source #

Applies one or more updates to the spreadsheet. Each request is validated before being applied. If any request is not valid then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. The replies will mirror the requests. For example, if you applied 4 updates and the 3rd one had a reply, then the response will have 2 empty replies, the actual reply, and another empty reply, in that order. Due to the collaborative nature of spreadsheets, it is not guaranteed that the spreadsheet will reflect exactly your changes after this completes, however it is guaranteed that the updates in the request will be applied together atomically. Your changes may be altered with respect to collaborator changes. If there are no collaborators, the spreadsheet should reflect your changes.

See: spreadsheetsBatchUpdate smart constructor.

Instances

Eq SpreadsheetsBatchUpdate Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.BatchUpdate Methods (==) :: SpreadsheetsBatchUpdate -> SpreadsheetsBatchUpdate -> Bool # (/=) :: SpreadsheetsBatchUpdate -> SpreadsheetsBatchUpdate -> Bool #
Data SpreadsheetsBatchUpdate Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.BatchUpdate Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SpreadsheetsBatchUpdate -> c SpreadsheetsBatchUpdate # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SpreadsheetsBatchUpdate # toConstr :: SpreadsheetsBatchUpdate -> Constr # dataTypeOf :: SpreadsheetsBatchUpdate -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SpreadsheetsBatchUpdate) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SpreadsheetsBatchUpdate) # gmapT :: (forall b. Data b => b -> b) -> SpreadsheetsBatchUpdate -> SpreadsheetsBatchUpdate # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SpreadsheetsBatchUpdate -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SpreadsheetsBatchUpdate -> r # gmapQ :: (forall d. Data d => d -> u) -> SpreadsheetsBatchUpdate -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SpreadsheetsBatchUpdate -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SpreadsheetsBatchUpdate -> m SpreadsheetsBatchUpdate # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SpreadsheetsBatchUpdate -> m SpreadsheetsBatchUpdate # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SpreadsheetsBatchUpdate -> m SpreadsheetsBatchUpdate #
Show SpreadsheetsBatchUpdate Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.BatchUpdate Methods showsPrec :: Int -> SpreadsheetsBatchUpdate -> ShowS # show :: SpreadsheetsBatchUpdate -> String # showList :: [SpreadsheetsBatchUpdate] -> ShowS #
Generic SpreadsheetsBatchUpdate Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.BatchUpdate Associated Types type Rep SpreadsheetsBatchUpdate :: Type -> Type # Methods from :: SpreadsheetsBatchUpdate -> Rep SpreadsheetsBatchUpdate x # to :: Rep SpreadsheetsBatchUpdate x -> SpreadsheetsBatchUpdate #
GoogleRequest SpreadsheetsBatchUpdate Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.BatchUpdate Associated Types type Rs SpreadsheetsBatchUpdate :: Type # type Scopes SpreadsheetsBatchUpdate :: [Symbol] # Methods requestClient :: SpreadsheetsBatchUpdate -> GClient (Rs SpreadsheetsBatchUpdate) #
type Rep SpreadsheetsBatchUpdate Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.BatchUpdate type Rep SpreadsheetsBatchUpdate = D1 (MetaData "SpreadsheetsBatchUpdate" "Network.Google.Resource.Sheets.Spreadsheets.BatchUpdate" "gogol-sheets-0.4.0-DWkMVDpj7ZbHiXYeCjugGu" False) (C1 (MetaCons "SpreadsheetsBatchUpdate'" PrefixI True) ((S1 (MetaSel (Just "_sbuXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_sbuUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_sbuAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_sbuSpreadsheetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_sbuUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_sbuPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 BatchUpdateSpreadsheetRequest) :: S1 (MetaSel (Just "_sbuCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes SpreadsheetsBatchUpdate Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.BatchUpdate type Scopes SpreadsheetsBatchUpdate = "https://www.googleapis.com/auth/drive" ': ("https://www.googleapis.com/auth/drive.file" ': ("https://www.googleapis.com/auth/spreadsheets" ': ([] :: [Symbol])))
type Rs SpreadsheetsBatchUpdate Source #
Instance details Defined in Network.Google.Resource.Sheets.Spreadsheets.BatchUpdate type Rs SpreadsheetsBatchUpdate = BatchUpdateSpreadsheetResponse

Request Lenses

sbuXgafv :: Lens' SpreadsheetsBatchUpdate (Maybe Xgafv) Source #

V1 error format.

sbuUploadProtocol :: Lens' SpreadsheetsBatchUpdate (Maybe Text) Source #

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

sbuAccessToken :: Lens' SpreadsheetsBatchUpdate (Maybe Text) Source #

OAuth access token.

sbuSpreadsheetId :: Lens' SpreadsheetsBatchUpdate Text Source #

The spreadsheet to apply the updates to.

sbuUploadType :: Lens' SpreadsheetsBatchUpdate (Maybe Text) Source #

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

sbuPayload :: Lens' SpreadsheetsBatchUpdate BatchUpdateSpreadsheetRequest Source #

Multipart request metadata.

sbuCallback :: Lens' SpreadsheetsBatchUpdate (Maybe Text) Source #

JSONP