gogol-sheets-0.4.0: Google Sheets SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.Sheets.Spreadsheets.Values.Append

Contents

Description

Appends values to a spreadsheet. The input range is used to search for existing data and find a "table" within that range. Values will be appended to the next row of the table, starting with the first column of the table. See the guide and sample code for specific details of how tables are detected and data is appended. The caller must specify the spreadsheet ID, range, and a valueInputOption. The `valueInputOption` only controls how the input data will be added to the sheet (column-wise or row-wise), it does not influence what cell the data starts being written to.

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

Synopsis

REST Resource

type SpreadsheetsValuesAppendResource = "v4" :> ("spreadsheets" :> (Capture "spreadsheetId" Text :> ("values" :> (CaptureMode "range" "append" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "valueInputOption" Text :> (QueryParam "insertDataOption" Text :> (QueryParam "includeValuesInResponse" Bool :> (QueryParam "responseDateTimeRenderOption" Text :> (QueryParam "callback" Text :> (QueryParam "responseValueRenderOption" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] ValueRange :> Post '[JSON] AppendValuesResponse)))))))))))))))) Source #

A resource alias for sheets.spreadsheets.values.append method which the SpreadsheetsValuesAppend request conforms to.

Creating a Request

spreadsheetsValuesAppend Source #

Arguments

:: Text

svaSpreadsheetId

-> ValueRange

svaPayload

-> Text

svaRange

-> SpreadsheetsValuesAppend 

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

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

data SpreadsheetsValuesAppend Source #

Appends values to a spreadsheet. The input range is used to search for existing data and find a "table" within that range. Values will be appended to the next row of the table, starting with the first column of the table. See the guide and sample code for specific details of how tables are detected and data is appended. The caller must specify the spreadsheet ID, range, and a valueInputOption. The `valueInputOption` only controls how the input data will be added to the sheet (column-wise or row-wise), it does not influence what cell the data starts being written to.

See: spreadsheetsValuesAppend smart constructor.

Instances
Eq SpreadsheetsValuesAppend Source # 
Instance details

Defined in Network.Google.Resource.Sheets.Spreadsheets.Values.Append

Methods

(==) :: SpreadsheetsValuesAppend -> SpreadsheetsValuesAppend -> Bool #

(/=) :: SpreadsheetsValuesAppend -> SpreadsheetsValuesAppend -> Bool #

Data SpreadsheetsValuesAppend Source # 
Instance details

Defined in Network.Google.Resource.Sheets.Spreadsheets.Values.Append

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SpreadsheetsValuesAppend -> c SpreadsheetsValuesAppend #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SpreadsheetsValuesAppend #

toConstr :: SpreadsheetsValuesAppend -> Constr #

dataTypeOf :: SpreadsheetsValuesAppend -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SpreadsheetsValuesAppend) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SpreadsheetsValuesAppend) #

gmapT :: (forall b. Data b => b -> b) -> SpreadsheetsValuesAppend -> SpreadsheetsValuesAppend #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SpreadsheetsValuesAppend -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SpreadsheetsValuesAppend -> r #

gmapQ :: (forall d. Data d => d -> u) -> SpreadsheetsValuesAppend -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SpreadsheetsValuesAppend -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SpreadsheetsValuesAppend -> m SpreadsheetsValuesAppend #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SpreadsheetsValuesAppend -> m SpreadsheetsValuesAppend #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SpreadsheetsValuesAppend -> m SpreadsheetsValuesAppend #

Show SpreadsheetsValuesAppend Source # 
Instance details

Defined in Network.Google.Resource.Sheets.Spreadsheets.Values.Append

Methods

showsPrec :: Int -> SpreadsheetsValuesAppend -> ShowS #

show :: SpreadsheetsValuesAppend -> String #

showList :: [SpreadsheetsValuesAppend] -> ShowS #

Generic SpreadsheetsValuesAppend Source # 
Instance details

Defined in Network.Google.Resource.Sheets.Spreadsheets.Values.Append

Associated Types

type Rep SpreadsheetsValuesAppend :: Type -> Type #

Methods

from :: SpreadsheetsValuesAppend -> Rep SpreadsheetsValuesAppend x #

to :: Rep SpreadsheetsValuesAppend x -> SpreadsheetsValuesAppend #

GoogleRequest SpreadsheetsValuesAppend Source # 
Instance details

Defined in Network.Google.Resource.Sheets.Spreadsheets.Values.Append

Associated Types

type Rs SpreadsheetsValuesAppend :: Type #

type Scopes SpreadsheetsValuesAppend :: [Symbol] #

Methods

requestClient :: SpreadsheetsValuesAppend -> GClient (Rs SpreadsheetsValuesAppend) #

type Rep SpreadsheetsValuesAppend Source # 
Instance details

Defined in Network.Google.Resource.Sheets.Spreadsheets.Values.Append

type Rep SpreadsheetsValuesAppend = D1 (MetaData "SpreadsheetsValuesAppend" "Network.Google.Resource.Sheets.Spreadsheets.Values.Append" "gogol-sheets-0.4.0-DWkMVDpj7ZbHiXYeCjugGu" False) (C1 (MetaCons "SpreadsheetsValuesAppend'" PrefixI True) (((S1 (MetaSel (Just "_svaXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_svaUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_svaAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_svaSpreadsheetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_svaUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_svaValueInputOption") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 (MetaSel (Just "_svaPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ValueRange) :*: (S1 (MetaSel (Just "_svaInsertDataOption") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_svaRange") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :*: ((S1 (MetaSel (Just "_svaIncludeValuesInResponse") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_svaResponseDateTimeRenderOption") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_svaCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_svaResponseValueRenderOption") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))
type Scopes SpreadsheetsValuesAppend Source # 
Instance details

Defined in Network.Google.Resource.Sheets.Spreadsheets.Values.Append

type Scopes SpreadsheetsValuesAppend = "https://www.googleapis.com/auth/drive" ': ("https://www.googleapis.com/auth/drive.file" ': ("https://www.googleapis.com/auth/spreadsheets" ': ([] :: [Symbol])))
type Rs SpreadsheetsValuesAppend Source # 
Instance details

Defined in Network.Google.Resource.Sheets.Spreadsheets.Values.Append

type Rs SpreadsheetsValuesAppend = AppendValuesResponse

Request Lenses

svaXgafv :: Lens' SpreadsheetsValuesAppend (Maybe Xgafv) Source #

V1 error format.

svaUploadProtocol :: Lens' SpreadsheetsValuesAppend (Maybe Text) Source #

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

svaAccessToken :: Lens' SpreadsheetsValuesAppend (Maybe Text) Source #

OAuth access token.

svaSpreadsheetId :: Lens' SpreadsheetsValuesAppend Text Source #

The ID of the spreadsheet to update.

svaUploadType :: Lens' SpreadsheetsValuesAppend (Maybe Text) Source #

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

svaValueInputOption :: Lens' SpreadsheetsValuesAppend (Maybe Text) Source #

How the input data should be interpreted.

svaPayload :: Lens' SpreadsheetsValuesAppend ValueRange Source #

Multipart request metadata.

svaInsertDataOption :: Lens' SpreadsheetsValuesAppend (Maybe Text) Source #

How the input data should be inserted.

svaRange :: Lens' SpreadsheetsValuesAppend Text Source #

The A1 notation of a range to search for a logical table of data. Values will be appended after the last row of the table.

svaIncludeValuesInResponse :: Lens' SpreadsheetsValuesAppend (Maybe Bool) Source #

Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values.

svaResponseDateTimeRenderOption :: Lens' SpreadsheetsValuesAppend (Maybe Text) Source #

Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].

svaCallback :: Lens' SpreadsheetsValuesAppend (Maybe Text) Source #

JSONP

svaResponseValueRenderOption :: Lens' SpreadsheetsValuesAppend (Maybe Text) Source #

Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.