Blame - docs/dyn/calendar_v3.acl.html - platform/external/python/google-api-python-client

2014-04-24 15:46:26 -0400

[diff] [blame]

116

ruleId: string, ACL rule identifier. (required)

</pre>

</div>

<code class="details" id="get">get(calendarId, ruleId)</code>

122

<pre>Returns an access control rule.

123

124

Args:

Bu Sun Kim

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

[diff] [blame]

125

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

126

ruleId: string, ACL rule identifier. (required)

127

128

Returns:

129

An object of the form:

130

131

{

Yoshi Automation Bot

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

[diff] [blame^]

132

"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").

133

"scope": { # The scope of the rule.

134

"type": "A String", # The type of the scope. Possible values are:

135

# - "default" - The public scope. This is the default value.

136

# - "user" - Limits the scope to a single user.

137

# - "group" - Limits the scope to a group.

138

# - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.

139

"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".

140

},

141

"role": "A String", # The role assigned to the scope. Possible values are:

142

# - "none" - Provides no access.

143

# - "freeBusyReader" - Provides read access to free/busy information.

144

# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

145

# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.

146

# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

147

"id": "A String", # Identifier of the ACL rule.

148

"etag": "A String", # ETag of the resource.

149

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

153

<code class="details" id="insert">insert(calendarId, body=None, sendNotifications=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

154

<pre>Creates an access control rule.

155

156

Args:

Bu Sun Kim

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

[diff] [blame]

157

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

Dan O'Meara

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

[diff] [blame]

158

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

159

The object takes the form of:

160

161

{

Yoshi Automation Bot

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

[diff] [blame^]

162

"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").

163

"scope": { # The scope of the rule.

164

"type": "A String", # The type of the scope. Possible values are:

165

# - "default" - The public scope. This is the default value.

166

# - "user" - Limits the scope to a single user.

167

# - "group" - Limits the scope to a group.

168

# - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.

169

"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".

170

},

171

"role": "A String", # The role assigned to the scope. Possible values are:

172

# - "none" - Provides no access.

173

# - "freeBusyReader" - Provides read access to free/busy information.

174

# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

175

# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.

176

# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

177

"id": "A String", # Identifier of the ACL rule.

178

"etag": "A String", # ETag of the resource.

179

}

180

181

sendNotifications: boolean, Whether to send notifications about the calendar sharing change. Optional. The default is True.

182

183

Returns:

184

An object of the form:

185

186

{

187

"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").

Bu Sun Kim

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

[diff] [blame]

188

"scope": { # The scope of the rule.

189

"type": "A String", # The type of the scope. Possible values are:

190

# - "default" - The public scope. This is the default value.

191

# - "user" - Limits the scope to a single user.

192

# - "group" - Limits the scope to a group.

193

# - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.

194

"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".

195

},

Yoshi Automation Bot

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

[diff] [blame^]

196

"role": "A String", # The role assigned to the scope. Possible values are:

197

# - "none" - Provides no access.

198

# - "freeBusyReader" - Provides read access to free/busy information.

199

# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

200

# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.

201

# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

202

"id": "A String", # Identifier of the ACL rule.

Bu Sun Kim

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

[diff] [blame]

203

"etag": "A String", # ETag of the resource.

Yoshi Automation Bot

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

[diff] [blame^]

204

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Yoshi Automation Bot

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

[diff] [blame^]

208

<code class="details" id="list">list(calendarId, pageToken=None, maxResults=None, syncToken=None, showDeleted=None)</code>

Bu Sun Kim

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

[diff] [blame]

209

<pre>Returns the rules in the access control list for the calendar.

210

211

Args:

212

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

Bu Sun Kim

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

[diff] [blame]

213

pageToken: string, Token specifying which result page to return. Optional.

Yoshi Automation Bot

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

[diff] [blame^]

214

maxResults: integer, Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.

Bu Sun Kim

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

[diff] [blame]

215

syncToken: string, Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.

216

If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.

