Blame - docs/dyn/classroom_v1.courses.html - platform/external/python/google-api-python-client

2015-09-11 13:55:40 -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="classroom_v1.html">Google Classroom API</a> . <a href="classroom_v1.courses.html">courses</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="classroom_v1.courses.aliases.html">aliases()</a></code>

79

</p>

80

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

81

82

Bu Sun Kim

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

[diff] [blame]

83

<code><a href="classroom_v1.courses.announcements.html">announcements()</a></code>

84

</p>

85

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

86

87

Jon Wayne Parrott

0a471d3

2016-05-19 10:54:38 -0700

[diff] [blame]

88

<code><a href="classroom_v1.courses.courseWork.html">courseWork()</a></code>

89

</p>

90

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

91

92

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

93

<code><a href="classroom_v1.courses.students.html">students()</a></code>

94

</p>

95

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

96

97

98

<code><a href="classroom_v1.courses.teachers.html">teachers()</a></code>

99

</p>

100

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

101

102

Bu Sun Kim

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

[diff] [blame]

103

<code><a href="classroom_v1.courses.topics.html">topics()</a></code>

104

</p>

105

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

106

107

Dan O'Meara

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

[diff] [blame]

108

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

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

109

<p class="firstline">Creates a course.</p>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

110

Thomas Coffee

2f24537

2017-03-27 10:39:26 -0700

[diff] [blame]

111

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

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

112

<p class="firstline">Deletes a course.</p>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

113

Thomas Coffee

2f24537

2017-03-27 10:39:26 -0700

[diff] [blame]

114

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

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

115

<p class="firstline">Returns a course.</p>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

116

Bu Sun Kim

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

[diff] [blame]

117

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

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

118

<p class="firstline">Returns a list of courses that the requesting user is permitted to view,</p>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

119

120

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

121

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

122

Dan O'Meara

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

[diff] [blame]

123

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

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

124

<p class="firstline">Updates one or more fields in a course.</p>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

125

Dan O'Meara

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

[diff] [blame]

126

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

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

127

<p class="firstline">Updates a course.</p>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

128

<h3>Method Details</h3>

129

Dan O'Meara

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

[diff] [blame]

130

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

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

131

<pre>Creates a course.

132

133

The user specified in `ownerId` is the owner of the created course

134

and added as a teacher.

135

136

This method returns the following error codes:

137

138

* `PERMISSION_DENIED` if the requesting user is not permitted to create

139

courses or for access errors.

140

* `NOT_FOUND` if the primary teacher is not a valid user.

Bu Sun Kim

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

[diff] [blame]

141

* `FAILED_PRECONDITION` if the course owner's account is disabled or for

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

142

the following request errors:

143

* UserGroupsMembershipLimitReached

144

* `ALREADY_EXISTS` if an alias was specified in the `id` and

145

already exists.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

146

147

Args:

Dan O'Meara

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

[diff] [blame]

148

body: object, The request body.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

149

The object takes the form of:

150

151

{ # A Course in Classroom.

Bu Sun Kim

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

[diff] [blame^]

152

"name": "A String", # Name of the course.

153

# For example, "10th Grade Biology".

154

# The name is required. It must be between 1 and 750 characters and a valid

155

# UTF-8 string.

156

"teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the

157

# course.

158

#

159

# This field will only be set for teachers of the course and domain

# administrators.

#

# Read-only.

"id": "A String", # Drive API resource ID.

164

"title": "A String", # Title of the Drive folder.

165

#

166

# Read-only.

167

"alternateLink": "A String", # URL that can be used to access the Drive folder.

168

#

169

# Read-only.

170

},

Bu Sun Kim

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

[diff] [blame]

171

"section": "A String", # Section of the course.

172

# For example, "Period 2".

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

173

# If set, this field must be a valid UTF-8 string and no longer than 2800

174

# characters.

Bu Sun Kim

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

[diff] [blame]

175

"id": "A String", # Identifier for this course assigned by Classroom.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

#

# When

# creating a course,

# you may optionally set this identifier to an

180

# alias string in the

181

# request to create a corresponding alias. The `id` is still assigned by

182

# Classroom and cannot be updated after the course is created.

183

#

184

# Specifying this field in a course update mask results in an error.

Bu Sun Kim

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

[diff] [blame]

185

"room": "A String", # Optional room location.

186

# For example, "301".

Bu Sun Kim

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

[diff] [blame]

187

# If set, this field must be a valid UTF-8 string and no longer than 650

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

188

# characters.

Bu Sun Kim

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

[diff] [blame]

189

"courseGroupEmail": "A String", # The email address of a Google group containing all members of the course.

190

# This group does not accept email and can only be used for permissions.

191

#

192

# Read-only.

193

"courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course.

194

#

195

# Read-only.

196

{ # A set of materials that appears on the "About" page of the course.

197

# These materials might include a syllabus, schedule, or other background

198

# information relating to the course as a whole.

199

"title": "A String", # Title for this set.

200

"materials": [ # Materials attached to this set.

201

{ # A material attached to a course as part of a material set.

202

"driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.

Bu Sun Kim

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

[diff] [blame]

203

"alternateLink": "A String", # URL that can be used to access the Drive item.

204

#

205

# Read-only.

206

"thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.

207

#

208

# Read-only.

209

"id": "A String", # Drive API resource ID.

Bu Sun Kim

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

[diff] [blame^]

210

"title": "A String", # Title of the Drive item.

211

#

212

# Read-only.

Bu Sun Kim

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

[diff] [blame]

213

},

214

"youTubeVideo": { # YouTube video item. # Youtube video attachment.

Bu Sun Kim

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

[diff] [blame^]

215

"title": "A String", # Title of the YouTube video.

216

#

217

# Read-only.

Bu Sun Kim

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

[diff] [blame]

218

"alternateLink": "A String", # URL that can be used to view the YouTube video.

219

#

220

# Read-only.

221

"thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.

222

#

223

# Read-only.

224

"id": "A String", # YouTube API resource ID.

Bu Sun Kim

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

[diff] [blame]

225

},

226

"form": { # Google Forms item. # Google Forms attachment.

Bu Sun Kim

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

[diff] [blame^]

227

"formUrl": "A String", # URL of the form.

Bu Sun Kim

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

[diff] [blame]

228

"title": "A String", # Title of the Form.

229

#

230

# Read-only.

231

"thumbnailUrl": "A String", # URL of a thumbnail image of the Form.

232

#

233

# Read-only.

234

"responseUrl": "A String", # URL of the form responses document.

235

# Only set if respsonses have been recorded and only when the

236

# requesting user is an editor of the form.

237

#

238

# Read-only.

Bu Sun Kim

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

[diff] [blame]

239

},

240

"link": { # URL item. # Link atatchment.

Bu Sun Kim

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

[diff] [blame]

241

"title": "A String", # Title of the target of the URL.

242

#

243

# Read-only.

244

"thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.

245

#

246

# Read-only.

Bu Sun Kim

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

[diff] [blame^]

247

"url": "A String", # URL to link to.

248

# This must be a valid UTF-8 string containing between 1 and 2024 characters.

Bu Sun Kim

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

[diff] [blame]

},

},

],

},

],

"enrollmentCode": "A String", # Enrollment code to use when joining this course.

255

# Specifying this field in a course update mask results in an error.

256

#

257

# Read-only.

258

"descriptionHeading": "A String", # Optional heading for the description.

259

# For example, "Welcome to 10th Grade Biology."

260

# If set, this field must be a valid UTF-8 string and no longer than 3600

261

# characters.

Bu Sun Kim

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

[diff] [blame]

262

"updateTime": "A String", # Time of the most recent update to this course.

263

