Network.Google.Resource.Sheets.Spreadsheets.BatchUpdate

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.

REST Resource

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

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

Creating a Request

spreadsheetsBatchUpdate

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:

• sbuXgafv
• sbuUploadProtocol
• sbuPp
• sbuAccessToken
• sbuSpreadsheetId
• sbuUploadType
• sbuPayload
• sbuBearerToken
• sbuCallback

data SpreadsheetsBatchUpdate

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

Methods

(==) :: SpreadsheetsBatchUpdate -> SpreadsheetsBatchUpdate -> Bool

(/=) :: SpreadsheetsBatchUpdate -> SpreadsheetsBatchUpdate -> Bool

Data SpreadsheetsBatchUpdate

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

Methods

showsPrec :: Int -> SpreadsheetsBatchUpdate -> ShowS

show :: SpreadsheetsBatchUpdate -> String

showList :: [SpreadsheetsBatchUpdate] -> ShowS

Generic SpreadsheetsBatchUpdate

Associated Types

type Rep SpreadsheetsBatchUpdate :: * -> *

Methods

from :: SpreadsheetsBatchUpdate -> Rep SpreadsheetsBatchUpdate x

to :: Rep SpreadsheetsBatchUpdate x -> SpreadsheetsBatchUpdate

GoogleRequest SpreadsheetsBatchUpdate

Associated Types

type Rs SpreadsheetsBatchUpdate :: *

type Scopes SpreadsheetsBatchUpdate :: [Symbol]

Methods

requestClient :: SpreadsheetsBatchUpdate -> Client (Rs SpreadsheetsBatchUpdate)

type Rep SpreadsheetsBatchUpdate

type Rep SpreadsheetsBatchUpdate = D1 (MetaData "SpreadsheetsBatchUpdate" "Network.Google.Resource.Sheets.Spreadsheets.BatchUpdate" "gogol-sheets-0.1.1-1pkXSdCGpV83QL9chaCos2" False) (C1 (MetaCons "SpreadsheetsBatchUpdate'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_sbuXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv))) (S1 (MetaSel (Just Symbol "_sbuUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_sbuPp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) (S1 (MetaSel (Just Symbol "_sbuAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_sbuSpreadsheetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_sbuUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_sbuPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 BatchUpdateSpreadsheetRequest)) ((:*:) (S1 (MetaSel (Just Symbol "_sbuBearerToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_sbuCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))

type Scopes SpreadsheetsBatchUpdate

type Scopes SpreadsheetsBatchUpdate = (:) Symbol "https://www.googleapis.com/auth/drive" ((:) Symbol "https://www.googleapis.com/auth/spreadsheets" ([] Symbol))

type Rs SpreadsheetsBatchUpdate

type Rs SpreadsheetsBatchUpdate = BatchUpdateSpreadsheetResponse

Request Lenses

sbuXgafv :: Lens' SpreadsheetsBatchUpdate (Maybe Xgafv)

V1 error format.

sbuUploadProtocol :: Lens' SpreadsheetsBatchUpdate (Maybe Text)

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

sbuPp :: Lens' SpreadsheetsBatchUpdate Bool

Pretty-print response.

sbuAccessToken :: Lens' SpreadsheetsBatchUpdate (Maybe Text)

OAuth access token.

sbuSpreadsheetId :: Lens' SpreadsheetsBatchUpdate Text

The spreadsheet to apply the updates to.

sbuUploadType :: Lens' SpreadsheetsBatchUpdate (Maybe Text)

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

sbuPayload :: Lens' SpreadsheetsBatchUpdate BatchUpdateSpreadsheetRequest

Multipart request metadata.

sbuBearerToken :: Lens' SpreadsheetsBatchUpdate (Maybe Text)

OAuth bearer token.

sbuCallback :: Lens' SpreadsheetsBatchUpdate (Maybe Text)

JSONP