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

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

[diff] [blame]

78

<code><a href="#close">close()</a></code></p>

79

<p class="firstline">Close httplib2 connections.</p>

80

Dan O'Meara

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

[diff] [blame]

81

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

Bu Sun Kim

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

[diff] [blame]

82

<p class="firstline">Creates a deployment of an Apps Script project.</p>

83

84

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

85

<p class="firstline">Deletes a deployment of an Apps Script project.</p>

86

87

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

88

<p class="firstline">Gets a deployment of an Apps Script project.</p>

89

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

90

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

Bu Sun Kim

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

[diff] [blame]

91

<p class="firstline">Lists the deployments of an Apps Script project.</p>

92

93

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

94

<p class="firstline">Retrieves the next page of results.</p>

95

Dan O'Meara

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

[diff] [blame]

96

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

Bu Sun Kim

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

[diff] [blame]

97

<p class="firstline">Updates a deployment of an Apps Script project.</p>

98

<h3>Method Details</h3>

99

Dmitry Frenkel

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

[diff] [blame]

100

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

101

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

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

[diff] [blame]

105

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

Bu Sun Kim

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

[diff] [blame]

106

<pre>Creates a deployment of an Apps Script project.

107

108

Args:

Bu Sun Kim

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

[diff] [blame]

109

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

Dan O'Meara

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

[diff] [blame]

110

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

111

The object takes the form of:

112

113

{ # Metadata the defines how a deployment is configured.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

114

"versionNumber": 42, # The version number on which this deployment is based.

Dmitry Frenkel

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

[diff] [blame]

115

"manifestFileName": "A String", # The manifest file name for this deployment.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

116

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

Dmitry Frenkel

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

[diff] [blame]

117

"description": "A String", # The description for this deployment.

118

}

Bu Sun Kim

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

[diff] [blame]

119

120

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

127

128

