google-apis-classroom_v1 0.40.0 → 0.42.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/OVERVIEW.md +1 -1
- data/lib/google/apis/classroom_v1/classes.rb +97 -0
- data/lib/google/apis/classroom_v1/gem_version.rb +2 -2
- data/lib/google/apis/classroom_v1/representations.rb +34 -0
- data/lib/google/apis/classroom_v1/service.rb +159 -74
- data/lib/google/apis/classroom_v1.rb +1 -1
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 8ed825042757797757c9b48698e7cb699e09816bb3a149d44fc7f26a1992b99e
|
4
|
+
data.tar.gz: ab213fe63bd01d70272639e38a4d19591716bc245860bcc26c20058f341ed2dd
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: bee5ec3491e029cb5e4b535b4a18997935fa240af618647bac1e12c1a9af0def95d950bd4a0668d9245dba7ab4e4599240576d66ce6fa892268edd9ef24d180d
|
7
|
+
data.tar.gz: 42727553b672438129fab5e43f2eb5cf46078d1fc8e6467771985bd82e59b7141a283f866ef086041f8785e2e429b7db512ffc3f2d02e85eebbba581cd59932c
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,13 @@
|
|
1
1
|
# Release history for google-apis-classroom_v1
|
2
2
|
|
3
|
+
### v0.42.0 (2025-04-27)
|
4
|
+
|
5
|
+
* Regenerated from discovery document revision 20250420
|
6
|
+
|
7
|
+
### v0.41.0 (2025-04-06)
|
8
|
+
|
9
|
+
* Regenerated from discovery document revision 20250331
|
10
|
+
|
3
11
|
### v0.40.0 (2025-03-09)
|
4
12
|
|
5
13
|
* Regenerated from discovery document revision 20250303
|
data/OVERVIEW.md
CHANGED
@@ -79,7 +79,7 @@ Gem names for modern clients are often of the form `google-cloud-<service_name>`
|
|
79
79
|
|
80
80
|
**For most users, we recommend the modern client, if one is available.** Compared with simple clients, modern clients are generally much easier to use and more Ruby-like, support more advanced features such as streaming and long-running operations, and often provide much better performance. You may consider using a simple client instead, if a modern client is not yet available for the service you want to use, or if you are not able to use gRPC on your infrastructure.
|
81
81
|
|
82
|
-
The [product documentation](https://developers.google.com/classroom/) may provide guidance regarding the preferred client library to use.
|
82
|
+
The [product documentation](https://developers.google.com/workspace/classroom/) may provide guidance regarding the preferred client library to use.
|
83
83
|
|
84
84
|
## Supported Ruby versions
|
85
85
|
|
@@ -781,6 +781,15 @@ module Google
|
|
781
781
|
# @return [Google::Apis::ClassroomV1::GradeCategory]
|
782
782
|
attr_accessor :grade_category
|
783
783
|
|
784
|
+
# Identifier of the grading period associated with the coursework. * At creation,
|
785
|
+
# if unspecified, the grading period ID will be set based on the `dueDate` (or `
|
786
|
+
# scheduledTime` if no `dueDate` is set). * To indicate no association to any
|
787
|
+
# grading period, set this field to an empty string (""). * If specified, it
|
788
|
+
# must match an existing grading period ID in the course.
|
789
|
+
# Corresponds to the JSON property `gradingPeriodId`
|
790
|
+
# @return [String]
|
791
|
+
attr_accessor :grading_period_id
|
792
|
+
|
784
793
|
# Classroom-assigned identifier of this course work, unique per course. Read-
|
785
794
|
# only.
|
786
795
|
# Corresponds to the JSON property `id`
|
@@ -865,6 +874,7 @@ module Google
|
|
865
874
|
@due_date = args[:due_date] if args.key?(:due_date)
|
866
875
|
@due_time = args[:due_time] if args.key?(:due_time)
|
867
876
|
@grade_category = args[:grade_category] if args.key?(:grade_category)
|
877
|
+
@grading_period_id = args[:grading_period_id] if args.key?(:grading_period_id)
|
868
878
|
@id = args[:id] if args.key?(:id)
|
869
879
|
@individual_students_options = args[:individual_students_options] if args.key?(:individual_students_options)
|
870
880
|
@materials = args[:materials] if args.key?(:materials)
|
@@ -1396,6 +1406,93 @@ module Google
|
|
1396
1406
|
end
|
1397
1407
|
end
|
1398
1408
|
|
1409
|
+
# An individual grading period. Grading periods must not have overlapping date
|
1410
|
+
# ranges and must be listed in chronological order. For example, if the end_date
|
1411
|
+
# of a grading period is 2024-01-25, then the start_date of the next grading
|
1412
|
+
# period must be 2024-01-26 or later. Each grading period must have a unique
|
1413
|
+
# title within a course.
|
1414
|
+
class GradingPeriod
|
1415
|
+
include Google::Apis::Core::Hashable
|
1416
|
+
|
1417
|
+
# Represents a whole or partial calendar date, such as a birthday. The time of
|
1418
|
+
# day and time zone are either specified elsewhere or are insignificant. The
|
1419
|
+
# date is relative to the Gregorian Calendar. This can represent one of the
|
1420
|
+
# following: * A full date, with non-zero year, month, and day values. * A month
|
1421
|
+
# and day, with a zero year (for example, an anniversary). * A year on its own,
|
1422
|
+
# with a zero month and a zero day. * A year and month, with a zero day (for
|
1423
|
+
# example, a credit card expiration date). Related types: * google.type.
|
1424
|
+
# TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
|
1425
|
+
# Corresponds to the JSON property `endDate`
|
1426
|
+
# @return [Google::Apis::ClassroomV1::Date]
|
1427
|
+
attr_accessor :end_date
|
1428
|
+
|
1429
|
+
# Output only. System generated grading period ID. Read-only.
|
1430
|
+
# Corresponds to the JSON property `id`
|
1431
|
+
# @return [String]
|
1432
|
+
attr_accessor :id
|
1433
|
+
|
1434
|
+
# Represents a whole or partial calendar date, such as a birthday. The time of
|
1435
|
+
# day and time zone are either specified elsewhere or are insignificant. The
|
1436
|
+
# date is relative to the Gregorian Calendar. This can represent one of the
|
1437
|
+
# following: * A full date, with non-zero year, month, and day values. * A month
|
1438
|
+
# and day, with a zero year (for example, an anniversary). * A year on its own,
|
1439
|
+
# with a zero month and a zero day. * A year and month, with a zero day (for
|
1440
|
+
# example, a credit card expiration date). Related types: * google.type.
|
1441
|
+
# TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
|
1442
|
+
# Corresponds to the JSON property `startDate`
|
1443
|
+
# @return [Google::Apis::ClassroomV1::Date]
|
1444
|
+
attr_accessor :start_date
|
1445
|
+
|
1446
|
+
# Required. Title of the grading period. For example, “Semester 1”.
|
1447
|
+
# Corresponds to the JSON property `title`
|
1448
|
+
# @return [String]
|
1449
|
+
attr_accessor :title
|
1450
|
+
|
1451
|
+
def initialize(**args)
|
1452
|
+
update!(**args)
|
1453
|
+
end
|
1454
|
+
|
1455
|
+
# Update properties of this object
|
1456
|
+
def update!(**args)
|
1457
|
+
@end_date = args[:end_date] if args.key?(:end_date)
|
1458
|
+
@id = args[:id] if args.key?(:id)
|
1459
|
+
@start_date = args[:start_date] if args.key?(:start_date)
|
1460
|
+
@title = args[:title] if args.key?(:title)
|
1461
|
+
end
|
1462
|
+
end
|
1463
|
+
|
1464
|
+
# Grading period settings that include all the individual grading periods in a
|
1465
|
+
# course.
|
1466
|
+
class GradingPeriodSettings
|
1467
|
+
include Google::Apis::Core::Hashable
|
1468
|
+
|
1469
|
+
# Supports toggling the application of grading periods on existing stream items.
|
1470
|
+
# Once set, this value is persisted meaning that it does not need to be set in
|
1471
|
+
# every request to update `GradingPeriodSettings`. If not previously set, the
|
1472
|
+
# default is False.
|
1473
|
+
# Corresponds to the JSON property `applyToExistingCoursework`
|
1474
|
+
# @return [Boolean]
|
1475
|
+
attr_accessor :apply_to_existing_coursework
|
1476
|
+
alias_method :apply_to_existing_coursework?, :apply_to_existing_coursework
|
1477
|
+
|
1478
|
+
# The list of grading periods in a specific course. Grading periods must not
|
1479
|
+
# have overlapping date ranges and must be listed in chronological order. Each
|
1480
|
+
# grading period must have a unique title within a course.
|
1481
|
+
# Corresponds to the JSON property `gradingPeriods`
|
1482
|
+
# @return [Array<Google::Apis::ClassroomV1::GradingPeriod>]
|
1483
|
+
attr_accessor :grading_periods
|
1484
|
+
|
1485
|
+
def initialize(**args)
|
1486
|
+
update!(**args)
|
1487
|
+
end
|
1488
|
+
|
1489
|
+
# Update properties of this object
|
1490
|
+
def update!(**args)
|
1491
|
+
@apply_to_existing_coursework = args[:apply_to_existing_coursework] if args.key?(:apply_to_existing_coursework)
|
1492
|
+
@grading_periods = args[:grading_periods] if args.key?(:grading_periods)
|
1493
|
+
end
|
1494
|
+
end
|
1495
|
+
|
1399
1496
|
# Association between a student and a guardian of that student. The guardian may
|
1400
1497
|
# receive information about the student's course work.
|
1401
1498
|
class Guardian
|
@@ -16,13 +16,13 @@ module Google
|
|
16
16
|
module Apis
|
17
17
|
module ClassroomV1
|
18
18
|
# Version of the google-apis-classroom_v1 gem
|
19
|
-
GEM_VERSION = "0.
|
19
|
+
GEM_VERSION = "0.42.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
22
|
GENERATOR_VERSION = "0.16.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20250420"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -196,6 +196,18 @@ module Google
|
|
196
196
|
include Google::Apis::Core::JsonObjectSupport
|
197
197
|
end
|
198
198
|
|
199
|
+
class GradingPeriod
|
200
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
201
|
+
|
202
|
+
include Google::Apis::Core::JsonObjectSupport
|
203
|
+
end
|
204
|
+
|
205
|
+
class GradingPeriodSettings
|
206
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
207
|
+
|
208
|
+
include Google::Apis::Core::JsonObjectSupport
|
209
|
+
end
|
210
|
+
|
199
211
|
class Guardian
|
200
212
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
201
213
|
|
@@ -674,6 +686,7 @@ module Google
|
|
674
686
|
|
675
687
|
property :grade_category, as: 'gradeCategory', class: Google::Apis::ClassroomV1::GradeCategory, decorator: Google::Apis::ClassroomV1::GradeCategory::Representation
|
676
688
|
|
689
|
+
property :grading_period_id, as: 'gradingPeriodId'
|
677
690
|
property :id, as: 'id'
|
678
691
|
property :individual_students_options, as: 'individualStudentsOptions', class: Google::Apis::ClassroomV1::IndividualStudentsOptions, decorator: Google::Apis::ClassroomV1::IndividualStudentsOptions::Representation
|
679
692
|
|
@@ -832,6 +845,27 @@ module Google
|
|
832
845
|
end
|
833
846
|
end
|
834
847
|
|
848
|
+
class GradingPeriod
|
849
|
+
# @private
|
850
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
851
|
+
property :end_date, as: 'endDate', class: Google::Apis::ClassroomV1::Date, decorator: Google::Apis::ClassroomV1::Date::Representation
|
852
|
+
|
853
|
+
property :id, as: 'id'
|
854
|
+
property :start_date, as: 'startDate', class: Google::Apis::ClassroomV1::Date, decorator: Google::Apis::ClassroomV1::Date::Representation
|
855
|
+
|
856
|
+
property :title, as: 'title'
|
857
|
+
end
|
858
|
+
end
|
859
|
+
|
860
|
+
class GradingPeriodSettings
|
861
|
+
# @private
|
862
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
863
|
+
property :apply_to_existing_coursework, as: 'applyToExistingCoursework'
|
864
|
+
collection :grading_periods, as: 'gradingPeriods', class: Google::Apis::ClassroomV1::GradingPeriod, decorator: Google::Apis::ClassroomV1::GradingPeriod::Representation
|
865
|
+
|
866
|
+
end
|
867
|
+
end
|
868
|
+
|
835
869
|
class Guardian
|
836
870
|
# @private
|
837
871
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -30,7 +30,7 @@ module Google
|
|
30
30
|
# Classroom = Google::Apis::ClassroomV1 # Alias the module
|
31
31
|
# service = Classroom::ClassroomService.new
|
32
32
|
#
|
33
|
-
# @see https://developers.google.com/classroom/
|
33
|
+
# @see https://developers.google.com/workspace/classroom/
|
34
34
|
class ClassroomService < Google::Apis::Core::BaseService
|
35
35
|
DEFAULT_ENDPOINT_TEMPLATE = "https://classroom.$UNIVERSE_DOMAIN$/"
|
36
36
|
|
@@ -158,6 +158,39 @@ module Google
|
|
158
158
|
execute_or_queue_command(command, &block)
|
159
159
|
end
|
160
160
|
|
161
|
+
# Returns the grading period settings in a course. This method returns the
|
162
|
+
# following error codes: * `PERMISSION_DENIED` if the requesting user isn't
|
163
|
+
# permitted to access the grading period settings in the requested course or for
|
164
|
+
# access errors. * `NOT_FOUND` if the requested course does not exist.
|
165
|
+
# @param [String] course_id
|
166
|
+
# Required. The identifier of the course.
|
167
|
+
# @param [String] fields
|
168
|
+
# Selector specifying which fields to include in a partial response.
|
169
|
+
# @param [String] quota_user
|
170
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
171
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
172
|
+
# @param [Google::Apis::RequestOptions] options
|
173
|
+
# Request-specific options
|
174
|
+
#
|
175
|
+
# @yield [result, err] Result & error if block supplied
|
176
|
+
# @yieldparam result [Google::Apis::ClassroomV1::GradingPeriodSettings] parsed result object
|
177
|
+
# @yieldparam err [StandardError] error object if request failed
|
178
|
+
#
|
179
|
+
# @return [Google::Apis::ClassroomV1::GradingPeriodSettings]
|
180
|
+
#
|
181
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
182
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
183
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
184
|
+
def get_course_grading_period_settings(course_id, fields: nil, quota_user: nil, options: nil, &block)
|
185
|
+
command = make_simple_command(:get, 'v1/courses/{courseId}/gradingPeriodSettings', options)
|
186
|
+
command.response_representation = Google::Apis::ClassroomV1::GradingPeriodSettings::Representation
|
187
|
+
command.response_class = Google::Apis::ClassroomV1::GradingPeriodSettings
|
188
|
+
command.params['courseId'] = course_id unless course_id.nil?
|
189
|
+
command.query['fields'] = fields unless fields.nil?
|
190
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
191
|
+
execute_or_queue_command(command, &block)
|
192
|
+
end
|
193
|
+
|
161
194
|
# Returns a list of courses that the requesting user is permitted to view,
|
162
195
|
# restricted to those that match the request. Returned courses are ordered by
|
163
196
|
# creation time, with the most recently created coming first. This method
|
@@ -303,6 +336,59 @@ module Google
|
|
303
336
|
execute_or_queue_command(command, &block)
|
304
337
|
end
|
305
338
|
|
339
|
+
# Updates grading period settings of a course. Individual grading periods can be
|
340
|
+
# added, removed, or modified using this method. The requesting user and course
|
341
|
+
# owner must be eligible to modify Grading Periods. For details, see [licensing
|
342
|
+
# requirements](https://developers.google.com/workspace/classroom/grading-
|
343
|
+
# periods/manage-grading-periods#licensing_requirements). This method returns
|
344
|
+
# the following error codes: * `PERMISSION_DENIED` if the requesting user is not
|
345
|
+
# permitted to modify the grading period settings in a course or for access
|
346
|
+
# errors: * UserIneligibleToUpdateGradingPeriodSettings * `INVALID_ARGUMENT` if
|
347
|
+
# the request is malformed. * `NOT_FOUND` if the requested course does not exist.
|
348
|
+
# @param [String] course_id
|
349
|
+
# Required. The identifier of the course.
|
350
|
+
# @param [Google::Apis::ClassroomV1::GradingPeriodSettings] grading_period_settings_object
|
351
|
+
# @param [String] update_mask
|
352
|
+
# Mask that identifies which fields in the GradingPeriodSettings to update. The
|
353
|
+
# GradingPeriodSettings `grading_periods` list will be fully replaced by the
|
354
|
+
# grading periods specified in the update request. For example: * Grading
|
355
|
+
# periods included in the list without an ID are considered additions, and a new
|
356
|
+
# ID will be assigned when the request is made. * Grading periods that currently
|
357
|
+
# exist, but are missing from the request will be considered deletions. *
|
358
|
+
# Grading periods with an existing ID and modified data are considered edits.
|
359
|
+
# Unmodified data will be left as is. * Grading periods included with an unknown
|
360
|
+
# ID will result in an error. The following fields may be specified: * `
|
361
|
+
# grading_periods` * `apply_to_existing_coursework`
|
362
|
+
# @param [String] fields
|
363
|
+
# Selector specifying which fields to include in a partial response.
|
364
|
+
# @param [String] quota_user
|
365
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
366
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
367
|
+
# @param [Google::Apis::RequestOptions] options
|
368
|
+
# Request-specific options
|
369
|
+
#
|
370
|
+
# @yield [result, err] Result & error if block supplied
|
371
|
+
# @yieldparam result [Google::Apis::ClassroomV1::GradingPeriodSettings] parsed result object
|
372
|
+
# @yieldparam err [StandardError] error object if request failed
|
373
|
+
#
|
374
|
+
# @return [Google::Apis::ClassroomV1::GradingPeriodSettings]
|
375
|
+
#
|
376
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
377
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
378
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
379
|
+
def update_course_grading_period_settings(course_id, grading_period_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
380
|
+
command = make_simple_command(:patch, 'v1/courses/{courseId}/gradingPeriodSettings', options)
|
381
|
+
command.request_representation = Google::Apis::ClassroomV1::GradingPeriodSettings::Representation
|
382
|
+
command.request_object = grading_period_settings_object
|
383
|
+
command.response_representation = Google::Apis::ClassroomV1::GradingPeriodSettings::Representation
|
384
|
+
command.response_class = Google::Apis::ClassroomV1::GradingPeriodSettings
|
385
|
+
command.params['courseId'] = course_id unless course_id.nil?
|
386
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
387
|
+
command.query['fields'] = fields unless fields.nil?
|
388
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
389
|
+
execute_or_queue_command(command, &block)
|
390
|
+
end
|
391
|
+
|
306
392
|
# Creates an alias for a course. This method returns the following error codes: *
|
307
393
|
# `PERMISSION_DENIED` if the requesting user is not permitted to create the
|
308
394
|
# alias or for access errors. * `NOT_FOUND` if the course does not exist. * `
|
@@ -547,9 +633,9 @@ module Google
|
|
547
633
|
# Gets metadata for Classroom add-ons in the context of a specific post. To
|
548
634
|
# maintain the integrity of its own data and permissions model, an add-on should
|
549
635
|
# call this to validate query parameters and the requesting user's role whenever
|
550
|
-
# the add-on is opened in an [iframe](https://developers.google.com/
|
551
|
-
# add-ons/get-started/iframes/iframes-overview). This method returns
|
552
|
-
# following error codes: * `PERMISSION_DENIED` for access errors. * `
|
636
|
+
# the add-on is opened in an [iframe](https://developers.google.com/workspace/
|
637
|
+
# classroom/add-ons/get-started/iframes/iframes-overview). This method returns
|
638
|
+
# the following error codes: * `PERMISSION_DENIED` for access errors. * `
|
553
639
|
# INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the
|
554
640
|
# identified resources does not exist.
|
555
641
|
# @param [String] course_id
|
@@ -567,8 +653,8 @@ module Google
|
|
567
653
|
# @param [String] attachment_id
|
568
654
|
# Optional. The identifier of the attachment. This field is required for all
|
569
655
|
# requests except when the user is in the [Attachment Discovery iframe](https://
|
570
|
-
# developers.google.com/classroom/add-ons/get-started/iframes/
|
571
|
-
# discovery-iframe).
|
656
|
+
# developers.google.com/workspace/classroom/add-ons/get-started/iframes/
|
657
|
+
# attachment-discovery-iframe).
|
572
658
|
# @param [String] post_id
|
573
659
|
# Optional. Deprecated, use `item_id` instead.
|
574
660
|
# @param [String] fields
|
@@ -1130,9 +1216,9 @@ module Google
|
|
1130
1216
|
# Gets metadata for Classroom add-ons in the context of a specific post. To
|
1131
1217
|
# maintain the integrity of its own data and permissions model, an add-on should
|
1132
1218
|
# call this to validate query parameters and the requesting user's role whenever
|
1133
|
-
# the add-on is opened in an [iframe](https://developers.google.com/
|
1134
|
-
# add-ons/get-started/iframes/iframes-overview). This method returns
|
1135
|
-
# following error codes: * `PERMISSION_DENIED` for access errors. * `
|
1219
|
+
# the add-on is opened in an [iframe](https://developers.google.com/workspace/
|
1220
|
+
# classroom/add-ons/get-started/iframes/iframes-overview). This method returns
|
1221
|
+
# the following error codes: * `PERMISSION_DENIED` for access errors. * `
|
1136
1222
|
# INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the
|
1137
1223
|
# identified resources does not exist.
|
1138
1224
|
# @param [String] course_id
|
@@ -1150,8 +1236,8 @@ module Google
|
|
1150
1236
|
# @param [String] attachment_id
|
1151
1237
|
# Optional. The identifier of the attachment. This field is required for all
|
1152
1238
|
# requests except when the user is in the [Attachment Discovery iframe](https://
|
1153
|
-
# developers.google.com/classroom/add-ons/get-started/iframes/
|
1154
|
-
# discovery-iframe).
|
1239
|
+
# developers.google.com/workspace/classroom/add-ons/get-started/iframes/
|
1240
|
+
# attachment-discovery-iframe).
|
1155
1241
|
# @param [String] post_id
|
1156
1242
|
# Optional. Deprecated, use `item_id` instead.
|
1157
1243
|
# @param [String] fields
|
@@ -1310,9 +1396,7 @@ module Google
|
|
1310
1396
|
# CourseWork` object, an `INVALID_ARGUMENT` error is returned. The following
|
1311
1397
|
# fields may be specified by teachers: * `title` * `description` * `state` * `
|
1312
1398
|
# due_date` * `due_time` * `max_points` * `scheduled_time` * `
|
1313
|
-
# submission_modification_mode` * `topic_id` * `grading_period_id`
|
1314
|
-
# V1_20240401_PREVIEW](https://developers.google.com/classroom/reference/preview)
|
1315
|
-
# and later.
|
1399
|
+
# submission_modification_mode` * `topic_id` * `grading_period_id`
|
1316
1400
|
# @param [String] fields
|
1317
1401
|
# Selector specifying which fields to include in a partial response.
|
1318
1402
|
# @param [String] quota_user
|
@@ -1348,19 +1432,19 @@ module Google
|
|
1348
1432
|
# can be updated. Rubric update capabilities are [limited](/classroom/rubrics/
|
1349
1433
|
# limitations) once grading has started. The requesting user and course owner
|
1350
1434
|
# must have rubrics creation capabilities. For details, see [licensing
|
1351
|
-
# requirements](https://developers.google.com/classroom/rubrics/
|
1352
|
-
# license-requirements). This request must be made by the Google
|
1353
|
-
# of the [OAuth client ID](https://support.google.com/cloud/answer/
|
1354
|
-
# to create the parent course work item. This method returns the
|
1355
|
-
# codes: * `PERMISSION_DENIED` if the requesting developer
|
1356
|
-
# the corresponding course work, if the user isn't
|
1357
|
-
# requested modification to the rubric, or for access
|
1358
|
-
# also returned if grading has already started on the
|
1359
|
-
# INVALID_ARGUMENT` if the request is malformed and for the following
|
1360
|
-
# error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested
|
1361
|
-
# course work, or rubric doesn't exist or if the user doesn't have
|
1362
|
-
# corresponding course work. * `INTERNAL` if grading has already
|
1363
|
-
# rubric.
|
1435
|
+
# requirements](https://developers.google.com/workspace/classroom/rubrics/
|
1436
|
+
# limitations#license-requirements). This request must be made by the Google
|
1437
|
+
# Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/
|
1438
|
+
# 6158849) used to create the parent course work item. This method returns the
|
1439
|
+
# following error codes: * `PERMISSION_DENIED` if the requesting developer
|
1440
|
+
# project didn't create the corresponding course work, if the user isn't
|
1441
|
+
# permitted to make the requested modification to the rubric, or for access
|
1442
|
+
# errors. This error code is also returned if grading has already started on the
|
1443
|
+
# rubric. * `INVALID_ARGUMENT` if the request is malformed and for the following
|
1444
|
+
# request error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested
|
1445
|
+
# course, course work, or rubric doesn't exist or if the user doesn't have
|
1446
|
+
# access to the corresponding course work. * `INTERNAL` if grading has already
|
1447
|
+
# started on the rubric.
|
1364
1448
|
# @param [String] course_id
|
1365
1449
|
# Required. Identifier of the course.
|
1366
1450
|
# @param [String] course_work_id
|
@@ -1771,18 +1855,19 @@ module Google
|
|
1771
1855
|
|
1772
1856
|
# Creates a rubric. The requesting user and course owner must have rubrics
|
1773
1857
|
# creation capabilities. For details, see [licensing requirements](https://
|
1774
|
-
# developers.google.com/classroom/rubrics/limitations#license-
|
1775
|
-
# further details, see [Rubrics structure and known
|
1776
|
-
# rubrics/limitations). This request must be made by the
|
1777
|
-
# the [OAuth client ID](https://support.google.com/cloud/
|
1778
|
-
# create the parent course work item. This method
|
1779
|
-
# codes: * `PERMISSION_DENIED` if the requesting
|
1780
|
-
# rubrics for course work in the requested course.
|
1781
|
-
# has insufficient OAuth scopes. * `
|
1782
|
-
# malformed and for the following request
|
1783
|
-
# * `NOT_FOUND` if the requested course
|
1784
|
-
# doesn't have access to the course or
|
1785
|
-
# the following request error: * `
|
1858
|
+
# developers.google.com/workspace/classroom/rubrics/limitations#license-
|
1859
|
+
# requirements). For further details, see [Rubrics structure and known
|
1860
|
+
# limitations](/classroom/rubrics/limitations). This request must be made by the
|
1861
|
+
# Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/
|
1862
|
+
# answer/6158849) used to create the parent course work item. This method
|
1863
|
+
# returns the following error codes: * `PERMISSION_DENIED` if the requesting
|
1864
|
+
# user isn't permitted to create rubrics for course work in the requested course.
|
1865
|
+
# * `INTERNAL` if the request has insufficient OAuth scopes. * `
|
1866
|
+
# INVALID_ARGUMENT` if the request is malformed and for the following request
|
1867
|
+
# error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested course
|
1868
|
+
# or course work don't exist or the user doesn't have access to the course or
|
1869
|
+
# course work. * `FAILED_PRECONDITION` for the following request error: * `
|
1870
|
+
# AttachmentNotVisible`
|
1786
1871
|
# @param [String] course_id
|
1787
1872
|
# Required. Identifier of the course.
|
1788
1873
|
# @param [String] course_work_id
|
@@ -1820,11 +1905,11 @@ module Google
|
|
1820
1905
|
|
1821
1906
|
# Deletes a rubric. The requesting user and course owner must have rubrics
|
1822
1907
|
# creation capabilities. For details, see [licensing requirements](https://
|
1823
|
-
# developers.google.com/classroom/rubrics/limitations#license-
|
1824
|
-
# This request must be made by the Google Cloud console of the [
|
1825
|
-
# https://support.google.com/cloud/answer/6158849) used to
|
1826
|
-
# corresponding rubric. This method returns the following error codes:
|
1827
|
-
# PERMISSION_DENIED` if the requesting developer project didn't create the
|
1908
|
+
# developers.google.com/workspace/classroom/rubrics/limitations#license-
|
1909
|
+
# requirements). This request must be made by the Google Cloud console of the [
|
1910
|
+
# OAuth client ID](https://support.google.com/cloud/answer/6158849) used to
|
1911
|
+
# create the corresponding rubric. This method returns the following error codes:
|
1912
|
+
# * `PERMISSION_DENIED` if the requesting developer project didn't create the
|
1828
1913
|
# corresponding rubric, or if the requesting user isn't permitted to delete the
|
1829
1914
|
# requested rubric. * `NOT_FOUND` if no rubric exists with the requested ID or
|
1830
1915
|
# the user does not have access to the course, course work, or rubric. * `
|
@@ -1953,19 +2038,19 @@ module Google
|
|
1953
2038
|
# can be updated. Rubric update capabilities are [limited](/classroom/rubrics/
|
1954
2039
|
# limitations) once grading has started. The requesting user and course owner
|
1955
2040
|
# must have rubrics creation capabilities. For details, see [licensing
|
1956
|
-
# requirements](https://developers.google.com/classroom/rubrics/
|
1957
|
-
# license-requirements). This request must be made by the Google
|
1958
|
-
# of the [OAuth client ID](https://support.google.com/cloud/answer/
|
1959
|
-
# to create the parent course work item. This method returns the
|
1960
|
-
# codes: * `PERMISSION_DENIED` if the requesting developer
|
1961
|
-
# the corresponding course work, if the user isn't
|
1962
|
-
# requested modification to the rubric, or for access
|
1963
|
-
# also returned if grading has already started on the
|
1964
|
-
# INVALID_ARGUMENT` if the request is malformed and for the following
|
1965
|
-
# error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested
|
1966
|
-
# course work, or rubric doesn't exist or if the user doesn't have
|
1967
|
-
# corresponding course work. * `INTERNAL` if grading has already
|
1968
|
-
# rubric.
|
2041
|
+
# requirements](https://developers.google.com/workspace/classroom/rubrics/
|
2042
|
+
# limitations#license-requirements). This request must be made by the Google
|
2043
|
+
# Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/
|
2044
|
+
# 6158849) used to create the parent course work item. This method returns the
|
2045
|
+
# following error codes: * `PERMISSION_DENIED` if the requesting developer
|
2046
|
+
# project didn't create the corresponding course work, if the user isn't
|
2047
|
+
# permitted to make the requested modification to the rubric, or for access
|
2048
|
+
# errors. This error code is also returned if grading has already started on the
|
2049
|
+
# rubric. * `INVALID_ARGUMENT` if the request is malformed and for the following
|
2050
|
+
# request error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested
|
2051
|
+
# course, course work, or rubric doesn't exist or if the user doesn't have
|
2052
|
+
# access to the corresponding course work. * `INTERNAL` if grading has already
|
2053
|
+
# started on the rubric.
|
1969
2054
|
# @param [String] course_id
|
1970
2055
|
# Required. Identifier of the course.
|
1971
2056
|
# @param [String] course_work_id
|
@@ -2509,9 +2594,9 @@ module Google
|
|
2509
2594
|
# Gets metadata for Classroom add-ons in the context of a specific post. To
|
2510
2595
|
# maintain the integrity of its own data and permissions model, an add-on should
|
2511
2596
|
# call this to validate query parameters and the requesting user's role whenever
|
2512
|
-
# the add-on is opened in an [iframe](https://developers.google.com/
|
2513
|
-
# add-ons/get-started/iframes/iframes-overview). This method returns
|
2514
|
-
# following error codes: * `PERMISSION_DENIED` for access errors. * `
|
2597
|
+
# the add-on is opened in an [iframe](https://developers.google.com/workspace/
|
2598
|
+
# classroom/add-ons/get-started/iframes/iframes-overview). This method returns
|
2599
|
+
# the following error codes: * `PERMISSION_DENIED` for access errors. * `
|
2515
2600
|
# INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the
|
2516
2601
|
# identified resources does not exist.
|
2517
2602
|
# @param [String] course_id
|
@@ -2529,8 +2614,8 @@ module Google
|
|
2529
2614
|
# @param [String] attachment_id
|
2530
2615
|
# Optional. The identifier of the attachment. This field is required for all
|
2531
2616
|
# requests except when the user is in the [Attachment Discovery iframe](https://
|
2532
|
-
# developers.google.com/classroom/add-ons/get-started/iframes/
|
2533
|
-
# discovery-iframe).
|
2617
|
+
# developers.google.com/workspace/classroom/add-ons/get-started/iframes/
|
2618
|
+
# attachment-discovery-iframe).
|
2534
2619
|
# @param [String] post_id
|
2535
2620
|
# Optional. Deprecated, use `item_id` instead.
|
2536
2621
|
# @param [String] fields
|
@@ -2937,9 +3022,9 @@ module Google
|
|
2937
3022
|
# Gets metadata for Classroom add-ons in the context of a specific post. To
|
2938
3023
|
# maintain the integrity of its own data and permissions model, an add-on should
|
2939
3024
|
# call this to validate query parameters and the requesting user's role whenever
|
2940
|
-
# the add-on is opened in an [iframe](https://developers.google.com/
|
2941
|
-
# add-ons/get-started/iframes/iframes-overview). This method returns
|
2942
|
-
# following error codes: * `PERMISSION_DENIED` for access errors. * `
|
3025
|
+
# the add-on is opened in an [iframe](https://developers.google.com/workspace/
|
3026
|
+
# classroom/add-ons/get-started/iframes/iframes-overview). This method returns
|
3027
|
+
# the following error codes: * `PERMISSION_DENIED` for access errors. * `
|
2943
3028
|
# INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the
|
2944
3029
|
# identified resources does not exist.
|
2945
3030
|
# @param [String] course_id
|
@@ -2955,8 +3040,8 @@ module Google
|
|
2955
3040
|
# @param [String] attachment_id
|
2956
3041
|
# Optional. The identifier of the attachment. This field is required for all
|
2957
3042
|
# requests except when the user is in the [Attachment Discovery iframe](https://
|
2958
|
-
# developers.google.com/classroom/add-ons/get-started/iframes/
|
2959
|
-
# discovery-iframe).
|
3043
|
+
# developers.google.com/workspace/classroom/add-ons/get-started/iframes/
|
3044
|
+
# attachment-discovery-iframe).
|
2960
3045
|
# @param [String] item_id
|
2961
3046
|
# Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under
|
2962
3047
|
# which the attachment is attached. This field is required, but is not marked as
|
@@ -3350,10 +3435,10 @@ module Google
|
|
3350
3435
|
end
|
3351
3436
|
|
3352
3437
|
# Adds a user as a student of a course. Domain administrators are permitted to [
|
3353
|
-
# directly add](https://developers.google.com/classroom/guides/manage-
|
3354
|
-
# users within their domain as students to courses within their domain.
|
3355
|
-
# are permitted to add themselves to a course using an enrollment code.
|
3356
|
-
# method returns the following error codes: * `PERMISSION_DENIED` if the
|
3438
|
+
# directly add](https://developers.google.com/workspace/classroom/guides/manage-
|
3439
|
+
# users) users within their domain as students to courses within their domain.
|
3440
|
+
# Students are permitted to add themselves to a course using an enrollment code.
|
3441
|
+
# This method returns the following error codes: * `PERMISSION_DENIED` if the
|
3357
3442
|
# requesting user is not permitted to create students in this course or for
|
3358
3443
|
# access errors. * `NOT_FOUND` if the requested course ID does not exist. * `
|
3359
3444
|
# FAILED_PRECONDITION` if the requested user's account is disabled, for the
|
@@ -3519,9 +3604,9 @@ module Google
|
|
3519
3604
|
end
|
3520
3605
|
|
3521
3606
|
# Creates a teacher of a course. Domain administrators are permitted to [
|
3522
|
-
# directly add](https://developers.google.com/classroom/guides/manage-
|
3523
|
-
# users within their domain as teachers to courses within their domain.
|
3524
|
-
# admin users should send an Invitation instead. This method returns the
|
3607
|
+
# directly add](https://developers.google.com/workspace/classroom/guides/manage-
|
3608
|
+
# users) users within their domain as teachers to courses within their domain.
|
3609
|
+
# Non-admin users should send an Invitation instead. This method returns the
|
3525
3610
|
# following error codes: * `PERMISSION_DENIED` if the requesting user is not
|
3526
3611
|
# permitted to create teachers in this course or for access errors. * `NOT_FOUND`
|
3527
3612
|
# if the requested course ID does not exist. * `FAILED_PRECONDITION` if the
|
@@ -23,7 +23,7 @@ module Google
|
|
23
23
|
#
|
24
24
|
# Manages classes, rosters, and invitations in Google Classroom.
|
25
25
|
#
|
26
|
-
# @see https://developers.google.com/classroom/
|
26
|
+
# @see https://developers.google.com/workspace/classroom/
|
27
27
|
module ClassroomV1
|
28
28
|
# Version of the Google Classroom API this client connects to.
|
29
29
|
# This is NOT the gem version.
|
metadata
CHANGED
@@ -1,13 +1,13 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-classroom_v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.42.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
bindir: bin
|
9
9
|
cert_chain: []
|
10
|
-
date: 2025-
|
10
|
+
date: 2025-04-27 00:00:00.000000000 Z
|
11
11
|
dependencies:
|
12
12
|
- !ruby/object:Gem::Dependency
|
13
13
|
name: google-apis-core
|
@@ -57,7 +57,7 @@ licenses:
|
|
57
57
|
metadata:
|
58
58
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
59
59
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-classroom_v1/CHANGELOG.md
|
60
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-classroom_v1/v0.
|
60
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-classroom_v1/v0.42.0
|
61
61
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-classroom_v1
|
62
62
|
rdoc_options: []
|
63
63
|
require_paths:
|