# Specifying this field in a course update mask results in an error.

264

#

265

# Read-only.

Bu Sun Kim

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

[diff] [blame^]

266

"calendarId": "A String", # The Calendar ID for a calendar that all course members can see, to which

267

# Classroom adds events for course work and announcements in the course.

268

#

269

# Read-only.

Bu Sun Kim

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

[diff] [blame]

270

"alternateLink": "A String", # Absolute link to this course in the Classroom web UI.

271

#

272

# Read-only.

273

"guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.

274

#

275

# Read-only.

276

"courseState": "A String", # State of the course.

277

# If unspecified, the default state is `PROVISIONED`.

278

"ownerId": "A String", # The identifier of the owner of a course.

279

#

280

# When specified as a parameter of a

281

# create course request, this

282

# field is required.

283

# The identifier can be one of the following:

284

#

285

# * the numeric identifier for the user

286

# * the email address of the user

287

# * the string literal `"me"`, indicating the requesting user

288

#

289

# This must be set in a create request. Admins can also specify this field

290

# in a patch course request to

291

# transfer ownership. In other contexts, it is read-only.

292

"description": "A String", # Optional description.

293

# For example, "We'll be learning about the structure of living

294

# creatures from a combination of textbooks, guest lectures, and lab work.

295

# Expect to be excited!"

296

# If set, this field must be a valid UTF-8 string and no longer than 30,000

297

# characters.

298

"teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course.

299

# This group does not accept email and can only be used for permissions.

300

#

301

# Read-only.

302

"creationTime": "A String", # Creation time of the course.

303

# Specifying this field in a course update mask results in an error.

304

#

305

# Read-only.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

306

}

307

308

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

309

Allowed values

310

1 - v1 error format

311

2 - v2 error format

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

312

313

Returns:

314

An object of the form:

315

316

{ # A Course in Classroom.

Bu Sun Kim

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

[diff] [blame^]

317

"name": "A String", # Name of the course.

318

# For example, "10th Grade Biology".

319

# The name is required. It must be between 1 and 750 characters and a valid

320

# UTF-8 string.

321

"teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the

322

# course.

323

#

324

# This field will only be set for teachers of the course and domain

# administrators.

#

# Read-only.

"id": "A String", # Drive API resource ID.

329

"title": "A String", # Title of the Drive folder.

330

#

331

# Read-only.

332

"alternateLink": "A String", # URL that can be used to access the Drive folder.

333

#

334

# Read-only.

335

},

Bu Sun Kim

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

[diff] [blame]

336

"section": "A String", # Section of the course.

337

# For example, "Period 2".

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

338

# If set, this field must be a valid UTF-8 string and no longer than 2800

339

# characters.

Bu Sun Kim

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

[diff] [blame]

340

"id": "A String", # Identifier for this course assigned by Classroom.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

#

# When

# creating a course,

# you may optionally set this identifier to an

345

# alias string in the

346

# request to create a corresponding alias. The `id` is still assigned by

347

# Classroom and cannot be updated after the course is created.

348

#

349

# Specifying this field in a course update mask results in an error.

Bu Sun Kim

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

[diff] [blame]

350

"room": "A String", # Optional room location.

351

# For example, "301".

Bu Sun Kim

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

[diff] [blame]

352

# If set, this field must be a valid UTF-8 string and no longer than 650

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

353

# characters.

Bu Sun Kim

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

[diff] [blame]

354

"courseGroupEmail": "A String", # The email address of a Google group containing all members of the course.

355

# This group does not accept email and can only be used for permissions.

356

#

357

# Read-only.

358

"courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course.

359

#

360

# Read-only.

361

{ # A set of materials that appears on the "About" page of the course.

362

# These materials might include a syllabus, schedule, or other background

363

# information relating to the course as a whole.

364

"title": "A String", # Title for this set.

365

"materials": [ # Materials attached to this set.

366

{ # A material attached to a course as part of a material set.

367

"driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.

Bu Sun Kim

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

[diff] [blame]

368

"alternateLink": "A String", # URL that can be used to access the Drive item.

369

#

370

# Read-only.

371

"thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.

372

#

373

# Read-only.

374

"id": "A String", # Drive API resource ID.

Bu Sun Kim

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

[diff] [blame^]

375

"title": "A String", # Title of the Drive item.

376

#

377

# Read-only.

Bu Sun Kim

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

[diff] [blame]

378

},

379

"youTubeVideo": { # YouTube video item. # Youtube video attachment.

Bu Sun Kim

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

[diff] [blame^]

380

"title": "A String", # Title of the YouTube video.

381

#

382

# Read-only.

Bu Sun Kim

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

[diff] [blame]

383

"alternateLink": "A String", # URL that can be used to view the YouTube video.

384

#

385

# Read-only.

386

"thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.

387

#

388

# Read-only.

389

"id": "A String", # YouTube API resource ID.

Bu Sun Kim

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

[diff] [blame]

390

},

391

"form": { # Google Forms item. # Google Forms attachment.

Bu Sun Kim

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

[diff] [blame^]

392

"formUrl": "A String", # URL of the form.

Bu Sun Kim

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

[diff] [blame]

393

"title": "A String", # Title of the Form.

394

#

395

# Read-only.

396

"thumbnailUrl": "A String", # URL of a thumbnail image of the Form.

397

#

398

# Read-only.

399

"responseUrl": "A String", # URL of the form responses document.

400

# Only set if respsonses have been recorded and only when the

401

# requesting user is an editor of the form.

402

#

403

# Read-only.

Bu Sun Kim

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

[diff] [blame]

404

},

405

"link": { # URL item. # Link atatchment.

Bu Sun Kim

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

[diff] [blame]

406

"title": "A String", # Title of the target of the URL.

407

#

408

# Read-only.

409

"thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.

410

#

411

# Read-only.

Bu Sun Kim

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

[diff] [blame^]

412

"url": "A String", # URL to link to.

413

# This must be a valid UTF-8 string containing between 1 and 2024 characters.

Bu Sun Kim

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

[diff] [blame]

},

},

],

},

],

"enrollmentCode": "A String", # Enrollment code to use when joining this course.

420

# Specifying this field in a course update mask results in an error.

421

#

422

# Read-only.

423

"descriptionHeading": "A String", # Optional heading for the description.

424

# For example, "Welcome to 10th Grade Biology."

425

# If set, this field must be a valid UTF-8 string and no longer than 3600

426

# characters.

Bu Sun Kim

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

[diff] [blame]

427

"updateTime": "A String", # Time of the most recent update to this course.

428

# Specifying this field in a course update mask results in an error.

429

#

430

# Read-only.

Bu Sun Kim

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

[diff] [blame^]

431

"calendarId": "A String", # The Calendar ID for a calendar that all course members can see, to which

432

# Classroom adds events for course work and announcements in the course.

433

#

434

# Read-only.

Bu Sun Kim

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

[diff] [blame]

435

"alternateLink": "A String", # Absolute link to this course in the Classroom web UI.

436

#

437

# Read-only.

438

"guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.

439

#

440

# Read-only.

441

"courseState": "A String", # State of the course.

442

# If unspecified, the default state is `PROVISIONED`.

443

"ownerId": "A String", # The identifier of the owner of a course.

444

#

445

# When specified as a parameter of a

446

# create course request, this

447

# field is required.

448

# The identifier can be one of the following:

449

#

450

# * the numeric identifier for the user

451

# * the email address of the user

452

# * the string literal `"me"`, indicating the requesting user

453

#

454

# This must be set in a create request. Admins can also specify this field

455

# in a patch course request to

456

# transfer ownership. In other contexts, it is read-only.

457

"description": "A String", # Optional description.

458

