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

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

[diff] [blame]

<style>

body, h1, h2, h3, div, span, p, pre, a {

margin: 0;

padding: 0;

border: 0;

font-weight: inherit;

9

font-style: inherit;

10

font-size: 100%;

11

font-family: inherit;

12

vertical-align: baseline;

}

body {

font-size: 13px;

padding: 1em;

}

h1 {

font-size: 26px;

margin-bottom: 1em;

}

h2 {

font-size: 24px;

margin-bottom: 1em;

}

h3 {

font-size: 20px;

margin-bottom: 1em;

margin-top: 1em;

}

pre, code {

line-height: 1.5;

font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;

}

pre {

margin-top: 0.5em;

}

h1, h2, h3, p {

font-family: Arial, sans serif;

}

h1, h2, h3 {

border-bottom: solid #CCC 1px;

}

.toc_element {

margin-top: 0.5em;

}

.firstline {

margin-left: 2 em;

}

.method {

margin-top: 1em;

border: solid 1px #CCC;

padding: 1em;

background: #EEE;

}

.details {

font-weight: bold;

font-size: 14px;

}

</style>

<h1><a href="script_v1.html">Apps Script API</a> . <a href="script_v1.projects.html">projects</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="script_v1.projects.deployments.html">deployments()</a></code>

79

</p>

80

<p class="firstline">Returns the deployments Resource.</p>

81

82

83

<code><a href="script_v1.projects.versions.html">versions()</a></code>

84

</p>

85

<p class="firstline">Returns the versions Resource.</p>

86

87

Dan O'Meara

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

[diff] [blame]

88

<code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

89

<p class="firstline">Creates a new, empty script project with no script files and a base</p>

90

91

<code><a href="#get">get(scriptId, x__xgafv=None)</a></code></p>

92

<p class="firstline">Gets a script project's metadata.</p>

93

94

<code><a href="#getContent">getContent(scriptId, versionNumber=None, x__xgafv=None)</a></code></p>

95

<p class="firstline">Gets the content of the script project, including the code source and</p>

96

Bu Sun Kim

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

[diff] [blame]

97

<code><a href="#getMetrics">getMetrics(scriptId, metricsGranularity=None, metricsFilter_deploymentId=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

98

<p class="firstline">Get metrics data for scripts, such as number of executions and</p>

99

Dan O'Meara

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

[diff] [blame]

100

<code><a href="#updateContent">updateContent(scriptId, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

101

<p class="firstline">Updates the content of the specified script project.</p>

102

<h3>Method Details</h3>

103

Dan O'Meara

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

[diff] [blame]

104

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

Bu Sun Kim

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

[diff] [blame]

105

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

106

manifest file.

107

108

Args:

Dan O'Meara

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

[diff] [blame]

109

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

110

The object takes the form of:

111

112

{ # Request to create a script project.

Bu Sun Kim

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

[diff] [blame]

113

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

114

"parentId": "A String", # The Drive ID of a parent file that the created script project is bound to.

Bu Sun Kim

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

[diff] [blame]

115

# This is usually the ID of a Google Doc, Google Sheet, Google Form, or

116

# Google Slides file. If not set, a standalone script project is created.

117

}

118

119

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

126

127

{ # The script project resource.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

128

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

129

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

130

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

131

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

132

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

133

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

134

},

135

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

Bu Sun Kim

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

[diff] [blame]

136

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

137

"parentId": "A String", # The parent's Drive ID that the script will be attached to. This is usually

Bu Sun Kim

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

[diff] [blame]

138

# the ID of a Google Document or Google Sheet. This filed is optional, and

139

# if not set, a stand-alone script will be created.

Bu Sun Kim

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

[diff] [blame]

140

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

Bu Sun Kim

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

[diff] [blame]

141

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

142

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

143

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

144

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

Bu Sun Kim

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

[diff] [blame]

145

},

146

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

Bu Sun Kim

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

[diff] [blame]

152

<pre>Gets a script project's metadata.

Bu Sun Kim

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

[diff] [blame]

153

154

Args:

Bu Sun Kim

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

[diff] [blame]

155

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

Bu Sun Kim

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

[diff] [blame]

156

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

163

164

{ # The script project resource.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

165

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

166

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

167

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

168

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

169

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

170

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

171

},

172

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

Bu Sun Kim

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

[diff] [blame]

173

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

174

"parentId": "A String", # The parent's Drive ID that the script will be attached to. This is usually

Bu Sun Kim

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

[diff] [blame]

175

# the ID of a Google Document or Google Sheet. This filed is optional, and

176

# if not set, a stand-alone script will be created.

Bu Sun Kim

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

[diff] [blame]

177

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

Bu Sun Kim

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

[diff] [blame]

178

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

179

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

180

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

181

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

Bu Sun Kim

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

[diff] [blame]

182

},