217

Learn more about incremental synchronization.

218

Optional. The default is to return all entries.

Bu Sun Kim

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

[diff] [blame]

219

showDeleted: boolean, Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.

Bu Sun Kim

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

[diff] [blame]

220

221

Returns:

222

An object of the form:

223

224

{

Yoshi Automation Bot

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

[diff] [blame^]

225

"kind": "calendar#acl", # Type of the collection ("calendar#acl").

Bu Sun Kim

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

[diff] [blame]

226

"items": [ # List of rules on the access control list.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

227

{

Yoshi Automation Bot

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

[diff] [blame^]

228

"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").

229

"scope": { # The scope of the rule.

230

"type": "A String", # The type of the scope. Possible values are:

231

# - "default" - The public scope. This is the default value.

232

# - "user" - Limits the scope to a single user.

233

# - "group" - Limits the scope to a group.

234

# - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.

235

"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

236

},

Yoshi Automation Bot

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

[diff] [blame^]

237

"role": "A String", # The role assigned to the scope. Possible values are:

238

# - "none" - Provides no access.

239

# - "freeBusyReader" - Provides read access to free/busy information.

240

# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

241

# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.

242

# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

243

"id": "A String", # Identifier of the ACL rule.

244

"etag": "A String", # ETag of the resource.

245

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

246

],

Bu Sun Kim

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

[diff] [blame]

247

"nextSyncToken": "A String", # Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.

Dmitry Frenkel

3e17f89

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

[diff] [blame]

248

"nextPageToken": "A String", # Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.

Yoshi Automation Bot

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

[diff] [blame^]

249

"etag": "A String", # ETag of the collection.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

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

255

<pre>Retrieves the next page of results.

256

257

Args:

258

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

259

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

260

261

Returns:

Bu Sun Kim

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

[diff] [blame]

262

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

263

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]

268

<code class="details" id="patch">patch(calendarId, ruleId, body=None, sendNotifications=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

269

<pre>Updates an access control rule. This method supports patch semantics.

270

271

Args:

Bu Sun Kim

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

[diff] [blame]

272

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

273

ruleId: string, ACL rule identifier. (required)

Dan O'Meara

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

[diff] [blame]

274

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

275

The object takes the form of:

276

277

{

Yoshi Automation Bot

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

[diff] [blame^]

278

"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").

279

"scope": { # The scope of the rule.

280

"type": "A String", # The type of the scope. Possible values are:

281

# - "default" - The public scope. This is the default value.

282

# - "user" - Limits the scope to a single user.

283

# - "group" - Limits the scope to a group.

284

# - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.

285

"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".

286

},

287

"role": "A String", # The role assigned to the scope. Possible values are:

288

# - "none" - Provides no access.

289

# - "freeBusyReader" - Provides read access to free/busy information.

290

# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

291

# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.

292

# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

293

"id": "A String", # Identifier of the ACL rule.

294

"etag": "A String", # ETag of the resource.

295

}

296

297

sendNotifications: boolean, Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.

298

299

Returns:

300

An object of the form:

301

302

{

303

"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").

Bu Sun Kim

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

[diff] [blame]

304

"scope": { # The scope of the rule.

305

"type": "A String", # The type of the scope. Possible values are:

306

# - "default" - The public scope. This is the default value.

307

# - "user" - Limits the scope to a single user.

308

# - "group" - Limits the scope to a group.

309

# - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.

310

"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".

311

},

Yoshi Automation Bot

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

[diff] [blame^]

312

"role": "A String", # The role assigned to the scope. Possible values are:

313

# - "none" - Provides no access.

314

# - "freeBusyReader" - Provides read access to free/busy information.

315

# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

316

# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.

317

# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

318

"id": "A String", # Identifier of the ACL rule.

Bu Sun Kim

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

[diff] [blame]

319

"etag": "A String", # ETag of the resource.

Yoshi Automation Bot

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

[diff] [blame^]

320

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

324