# For example, "We'll be learning about the structure of living

459

# creatures from a combination of textbooks, guest lectures, and lab work.

460

# Expect to be excited!"

461

# If set, this field must be a valid UTF-8 string and no longer than 30,000

462

# characters.

463

"teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course.

464

# This group does not accept email and can only be used for permissions.

465

#

466

# Read-only.

467

"creationTime": "A String", # Creation time of the course.

468

# Specifying this field in a course update mask results in an error.

469

#

470

# Read-only.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

}</pre>

</div>

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

475

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

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

476

<pre>Deletes a course.

477

478

This method returns the following error codes:

479

480

* `PERMISSION_DENIED` if the requesting user is not permitted to delete the

481

requested course or for access errors.

482

* `NOT_FOUND` if no course exists with the requested ID.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

483

484

Args:

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

485

id: string, Identifier of the course to delete.

486

This identifier can be either the Classroom-assigned identifier or an

487

alias. (required)

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

488

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

489

Allowed values

490

1 - v1 error format

491

2 - v2 error format

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

492

493

Returns:

494

An object of the form:

495

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

496

{ # A generic empty message that you can re-use to avoid defining duplicated

497

# empty messages in your APIs. A typical example is to use it as the request

498

# or the response type of an API method. For instance:

499

#

500

# service Foo {

501

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

502

# }

503

#

504

# The JSON representation for `Empty` is empty JSON object `{}`.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

}</pre>

</div>

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

509

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

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

510

<pre>Returns a course.

511

512

This method returns the following error codes:

513

514

* `PERMISSION_DENIED` if the requesting user is not permitted to access the

515

requested course or for access errors.

516

* `NOT_FOUND` if no course exists with the requested ID.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

517

518

Args:

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

519

id: string, Identifier of the course to return.

520

This identifier can be either the Classroom-assigned identifier or an

521

alias. (required)

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

522

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

523

Allowed values

524

1 - v1 error format

525

2 - v2 error format

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

526

527

Returns:

528

An object of the form:

529

530

{ # A Course in Classroom.

Bu Sun Kim

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

[diff] [blame^]

531

"name": "A String", # Name of the course.

532

# For example, "10th Grade Biology".

533

# The name is required. It must be between 1 and 750 characters and a valid

534

# UTF-8 string.

535

"teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the

536

# course.

537

#

538

# This field will only be set for teachers of the course and domain

# administrators.

#

# Read-only.

"id": "A String", # Drive API resource ID.

543

"title": "A String", # Title of the Drive folder.

544

#

545

# Read-only.

546

"alternateLink": "A String", # URL that can be used to access the Drive folder.

547

#

548

# Read-only.

549

},

Bu Sun Kim

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

[diff] [blame]

550

"section": "A String", # Section of the course.

551

# For example, "Period 2".

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

552

# If set, this field must be a valid UTF-8 string and no longer than 2800

553

# characters.

Bu Sun Kim

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

[diff] [blame]

554

"id": "A String", # Identifier for this course assigned by Classroom.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

#

# When

# creating a course,

# you may optionally set this identifier to an

559

# alias string in the

560

# request to create a corresponding alias. The `id` is still assigned by

561

# Classroom and cannot be updated after the course is created.

562

#

563

# Specifying this field in a course update mask results in an error.

Bu Sun Kim

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

[diff] [blame]

564

"room": "A String", # Optional room location.

565

# For example, "301".

Bu Sun Kim

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

[diff] [blame]

566

# If set, this field must be a valid UTF-8 string and no longer than 650

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

567

# characters.

Bu Sun Kim

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

[diff] [blame]

568

"courseGroupEmail": "A String", # The email address of a Google group containing all members of the course.

569

# This group does not accept email and can only be used for permissions.

570

#

571

# Read-only.

572

"courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course.

573

#

574

# Read-only.

575

{ # A set of materials that appears on the "About" page of the course.

576

# These materials might include a syllabus, schedule, or other background

577

# information relating to the course as a whole.

578

"title": "A String", # Title for this set.

579

"materials": [ # Materials attached to this set.

580

{ # A material attached to a course as part of a material set.

581

"driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.

Bu Sun Kim

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

[diff] [blame]

582

"alternateLink": "A String", # URL that can be used to access the Drive item.

583

#

584

# Read-only.

585

"thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.

586

#

587

# Read-only.

588

"id": "A String", # Drive API resource ID.

Bu Sun Kim

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

[diff] [blame^]

589

"title": "A String", # Title of the Drive item.

590

#

591

# Read-only.

Bu Sun Kim

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

[diff] [blame]

592

},

593

"youTubeVideo": { # YouTube video item. # Youtube video attachment.

Bu Sun Kim

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

[diff] [blame^]

594

"title": "A String", # Title of the YouTube video.

595

#

596

# Read-only.

Bu Sun Kim

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

[diff] [blame]

597

"alternateLink": "A String", # URL that can be used to view the YouTube video.

598

#

599

# Read-only.

600

"thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.

601

#

602

# Read-only.

603

"id": "A String", # YouTube API resource ID.

Bu Sun Kim

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

[diff] [blame]

604

},

605

"form": { # Google Forms item. # Google Forms attachment.

Bu Sun Kim

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

[diff] [blame^]

606

"formUrl": "A String", # URL of the form.

Bu Sun Kim

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

[diff] [blame]

607

"title": "A String", # Title of the Form.

608

#

609

# Read-only.

610

"thumbnailUrl": "A String", # URL of a thumbnail image of the Form.

611

#

612

# Read-only.

613

"responseUrl": "A String", # URL of the form responses document.

614

# Only set if respsonses have been recorded and only when the

615

# requesting user is an editor of the form.

616

#

617

# Read-only.

Bu Sun Kim

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

[diff] [blame]

618

},

619

"link": { # URL item. # Link atatchment.

Bu Sun Kim

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

[diff] [blame]

620

"title": "A String", # Title of the target of the URL.

621

#

622

# Read-only.

623

"thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.

624

#

625

# Read-only.

Bu Sun Kim

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

[diff] [blame^]

626

"url": "A String", # URL to link to.

627

# This must be a valid UTF-8 string containing between 1 and 2024 characters.

Bu Sun Kim

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

[diff] [blame]

},

},

],

},

],

"enrollmentCode": "A String", # Enrollment code to use when joining this course.

634

# Specifying this field in a course update mask results in an error.

635

#

636

# Read-only.

637

"descriptionHeading": "A String", # Optional heading for the description.

638

# For example, "Welcome to 10th Grade Biology."

639

# If set, this field must be a valid UTF-8 string and no longer than 3600

640

# characters.

Bu Sun Kim

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

[diff] [blame]

641

"updateTime": "A String", # Time of the most recent update to this course.

642

# Specifying this field in a course update mask results in an error.

643

#

644

# Read-only.

Bu Sun Kim

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

[diff] [blame^]

645

"calendarId": "A String", # The Calendar ID for a calendar that all course members can see, to which

646

# Classroom adds events for course work and announcements in the course.

647

#

648

# Read-only.

Bu Sun Kim

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

[diff] [blame]

649

"alternateLink": "A String", # Absolute link to this course in the Classroom web UI.

650

#

651

# Read-only.

652

"guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.

653

#

654

# Read-only.

655

"courseState": "A String", # State of the course.

656

# If unspecified, the default state is `PROVISIONED`.

657

"ownerId": "A String", # The identifier of the owner of a course.

658

#

659

# When specified as a parameter of a

660

# create course request, this

661

# field is required.

662

# The identifier can be one of the following:

663

#

664

# * the numeric identifier for the user

665

# * the email address of the user

666

# * the string literal `"me"`, indicating the requesting user

667

#

