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 |
- Service Configuration
- OAuth Scopes
- API Declaration
- Resources
- script.processes.list
- script.processes.listScriptProcesses
- script.projects.create
- script.projects.deployments.create
- script.projects.deployments.delete
- script.projects.deployments.get
- script.projects.deployments.list
- script.projects.deployments.update
- script.projects.get
- script.projects.getContent
- script.projects.getMetrics
- script.projects.updateContent
- script.projects.versions.create
- script.projects.versions.get
- script.projects.versions.list
- script.scripts.run
- Types
- GoogleAppsScriptTypeFunctionSet
- GoogleAppsScriptTypeExecutionAPIConfig
- GoogleAppsScriptTypeProcessProcessType
- Status
- GoogleAppsScriptTypeProcessUserAccessLevel
- Metrics
- GoogleAppsScriptTypeProcess
- GoogleAppsScriptTypeWebAppConfigExecuteAs
- Project
- Operation
- ListUserProcessesResponse
- Empty
- GoogleAppsScriptTypeUser
- EntryPoint
- ListVersionsResponse
- GoogleAppsScriptTypeExecutionAPIConfigAccess
- ExecutionRequest
- ListScriptProcessesResponse
- StatusDetailsItem
- FileType
- ScriptStackTraceElement
- Content
- GoogleAppsScriptTypeAddOnEntryPointAddOnType
- MetricsValue
- GoogleAppsScriptTypeAddOnEntryPoint
- GoogleAppsScriptTypeWebAppConfig
- Version
- Xgafv
- ExecutionError
- GoogleAppsScriptTypeWebAppEntryPoint
- EntryPointEntryPointType
- CreateProjectRequest
- GoogleAppsScriptTypeProcessProcessStatus
- DeploymentConfig
- GoogleAppsScriptTypeWebAppConfigAccess
- ListDeploymentsResponse
- GoogleAppsScriptTypeFunction
- File
- GoogleAppsScriptTypeExecutionAPIEntryPoint
- OperationResponse
- ExecutionResponse
- Deployment
- UpdateDeploymentRequest
Manages and executes Google Apps Script projects.
Synopsis
- scriptService :: ServiceConfig
- mailGoogleComScope :: Proxy '["https://mail.google.com/"]
- m8FeedsScope :: Proxy '["https://www.google.com/m8/feeds"]
- adminDirectoryUserScope :: Proxy '["https://www.googleapis.com/auth/admin.directory.user"]
- scriptProjectsScope :: Proxy '["https://www.googleapis.com/auth/script.projects"]
- userInfoEmailScope :: Proxy '["https://www.googleapis.com/auth/userinfo.email"]
- scriptMetricsScope :: Proxy '["https://www.googleapis.com/auth/script.metrics"]
- formsCurrentOnlyScope :: Proxy '["https://www.googleapis.com/auth/forms.currentonly"]
- scriptDeploymentsScope :: Proxy '["https://www.googleapis.com/auth/script.deployments"]
- driveScope :: Proxy '["https://www.googleapis.com/auth/drive"]
- adminDirectoryGroupScope :: Proxy '["https://www.googleapis.com/auth/admin.directory.group"]
- scriptProjectsReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/script.projects.readonly"]
- calendarFeedsScope :: Proxy '["https://www.google.com/calendar/feeds"]
- formsScope :: Proxy '["https://www.googleapis.com/auth/forms"]
- spreadsheetsScope :: Proxy '["https://www.googleapis.com/auth/spreadsheets"]
- scriptDeploymentsReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/script.deployments.readonly"]
- groupsScope :: Proxy '["https://www.googleapis.com/auth/groups"]
- scriptProcessesScope :: Proxy '["https://www.googleapis.com/auth/script.processes"]
- documentsScope :: Proxy '["https://www.googleapis.com/auth/documents"]
- type ScriptAPI = ScriptsRunResource :<|> (ProcessesListResource :<|> (ProcessesListScriptProcessesResource :<|> (ProjectsVersionsListResource :<|> (ProjectsVersionsGetResource :<|> (ProjectsVersionsCreateResource :<|> (ProjectsDeploymentsListResource :<|> (ProjectsDeploymentsGetResource :<|> (ProjectsDeploymentsCreateResource :<|> (ProjectsDeploymentsDeleteResource :<|> (ProjectsDeploymentsUpdateResource :<|> (ProjectsUpdateContentResource :<|> (ProjectsGetResource :<|> (ProjectsCreateResource :<|> (ProjectsGetContentResource :<|> ProjectsGetMetricsResource))))))))))))))
- module Network.Google.Resource.Script.Processes.List
- module Network.Google.Resource.Script.Processes.ListScriptProcesses
- module Network.Google.Resource.Script.Projects.Create
- module Network.Google.Resource.Script.Projects.Deployments.Create
- module Network.Google.Resource.Script.Projects.Deployments.Delete
- module Network.Google.Resource.Script.Projects.Deployments.Get
- module Network.Google.Resource.Script.Projects.Deployments.List
- module Network.Google.Resource.Script.Projects.Deployments.Update
- module Network.Google.Resource.Script.Projects.Get
- module Network.Google.Resource.Script.Projects.GetContent
- module Network.Google.Resource.Script.Projects.GetMetrics
- module Network.Google.Resource.Script.Projects.UpdateContent
- module Network.Google.Resource.Script.Projects.Versions.Create
- module Network.Google.Resource.Script.Projects.Versions.Get
- module Network.Google.Resource.Script.Projects.Versions.List
- module Network.Google.Resource.Script.Scripts.Run
- data GoogleAppsScriptTypeFunctionSet
- googleAppsScriptTypeFunctionSet :: GoogleAppsScriptTypeFunctionSet
- gastfsValues :: Lens' GoogleAppsScriptTypeFunctionSet [GoogleAppsScriptTypeFunction]
- data GoogleAppsScriptTypeExecutionAPIConfig
- googleAppsScriptTypeExecutionAPIConfig :: GoogleAppsScriptTypeExecutionAPIConfig
- gasteacAccess :: Lens' GoogleAppsScriptTypeExecutionAPIConfig (Maybe GoogleAppsScriptTypeExecutionAPIConfigAccess)
- data GoogleAppsScriptTypeProcessProcessType
- data Status
- status :: Status
- sDetails :: Lens' Status [StatusDetailsItem]
- sCode :: Lens' Status (Maybe Int32)
- sMessage :: Lens' Status (Maybe Text)
- data GoogleAppsScriptTypeProcessUserAccessLevel
- data Metrics
- metrics :: Metrics
- mActiveUsers :: Lens' Metrics [MetricsValue]
- mFailedExecutions :: Lens' Metrics [MetricsValue]
- mTotalExecutions :: Lens' Metrics [MetricsValue]
- data GoogleAppsScriptTypeProcess
- googleAppsScriptTypeProcess :: GoogleAppsScriptTypeProcess
- gastpProcessStatus :: Lens' GoogleAppsScriptTypeProcess (Maybe GoogleAppsScriptTypeProcessProcessStatus)
- gastpStartTime :: Lens' GoogleAppsScriptTypeProcess (Maybe UTCTime)
- gastpProjectName :: Lens' GoogleAppsScriptTypeProcess (Maybe Text)
- gastpFunctionName :: Lens' GoogleAppsScriptTypeProcess (Maybe Text)
- gastpUserAccessLevel :: Lens' GoogleAppsScriptTypeProcess (Maybe GoogleAppsScriptTypeProcessUserAccessLevel)
- gastpProcessType :: Lens' GoogleAppsScriptTypeProcess (Maybe GoogleAppsScriptTypeProcessProcessType)
- gastpExecutingUser :: Lens' GoogleAppsScriptTypeProcess (Maybe Text)
- gastpDuration :: Lens' GoogleAppsScriptTypeProcess (Maybe Scientific)
- data GoogleAppsScriptTypeWebAppConfigExecuteAs
- data Project
- project :: Project
- pCreator :: Lens' Project (Maybe GoogleAppsScriptTypeUser)
- pLastModifyUser :: Lens' Project (Maybe GoogleAppsScriptTypeUser)
- pUpdateTime :: Lens' Project (Maybe UTCTime)
- pScriptId :: Lens' Project (Maybe Text)
- pTitle :: Lens' Project (Maybe Text)
- pParentId :: Lens' Project (Maybe Text)
- pCreateTime :: Lens' Project (Maybe UTCTime)
- data Operation
- operation :: Operation
- oDone :: Lens' Operation (Maybe Bool)
- oError :: Lens' Operation (Maybe Status)
- oResponse :: Lens' Operation (Maybe OperationResponse)
- data ListUserProcessesResponse
- listUserProcessesResponse :: ListUserProcessesResponse
- luprNextPageToken :: Lens' ListUserProcessesResponse (Maybe Text)
- luprProcesses :: Lens' ListUserProcessesResponse [GoogleAppsScriptTypeProcess]
- data Empty
- empty :: Empty
- data GoogleAppsScriptTypeUser
- googleAppsScriptTypeUser :: GoogleAppsScriptTypeUser
- gastuEmail :: Lens' GoogleAppsScriptTypeUser (Maybe Text)
- gastuPhotoURL :: Lens' GoogleAppsScriptTypeUser (Maybe Text)
- gastuDomain :: Lens' GoogleAppsScriptTypeUser (Maybe Text)
- gastuName :: Lens' GoogleAppsScriptTypeUser (Maybe Text)
- data EntryPoint
- entryPoint :: EntryPoint
- epExecutionAPI :: Lens' EntryPoint (Maybe GoogleAppsScriptTypeExecutionAPIEntryPoint)
- epAddOn :: Lens' EntryPoint (Maybe GoogleAppsScriptTypeAddOnEntryPoint)
- epEntryPointType :: Lens' EntryPoint (Maybe EntryPointEntryPointType)
- epWebApp :: Lens' EntryPoint (Maybe GoogleAppsScriptTypeWebAppEntryPoint)
- data ListVersionsResponse
- listVersionsResponse :: ListVersionsResponse
- lvrNextPageToken :: Lens' ListVersionsResponse (Maybe Text)
- lvrVersions :: Lens' ListVersionsResponse [Version]
- data GoogleAppsScriptTypeExecutionAPIConfigAccess
- data ExecutionRequest
- executionRequest :: ExecutionRequest
- erFunction :: Lens' ExecutionRequest (Maybe Text)
- erSessionState :: Lens' ExecutionRequest (Maybe Text)
- erDevMode :: Lens' ExecutionRequest (Maybe Bool)
- erParameters :: Lens' ExecutionRequest [JSONValue]
- data ListScriptProcessesResponse
- listScriptProcessesResponse :: ListScriptProcessesResponse
- lsprNextPageToken :: Lens' ListScriptProcessesResponse (Maybe Text)
- lsprProcesses :: Lens' ListScriptProcessesResponse [GoogleAppsScriptTypeProcess]
- data StatusDetailsItem
- statusDetailsItem :: HashMap Text JSONValue -> StatusDetailsItem
- sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue)
- data FileType
- data ScriptStackTraceElement
- scriptStackTraceElement :: ScriptStackTraceElement
- ssteFunction :: Lens' ScriptStackTraceElement (Maybe Text)
- ssteLineNumber :: Lens' ScriptStackTraceElement (Maybe Int32)
- data Content
- content :: Content
- cScriptId :: Lens' Content (Maybe Text)
- cFiles :: Lens' Content [File]
- data GoogleAppsScriptTypeAddOnEntryPointAddOnType
- data MetricsValue
- metricsValue :: MetricsValue
- mvStartTime :: Lens' MetricsValue (Maybe UTCTime)
- mvValue :: Lens' MetricsValue (Maybe Word64)
- mvEndTime :: Lens' MetricsValue (Maybe UTCTime)
- data GoogleAppsScriptTypeAddOnEntryPoint
- googleAppsScriptTypeAddOnEntryPoint :: GoogleAppsScriptTypeAddOnEntryPoint
- gastaoepPostInstallTipURL :: Lens' GoogleAppsScriptTypeAddOnEntryPoint (Maybe Text)
- gastaoepAddOnType :: Lens' GoogleAppsScriptTypeAddOnEntryPoint (Maybe GoogleAppsScriptTypeAddOnEntryPointAddOnType)
- gastaoepReportIssueURL :: Lens' GoogleAppsScriptTypeAddOnEntryPoint (Maybe Text)
- gastaoepHelpURL :: Lens' GoogleAppsScriptTypeAddOnEntryPoint (Maybe Text)
- gastaoepTitle :: Lens' GoogleAppsScriptTypeAddOnEntryPoint (Maybe Text)
- gastaoepDescription :: Lens' GoogleAppsScriptTypeAddOnEntryPoint (Maybe Text)
- data GoogleAppsScriptTypeWebAppConfig
- googleAppsScriptTypeWebAppConfig :: GoogleAppsScriptTypeWebAppConfig
- gastwacAccess :: Lens' GoogleAppsScriptTypeWebAppConfig (Maybe GoogleAppsScriptTypeWebAppConfigAccess)
- gastwacExecuteAs :: Lens' GoogleAppsScriptTypeWebAppConfig (Maybe GoogleAppsScriptTypeWebAppConfigExecuteAs)
- data Version
- version :: Version
- vVersionNumber :: Lens' Version (Maybe Int32)
- vScriptId :: Lens' Version (Maybe Text)
- vDescription :: Lens' Version (Maybe Text)
- vCreateTime :: Lens' Version (Maybe UTCTime)
- data Xgafv
- data ExecutionError
- executionError :: ExecutionError
- eeScriptStackTraceElements :: Lens' ExecutionError [ScriptStackTraceElement]
- eeErrorType :: Lens' ExecutionError (Maybe Text)
- eeErrorMessage :: Lens' ExecutionError (Maybe Text)
- data GoogleAppsScriptTypeWebAppEntryPoint
- googleAppsScriptTypeWebAppEntryPoint :: GoogleAppsScriptTypeWebAppEntryPoint
- gastwaepEntryPointConfig :: Lens' GoogleAppsScriptTypeWebAppEntryPoint (Maybe GoogleAppsScriptTypeWebAppConfig)
- gastwaepURL :: Lens' GoogleAppsScriptTypeWebAppEntryPoint (Maybe Text)
- data EntryPointEntryPointType
- data CreateProjectRequest
- createProjectRequest :: CreateProjectRequest
- cprTitle :: Lens' CreateProjectRequest (Maybe Text)
- cprParentId :: Lens' CreateProjectRequest (Maybe Text)
- data GoogleAppsScriptTypeProcessProcessStatus
- data DeploymentConfig
- deploymentConfig :: DeploymentConfig
- dcVersionNumber :: Lens' DeploymentConfig (Maybe Int32)
- dcScriptId :: Lens' DeploymentConfig (Maybe Text)
- dcManifestFileName :: Lens' DeploymentConfig (Maybe Text)
- dcDescription :: Lens' DeploymentConfig (Maybe Text)
- data GoogleAppsScriptTypeWebAppConfigAccess
- data ListDeploymentsResponse
- listDeploymentsResponse :: ListDeploymentsResponse
- ldrNextPageToken :: Lens' ListDeploymentsResponse (Maybe Text)
- ldrDeployments :: Lens' ListDeploymentsResponse [Deployment]
- data GoogleAppsScriptTypeFunction
- googleAppsScriptTypeFunction :: GoogleAppsScriptTypeFunction
- gastfName :: Lens' GoogleAppsScriptTypeFunction (Maybe Text)
- data File
- file :: File
- fFunctionSet :: Lens' File (Maybe GoogleAppsScriptTypeFunctionSet)
- fLastModifyUser :: Lens' File (Maybe GoogleAppsScriptTypeUser)
- fUpdateTime :: Lens' File (Maybe UTCTime)
- fName :: Lens' File (Maybe Text)
- fSource :: Lens' File (Maybe Text)
- fType :: Lens' File (Maybe FileType)
- fCreateTime :: Lens' File (Maybe UTCTime)
- data GoogleAppsScriptTypeExecutionAPIEntryPoint
- googleAppsScriptTypeExecutionAPIEntryPoint :: GoogleAppsScriptTypeExecutionAPIEntryPoint
- gasteaepEntryPointConfig :: Lens' GoogleAppsScriptTypeExecutionAPIEntryPoint (Maybe GoogleAppsScriptTypeExecutionAPIConfig)
- data OperationResponse
- operationResponse :: HashMap Text JSONValue -> OperationResponse
- orAddtional :: Lens' OperationResponse (HashMap Text JSONValue)
- data ExecutionResponse
- executionResponse :: ExecutionResponse
- erResult :: Lens' ExecutionResponse (Maybe JSONValue)
- data Deployment
- deployment :: Deployment
- dDeploymentId :: Lens' Deployment (Maybe Text)
- dUpdateTime :: Lens' Deployment (Maybe UTCTime)
- dEntryPoints :: Lens' Deployment [EntryPoint]
- dDeploymentConfig :: Lens' Deployment (Maybe DeploymentConfig)
- data UpdateDeploymentRequest
- updateDeploymentRequest :: UpdateDeploymentRequest
- udrDeploymentConfig :: Lens' UpdateDeploymentRequest (Maybe DeploymentConfig)
Service Configuration
scriptService :: ServiceConfig Source #
Default request referring to version v1
of the Apps Script API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
mailGoogleComScope :: Proxy '["https://mail.google.com/"] Source #
Read, compose, send, and permanently delete all your email from Gmail
m8FeedsScope :: Proxy '["https://www.google.com/m8/feeds"] Source #
See, edit, download, and permanently delete your contacts
adminDirectoryUserScope :: Proxy '["https://www.googleapis.com/auth/admin.directory.user"] Source #
View and manage the provisioning of users on your domain
scriptProjectsScope :: Proxy '["https://www.googleapis.com/auth/script.projects"] Source #
Create and update Google Apps Script projects
userInfoEmailScope :: Proxy '["https://www.googleapis.com/auth/userinfo.email"] Source #
View your email address
scriptMetricsScope :: Proxy '["https://www.googleapis.com/auth/script.metrics"] Source #
View Google Apps Script project's metrics
formsCurrentOnlyScope :: Proxy '["https://www.googleapis.com/auth/forms.currentonly"] Source #
View and manage forms that this application has been installed in
scriptDeploymentsScope :: Proxy '["https://www.googleapis.com/auth/script.deployments"] Source #
Create and update Google Apps Script deployments
driveScope :: Proxy '["https://www.googleapis.com/auth/drive"] Source #
See, edit, create, and delete all of your Google Drive files
adminDirectoryGroupScope :: Proxy '["https://www.googleapis.com/auth/admin.directory.group"] Source #
View and manage the provisioning of groups on your domain
scriptProjectsReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/script.projects.readonly"] Source #
View Google Apps Script projects
calendarFeedsScope :: Proxy '["https://www.google.com/calendar/feeds"] Source #
See, edit, share, and permanently delete all the calendars you can access using Google Calendar
formsScope :: Proxy '["https://www.googleapis.com/auth/forms"] Source #
View and manage your forms in Google Drive
spreadsheetsScope :: Proxy '["https://www.googleapis.com/auth/spreadsheets"] Source #
See, edit, create, and delete your spreadsheets in Google Drive
scriptDeploymentsReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/script.deployments.readonly"] Source #
View Google Apps Script deployments
groupsScope :: Proxy '["https://www.googleapis.com/auth/groups"] Source #
View and manage your Google Groups
scriptProcessesScope :: Proxy '["https://www.googleapis.com/auth/script.processes"] Source #
View Google Apps Script processes
documentsScope :: Proxy '["https://www.googleapis.com/auth/documents"] Source #
View and manage your Google Docs documents
API Declaration
type ScriptAPI = ScriptsRunResource :<|> (ProcessesListResource :<|> (ProcessesListScriptProcessesResource :<|> (ProjectsVersionsListResource :<|> (ProjectsVersionsGetResource :<|> (ProjectsVersionsCreateResource :<|> (ProjectsDeploymentsListResource :<|> (ProjectsDeploymentsGetResource :<|> (ProjectsDeploymentsCreateResource :<|> (ProjectsDeploymentsDeleteResource :<|> (ProjectsDeploymentsUpdateResource :<|> (ProjectsUpdateContentResource :<|> (ProjectsGetResource :<|> (ProjectsCreateResource :<|> (ProjectsGetContentResource :<|> ProjectsGetMetricsResource)))))))))))))) Source #
Represents the entirety of the methods and resources available for the Apps Script API service.
Resources
script.processes.list
script.processes.listScriptProcesses
script.projects.create
script.projects.deployments.create
script.projects.deployments.delete
script.projects.deployments.get
script.projects.deployments.list
script.projects.deployments.update
script.projects.get
script.projects.getContent
script.projects.getMetrics
script.projects.updateContent
script.projects.versions.create
script.projects.versions.get
script.projects.versions.list
script.scripts.run
Types
GoogleAppsScriptTypeFunctionSet
data GoogleAppsScriptTypeFunctionSet Source #
A set of functions. No duplicates are permitted.
See: googleAppsScriptTypeFunctionSet
smart constructor.
Instances
googleAppsScriptTypeFunctionSet :: GoogleAppsScriptTypeFunctionSet Source #
Creates a value of GoogleAppsScriptTypeFunctionSet
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gastfsValues :: Lens' GoogleAppsScriptTypeFunctionSet [GoogleAppsScriptTypeFunction] Source #
A list of functions composing the set.
GoogleAppsScriptTypeExecutionAPIConfig
data GoogleAppsScriptTypeExecutionAPIConfig Source #
API executable entry point configuration.
See: googleAppsScriptTypeExecutionAPIConfig
smart constructor.
Instances
googleAppsScriptTypeExecutionAPIConfig :: GoogleAppsScriptTypeExecutionAPIConfig Source #
Creates a value of GoogleAppsScriptTypeExecutionAPIConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gasteacAccess :: Lens' GoogleAppsScriptTypeExecutionAPIConfig (Maybe GoogleAppsScriptTypeExecutionAPIConfigAccess) Source #
Who has permission to run the API executable.
GoogleAppsScriptTypeProcessProcessType
data GoogleAppsScriptTypeProcessProcessType Source #
The executions type.
ProcessTypeUnspecified |
|
AddOn |
|
ExecutionAPI |
|
TimeDriven |
|
Trigger |
|
WebApp |
|
Editor |
|
SimpleTrigger |
|
Menu |
|
BatchTask |
|
Instances
Status
If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, the response body's error field contains this `Status` object.
See: status
smart constructor.
Instances
Eq Status Source # | |
Data Status Source # | |
Defined in Network.Google.Script.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Status -> c Status # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Status # toConstr :: Status -> Constr # dataTypeOf :: Status -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Status) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Status) # gmapT :: (forall b. Data b => b -> b) -> Status -> Status # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r # gmapQ :: (forall d. Data d => d -> u) -> Status -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Status -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Status -> m Status # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Status -> m Status # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Status -> m Status # | |
Show Status Source # | |
Generic Status Source # | |
ToJSON Status Source # | |
Defined in Network.Google.Script.Types.Product | |
FromJSON Status Source # | |
type Rep Status Source # | |
Defined in Network.Google.Script.Types.Product type Rep Status = D1 (MetaData "Status" "Network.Google.Script.Types.Product" "gogol-script-0.4.0-FTMJIbj3qQWJYzgfzFUSMi" False) (C1 (MetaCons "Status'" PrefixI True) (S1 (MetaSel (Just "_sDetails") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [StatusDetailsItem])) :*: (S1 (MetaSel (Just "_sCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_sMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) |
sDetails :: Lens' Status [StatusDetailsItem] Source #
An array that contains a single ExecutionError object that provides information about the nature of the error.
sCode :: Lens' Status (Maybe Int32) Source #
The status code. For this API, this value either:
- 10, indicating a `SCRIPT_TIMEOUT` error,
- 3, indicating an `INVALID_ARGUMENT` error, or
- 1, indicating a `CANCELLED` execution.
sMessage :: Lens' Status (Maybe Text) Source #
A developer-facing error message, which is in English. Any user-facing error message is localized and sent in the details field, or localized by the client.
GoogleAppsScriptTypeProcessUserAccessLevel
data GoogleAppsScriptTypeProcessUserAccessLevel Source #
The executing users access level to the script.
UserAccessLevelUnspecified |
|
None |
|
Read' |
|
Write |
|
Owner |
|
Instances
Metrics
Resource containing usage stats for a given script, based on the supplied filter and mask present in the request.
See: metrics
smart constructor.
Instances
Eq Metrics Source # | |
Data Metrics Source # | |
Defined in Network.Google.Script.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Metrics -> c Metrics # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Metrics # toConstr :: Metrics -> Constr # dataTypeOf :: Metrics -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Metrics) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Metrics) # gmapT :: (forall b. Data b => b -> b) -> Metrics -> Metrics # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Metrics -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Metrics -> r # gmapQ :: (forall d. Data d => d -> u) -> Metrics -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Metrics -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Metrics -> m Metrics # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Metrics -> m Metrics # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Metrics -> m Metrics # | |
Show Metrics Source # | |
Generic Metrics Source # | |
ToJSON Metrics Source # | |
Defined in Network.Google.Script.Types.Product | |
FromJSON Metrics Source # | |
type Rep Metrics Source # | |
Defined in Network.Google.Script.Types.Product type Rep Metrics = D1 (MetaData "Metrics" "Network.Google.Script.Types.Product" "gogol-script-0.4.0-FTMJIbj3qQWJYzgfzFUSMi" False) (C1 (MetaCons "Metrics'" PrefixI True) (S1 (MetaSel (Just "_mActiveUsers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [MetricsValue])) :*: (S1 (MetaSel (Just "_mFailedExecutions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [MetricsValue])) :*: S1 (MetaSel (Just "_mTotalExecutions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [MetricsValue]))))) |
Creates a value of Metrics
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mActiveUsers :: Lens' Metrics [MetricsValue] Source #
Number of active users.
mFailedExecutions :: Lens' Metrics [MetricsValue] Source #
Number of failed executions.
mTotalExecutions :: Lens' Metrics [MetricsValue] Source #
Number of total executions.
GoogleAppsScriptTypeProcess
data GoogleAppsScriptTypeProcess Source #
Representation of a single script process execution that was started from the script editor, a trigger, an application, or using the Apps Script API. This is distinct from the `Operation` resource, which only represents executions started via the Apps Script API.
See: googleAppsScriptTypeProcess
smart constructor.
Instances
googleAppsScriptTypeProcess :: GoogleAppsScriptTypeProcess Source #
Creates a value of GoogleAppsScriptTypeProcess
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gastpProcessStatus :: Lens' GoogleAppsScriptTypeProcess (Maybe GoogleAppsScriptTypeProcessProcessStatus) Source #
The executions status.
gastpStartTime :: Lens' GoogleAppsScriptTypeProcess (Maybe UTCTime) Source #
Time the execution started.
gastpProjectName :: Lens' GoogleAppsScriptTypeProcess (Maybe Text) Source #
Name of the script being executed.
gastpFunctionName :: Lens' GoogleAppsScriptTypeProcess (Maybe Text) Source #
Name of the function the started the execution.
gastpUserAccessLevel :: Lens' GoogleAppsScriptTypeProcess (Maybe GoogleAppsScriptTypeProcessUserAccessLevel) Source #
The executing users access level to the script.
gastpProcessType :: Lens' GoogleAppsScriptTypeProcess (Maybe GoogleAppsScriptTypeProcessProcessType) Source #
The executions type.
gastpExecutingUser :: Lens' GoogleAppsScriptTypeProcess (Maybe Text) Source #
User-facing name for the user executing the script.
gastpDuration :: Lens' GoogleAppsScriptTypeProcess (Maybe Scientific) Source #
Duration the execution spent executing.
GoogleAppsScriptTypeWebAppConfigExecuteAs
data GoogleAppsScriptTypeWebAppConfigExecuteAs Source #
Who to execute the web app as.
UnknownExecuteAs |
|
UserAccessing |
|
UserDeploying |
|
Instances
Project
The script project resource.
See: project
smart constructor.
Instances
Creates a value of Project
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pCreator :: Lens' Project (Maybe GoogleAppsScriptTypeUser) Source #
User who originally created the script.
pLastModifyUser :: Lens' Project (Maybe GoogleAppsScriptTypeUser) Source #
User who last modified the script.
pParentId :: Lens' Project (Maybe Text) Source #
The parent's Drive ID that the script will be attached to. This is usually the ID of a Google Document or Google Sheet. This filed is optional, and if not set, a stand-alone script will be created.
Operation
A representation of an execution of an Apps Script function started with run. The execution response does not arrive until the function finishes executing. The maximum execution runtime is listed in the Apps Script quotas guide.
After execution has started, it can have one of four outcomes:
- If the script function returns successfully, the response field contains an ExecutionResponse object with the function's return value in the object's `result` field.
- If the script function (or Apps Script itself) throws an exception, the error field contains a Status object. The `Status` object's `details` field contains an array with a single ExecutionError object that provides information about the nature of the error.
- If the execution has not yet completed, the done field is `false` and the neither the `response` nor `error` fields are present.
- If the `run` call itself fails (for example, because of a malformed request or an authorization error), the method returns an HTTP response code in the 4XX range with a different format for the response body. Client libraries automatically convert a 4XX response into an exception class.
See: operation
smart constructor.
Instances
Eq Operation Source # | |
Data Operation Source # | |
Defined in Network.Google.Script.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Operation -> c Operation # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Operation # toConstr :: Operation -> Constr # dataTypeOf :: Operation -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Operation) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Operation) # gmapT :: (forall b. Data b => b -> b) -> Operation -> Operation # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Operation -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Operation -> r # gmapQ :: (forall d. Data d => d -> u) -> Operation -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Operation -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Operation -> m Operation # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Operation -> m Operation # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Operation -> m Operation # | |
Show Operation Source # | |
Generic Operation Source # | |
ToJSON Operation Source # | |
Defined in Network.Google.Script.Types.Product | |
FromJSON Operation Source # | |
type Rep Operation Source # | |
Defined in Network.Google.Script.Types.Product type Rep Operation = D1 (MetaData "Operation" "Network.Google.Script.Types.Product" "gogol-script-0.4.0-FTMJIbj3qQWJYzgfzFUSMi" False) (C1 (MetaCons "Operation'" PrefixI True) (S1 (MetaSel (Just "_oDone") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 (MetaSel (Just "_oError") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Status)) :*: S1 (MetaSel (Just "_oResponse") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe OperationResponse))))) |
oDone :: Lens' Operation (Maybe Bool) Source #
This field indicates whether the script execution has completed. A completed execution has a populated `response` field containing the ExecutionResponse from function that was executed.
oError :: Lens' Operation (Maybe Status) Source #
If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, this field contains a Status object. The `Status` object's `details` field contains an array with a single ExecutionError object that provides information about the nature of the error.
oResponse :: Lens' Operation (Maybe OperationResponse) Source #
If the script function returns successfully, this field contains an ExecutionResponse object with the function's return value.
ListUserProcessesResponse
data ListUserProcessesResponse Source #
Response with the list of Process resources.
See: listUserProcessesResponse
smart constructor.
Instances
listUserProcessesResponse :: ListUserProcessesResponse Source #
Creates a value of ListUserProcessesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
luprNextPageToken :: Lens' ListUserProcessesResponse (Maybe Text) Source #
Token for the next page of results. If empty, there are no more pages remaining.
luprProcesses :: Lens' ListUserProcessesResponse [GoogleAppsScriptTypeProcess] Source #
List of processes matching request parameters.
Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
See: empty
smart constructor.
Instances
Eq Empty Source # | |
Data Empty Source # | |
Defined in Network.Google.Script.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Empty -> c Empty # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Empty # dataTypeOf :: Empty -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Empty) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Empty) # gmapT :: (forall b. Data b => b -> b) -> Empty -> Empty # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Empty -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Empty -> r # gmapQ :: (forall d. Data d => d -> u) -> Empty -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Empty -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Empty -> m Empty # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Empty -> m Empty # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Empty -> m Empty # | |
Show Empty Source # | |
Generic Empty Source # | |
ToJSON Empty Source # | |
Defined in Network.Google.Script.Types.Product | |
FromJSON Empty Source # | |
type Rep Empty Source # | |
GoogleAppsScriptTypeUser
data GoogleAppsScriptTypeUser Source #
A simple user profile resource.
See: googleAppsScriptTypeUser
smart constructor.
Instances
googleAppsScriptTypeUser :: GoogleAppsScriptTypeUser Source #
Creates a value of GoogleAppsScriptTypeUser
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gastuEmail :: Lens' GoogleAppsScriptTypeUser (Maybe Text) Source #
The user's identifying email address.
gastuPhotoURL :: Lens' GoogleAppsScriptTypeUser (Maybe Text) Source #
The user's photo.
gastuDomain :: Lens' GoogleAppsScriptTypeUser (Maybe Text) Source #
The user's domain.
EntryPoint
data EntryPoint Source #
A configuration that defines how a deployment is accessed externally.
See: entryPoint
smart constructor.
Instances
entryPoint :: EntryPoint Source #
Creates a value of EntryPoint
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
epExecutionAPI :: Lens' EntryPoint (Maybe GoogleAppsScriptTypeExecutionAPIEntryPoint) Source #
An entry point specification for Apps Script API execution calls.
epAddOn :: Lens' EntryPoint (Maybe GoogleAppsScriptTypeAddOnEntryPoint) Source #
Add-on properties.
epEntryPointType :: Lens' EntryPoint (Maybe EntryPointEntryPointType) Source #
The type of the entry point.
epWebApp :: Lens' EntryPoint (Maybe GoogleAppsScriptTypeWebAppEntryPoint) Source #
An entry point specification for web apps.
ListVersionsResponse
data ListVersionsResponse Source #
Response with the list of the versions for the specified script project.
See: listVersionsResponse
smart constructor.
Instances
listVersionsResponse :: ListVersionsResponse Source #
Creates a value of ListVersionsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lvrNextPageToken :: Lens' ListVersionsResponse (Maybe Text) Source #
The token use to fetch the next page of records. if not exist in the response, that means no more versions to list.
lvrVersions :: Lens' ListVersionsResponse [Version] Source #
The list of versions.
GoogleAppsScriptTypeExecutionAPIConfigAccess
data GoogleAppsScriptTypeExecutionAPIConfigAccess Source #
Who has permission to run the API executable.
UnknownAccess |
|
Myself |
|
Domain |
|
Anyone |
|
AnyoneAnonymous |
|
Instances
ExecutionRequest
data ExecutionRequest Source #
A request to run the function in a script. The script is identified by the specified `script_id`. Executing a function on a script returns results based on the implementation of the script.
See: executionRequest
smart constructor.
Instances
executionRequest :: ExecutionRequest Source #
Creates a value of ExecutionRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
erFunction :: Lens' ExecutionRequest (Maybe Text) Source #
The name of the function to execute in the given script. The name does not include parentheses or parameters.
erSessionState :: Lens' ExecutionRequest (Maybe Text) Source #
For Android add-ons only. An ID that represents the user's current session in the Android app for Google Docs or Sheets, included as extra data in the Intent that launches the add-on. When an Android add-on is run with a session state, it gains the privileges of a bound script—that is, it can access information like the user's current cursor position (in Docs) or selected cell (in Sheets). To retrieve the state, call `Intent.getStringExtra("com.google.android.apps.docs.addons.SessionState")`. Optional.
erDevMode :: Lens' ExecutionRequest (Maybe Bool) Source #
If `true` and the user is an owner of the script, the script runs at the most recently saved version rather than the version deployed for use with the Apps Script API. Optional; default is `false`.
erParameters :: Lens' ExecutionRequest [JSONValue] Source #
The parameters to be passed to the function being executed. The object type for each parameter should match the expected type in Apps Script. Parameters cannot be Apps Script-specific object types (such as a `Document` or a `Calendar`); they can only be primitive types such as `string`, `number`, `array`, `object`, or `boolean`. Optional.
ListScriptProcessesResponse
data ListScriptProcessesResponse Source #
Response with the list of Process resources.
See: listScriptProcessesResponse
smart constructor.
Instances
listScriptProcessesResponse :: ListScriptProcessesResponse Source #
Creates a value of ListScriptProcessesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lsprNextPageToken :: Lens' ListScriptProcessesResponse (Maybe Text) Source #
Token for the next page of results. If empty, there are no more pages remaining.
lsprProcesses :: Lens' ListScriptProcessesResponse [GoogleAppsScriptTypeProcess] Source #
List of processes matching request parameters.
StatusDetailsItem
data StatusDetailsItem Source #
Instances
Creates a value of StatusDetailsItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
FileType
The type of the file.
EnumTypeUnspecified |
|
ServerJs |
|
HTML |
|
JSON |
|
Instances
ScriptStackTraceElement
data ScriptStackTraceElement Source #
A stack trace through the script that shows where the execution failed.
See: scriptStackTraceElement
smart constructor.
Instances
scriptStackTraceElement :: ScriptStackTraceElement Source #
Creates a value of ScriptStackTraceElement
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ssteFunction :: Lens' ScriptStackTraceElement (Maybe Text) Source #
The name of the function that failed.
ssteLineNumber :: Lens' ScriptStackTraceElement (Maybe Int32) Source #
The line number where the script failed.
Content
The Content resource.
See: content
smart constructor.
Instances
Eq Content Source # | |
Data Content Source # | |
Defined in Network.Google.Script.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Content -> c Content # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Content # toConstr :: Content -> Constr # dataTypeOf :: Content -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Content) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Content) # gmapT :: (forall b. Data b => b -> b) -> Content -> Content # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Content -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Content -> r # gmapQ :: (forall d. Data d => d -> u) -> Content -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Content -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Content -> m Content # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Content -> m Content # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Content -> m Content # | |
Show Content Source # | |
Generic Content Source # | |
ToJSON Content Source # | |
Defined in Network.Google.Script.Types.Product | |
FromJSON Content Source # | |
type Rep Content Source # | |
Defined in Network.Google.Script.Types.Product type Rep Content = D1 (MetaData "Content" "Network.Google.Script.Types.Product" "gogol-script-0.4.0-FTMJIbj3qQWJYzgfzFUSMi" False) (C1 (MetaCons "Content'" PrefixI True) (S1 (MetaSel (Just "_cScriptId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cFiles") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [File])))) |
cFiles :: Lens' Content [File] Source #
The list of script project files. One of the files is a script manifest; it must be named "appsscript", must have type of JSON, and include the manifest configurations for the project.
GoogleAppsScriptTypeAddOnEntryPointAddOnType
data GoogleAppsScriptTypeAddOnEntryPointAddOnType Source #
The add-on's required list of supported container types.
UnknownAddonType |
|
Gmail |
|
DataStudio |
|
Instances
MetricsValue
data MetricsValue Source #
Metrics value that holds number of executions counted.
See: metricsValue
smart constructor.
Instances
metricsValue :: MetricsValue Source #
Creates a value of MetricsValue
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mvStartTime :: Lens' MetricsValue (Maybe UTCTime) Source #
Required field indicating the start time of the interval.
mvEndTime :: Lens' MetricsValue (Maybe UTCTime) Source #
Required field indicating the end time of the interval.
GoogleAppsScriptTypeAddOnEntryPoint
data GoogleAppsScriptTypeAddOnEntryPoint Source #
An add-on entry point.
See: googleAppsScriptTypeAddOnEntryPoint
smart constructor.
Instances
googleAppsScriptTypeAddOnEntryPoint :: GoogleAppsScriptTypeAddOnEntryPoint Source #
Creates a value of GoogleAppsScriptTypeAddOnEntryPoint
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gastaoepPostInstallTipURL :: Lens' GoogleAppsScriptTypeAddOnEntryPoint (Maybe Text) Source #
The add-on's required post install tip URL.
gastaoepAddOnType :: Lens' GoogleAppsScriptTypeAddOnEntryPoint (Maybe GoogleAppsScriptTypeAddOnEntryPointAddOnType) Source #
The add-on's required list of supported container types.
gastaoepReportIssueURL :: Lens' GoogleAppsScriptTypeAddOnEntryPoint (Maybe Text) Source #
The add-on's optional report issue URL.
gastaoepHelpURL :: Lens' GoogleAppsScriptTypeAddOnEntryPoint (Maybe Text) Source #
The add-on's optional help URL.
gastaoepTitle :: Lens' GoogleAppsScriptTypeAddOnEntryPoint (Maybe Text) Source #
The add-on's required title.
gastaoepDescription :: Lens' GoogleAppsScriptTypeAddOnEntryPoint (Maybe Text) Source #
The add-on's optional description.
GoogleAppsScriptTypeWebAppConfig
data GoogleAppsScriptTypeWebAppConfig Source #
Web app entry point configuration.
See: googleAppsScriptTypeWebAppConfig
smart constructor.
Instances
googleAppsScriptTypeWebAppConfig :: GoogleAppsScriptTypeWebAppConfig Source #
Creates a value of GoogleAppsScriptTypeWebAppConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gastwacAccess :: Lens' GoogleAppsScriptTypeWebAppConfig (Maybe GoogleAppsScriptTypeWebAppConfigAccess) Source #
Who has permission to run the web app.
gastwacExecuteAs :: Lens' GoogleAppsScriptTypeWebAppConfig (Maybe GoogleAppsScriptTypeWebAppConfigExecuteAs) Source #
Who to execute the web app as.
Version
A resource representing a script project version. A version is a "snapshot" of a script project and is similar to a read-only branched release. When creating deployments, the version to use must be specified.
See: version
smart constructor.
Instances
Eq Version Source # | |
Data Version Source # | |
Defined in Network.Google.Script.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Version -> c Version # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Version # toConstr :: Version -> Constr # dataTypeOf :: Version -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Version) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Version) # gmapT :: (forall b. Data b => b -> b) -> Version -> Version # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Version -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Version -> r # gmapQ :: (forall d. Data d => d -> u) -> Version -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Version -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Version -> m Version # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Version -> m Version # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Version -> m Version # | |
Show Version Source # | |
Generic Version Source # | |
ToJSON Version Source # | |
Defined in Network.Google.Script.Types.Product | |
FromJSON Version Source # | |
type Rep Version Source # | |
Defined in Network.Google.Script.Types.Product type Rep Version = D1 (MetaData "Version" "Network.Google.Script.Types.Product" "gogol-script-0.4.0-FTMJIbj3qQWJYzgfzFUSMi" False) (C1 (MetaCons "Version'" PrefixI True) ((S1 (MetaSel (Just "_vVersionNumber") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_vScriptId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_vDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_vCreateTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DateTime'))))) |
Creates a value of Version
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
vVersionNumber :: Lens' Version (Maybe Int32) Source #
The incremental ID that is created by Apps Script when a version is created. This is system assigned number and is immutable once created.
Xgafv
V1 error format.
Instances
ExecutionError
data ExecutionError Source #
An object that provides information about the nature of an error resulting from an attempted execution of a script function using the Apps Script API. If a run call succeeds but the script function (or Apps Script itself) throws an exception, the response body's error field contains a Status object. The `Status` object's `details` field contains an array with a single one of these `ExecutionError` objects.
See: executionError
smart constructor.
Instances
executionError :: ExecutionError Source #
Creates a value of ExecutionError
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eeScriptStackTraceElements :: Lens' ExecutionError [ScriptStackTraceElement] Source #
An array of objects that provide a stack trace through the script to show where the execution failed, with the deepest call first.
eeErrorType :: Lens' ExecutionError (Maybe Text) Source #
The error type, for example `TypeError` or `ReferenceError`. If the error type is unavailable, this field is not included.
eeErrorMessage :: Lens' ExecutionError (Maybe Text) Source #
The error message thrown by Apps Script, usually localized into the user's language.
GoogleAppsScriptTypeWebAppEntryPoint
data GoogleAppsScriptTypeWebAppEntryPoint Source #
A web application entry point.
See: googleAppsScriptTypeWebAppEntryPoint
smart constructor.
Instances
googleAppsScriptTypeWebAppEntryPoint :: GoogleAppsScriptTypeWebAppEntryPoint Source #
Creates a value of GoogleAppsScriptTypeWebAppEntryPoint
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gastwaepEntryPointConfig :: Lens' GoogleAppsScriptTypeWebAppEntryPoint (Maybe GoogleAppsScriptTypeWebAppConfig) Source #
The entry point's configuration.
gastwaepURL :: Lens' GoogleAppsScriptTypeWebAppEntryPoint (Maybe Text) Source #
The URL for the web application.
EntryPointEntryPointType
data EntryPointEntryPointType Source #
The type of the entry point.
EPEPTEntryPointTypeUnspecified |
|
EPEPTWebApp |
|
EPEPTExecutionAPI |
|
EPEPTAddOn |
|
Instances
CreateProjectRequest
data CreateProjectRequest Source #
Request to create a script project.
See: createProjectRequest
smart constructor.
Instances
createProjectRequest :: CreateProjectRequest Source #
Creates a value of CreateProjectRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cprParentId :: Lens' CreateProjectRequest (Maybe Text) Source #
The Drive ID of a parent file that the created script project is bound to. This is usually the ID of a Google Doc, Google Sheet, Google Form, or Google Slides file. If not set, a standalone script project is created.
GoogleAppsScriptTypeProcessProcessStatus
data GoogleAppsScriptTypeProcessProcessStatus Source #
The executions status.
ProcessStatusUnspecified |
|
Running |
|
Paused |
|
Completed |
|
Canceled |
|
Failed |
|
TimedOut |
|
Unknown |
|
Delayed |
|
Instances
DeploymentConfig
data DeploymentConfig Source #
Metadata the defines how a deployment is configured.
See: deploymentConfig
smart constructor.
Instances
deploymentConfig :: DeploymentConfig Source #
Creates a value of DeploymentConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dcVersionNumber :: Lens' DeploymentConfig (Maybe Int32) Source #
The version number on which this deployment is based.
dcScriptId :: Lens' DeploymentConfig (Maybe Text) Source #
The script project's Drive ID.
dcManifestFileName :: Lens' DeploymentConfig (Maybe Text) Source #
The manifest file name for this deployment.
dcDescription :: Lens' DeploymentConfig (Maybe Text) Source #
The description for this deployment.
GoogleAppsScriptTypeWebAppConfigAccess
data GoogleAppsScriptTypeWebAppConfigAccess Source #
Who has permission to run the web app.
GASTWACAUnknownAccess |
|
GASTWACAMyself |
|
GASTWACADomain |
|
GASTWACAAnyone |
|
GASTWACAAnyoneAnonymous |
|
Instances
ListDeploymentsResponse
data ListDeploymentsResponse Source #
Response with the list of deployments for the specified Apps Script project.
See: listDeploymentsResponse
smart constructor.
Instances
listDeploymentsResponse :: ListDeploymentsResponse Source #
Creates a value of ListDeploymentsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ldrNextPageToken :: Lens' ListDeploymentsResponse (Maybe Text) Source #
The token that can be used in the next call to get the next page of results.
ldrDeployments :: Lens' ListDeploymentsResponse [Deployment] Source #
The list of deployments.
GoogleAppsScriptTypeFunction
data GoogleAppsScriptTypeFunction Source #
Represents a function in a script project.
See: googleAppsScriptTypeFunction
smart constructor.
Instances
googleAppsScriptTypeFunction :: GoogleAppsScriptTypeFunction Source #
Creates a value of GoogleAppsScriptTypeFunction
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gastfName :: Lens' GoogleAppsScriptTypeFunction (Maybe Text) Source #
The function name in the script project.
File
An individual file within a script project. A file is a third-party source code created by one or more developers. It can be a server-side JS code, HTML, or a configuration file. Each script project can contain multiple files.
See: file
smart constructor.
Instances
Creates a value of File
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fFunctionSet :: Lens' File (Maybe GoogleAppsScriptTypeFunctionSet) Source #
The defined set of functions in the script file, if any.
fLastModifyUser :: Lens' File (Maybe GoogleAppsScriptTypeUser) Source #
The user who modified the file most recently. This read-only field is only visible to users who have WRITER permission for the script project.
fUpdateTime :: Lens' File (Maybe UTCTime) Source #
Last modified date timestamp. This read-only field is only visible to users who have WRITER permission for the script project.
fName :: Lens' File (Maybe Text) Source #
The name of the file. The file extension is not part of the file name, which can be identified from the type field.
fCreateTime :: Lens' File (Maybe UTCTime) Source #
Creation date timestamp. This read-only field is only visible to users who have WRITER permission for the script project.
GoogleAppsScriptTypeExecutionAPIEntryPoint
data GoogleAppsScriptTypeExecutionAPIEntryPoint Source #
An API executable entry point.
See: googleAppsScriptTypeExecutionAPIEntryPoint
smart constructor.
Instances
googleAppsScriptTypeExecutionAPIEntryPoint :: GoogleAppsScriptTypeExecutionAPIEntryPoint Source #
Creates a value of GoogleAppsScriptTypeExecutionAPIEntryPoint
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gasteaepEntryPointConfig :: Lens' GoogleAppsScriptTypeExecutionAPIEntryPoint (Maybe GoogleAppsScriptTypeExecutionAPIConfig) Source #
The entry point's configuration.
OperationResponse
data OperationResponse Source #
If the script function returns successfully, this field contains an ExecutionResponse object with the function's return value.
See: operationResponse
smart constructor.
Instances
Creates a value of OperationResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
orAddtional :: Lens' OperationResponse (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
ExecutionResponse
data ExecutionResponse Source #
An object that provides the return value of a function executed using the Apps Script API. If the script function returns successfully, the response body's response field contains this `ExecutionResponse` object.
See: executionResponse
smart constructor.
Instances
executionResponse :: ExecutionResponse Source #
Creates a value of ExecutionResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
erResult :: Lens' ExecutionResponse (Maybe JSONValue) Source #
The return value of the script function. The type matches the object type returned in Apps Script. Functions called using the Apps Script API cannot return Apps Script-specific objects (such as a `Document` or a `Calendar`); they can only return primitive types such as a `string`, `number`, `array`, `object`, or `boolean`.
Deployment
data Deployment Source #
Representation of a single script deployment.
See: deployment
smart constructor.
Instances
deployment :: Deployment Source #
Creates a value of Deployment
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dDeploymentId :: Lens' Deployment (Maybe Text) Source #
The deployment ID for this deployment.
dUpdateTime :: Lens' Deployment (Maybe UTCTime) Source #
Last modified date time stamp.
dEntryPoints :: Lens' Deployment [EntryPoint] Source #
The deployment's entry points.
dDeploymentConfig :: Lens' Deployment (Maybe DeploymentConfig) Source #
The deployment configuration.
UpdateDeploymentRequest
data UpdateDeploymentRequest Source #
Request with deployment information to update an existing deployment.
See: updateDeploymentRequest
smart constructor.
Instances
updateDeploymentRequest :: UpdateDeploymentRequest Source #
Creates a value of UpdateDeploymentRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
udrDeploymentConfig :: Lens' UpdateDeploymentRequest (Maybe DeploymentConfig) Source #
The deployment configuration.