Blame - docs/dyn/script_v1.projects.html - platform/external/python/google-api-python-client

2019-06-14 16:50:42 -0700

[diff] [blame]

105

<h3>Method Details</h3>

106

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

107

<code class="details" id="close">close()</code>

108

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

112

<code class="details" id="create">create(body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

113

<pre>Creates a new, empty script project with no script files and a base manifest file.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

114

115

Args:

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

116

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

117

The object takes the form of:

118

119

{ # Request to create a script project.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

120

"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.

121

"title": "A String", # The title for the project.

122

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

123

124

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

131

132

{ # The script project resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

133

"createTime": "A String", # When the script was created.

134

"creator": { # A simple user profile resource. # User who originally created the script.

135

"domain": "A String", # The user's domain.

136

"email": "A String", # The user's identifying email address.

137

"name": "A String", # The user's display name.

138

"photoUrl": "A String", # The user's photo.

139

},

140

"lastModifyUser": { # A simple user profile resource. # User who last modified the script.

141

"domain": "A String", # The user's domain.

142

"email": "A String", # The user's identifying email address.

143

"name": "A String", # The user's display name.

144

"photoUrl": "A String", # The user's photo.

145

},

146

"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.

147

"scriptId": "A String", # The script project's Drive ID.

148

"title": "A String", # The title for the project.

149

"updateTime": "A String", # When the script was last updated.

150

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

<code class="details" id="get">get(scriptId, x__xgafv=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

155

<pre>Gets a script project's metadata.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

156

157

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

158

scriptId: string, The script project's Drive ID. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

159

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

166

167

{ # The script project resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

168

"createTime": "A String", # When the script was created.

169

"creator": { # A simple user profile resource. # User who originally created the script.

170

"domain": "A String", # The user's domain.

171

"email": "A String", # The user's identifying email address.

172

"name": "A String", # The user's display name.

173

"photoUrl": "A String", # The user's photo.

174

},

175

"lastModifyUser": { # A simple user profile resource. # User who last modified the script.

176

"domain": "A String", # The user's domain.

177

"email": "A String", # The user's identifying email address.

178

"name": "A String", # The user's display name.

179

"photoUrl": "A String", # The user's photo.

180

},

181

"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.

182

"scriptId": "A String", # The script project's Drive ID.

183

"title": "A String", # The title for the project.

184

"updateTime": "A String", # When the script was last updated.

185

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

<code class="details" id="getContent">getContent(scriptId, versionNumber=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

190

<pre>Gets the content of the script project, including the code source and metadata for each script file.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

191

192

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

193

scriptId: string, The script project's Drive ID. (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

194

versionNumber: integer, The version number of the project to retrieve. If not provided, the project's HEAD version is returned.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

195

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

202

203

{ # The Content resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

204

"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.

205

{ # 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.

206

"createTime": "A String", # Creation date timestamp. This read-only field is only visible to users who have WRITER permission for the script project.

207

"functionSet": { # A set of functions. No duplicates are permitted. # The defined set of functions in the script file, if any.

208

"values": [ # A list of functions composing the set.

209

{ # Represents a function in a script project.

210

"name": "A String", # The function name in the script project.

Yoshi Automation Bot

b6971b0

2020-11-26 17:16:03 -0800

[diff] [blame]

211

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

212

],

213

},

214

"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.

215

"domain": "A String", # The user's domain.

216

"email": "A String", # The user's identifying email address.

217

"name": "A String", # The user's display name.

218

"photoUrl": "A String", # The user's photo.

219

},

220

"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.

221

"source": "A String", # The file content.

222

"type": "A String", # The type of the file.

223

"updateTime": "A String", # Last modified date timestamp. This read-only field is only visible to users who have WRITER permission for the script project.

224

},

225

],

226

"scriptId": "A String", # The script project's Drive ID.

227

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

231

<code class="details" id="getMetrics">getMetrics(scriptId, metricsFilter_deploymentId=None, metricsGranularity=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

232

<pre>Get metrics data for scripts, such as number of executions and active users.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

233

234

Args:

235

scriptId: string, Required field indicating the script to get metrics for. (required)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

236

metricsFilter_deploymentId: string, Optional field indicating a specific deployment to retrieve metrics from.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

237

metricsGranularity: string, Required field indicating what granularity of metrics are returned.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

238

Allowed values

239

UNSPECIFIED_GRANULARITY - Default metric granularity used to query no metrics.

240

WEEKLY - Represents weekly metrics.

241

DAILY - Represents daily metrics over a period of 7 days.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

242

x__xgafv: string, V1 error format.

243

Allowed values

244

1 - v1 error format

245

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

246

247

Returns:

248

An object of the form:

249

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

250

{ # Resource containing usage stats for a given script, based on the supplied filter and mask present in the request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

251

"activeUsers": [ # Number of active users.

252

{ # Metrics value that holds number of executions counted.

253

"endTime": "A String", # Required field indicating the end time of the interval.

254

"startTime": "A String", # Required field indicating the start time of the interval.

255

"value": "A String", # Indicates the number of executions counted.

256

},

257

],

258

"failedExecutions": [ # Number of failed executions.

259

{ # Metrics value that holds number of executions counted.

260

"endTime": "A String", # Required field indicating the end time of the interval.

261

"startTime": "A String", # Required field indicating the start time of the interval.

262

"value": "A String", # Indicates the number of executions counted.

263

},

264

],

265

"totalExecutions": [ # Number of total executions.

266

{ # Metrics value that holds number of executions counted.

267

"endTime": "A String", # Required field indicating the end time of the interval.

268

"startTime": "A String", # Required field indicating the start time of the interval.

269

"value": "A String", # Indicates the number of executions counted.

270

},

271

],

272

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

276

<code class="details" id="updateContent">updateContent(scriptId, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

277

<pre>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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

278

279

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

280

scriptId: string, The script project's Drive ID. (required)

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

281

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

282

The object takes the form of:

283

284

{ # The Content resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

285

"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.

286

{ # 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.

287

"createTime": "A String", # Creation date timestamp. This read-only field is only visible to users who have WRITER permission for the script project.

288

"functionSet": { # A set of functions. No duplicates are permitted. # The defined set of functions in the script file, if any.

289

"values": [ # A list of functions composing the set.

290

{ # Represents a function in a script project.

291

"name": "A String", # The function name in the script project.

292

},

293

],

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

294

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

295

"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.

296

"domain": "A String", # The user's domain.

297

"email": "A String", # The user's identifying email address.

298

"name": "A String", # The user's display name.

299

"photoUrl": "A String", # The user's photo.

300

},

301

"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.

302

"source": "A String", # The file content.

303

"type": "A String", # The type of the file.

304

"updateTime": "A String", # Last modified date timestamp. This read-only field is only visible to users who have WRITER permission for the script project.

305

},

306

],

307

"scriptId": "A String", # The script project's Drive ID.

308

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

309

310

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

317

318

{ # The Content resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

319

"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.

320

{ # 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.

321

"createTime": "A String", # Creation date timestamp. This read-only field is only visible to users who have WRITER permission for the script project.

322

"functionSet": { # A set of functions. No duplicates are permitted. # The defined set of functions in the script file, if any.

323

"values": [ # A list of functions composing the set.

324

{ # Represents a function in a script project.

325

"name": "A String", # The function name in the script project.

Yoshi Automation Bot

b6971b0

2020-11-26 17:16:03 -0800

[diff] [blame]

326

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

327

],

328

},

329

"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.

330

"domain": "A String", # The user's domain.

331

"email": "A String", # The user's identifying email address.

332

"name": "A String", # The user's display name.

333

"photoUrl": "A String", # The user's photo.

334

},

335

"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.

336

"source": "A String", # The file content.

337

"type": "A String", # The type of the file.

338

"updateTime": "A String", # Last modified date timestamp. This read-only field is only visible to users who have WRITER permission for the script project.

339

},

340

],

341

"scriptId": "A String", # The script project's Drive ID.

342

}</pre>

Bu Sun Kim