668

# This must be set in a create request. Admins can also specify this field

669

# in a patch course request to

670

# transfer ownership. In other contexts, it is read-only.

671

"description": "A String", # Optional description.

672

# For example, "We'll be learning about the structure of living

673

# creatures from a combination of textbooks, guest lectures, and lab work.

674

# Expect to be excited!"

675

# If set, this field must be a valid UTF-8 string and no longer than 30,000

676

# characters.

677

"teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course.

678

# This group does not accept email and can only be used for permissions.

679

#

680

# Read-only.

681

"creationTime": "A String", # Creation time of the course.

682

# Specifying this field in a course update mask results in an error.

683

#

684

# Read-only.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

689

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

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

690

<pre>Returns a list of courses that the requesting user is permitted to view,

Bu Sun Kim

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

[diff] [blame]

691

restricted to those that match the request. Returned courses are ordered by

692

creation time, with the most recently created coming first.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

693

694

This method returns the following error codes:

695

696

* `PERMISSION_DENIED` for access errors.

697

* `INVALID_ARGUMENT` if the query argument is malformed.

698

* `NOT_FOUND` if any users specified in the query arguments do not exist.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

699

700

Args:

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

701

studentId: string, Restricts returned courses to those having a student with the specified

702

identifier. The identifier can be one of the following:

703

704

* the numeric identifier for the user

705

* the email address of the user

Bu Sun Kim

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

[diff] [blame]

706

* the string literal `"me"`, indicating the requesting user

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

707

pageToken: string, nextPageToken

708

value returned from a previous

709

list call,

710

indicating that the subsequent page of results should be returned.

711

712

The list request must be

713

otherwise identical to the one that resulted in this token.

Bu Sun Kim

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

[diff] [blame]

714

pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the

715

server may assign a maximum.

716

717

The server may return fewer than the specified number of results.

718

teacherId: string, Restricts returned courses to those having a teacher with the specified

719

identifier. The identifier can be one of the following:

720

721

* the numeric identifier for the user

722

* the email address of the user

723

* the string literal `"me"`, indicating the requesting user

724

courseStates: string, Restricts returned courses to those in one of the specified states

725

The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED. (repeated)

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

726

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

727

Allowed values

728

1 - v1 error format

729

2 - v2 error format

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

730

731

Returns:

732

An object of the form:

733

734

{ # Response when listing courses.

Bu Sun Kim

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

[diff] [blame]

735

"courses": [ # Courses that match the list request.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

736

{ # A Course in Classroom.

Bu Sun Kim

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

[diff] [blame^]

737

"name": "A String", # Name of the course.

738

# For example, "10th Grade Biology".

739

# The name is required. It must be between 1 and 750 characters and a valid

740

# UTF-8 string.

741

"teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the

742

# course.

743

#

744

# This field will only be set for teachers of the course and domain

# administrators.

#

# Read-only.

"id": "A String", # Drive API resource ID.

749

"title": "A String", # Title of the Drive folder.

750

#

751

# Read-only.

752

"alternateLink": "A String", # URL that can be used to access the Drive folder.

753

#

754

# Read-only.

755

},

Bu Sun Kim

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

[diff] [blame]

756

"section": "A String", # Section of the course.

757

# For example, "Period 2".

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

758

# If set, this field must be a valid UTF-8 string and no longer than 2800

759

# characters.

Bu Sun Kim

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

[diff] [blame]

760

"id": "A String", # Identifier for this course assigned by Classroom.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

#

# When

# creating a course,

# you may optionally set this identifier to an

765

# alias string in the

766

# request to create a corresponding alias. The `id` is still assigned by

767

# Classroom and cannot be updated after the course is created.

768

#

769

# Specifying this field in a course update mask results in an error.

Bu Sun Kim

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

[diff] [blame]

770

"room": "A String", # Optional room location.

771

# For example, "301".

Bu Sun Kim

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

[diff] [blame]

772

# If set, this field must be a valid UTF-8 string and no longer than 650

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

773

# characters.

Bu Sun Kim

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

[diff] [blame]

774

"courseGroupEmail": "A String", # The email address of a Google group containing all members of the course.

775

# This group does not accept email and can only be used for permissions.

776

#

777

# Read-only.

778

"courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course.

779

#

780

# Read-only.

781

{ # A set of materials that appears on the "About" page of the course.

782

# These materials might include a syllabus, schedule, or other background

783

# information relating to the course as a whole.

784

"title": "A String", # Title for this set.

785

"materials": [ # Materials attached to this set.

786

{ # A material attached to a course as part of a material set.

787

"driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.

Bu Sun Kim

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

[diff] [blame]

788

"alternateLink": "A String", # URL that can be used to access the Drive item.

789

#

790

# Read-only.

791

"thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.

792

#

793

# Read-only.

794

"id": "A String", # Drive API resource ID.

Bu Sun Kim

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

[diff] [blame^]

795

"title": "A String", # Title of the Drive item.

796

#

797

# Read-only.

Bu Sun Kim

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

[diff] [blame]

798

},

799

"youTubeVideo": { # YouTube video item. # Youtube video attachment.

Bu Sun Kim

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

[diff] [blame^]

800

"title": "A String", # Title of the YouTube video.

801

#

802

# Read-only.

Bu Sun Kim

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

[diff] [blame]

803

"alternateLink": "A String", # URL that can be used to view the YouTube video.

804

#

805

# Read-only.

806

"thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.

807

#

808

# Read-only.

809

"id": "A String", # YouTube API resource ID.

Bu Sun Kim

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

[diff] [blame]

810

},

811

"form": { # Google Forms item. # Google Forms attachment.

Bu Sun Kim

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

[diff] [blame^]

812

"formUrl": "A String", # URL of the form.

Bu Sun Kim

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

[diff] [blame]

813

"title": "A String", # Title of the Form.

814

#

815

# Read-only.

816

"thumbnailUrl": "A String", # URL of a thumbnail image of the Form.

817

#

818

# Read-only.

819

"responseUrl": "A String", # URL of the form responses document.

820

# Only set if respsonses have been recorded and only when the

821

# requesting user is an editor of the form.

822

#

823

# Read-only.

Bu Sun Kim

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

[diff] [blame]

824

},

825

"link": { # URL item. # Link atatchment.

Bu Sun Kim

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

[diff] [blame]

826

"title": "A String", # Title of the target of the URL.

827

#

828

# Read-only.

829

"thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.

830

#

831

# Read-only.

Bu Sun Kim

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

[diff] [blame^]

832

"url": "A String", # URL to link to.

833

# This must be a valid UTF-8 string containing between 1 and 2024 characters.

Bu Sun Kim

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

[diff] [blame]

},

},

],

},

],

"enrollmentCode": "A String", # Enrollment code to use when joining this course.

840

# Specifying this field in a course update mask results in an error.

841

#

842

# Read-only.

843

"descriptionHeading": "A String", # Optional heading for the description.

844

# For example, "Welcome to 10th Grade Biology."

845

# If set, this field must be a valid UTF-8 string and no longer than 3600

846

# characters.

Bu Sun Kim

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

[diff] [blame]

847

"updateTime": "A String", # Time of the most recent update to this course.

848

# Specifying this field in a course update mask results in an error.

849

#

850

# Read-only.

Bu Sun Kim

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

[diff] [blame^]

851

"calendarId": "A String", # The Calendar ID for a calendar that all course members can see, to which

852

# Classroom adds events for course work and announcements in the course.

853

#

854

# Read-only.

Bu Sun Kim

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

[diff] [blame]

855

"alternateLink": "A String", # Absolute link to this course in the Classroom web UI.

856

#

857

# Read-only.

858

"guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.

859

