gogol-script-0.3.0: Google Apps Script Execution 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.Script.Scripts.Run

Contents

Description

Runs a function in an Apps Script project that has been deployed for use with the Apps Script Execution API. This method requires authorization with an OAuth 2.0 token that includes at least one of the scopes listed in the Authentication section; script projects that do not require authorization cannot be executed through this API. To find the correct scopes to include in the authentication token, open the project in the script editor, then select **File > Project properties** and click the **Scopes** tab.

See: Google Apps Script Execution API Reference for script.scripts.run.

Synopsis

REST Resource

type ScriptsRunResource = "v1" :> ("scripts" :> (CaptureMode "scriptId" "run" Text :> (QueryParam "$.xgafv" Text :> (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] ExecutionRequest :> Post '[JSON] Operation))))))))))) Source #

A resource alias for script.scripts.run method which the ScriptsRun request conforms to.

Creating a Request

scriptsRun Source #

Arguments

:: ExecutionRequest

srPayload

-> Text

srScriptId

-> ScriptsRun 

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

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

data ScriptsRun Source #

Runs a function in an Apps Script project that has been deployed for use with the Apps Script Execution API. This method requires authorization with an OAuth 2.0 token that includes at least one of the scopes listed in the Authentication section; script projects that do not require authorization cannot be executed through this API. To find the correct scopes to include in the authentication token, open the project in the script editor, then select **File > Project properties** and click the **Scopes** tab.

See: scriptsRun smart constructor.

Instances

Eq ScriptsRun Source # 
Data ScriptsRun Source # 

Methods

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

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

toConstr :: ScriptsRun -> Constr #

dataTypeOf :: ScriptsRun -> DataType #

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

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

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

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

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

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

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

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

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

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

Show ScriptsRun Source # 
Generic ScriptsRun Source # 

Associated Types

type Rep ScriptsRun :: * -> * #

Methods

from :: ScriptsRun -> Rep ScriptsRun x #

to :: Rep ScriptsRun x -> ScriptsRun #

GoogleRequest ScriptsRun Source # 

Associated Types

type Rs ScriptsRun :: * #

type Scopes ScriptsRun :: [Symbol] #

Methods

requestClient :: ScriptsRun -> Client (Rs ScriptsRun) #

type Rep ScriptsRun Source # 
type Scopes ScriptsRun Source # 
type Scopes ScriptsRun = (:) Symbol "https://mail.google.com/" ((:) Symbol "https://www.google.com/calendar/feeds" ((:) Symbol "https://www.google.com/m8/feeds" ((:) Symbol "https://www.googleapis.com/auth/admin.directory.group" ((:) Symbol "https://www.googleapis.com/auth/admin.directory.user" ((:) Symbol "https://www.googleapis.com/auth/drive" ((:) Symbol "https://www.googleapis.com/auth/forms" ((:) Symbol "https://www.googleapis.com/auth/forms.currentonly" ((:) Symbol "https://www.googleapis.com/auth/groups" ((:) Symbol "https://www.googleapis.com/auth/spreadsheets" ((:) Symbol "https://www.googleapis.com/auth/userinfo.email" ([] Symbol)))))))))))
type Rs ScriptsRun Source # 

Request Lenses

srXgafv :: Lens' ScriptsRun (Maybe Text) Source #

V1 error format.

srUploadProtocol :: Lens' ScriptsRun (Maybe Text) Source #

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

srPp :: Lens' ScriptsRun Bool Source #

Pretty-print response.

srAccessToken :: Lens' ScriptsRun (Maybe Text) Source #

OAuth access token.

srUploadType :: Lens' ScriptsRun (Maybe Text) Source #

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

srPayload :: Lens' ScriptsRun ExecutionRequest Source #

Multipart request metadata.

srBearerToken :: Lens' ScriptsRun (Maybe Text) Source #

OAuth bearer token.

srScriptId :: Lens' ScriptsRun Text Source #

The project key of the script to be executed. To find the project key, open the project in the script editor, then select **File > Project properties**.

srCallback :: Lens' ScriptsRun (Maybe Text) Source #

JSONP