{ # Representation of a single script deployment.

Bu Sun Kim

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

[diff] [blame]

129

"entryPoints": [ # The deployment's entry points.

Bu Sun Kim

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

[diff] [blame]

130

{ # A configuration that defines how a deployment is accessed externally.

Bu Sun Kim

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

[diff] [blame]

131

"executionApi": { # An API executable entry point. # An entry point specification for Apps Script API execution calls.

132

"entryPointConfig": { # API executable entry point configuration. # The entry point's configuration.

133

"access": "A String", # Who has permission to run the API executable.

Bu Sun Kim

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

[diff] [blame]

134

},

135

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

136

"entryPointType": "A String", # The type of the entry point.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

137

"addOn": { # An add-on entry point. # Add-on properties.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

138

"description": "A String", # The add-on's optional description.

139

"title": "A String", # The add-on's required title.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

140

"helpUrl": "A String", # The add-on's optional help URL.

141

"postInstallTipUrl": "A String", # The add-on's required post install tip URL.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

142

"reportIssueUrl": "A String", # The add-on's optional report issue URL.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

143

"addOnType": "A String", # The add-on's required list of supported container types.

144

},

145

"webApp": { # A web application entry point. # An entry point specification for web apps.

146

"entryPointConfig": { # Web app entry point configuration. # The entry point's configuration.

147

"executeAs": "A String", # Who to execute the web app as.

148

"access": "A String", # Who has permission to run the web app.

149

},

150

"url": "A String", # The URL for the web application.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

151

},

Bu Sun Kim

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

[diff] [blame]

152

},

153

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

154

"deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

155

"versionNumber": 42, # The version number on which this deployment is based.

156

"manifestFileName": "A String", # The manifest file name for this deployment.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

157

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

158

"description": "A String", # The description for this deployment.

159

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

160

"deploymentId": "A String", # The deployment ID for this deployment.

161

"updateTime": "A String", # Last modified date time stamp.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

167

<pre>Deletes a deployment of an Apps Script project.

168

169

Args:

Bu Sun Kim

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

[diff] [blame]

170

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

Bu Sun Kim

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

[diff] [blame]

171

deploymentId: string, The deployment ID to be undeployed. (required)

172

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

179

Dmitry Frenkel

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

[diff] [blame]

180

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

186

<pre>Gets a deployment of an Apps Script project.

187

188

Args:

Bu Sun Kim

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

[diff] [blame]

189

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

Bu Sun Kim

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

[diff] [blame]

190

deploymentId: string, The deployment ID. (required)

191

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

198

199

{ # Representation of a single script deployment.

Bu Sun Kim

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

[diff] [blame]

200

"entryPoints": [ # The deployment's entry points.

Bu Sun Kim

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

[diff] [blame]

201

{ # A configuration that defines how a deployment is accessed externally.

Bu Sun Kim

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

[diff] [blame]

202

"executionApi": { # An API executable entry point. # An entry point specification for Apps Script API execution calls.

203

"entryPointConfig": { # API executable entry point configuration. # The entry point's configuration.

204

"access": "A String", # Who has permission to run the API executable.

Bu Sun Kim

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

[diff] [blame]

205

},

206

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

207

"entryPointType": "A String", # The type of the entry point.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

208

"addOn": { # An add-on entry point. # Add-on properties.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

209

"description": "A String", # The add-on's optional description.

210

"title": "A String", # The add-on's required title.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

211

"helpUrl": "A String", # The add-on's optional help URL.

212

"postInstallTipUrl": "A String", # The add-on's required post install tip URL.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

213

"reportIssueUrl": "A String", # The add-on's optional report issue URL.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

214

"addOnType": "A String", # The add-on's required list of supported container types.

215

},

216

"webApp": { # A web application entry point. # An entry point specification for web apps.

217

"entryPointConfig": { # Web app entry point configuration. # The entry point's configuration.

218

"executeAs": "A String", # Who to execute the web app as.

219

"access": "A String", # Who has permission to run the web app.

220

},

221

"url": "A String", # The URL for the web application.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

222

},

Bu Sun Kim

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

[diff] [blame]

223

},

224

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

225

"deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

226

"versionNumber": 42, # The version number on which this deployment is based.

227

"manifestFileName": "A String", # The manifest file name for this deployment.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

228

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

229

"description": "A String", # The description for this deployment.

230

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

231

"deploymentId": "A String", # The deployment ID for this deployment.

232

"updateTime": "A String", # Last modified date time stamp.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

237

<code class="details" id="list">list(scriptId, pageToken=None, pageSize=None, x__xgafv=None)</code>

Bu Sun Kim

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

[diff] [blame]

238

<pre>Lists the deployments of an Apps Script project.

239

240

Args:

Bu Sun Kim

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

[diff] [blame]

241

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

242

pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

243

pageSize: integer, The maximum number of deployments on each returned page. Defaults to 50.

Bu Sun Kim

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

[diff] [blame]

244

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

251

252

{ # Response with the list of deployments for the specified Apps Script project.

Bu Sun Kim

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

[diff] [blame]

253

"deployments": [ # The list of deployments.

Bu Sun Kim

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

[diff] [blame]

254

{ # Representation of a single script deployment.

Bu Sun Kim

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

[diff] [blame]

255

"entryPoints": [ # The deployment's entry points.

Bu Sun Kim

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

[diff] [blame]

256

{ # A configuration that defines how a deployment is accessed externally.

Bu Sun Kim

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

[diff] [blame]

257

"executionApi": { # An API executable entry point. # An entry point specification for Apps Script API execution calls.

258

"entryPointConfig": { # API executable entry point configuration. # The entry point's configuration.

259

"access": "A String", # Who has permission to run the API executable.

Bu Sun Kim

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

[diff] [blame]

260

},

261

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

262

"entryPointType": "A String", # The type of the entry point.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

263

"addOn": { # An add-on entry point. # Add-on properties.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

264

"description": "A String", # The add-on's optional description.

265

"title": "A String", # The add-on's required title.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

266

"helpUrl": "A String", # The add-on's optional help URL.

267

"postInstallTipUrl": "A String", # The add-on's required post install tip URL.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

268

"reportIssueUrl": "A String", # The add-on's optional report issue URL.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

269

"addOnType": "A String", # The add-on's required list of supported container types.

270

},

271

"webApp": { # A web application entry point. # An entry point specification for web apps.

272

"entryPointConfig": { # Web app entry point configuration. # The entry point's configuration.

273

"executeAs": "A String", # Who to execute the web app as.

274

"access": "A String", # Who has permission to run the web app.

275

},

276

"url": "A String", # The URL for the web application.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

277

},

Bu Sun Kim

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

[diff] [blame]

278

},

279

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

280

"deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

281

"versionNumber": 42, # The version number on which this deployment is based.

282

"manifestFileName": "A String", # The manifest file name for this deployment.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

283

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

284

"description": "A String", # The description for this deployment.

285

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

286

"deploymentId": "A String", # The deployment ID for this deployment.

287

"updateTime": "A String", # Last modified date time stamp.

Bu Sun Kim

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

[diff] [blame]

288

},

289

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

290

"nextPageToken": "A String", # The token that can be used in the next call to get the next page of results.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

296

<pre>Retrieves the next page of results.

297

298

Args:

299

previous_request: The request for the previous page. (required)

300

previous_response: The response from the request for the previous page. (required)

301

302

Returns:

Bu Sun Kim

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

[diff] [blame]

303

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

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

[diff] [blame]

304

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

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

[diff] [blame]

309

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

Bu Sun Kim

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

[diff] [blame]

310

<pre>Updates a deployment of an Apps Script project.

311

312

Args:

Bu Sun Kim

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

[diff] [blame]

313

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

Bu Sun Kim

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

[diff] [blame]

314

deploymentId: string, The deployment ID for this deployment. (required)

Dan O'Meara

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

[diff] [blame]

315

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

316

The object takes the form of:

317

318

{ # Request with deployment information to update an existing deployment.

Bu Sun Kim

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

[diff] [blame]

319

"deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

320

"versionNumber": 42, # The version number on which this deployment is based.

Dmitry Frenkel

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

[diff] [blame]

321

"manifestFileName": "A String", # The manifest file name for this deployment.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

322

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

Dmitry Frenkel

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

[diff] [blame]

323

"description": "A String", # The description for this deployment.

324

},

Bu Sun Kim

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

[diff] [blame]

325

}

326

327

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

334

335

{ # Representation of a single script deployment.

Bu Sun Kim

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

[diff] [blame]

336

"entryPoints": [ # The deployment's entry points.

Bu Sun Kim

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

[diff] [blame]

337

{ # A configuration that defines how a deployment is accessed externally.

Bu Sun Kim

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

[diff] [blame]

338

"executionApi": { # An API executable entry point. # An entry point specification for Apps Script API execution calls.

339

"entryPointConfig": { # API executable entry point configuration. # The entry point's configuration.

340

"access": "A String", # Who has permission to run the API executable.

Bu Sun Kim

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

[diff] [blame]

341

},

342

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

343

"entryPointType": "A String", # The type of the entry point.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

344

"addOn": { # An add-on entry point. # Add-on properties.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

345

"description": "A String", # The add-on's optional description.

346

"title": "A String", # The add-on's required title.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

347

"helpUrl": "A String", # The add-on's optional help URL.

348

"postInstallTipUrl": "A String", # The add-on's required post install tip URL.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

349

"reportIssueUrl": "A String", # The add-on's optional report issue URL.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

350

"addOnType": "A String", # The add-on's required list of supported container types.

351

},

352

"webApp": { # A web application entry point. # An entry point specification for web apps.

353

"entryPointConfig": { # Web app entry point configuration. # The entry point's configuration.

354

"executeAs": "A String", # Who to execute the web app as.

355

"access": "A String", # Who has permission to run the web app.

356

},

357

"url": "A String", # The URL for the web application.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

358

},

Bu Sun Kim

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

[diff] [blame]

359

},

360

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

361

"deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

362

"versionNumber": 42, # The version number on which this deployment is based.

363

"manifestFileName": "A String", # The manifest file name for this deployment.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

364

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

365

"description": "A String", # The description for this deployment.

366

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

367

"deploymentId": "A String", # The deployment ID for this deployment.

368

"updateTime": "A String", # Last modified date time stamp.

Bu Sun Kim