#

860

# Read-only.

861

"courseState": "A String", # State of the course.

862

# If unspecified, the default state is `PROVISIONED`.

863

"ownerId": "A String", # The identifier of the owner of a course.

864

#

865

# When specified as a parameter of a

866

# create course request, this

867

# field is required.

868

# The identifier can be one of the following:

869

#

870

# * the numeric identifier for the user

871

# * the email address of the user

872

# * the string literal `"me"`, indicating the requesting user

873

#

874

# This must be set in a create request. Admins can also specify this field

875

# in a patch course request to

876

# transfer ownership. In other contexts, it is read-only.

877

"description": "A String", # Optional description.

878

# For example, "We'll be learning about the structure of living

879

# creatures from a combination of textbooks, guest lectures, and lab work.

880

# Expect to be excited!"

881

# If set, this field must be a valid UTF-8 string and no longer than 30,000

882

# characters.

883

"teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course.

884

# This group does not accept email and can only be used for permissions.

885

#

886

# Read-only.

887

"creationTime": "A String", # Creation time of the course.

888

# Specifying this field in a course update mask results in an error.

889

#

890

# Read-only.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

891

},

892

],

Bu Sun Kim

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

[diff] [blame]

893

"nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further

894

# results are available.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

}</pre>

</div>

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

900

<pre>Retrieves the next page of results.

901

902

Args:

903

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

904

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

905

906

Returns:

Bu Sun Kim

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

[diff] [blame]

907

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

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

908

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]

913

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

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

914

<pre>Updates one or more fields in a course.

915

916

This method returns the following error codes:

917

918

* `PERMISSION_DENIED` if the requesting user is not permitted to modify the

919

requested course or for access errors.

920

* `NOT_FOUND` if no course exists with the requested ID.

921

* `INVALID_ARGUMENT` if invalid fields are specified in the update mask or

922

if no update mask is supplied.

923

* `FAILED_PRECONDITION` for the following request errors:

924

* CourseNotModifiable

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

925

926

Args:

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

927

id: string, Identifier of the course to update.

928

This identifier can be either the Classroom-assigned identifier or an

929

alias. (required)

Dan O'Meara

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

[diff] [blame]

930

body: object, The request body.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

931

The object takes the form of:

932

933

{ # A Course in Classroom.

Bu Sun Kim

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

[diff] [blame^]

934

"name": "A String", # Name of the course.

935

# For example, "10th Grade Biology".

936

# The name is required. It must be between 1 and 750 characters and a valid

937

# UTF-8 string.

938

"teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the

939

# course.

940

#

941

# This field will only be set for teachers of the course and domain

# administrators.

#

# Read-only.

"id": "A String", # Drive API resource ID.

946

"title": "A String", # Title of the Drive folder.

947

#

948

# Read-only.

949

"alternateLink": "A String", # URL that can be used to access the Drive folder.

950

#

951

# Read-only.

952

},

Bu Sun Kim

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

[diff] [blame]

953

"section": "A String", # Section of the course.

954

# For example, "Period 2".

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

955

# If set, this field must be a valid UTF-8 string and no longer than 2800

956

# characters.

Bu Sun Kim

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

[diff] [blame]

957

"id": "A String", # Identifier for this course assigned by Classroom.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

#

# When

# creating a course,

# you may optionally set this identifier to an

962

# alias string in the

963

# request to create a corresponding alias. The `id` is still assigned by

964

# Classroom and cannot be updated after the course is created.

965

#

966

# Specifying this field in a course update mask results in an error.

Bu Sun Kim

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

[diff] [blame]

967

"room": "A String", # Optional room location.

968

# For example, "301".

Bu Sun Kim

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

[diff] [blame]

969

# If set, this field must be a valid UTF-8 string and no longer than 650

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

970

# characters.

Bu Sun Kim

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

[diff] [blame]

971

"courseGroupEmail": "A String", # The email address of a Google group containing all members of the course.

972

# This group does not accept email and can only be used for permissions.

973

#

974

# Read-only.

975

"courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course.

976

#

977

# Read-only.

978

{ # A set of materials that appears on the "About" page of the course.

979

# These materials might include a syllabus, schedule, or other background

980

# information relating to the course as a whole.

981

"title": "A String", # Title for this set.

982

"materials": [ # Materials attached to this set.

983

{ # A material attached to a course as part of a material set.

984

"driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.

Bu Sun Kim

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

[diff] [blame]

985

"alternateLink": "A String", # URL that can be used to access the Drive item.

986

#

987

# Read-only.

988

"thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.

989

#

990

# Read-only.

991

"id": "A String", # Drive API resource ID.

Bu Sun Kim

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

[diff] [blame^]

992

"title": "A String", # Title of the Drive item.

993

#

994

# Read-only.

Bu Sun Kim

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

[diff] [blame]

995

},

996

"youTubeVideo": { # YouTube video item. # Youtube video attachment.

Bu Sun Kim

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

[diff] [blame^]

997

"title": "A String", # Title of the YouTube video.

998

#

999

# Read-only.

Bu Sun Kim

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

[diff] [blame]

1000

"alternateLink": "A String", # URL that can be used to view the YouTube video.

1001

#

1002

# Read-only.

1003

"thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.

1004

#

1005

# Read-only.

1006

"id": "A String", # YouTube API resource ID.

Bu Sun Kim

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

[diff] [blame]

1007

},

1008

"form": { # Google Forms item. # Google Forms attachment.

Bu Sun Kim

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

[diff] [blame^]

1009

"formUrl": "A String", # URL of the form.

Bu Sun Kim

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

[diff] [blame]

1010

"title": "A String", # Title of the Form.

1011

#

1012

# Read-only.

1013

"thumbnailUrl": "A String", # URL of a thumbnail image of the Form.

1014

#

1015

# Read-only.

1016

"responseUrl": "A String", # URL of the form responses document.

1017

# Only set if respsonses have been recorded and only when the

1018

# requesting user is an editor of the form.

1019

#

1020

# Read-only.

Bu Sun Kim

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

[diff] [blame]

1021

},

1022

"link": { # URL item. # Link atatchment.

Bu Sun Kim

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

[diff] [blame]

1023

"title": "A String", # Title of the target of the URL.

1024

#

1025

# Read-only.

1026

"thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.

1027

#

1028

# Read-only.

Bu Sun Kim

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

[diff] [blame^]

1029

"url": "A String", # URL to link to.

1030

# This must be a valid UTF-8 string containing between 1 and 2024 characters.

Bu Sun Kim

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

[diff] [blame]

},

},

],

},

],

"enrollmentCode": "A String", # Enrollment code to use when joining this course.

1037

# Specifying this field in a course update mask results in an error.

1038

#

1039

# Read-only.

1040

"descriptionHeading": "A String", # Optional heading for the description.

1041

# For example, "Welcome to 10th Grade Biology."

1042

# If set, this field must be a valid UTF-8 string and no longer than 3600

1043

# characters.

Bu Sun Kim

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

[diff] [blame]

1044

"updateTime": "A String", # Time of the most recent update to this course.

1045

# Specifying this field in a course update mask results in an error.

1046

#

1047

# Read-only.

Bu Sun Kim

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

[diff] [blame^]

1048

"calendarId": "A String", # The Calendar ID for a calendar that all course members can see, to which

1049

# Classroom adds events for course work and announcements in the course.

1050

#

1051

# Read-only.

Bu Sun Kim

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

[diff] [blame]

1052

"alternateLink": "A String", # Absolute link to this course in the Classroom web UI.

1053

#

1054

# Read-only.

1055

"guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.

1056

#

1057

# Read-only.

1058

"courseState": "A String", # State of the course.

1059