183

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

189

<pre>Gets the content of the script project, including the code source and

190

metadata for each script file.

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)

Bu Sun Kim

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

[diff] [blame]

194

versionNumber: integer, The version number of the project to retrieve. If not provided, the

Bu Sun Kim

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

[diff] [blame]

195

project's HEAD version is returned.

Bu Sun Kim

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

[diff] [blame]

196

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

203

204

{ # The Content resource.

Bu Sun Kim

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

[diff] [blame]

205

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

206

"files": [ # The list of script project files.

207

# One of the files is a script manifest; it must be named "appsscript",

Bu Sun Kim

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

[diff] [blame]

208

# must have type of JSON, and include the manifest configurations for the

209

# project.

210

{ # An individual file within a script project.

211

# A file is a third-party source code created by one or more

212

# developers. It can be a server-side JS code, HTML, or a

213

# configuration file. Each script project can contain multiple files.

Bu Sun Kim

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

[diff] [blame]

214

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

215

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

Bu Sun Kim

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

[diff] [blame]

216

{ # Represents a function in a script project.

Bu Sun Kim

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

[diff] [blame]

217

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

Bu Sun Kim

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

[diff] [blame]

218

},

219

],

220

},

Bu Sun Kim

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

[diff] [blame]

221

"lastModifyUser": { # A simple user profile resource. # The user who modified the file most recently.

Bu Sun Kim

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

[diff] [blame]

222

# This read-only field is only visible to users who have WRITER

223

# permission for the script project.

Bu Sun Kim

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

[diff] [blame]

224

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

225

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

226

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

227

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

Bu Sun Kim

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

[diff] [blame]

228

},

229

"createTime": "A String", # Creation date timestamp.

230

# This read-only field is only visible to users who have WRITER

231

# permission for the script project.

232

"updateTime": "A String", # Last modified date timestamp.

233

# This read-only field is only visible to users who have WRITER

234

# permission for the script project.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

235

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

236

"name": "A String", # The name of the file. The file extension is not part of the file

237

# name, which can be identified from the type field.

238

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

Bu Sun Kim

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

[diff] [blame]

239

},

240

],

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

245

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

Bu Sun Kim

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

[diff] [blame]

246

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

Bu Sun Kim

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

[diff] [blame]

251

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

Bu Sun Kim

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

[diff] [blame]

252

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

253

x__xgafv: string, V1 error format.

254

Allowed values

255

1 - v1 error format

256

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

257

258

Returns:

259

An object of the form:

260

261