<code class="details" id="update">update(calendarId, ruleId, body=None, sendNotifications=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

325

<pre>Updates an access control rule.

326

327

Args:

Bu Sun Kim

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

[diff] [blame]

328

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

329

ruleId: string, ACL rule identifier. (required)

Dan O'Meara

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

[diff] [blame]

330

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

331

The object takes the form of:

332

333

{

Yoshi Automation Bot

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

[diff] [blame^]

334

"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").

335

"scope": { # The scope of the rule.

336

"type": "A String", # The type of the scope. Possible values are:

337

# - "default" - The public scope. This is the default value.

338

# - "user" - Limits the scope to a single user.

339

# - "group" - Limits the scope to a group.

340

# - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.

341

"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".

342

},

343

"role": "A String", # The role assigned to the scope. Possible values are:

344

# - "none" - Provides no access.

345

# - "freeBusyReader" - Provides read access to free/busy information.

346

# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

347

# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.

348

# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

349

"id": "A String", # Identifier of the ACL rule.

350

"etag": "A String", # ETag of the resource.

351

}

352

353

sendNotifications: boolean, Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.

354

355

Returns:

356

An object of the form:

357

358

{

359

"kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").

Bu Sun Kim

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

[diff] [blame]

360

"scope": { # The scope of the rule.

361

"type": "A String", # The type of the scope. Possible values are:

362

# - "default" - The public scope. This is the default value.

363

# - "user" - Limits the scope to a single user.

364

# - "group" - Limits the scope to a group.

365

# - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.

366

"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".

367

},

Yoshi Automation Bot

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

[diff] [blame^]

368

"role": "A String", # The role assigned to the scope. Possible values are:

369

# - "none" - Provides no access.

370

# - "freeBusyReader" - Provides read access to free/busy information.

371

# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.

372

# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.

373

# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

374

"id": "A String", # Identifier of the ACL rule.

Bu Sun Kim

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

[diff] [blame]

375

"etag": "A String", # ETag of the resource.

Yoshi Automation Bot

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

[diff] [blame^]

376

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Yoshi Automation Bot

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

[diff] [blame^]

380

<code class="details" id="watch">watch(calendarId, body=None, pageToken=None, syncToken=None, maxResults=None, showDeleted=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

381

<pre>Watch for changes to ACL resources.

382

383

Args:

Bu Sun Kim

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

[diff] [blame]

384

calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required)

Dan O'Meara

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

[diff] [blame]

385

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

386

The object takes the form of:

387

388

{

Yoshi Automation Bot

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

[diff] [blame^]

389

"resourceUri": "A String", # A version-specific identifier for the watched resource.

Bu Sun Kim

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

[diff] [blame]

390

"address": "A String", # The address where notifications are delivered for this channel.

391

"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.

Dmitry Frenkel

3e17f89

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

[diff] [blame]

392

"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

Bu Sun Kim

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

[diff] [blame]

393

"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

Yoshi Automation Bot

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

[diff] [blame^]

394

"id": "A String", # A UUID or similar unique string that identifies this channel.

395

"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

Bu Sun Kim

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

[diff] [blame]

396

"params": { # Additional parameters controlling delivery channel behavior. Optional.

397

"a_key": "A String", # Declares a new parameter by name.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

398

},

Yoshi Automation Bot

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

[diff] [blame^]

399

"type": "A String", # The type of delivery mechanism used for this channel.

400

"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

401

}

402

Bu Sun Kim

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

[diff] [blame]

403

pageToken: string, Token specifying which result page to return. Optional.

Craig Citro

065b530

2014-08-14 00:47:23 -0700

[diff] [blame]

404

syncToken: string, Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.

405

If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.

406

Learn more about incremental synchronization.

407

Optional. The default is to return all entries.

Yoshi Automation Bot

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

[diff] [blame^]

408

maxResults: integer, Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.

Dmitry Frenkel

3e17f89

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

[diff] [blame]

409

showDeleted: boolean, Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.

John Asmuth