# If unspecified, the default state is `PROVISIONED`.

1060

"ownerId": "A String", # The identifier of the owner of a course.

1061

#

1062

# When specified as a parameter of a

1063

# create course request, this

1064

# field is required.

1065

# The identifier can be one of the following:

1066

#

1067

# * the numeric identifier for the user

1068

# * the email address of the user

1069

# * the string literal `"me"`, indicating the requesting user

1070

#

1071

# This must be set in a create request. Admins can also specify this field

1072

# in a patch course request to

1073

# transfer ownership. In other contexts, it is read-only.

1074

"description": "A String", # Optional description.

1075

# For example, "We'll be learning about the structure of living

1076

# creatures from a combination of textbooks, guest lectures, and lab work.

1077

# Expect to be excited!"

1078

# If set, this field must be a valid UTF-8 string and no longer than 30,000

1079

# characters.

1080

"teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course.

1081

# This group does not accept email and can only be used for permissions.

1082

#

1083

# Read-only.

1084

"creationTime": "A String", # Creation time of the course.

1085

# Specifying this field in a course update mask results in an error.

1086

#

1087

# Read-only.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1088

}

1089

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

1090

updateMask: string, Mask that identifies which fields on the course to update.

1091

This field is required to do an update. The update will fail if invalid

1092

fields are specified. The following fields are valid:

* `name`

* `section`

* `descriptionHeading`

1097

* `description`

1098

* `room`

1099

* `courseState`

Bu Sun Kim

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

[diff] [blame]

1100

* `ownerId`

1101

1102

Note: patches to ownerId are treated as being effective immediately, but in

1103

practice it may take some time for the ownership transfer of all affected

1104

resources to complete.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

1105

1106

When set in a query parameter, this field should be specified as

1107

Dan O'Meara

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

[diff] [blame]

1108

`updateMask=<field1>,<field2>,...`

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1109

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

1110

Allowed values

1111

1 - v1 error format

1112

2 - v2 error format

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1113

1114

Returns:

1115

An object of the form:

1116

1117

{ # A Course in Classroom.

Bu Sun Kim

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

[diff] [blame^]

1118

"name": "A String", # Name of the course.

1119

# For example, "10th Grade Biology".

1120

# The name is required. It must be between 1 and 750 characters and a valid

1121

# UTF-8 string.

1122

"teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the

1123

# course.

1124

#

1125

# This field will only be set for teachers of the course and domain

# administrators.

#

# Read-only.

"id": "A String", # Drive API resource ID.

1130

"title": "A String", # Title of the Drive folder.

1131

#

1132

# Read-only.

1133

"alternateLink": "A String", # URL that can be used to access the Drive folder.

1134

#

1135

# Read-only.

1136

},

Bu Sun Kim

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

[diff] [blame]

1137

"section": "A String", # Section of the course.

1138

# For example, "Period 2".

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

1139

# If set, this field must be a valid UTF-8 string and no longer than 2800

1140

# characters.

Bu Sun Kim

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

[diff] [blame]

1141

"id": "A String", # Identifier for this course assigned by Classroom.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

#

# When

# creating a course,

# you may optionally set this identifier to an

1146

# alias string in the

1147

# request to create a corresponding alias. The `id` is still assigned by

1148

# Classroom and cannot be updated after the course is created.

1149

#

1150

# Specifying this field in a course update mask results in an error.

Bu Sun Kim

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

[diff] [blame]

1151

"room": "A String", # Optional room location.

1152

# For example, "301".

Bu Sun Kim

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

[diff] [blame]

1153

# If set, this field must be a valid UTF-8 string and no longer than 650

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

1154

# characters.

Bu Sun Kim

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

[diff] [blame]

1155

"courseGroupEmail": "A String", # The email address of a Google group containing all members of the course.

1156

# This group does not accept email and can only be used for permissions.

1157

#

1158

# Read-only.

1159

"courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course.

1160

#

1161

# Read-only.

1162

{ # A set of materials that appears on the "About" page of the course.

1163

# These materials might include a syllabus, schedule, or other background

1164

# information relating to the course as a whole.

1165

"title": "A String", # Title for this set.

1166

"materials": [ # Materials attached to this set.

1167

{ # A material attached to a course as part of a material set.

1168

"driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.

Bu Sun Kim

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

[diff] [blame]

1169

"alternateLink": "A String", # URL that can be used to access the Drive item.

1170

#

1171

# Read-only.

1172

"thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.

1173

#

1174

# Read-only.

1175

"id": "A String", # Drive API resource ID.

Bu Sun Kim

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

[diff] [blame^]

1176

"title": "A String", # Title of the Drive item.

1177

#

1178

# Read-only.

Bu Sun Kim

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

[diff] [blame]

1179

},

1180

"youTubeVideo": { # YouTube video item. # Youtube video attachment.

Bu Sun Kim

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

[diff] [blame^]

1181

"title": "A String", # Title of the YouTube video.

1182

#

1183

# Read-only.

Bu Sun Kim

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

[diff] [blame]

1184

"alternateLink": "A String", # URL that can be used to view the YouTube video.

1185

#

1186

# Read-only.

1187

"thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.

1188

#

1189

# Read-only.

1190

"id": "A String", # YouTube API resource ID.

Bu Sun Kim

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

[diff] [blame]

1191

},

1192

"form": { # Google Forms item. # Google Forms attachment.

Bu Sun Kim

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

[diff] [blame^]

1193

"formUrl": "A String", # URL of the form.

Bu Sun Kim

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

[diff] [blame]

1194

"title": "A String", # Title of the Form.

1195

#

1196

# Read-only.

1197

"thumbnailUrl": "A String", # URL of a thumbnail image of the Form.

1198

#

1199

# Read-only.

1200

"responseUrl": "A String", # URL of the form responses document.

1201

# Only set if respsonses have been recorded and only when the

1202

# requesting user is an editor of the form.

1203

#

1204

# Read-only.

Bu Sun Kim

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

[diff] [blame]

1205

},

1206

"link": { # URL item. # Link atatchment.

Bu Sun Kim

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

[diff] [blame]

1207

"title": "A String", # Title of the target of the URL.

1208

#

1209

# Read-only.

1210

"thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.

1211

#

1212

# Read-only.

Bu Sun Kim

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

[diff] [blame^]

1213

"url": "A String", # URL to link to.

1214

# This must be a valid UTF-8 string containing between 1 and 2024 characters.

Bu Sun Kim

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

[diff] [blame]

},

},

],

},

],

"enrollmentCode": "A String", # Enrollment code to use when joining this course.

1221

# Specifying this field in a course update mask results in an error.

1222

#

1223

# Read-only.

1224

"descriptionHeading": "A String", # Optional heading for the description.

1225

# For example, "Welcome to 10th Grade Biology."

1226

# If set, this field must be a valid UTF-8 string and no longer than 3600

1227

# characters.

Bu Sun Kim

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

[diff] [blame]

1228

"updateTime": "A String", # Time of the most recent update to this course.

1229

# Specifying this field in a course update mask results in an error.

1230

#

1231

# Read-only.

Bu Sun Kim

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

[diff] [blame^]

1232

"calendarId": "A String", # The Calendar ID for a calendar that all course members can see, to which

1233

# Classroom adds events for course work and announcements in the course.

1234

#

1235

# Read-only.

Bu Sun Kim

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

[diff] [blame]

1236

"alternateLink": "A String", # Absolute link to this course in the Classroom web UI.

1237

#

1238

# Read-only.

1239

"guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.

1240

#

1241

# Read-only.

1242

"courseState": "A String", # State of the course.

1243

# If unspecified, the default state is `PROVISIONED`.

1244