{ # Resource containing usage stats for a given script, based on the supplied

262

# filter and mask present in the request.

Bu Sun Kim

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

[diff] [blame]

263

"activeUsers": [ # Number of active users.

Bu Sun Kim

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

[diff] [blame]

264

{ # Metrics value that holds number of executions counted.

Bu Sun Kim

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

[diff] [blame]

265

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

266

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

267

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

Bu Sun Kim

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

[diff] [blame]

268

},

269

],

Bu Sun Kim

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

[diff] [blame]

270

"failedExecutions": [ # Number of failed executions.

Bu Sun Kim

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

[diff] [blame]

271

{ # Metrics value that holds number of executions counted.

Bu Sun Kim

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

[diff] [blame]

272

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

273

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

274

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

Bu Sun Kim

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

[diff] [blame]

275

},

276

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

277

"totalExecutions": [ # Number of total executions.

278

{ # Metrics value that holds number of executions counted.

279

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

280

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

281

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

282

},

283

],

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

288

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

Bu Sun Kim

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

[diff] [blame]

289

<pre>Updates the content of the specified script project.

290

This content is stored as the HEAD version, and is used when the script is

291

executed as a trigger, in the script editor, in add-on preview mode, or as

292

a web app or Apps Script API in development mode. This clears all the

293

existing files in the project.

294

295

Args:

Bu Sun Kim

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

[diff] [blame]

296

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

Dan O'Meara

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

[diff] [blame]

297

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

298

The object takes the form of:

299

300

{ # The Content resource.

Bu Sun Kim

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

[diff] [blame]

301

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

302

"files": [ # The list of script project files.

303

# One of the files is a script manifest; it must be named "appsscript",

Bu Sun Kim

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

[diff] [blame]

304

# must have type of JSON, and include the manifest configurations for the

305

# project.

306

{ # An individual file within a script project.

307

# A file is a third-party source code created by one or more

308

# developers. It can be a server-side JS code, HTML, or a

309

# configuration file. Each script project can contain multiple files.

Bu Sun Kim

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

[diff] [blame]

310

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

311

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

Bu Sun Kim

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

[diff] [blame]

312

{ # Represents a function in a script project.

Bu Sun Kim

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

[diff] [blame]

313

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

Bu Sun Kim

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

[diff] [blame]

314

},

315

],

316

},

Bu Sun Kim

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

[diff] [blame]

317

"lastModifyUser": { # A simple user profile resource. # The user who modified the file most recently.

Bu Sun Kim

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

[diff] [blame]

318

# This read-only field is only visible to users who have WRITER

319

# permission for the script project.

Bu Sun Kim

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

[diff] [blame]

320

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

321

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

322

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

323

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

Bu Sun Kim

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

[diff] [blame]

324

},

325

"createTime": "A String", # Creation date timestamp.

326

# This read-only field is only visible to users who have WRITER

327

# permission for the script project.

328

"updateTime": "A String", # Last modified date timestamp.

329

# This read-only field is only visible to users who have WRITER

330

# permission for the script project.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

331

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

332

"name": "A String", # The name of the file. The file extension is not part of the file

333

# name, which can be identified from the type field.

334

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

Bu Sun Kim

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

[diff] [blame]

335

},

336

],

Bu Sun Kim

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

[diff] [blame]

337

}

338

339

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

346

347

{ # The Content resource.

Bu Sun Kim

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

[diff] [blame]

348

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

349

"files": [ # The list of script project files.

350

# One of the files is a script manifest; it must be named "appsscript",

Bu Sun Kim

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

[diff] [blame]

351

# must have type of JSON, and include the manifest configurations for the

352

# project.

353

{ # An individual file within a script project.

354

# A file is a third-party source code created by one or more

355

# developers. It can be a server-side JS code, HTML, or a

356

# configuration file. Each script project can contain multiple files.

Bu Sun Kim

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

[diff] [blame]

357

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

358

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

Bu Sun Kim

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

[diff] [blame]

359

{ # Represents a function in a script project.

Bu Sun Kim

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

[diff] [blame]

360

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

Bu Sun Kim

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

[diff] [blame]

361

},

362

],

363

},

Bu Sun Kim

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

[diff] [blame]

364

"lastModifyUser": { # A simple user profile resource. # The user who modified the file most recently.

Bu Sun Kim

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

[diff] [blame]

365

# This read-only field is only visible to users who have WRITER

366

# permission for the script project.

Bu Sun Kim

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

[diff] [blame]

367

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

368

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

369

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

370

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

Bu Sun Kim

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

[diff] [blame]

371

},

372

"createTime": "A String", # Creation date timestamp.

373

# This read-only field is only visible to users who have WRITER

374

# permission for the script project.

375

"updateTime": "A String", # Last modified date timestamp.

376

# This read-only field is only visible to users who have WRITER

377

# permission for the script project.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

378

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

379

"name": "A String", # The name of the file. The file extension is not part of the file

380

# name, which can be identified from the type field.

381

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

Bu Sun Kim

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

[diff] [blame]

382

},

383

],

Bu Sun Kim