Returns the deployments Resource.
Returns the versions Resource.
create(body=None, x__xgafv=None)
Creates a new, empty script project with no script files and a base
get(scriptId=*, x__xgafv=None)
Gets a script project's metadata.
getContent(scriptId=*, versionNumber=None, x__xgafv=None)
Gets the content of the script project, including the code source and
getMetrics(scriptId=*, metricsFilter_deploymentId=None, x__xgafv=None, metricsGranularity=None)
Get metrics data for scripts, such as number of executions and
updateContent(scriptId=*, body=None, x__xgafv=None)
Updates the content of the specified script project.
create(body=None, x__xgafv=None)
Creates a new, empty script project with no script files and a base
manifest file.
Args:
body: object, The request body.
The object takes the form of:
{ # Request to create a script project.
"title": "A String", # The title for the project.
"parentId": "A String", # 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.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The script project resource.
"updateTime": "A String", # When the script was last updated.
"lastModifyUser": { # A simple user profile resource. # User who last modified the script.
"email": "A String", # The user's identifying email address.
"domain": "A String", # The user's domain.
"name": "A String", # The user's display name.
"photoUrl": "A String", # The user's photo.
},
"title": "A String", # The title for the project.
"creator": { # A simple user profile resource. # User who originally created the script.
"email": "A String", # The user's identifying email address.
"domain": "A String", # The user's domain.
"name": "A String", # The user's display name.
"photoUrl": "A String", # The user's photo.
},
"scriptId": "A String", # The script project's Drive ID.
"parentId": "A String", # 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.
"createTime": "A String", # When the script was created.
}
get(scriptId=*, x__xgafv=None)
Gets a script project's metadata.
Args:
scriptId: string, The script project's Drive ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The script project resource.
"updateTime": "A String", # When the script was last updated.
"lastModifyUser": { # A simple user profile resource. # User who last modified the script.
"email": "A String", # The user's identifying email address.
"domain": "A String", # The user's domain.
"name": "A String", # The user's display name.
"photoUrl": "A String", # The user's photo.
},
"title": "A String", # The title for the project.
"creator": { # A simple user profile resource. # User who originally created the script.
"email": "A String", # The user's identifying email address.
"domain": "A String", # The user's domain.
"name": "A String", # The user's display name.
"photoUrl": "A String", # The user's photo.
},
"scriptId": "A String", # The script project's Drive ID.
"parentId": "A String", # 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.
"createTime": "A String", # When the script was created.
}
getContent(scriptId=*, versionNumber=None, x__xgafv=None)
Gets the content of the script project, including the code source and
metadata for each script file.
Args:
scriptId: string, The script project's Drive ID. (required)
versionNumber: integer, The version number of the project to retrieve. If not provided, the
project's HEAD version is returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The Content resource.
"files": [ # 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.
{ # 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.
"updateTime": "A String", # Last modified date timestamp.
# This read-only field is only visible to users who have WRITER
# permission for the script project.
"lastModifyUser": { # A simple user profile resource. # 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.
"email": "A String", # The user's identifying email address.
"domain": "A String", # The user's domain.
"name": "A String", # The user's display name.
"photoUrl": "A String", # The user's photo.
},
"source": "A String", # The file content.
"functionSet": { # A set of functions. No duplicates are permitted. # The defined set of functions in the script file, if any.
"values": [ # A list of functions composing the set.
{ # Represents a function in a script project.
"name": "A String", # The function name in the script project.
},
],
},
"type": "A String", # The type of the file.
"createTime": "A String", # Creation date timestamp.
# This read-only field is only visible to users who have WRITER
# permission for the script project.
"name": "A String", # The name of the file. The file extension is not part of the file
# name, which can be identified from the type field.
},
],
"scriptId": "A String", # The script project's Drive ID.
}
getMetrics(scriptId=*, metricsFilter_deploymentId=None, x__xgafv=None, metricsGranularity=None)
Get metrics data for scripts, such as number of executions and
active users.
Args:
scriptId: string, Required field indicating the script to get metrics for. (required)
metricsFilter_deploymentId: string, Optional field indicating a specific deployment to retrieve metrics from.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
metricsGranularity: string, Required field indicating what granularity of metrics are returned.
Returns:
An object of the form:
{ # Resource containing usage stats for a given script, based on the supplied
# filter and mask present in the request.
"totalExecutions": [ # Number of total executions.
{ # Metrics value that holds number of executions counted.
"endTime": "A String", # Required field indicating the end time of the interval.
"value": "A String", # Indicates the number of executions counted.
"startTime": "A String", # Required field indicating the start time of the interval.
},
],
"activeUsers": [ # Number of active users.
{ # Metrics value that holds number of executions counted.
"endTime": "A String", # Required field indicating the end time of the interval.
"value": "A String", # Indicates the number of executions counted.
"startTime": "A String", # Required field indicating the start time of the interval.
},
],
"failedExecutions": [ # Number of failed executions.
{ # Metrics value that holds number of executions counted.
"endTime": "A String", # Required field indicating the end time of the interval.
"value": "A String", # Indicates the number of executions counted.
"startTime": "A String", # Required field indicating the start time of the interval.
},
],
}
updateContent(scriptId=*, body=None, x__xgafv=None)
Updates the content of the specified script project.
This content is stored as the HEAD version, and is used when the script is
executed as a trigger, in the script editor, in add-on preview mode, or as
a web app or Apps Script API in development mode. This clears all the
existing files in the project.
Args:
scriptId: string, The script project's Drive ID. (required)
body: object, The request body.
The object takes the form of:
{ # The Content resource.
"files": [ # 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.
{ # 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.
"updateTime": "A String", # Last modified date timestamp.
# This read-only field is only visible to users who have WRITER
# permission for the script project.
"lastModifyUser": { # A simple user profile resource. # 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.
"email": "A String", # The user's identifying email address.
"domain": "A String", # The user's domain.
"name": "A String", # The user's display name.
"photoUrl": "A String", # The user's photo.
},
"source": "A String", # The file content.
"functionSet": { # A set of functions. No duplicates are permitted. # The defined set of functions in the script file, if any.
"values": [ # A list of functions composing the set.
{ # Represents a function in a script project.
"name": "A String", # The function name in the script project.
},
],
},
"type": "A String", # The type of the file.
"createTime": "A String", # Creation date timestamp.
# This read-only field is only visible to users who have WRITER
# permission for the script project.
"name": "A String", # The name of the file. The file extension is not part of the file
# name, which can be identified from the type field.
},
],
"scriptId": "A String", # The script project's Drive ID.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The Content resource.
"files": [ # 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.
{ # 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.
"updateTime": "A String", # Last modified date timestamp.
# This read-only field is only visible to users who have WRITER
# permission for the script project.
"lastModifyUser": { # A simple user profile resource. # 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.
"email": "A String", # The user's identifying email address.
"domain": "A String", # The user's domain.
"name": "A String", # The user's display name.
"photoUrl": "A String", # The user's photo.
},
"source": "A String", # The file content.
"functionSet": { # A set of functions. No duplicates are permitted. # The defined set of functions in the script file, if any.
"values": [ # A list of functions composing the set.
{ # Represents a function in a script project.
"name": "A String", # The function name in the script project.
},
],
},
"type": "A String", # The type of the file.
"createTime": "A String", # Creation date timestamp.
# This read-only field is only visible to users who have WRITER
# permission for the script project.
"name": "A String", # The name of the file. The file extension is not part of the file
# name, which can be identified from the type field.
},
],
"scriptId": "A String", # The script project's Drive ID.
}