"ownerId": "A String", # The identifier of the owner of a course.

1245

#

1246

# When specified as a parameter of a

1247

# create course request, this

1248

# field is required.

1249

# The identifier can be one of the following:

1250

#

1251

# * the numeric identifier for the user

1252

# * the email address of the user

1253

# * the string literal `"me"`, indicating the requesting user

1254

#

1255

# This must be set in a create request. Admins can also specify this field

1256

# in a patch course request to

1257

# transfer ownership. In other contexts, it is read-only.

1258

"description": "A String", # Optional description.

1259

# For example, "We'll be learning about the structure of living

1260

# creatures from a combination of textbooks, guest lectures, and lab work.

1261

# Expect to be excited!"

1262

# If set, this field must be a valid UTF-8 string and no longer than 30,000

1263

# characters.

1264

"teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course.

1265

# This group does not accept email and can only be used for permissions.

1266

#

1267

# Read-only.

1268

"creationTime": "A String", # Creation time of the course.

1269

# Specifying this field in a course update mask results in an error.

1270

#

1271

# Read-only.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

1276

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

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

1277

<pre>Updates a course.

1278

1279

This method returns the following error codes:

1280

1281

* `PERMISSION_DENIED` if the requesting user is not permitted to modify the

1282

requested course or for access errors.

1283

* `NOT_FOUND` if no course exists with the requested ID.

1284

* `FAILED_PRECONDITION` for the following request errors:

1285

* CourseNotModifiable

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1286

1287

Args:

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

1288

id: string, Identifier of the course to update.

1289

This identifier can be either the Classroom-assigned identifier or an

1290

alias. (required)

Dan O'Meara

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

[diff] [blame]

1291

body: object, The request body.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1292

The object takes the form of:

1293

1294

{ # A Course in Classroom.

Bu Sun Kim

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

[diff] [blame^]

1295

"name": "A String", # Name of the course.

1296

# For example, "10th Grade Biology".

1297

# The name is required. It must be between 1 and 750 characters and a valid

1298

# UTF-8 string.

1299

"teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the

1300

# course.

1301

#

1302

# This field will only be set for teachers of the course and domain

# administrators.

#

# Read-only.

"id": "A String", # Drive API resource ID.

1307

"title": "A String", # Title of the Drive folder.

1308

#

1309

# Read-only.

1310

"alternateLink": "A String", # URL that can be used to access the Drive folder.

1311

#

1312

# Read-only.

1313

},

Bu Sun Kim

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

[diff] [blame]

1314

"section": "A String", # Section of the course.

1315

# For example, "Period 2".

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

1316

# If set, this field must be a valid UTF-8 string and no longer than 2800

1317

# characters.

Bu Sun Kim

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

[diff] [blame]

1318

"id": "A String", # Identifier for this course assigned by Classroom.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

#

# When

# creating a course,

# you may optionally set this identifier to an

1323

# alias string in the

1324

# request to create a corresponding alias. The `id` is still assigned by

1325

# Classroom and cannot be updated after the course is created.

1326

#

1327

# Specifying this field in a course update mask results in an error.

Bu Sun Kim

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

[diff] [blame]

1328

"room": "A String", # Optional room location.

1329

# For example, "301".

Bu Sun Kim

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

[diff] [blame]

1330

# If set, this field must be a valid UTF-8 string and no longer than 650

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

1331

# characters.

Bu Sun Kim

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

[diff] [blame]

1332

"courseGroupEmail": "A String", # The email address of a Google group containing all members of the course.

1333

# This group does not accept email and can only be used for permissions.

1334

#

1335

# Read-only.

1336

"courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course.

1337

#

1338

# Read-only.

1339

{ # A set of materials that appears on the "About" page of the course.

1340

# These materials might include a syllabus, schedule, or other background

1341

# information relating to the course as a whole.

1342

"title": "A String", # Title for this set.

1343

"materials": [ # Materials attached to this set.

1344

{ # A material attached to a course as part of a material set.

1345

"driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.

Bu Sun Kim

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

[diff] [blame]

1346

"alternateLink": "A String", # URL that can be used to access the Drive item.

1347

#

1348

# Read-only.

1349

"thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.

1350

#

1351

# Read-only.

1352

"id": "A String", # Drive API resource ID.

Bu Sun Kim

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

[diff] [blame^]

1353

"title": "A String", # Title of the Drive item.

1354

#

1355

# Read-only.

Bu Sun Kim

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

[diff] [blame]

1356

},

1357

"youTubeVideo": { # YouTube video item. # Youtube video attachment.

Bu Sun Kim

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

[diff] [blame^]

1358

"title": "A String", # Title of the YouTube video.

1359

#

1360

# Read-only.

Bu Sun Kim

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

[diff] [blame]

1361

"alternateLink": "A String", # URL that can be used to view the YouTube video.

1362

#

1363

# Read-only.

1364

"thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.

1365

#

1366

# Read-only.

1367

"id": "A String", # YouTube API resource ID.

Bu Sun Kim

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

[diff] [blame]

1368

},

1369

"form": { # Google Forms item. # Google Forms attachment.

Bu Sun Kim

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

[diff] [blame^]

1370

"formUrl": "A String", # URL of the form.

Bu Sun Kim

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

[diff] [blame]

1371

"title": "A String", # Title of the Form.

1372

#

1373

# Read-only.

1374

"thumbnailUrl": "A String", # URL of a thumbnail image of the Form.

1375

#

1376

# Read-only.

1377

"responseUrl": "A String", # URL of the form responses document.

1378

# Only set if respsonses have been recorded and only when the

1379

# requesting user is an editor of the form.

1380

#

1381

# Read-only.

Bu Sun Kim

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

[diff] [blame]

1382

},

1383

"link": { # URL item. # Link atatchment.

Bu Sun Kim

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

[diff] [blame]

1384

"title": "A String", # Title of the target of the URL.

1385

#

1386

# Read-only.

1387

"thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.

1388

#

1389

# Read-only.

Bu Sun Kim

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

[diff] [blame^]

1390

"url": "A String", # URL to link to.

1391

# This must be a valid UTF-8 string containing between 1 and 2024 characters.

Bu Sun Kim

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

[diff] [blame]

},

},

],

},

],

"enrollmentCode": "A String", # Enrollment code to use when joining this course.

1398

# Specifying this field in a course update mask results in an error.

1399

#

1400

# Read-only.

1401

"descriptionHeading": "A String", # Optional heading for the description.

1402

# For example, "Welcome to 10th Grade Biology."

1403

# If set, this field must be a valid UTF-8 string and no longer than 3600

1404

# characters.

Bu Sun Kim

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

[diff] [blame]

1405

"updateTime": "A String", # Time of the most recent update to this course.

1406

# Specifying this field in a course update mask results in an error.

1407

#

1408

# Read-only.

Bu Sun Kim

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

[diff] [blame^]

1409

"calendarId": "A String", # The Calendar ID for a calendar that all course members can see, to which

1410

# Classroom adds events for course work and announcements in the course.

1411

#

1412

# Read-only.

Bu Sun Kim

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

[diff] [blame]

1413

"alternateLink": "A String", # Absolute link to this course in the Classroom web UI.

1414

#

1415

# Read-only.

1416

"guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.

1417

#

1418

# Read-only.

1419

"courseState": "A String", # State of the course.

1420

# If unspecified, the default state is `PROVISIONED`.

1421

"ownerId": "A String", # The identifier of the owner of a course.

1422

#

1423

# When specified as a parameter of a

1424

# create course request, this

1425

# field is required.

1426

# The identifier can be one of the following:

1427

#

1428

# * the numeric identifier for the user

1429

# * the email address of the user

1430

# * the string literal `"me"`, indicating the requesting user

1431

#

1432

# This must be set in a create request. Admins can also specify this field

1433

# in a patch course request to

1434

# transfer ownership. In other contexts, it is read-only.

1435

"description": "A String", # Optional description.

1436

# For example, "We'll be learning about the structure of living

1437

# creatures from a combination of textbooks, guest lectures, and lab work.

1438

# Expect to be excited!"

1439

# If set, this field must be a valid UTF-8 string and no longer than 30,000

1440

# characters.

1441

"teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course.

1442

# This group does not accept email and can only be used for permissions.

1443

#

1444

# Read-only.

1445

"creationTime": "A String", # Creation time of the course.

1446

# Specifying this field in a course update mask results in an error.

1447

#

1448

# Read-only.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1449

}

1450

1451

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

1452

Allowed values

1453

1 - v1 error format

1454

2 - v2 error format

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1455

1456

Returns:

1457

An object of the form:

1458

1459

{ # A Course in Classroom.

Bu Sun Kim

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

[diff] [blame^]

1460

"name": "A String", # Name of the course.

1461

# For example, "10th Grade Biology".

1462

# The name is required. It must be between 1 and 750 characters and a valid

1463

# UTF-8 string.

1464

"teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the

1465

# course.

1466

#

1467

# This field will only be set for teachers of the course and domain

# administrators.

#

# Read-only.

"id": "A String", # Drive API resource ID.

1472

"title": "A String", # Title of the Drive folder.

1473

#

1474

# Read-only.

1475

"alternateLink": "A String", # URL that can be used to access the Drive folder.

1476

#

1477

# Read-only.

1478

},

Bu Sun Kim

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

[diff] [blame]

1479

"section": "A String", # Section of the course.

1480

# For example, "Period 2".

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

1481

# If set, this field must be a valid UTF-8 string and no longer than 2800

1482

# characters.

Bu Sun Kim

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

[diff] [blame]

1483

"id": "A String", # Identifier for this course assigned by Classroom.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

#

# When

# creating a course,

# you may optionally set this identifier to an

1488

# alias string in the

1489

# request to create a corresponding alias. The `id` is still assigned by

1490

# Classroom and cannot be updated after the course is created.

1491

#

1492

# Specifying this field in a course update mask results in an error.

Bu Sun Kim

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

[diff] [blame]

1493

"room": "A String", # Optional room location.

1494

# For example, "301".

Bu Sun Kim

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

[diff] [blame]

1495

# If set, this field must be a valid UTF-8 string and no longer than 650

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

1496

# characters.

Bu Sun Kim

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

[diff] [blame]

1497

"courseGroupEmail": "A String", # The email address of a Google group containing all members of the course.

1498

# This group does not accept email and can only be used for permissions.

1499

#

1500

# Read-only.

1501

"courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course.

1502

#

1503

# Read-only.

1504

{ # A set of materials that appears on the "About" page of the course.

1505

# These materials might include a syllabus, schedule, or other background

1506

# information relating to the course as a whole.

1507

"title": "A String", # Title for this set.

1508

"materials": [ # Materials attached to this set.

1509

{ # A material attached to a course as part of a material set.

1510

"driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.

Bu Sun Kim

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

[diff] [blame]

1511

"alternateLink": "A String", # URL that can be used to access the Drive item.

1512

#

1513

# Read-only.

1514

"thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.

1515

#

1516

# Read-only.

1517

"id": "A String", # Drive API resource ID.

Bu Sun Kim

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

[diff] [blame^]

1518

"title": "A String", # Title of the Drive item.

1519

#

1520

# Read-only.

Bu Sun Kim

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

[diff] [blame]

1521

},

1522

"youTubeVideo": { # YouTube video item. # Youtube video attachment.

Bu Sun Kim

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

[diff] [blame^]

1523

"title": "A String", # Title of the YouTube video.

1524

#

1525

# Read-only.

Bu Sun Kim

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

[diff] [blame]

1526

"alternateLink": "A String", # URL that can be used to view the YouTube video.

1527

#

1528

# Read-only.

1529

"thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.

1530

#

1531

# Read-only.

1532

"id": "A String", # YouTube API resource ID.

Bu Sun Kim

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

[diff] [blame]

1533

},

1534

"form": { # Google Forms item. # Google Forms attachment.

Bu Sun Kim

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

[diff] [blame^]

1535

"formUrl": "A String", # URL of the form.

Bu Sun Kim

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

[diff] [blame]

1536

"title": "A String", # Title of the Form.

1537

#

1538

# Read-only.

1539

"thumbnailUrl": "A String", # URL of a thumbnail image of the Form.

1540

#

1541

# Read-only.

1542

"responseUrl": "A String", # URL of the form responses document.

1543

# Only set if respsonses have been recorded and only when the

1544

# requesting user is an editor of the form.

1545

#

1546

# Read-only.

Bu Sun Kim

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

[diff] [blame]

1547

},

1548

"link": { # URL item. # Link atatchment.

Bu Sun Kim

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

[diff] [blame]

1549

"title": "A String", # Title of the target of the URL.

1550

#

1551

# Read-only.

1552

"thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.

1553

#

1554

# Read-only.

Bu Sun Kim

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

[diff] [blame^]

1555

"url": "A String", # URL to link to.

1556

# This must be a valid UTF-8 string containing between 1 and 2024 characters.

Bu Sun Kim

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

[diff] [blame]

},

},

],

},

],

"enrollmentCode": "A String", # Enrollment code to use when joining this course.

1563

# Specifying this field in a course update mask results in an error.

1564

#

1565

# Read-only.

1566

"descriptionHeading": "A String", # Optional heading for the description.

1567

# For example, "Welcome to 10th Grade Biology."

1568

# If set, this field must be a valid UTF-8 string and no longer than 3600

1569

# characters.

Bu Sun Kim

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

[diff] [blame]

1570

"updateTime": "A String", # Time of the most recent update to this course.

1571

# Specifying this field in a course update mask results in an error.

1572

#

1573

# Read-only.

Bu Sun Kim

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

[diff] [blame^]

1574

"calendarId": "A String", # The Calendar ID for a calendar that all course members can see, to which

1575

# Classroom adds events for course work and announcements in the course.

1576

#

1577

# Read-only.

Bu Sun Kim

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

[diff] [blame]

1578

"alternateLink": "A String", # Absolute link to this course in the Classroom web UI.

1579

#

1580

# Read-only.

1581

"guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.

1582

#

1583

# Read-only.

1584

"courseState": "A String", # State of the course.

1585

# If unspecified, the default state is `PROVISIONED`.

1586

"ownerId": "A String", # The identifier of the owner of a course.

1587

#

1588

# When specified as a parameter of a

1589

# create course request, this

1590

# field is required.

1591

# The identifier can be one of the following:

1592

#

1593

# * the numeric identifier for the user

1594

# * the email address of the user

1595

# * the string literal `"me"`, indicating the requesting user

1596

#

1597

# This must be set in a create request. Admins can also specify this field

1598

# in a patch course request to

1599

# transfer ownership. In other contexts, it is read-only.

1600

"description": "A String", # Optional description.

1601

# For example, "We'll be learning about the structure of living

1602

# creatures from a combination of textbooks, guest lectures, and lab work.

1603

# Expect to be excited!"

1604

# If set, this field must be a valid UTF-8 string and no longer than 30,000

1605

# characters.

1606

"teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course.

1607

# This group does not accept email and can only be used for permissions.

1608

#

1609

# Read-only.

1610

"creationTime": "A String", # Creation time of the course.

1611

# Specifying this field in a course update mask results in an error.

1612

#

1613

# Read-only.

Takashi Matsuo