google-apis-classroom_v1 0.48.0 → 0.50.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
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 3f6059b1c17b6ae7f9273ca5a7be8538b2727cf656f65854d553831f3e300e47
|
|
4
|
+
data.tar.gz: 006056da31cce0e7af49dd125db63fe256779bd59c0ebf53ed3b0715ff92d5ff
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 8349dce42719b2662ea58d121b62c2eb0da2f7c1dfa93c39fdf4a2bef5ec21823d5804840a94eeb2f54289e43338a6e86c4148b935d00e619808d753a1f05a7c
|
|
7
|
+
data.tar.gz: 2d5a2fc0a6ec2b61108a3a741976ba30665205821331ab1ed915e86641684a66597c700042aec5a1e397282ffbc0b4110571ba04361900823427139ca21f92c2
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# Release history for google-apis-classroom_v1
|
|
2
2
|
|
|
3
|
+
### v0.50.0 (2026-01-18)
|
|
4
|
+
|
|
5
|
+
* Regenerated from discovery document revision 20260111
|
|
6
|
+
|
|
7
|
+
### v0.49.0 (2026-01-11)
|
|
8
|
+
|
|
9
|
+
* Regenerated from discovery document revision 20260106
|
|
10
|
+
|
|
3
11
|
### v0.48.0 (2025-12-07)
|
|
4
12
|
|
|
5
13
|
* Regenerated from discovery document revision 20251202
|
|
@@ -544,6 +544,11 @@ module Google
|
|
|
544
544
|
# @return [String]
|
|
545
545
|
attr_accessor :section
|
|
546
546
|
|
|
547
|
+
# Optional. The subject of the course.
|
|
548
|
+
# Corresponds to the JSON property `subject`
|
|
549
|
+
# @return [String]
|
|
550
|
+
attr_accessor :subject
|
|
551
|
+
|
|
547
552
|
# Representation of a Google Drive folder.
|
|
548
553
|
# Corresponds to the JSON property `teacherFolder`
|
|
549
554
|
# @return [Google::Apis::ClassroomV1::DriveFolder]
|
|
@@ -584,6 +589,7 @@ module Google
|
|
|
584
589
|
@owner_id = args[:owner_id] if args.key?(:owner_id)
|
|
585
590
|
@room = args[:room] if args.key?(:room)
|
|
586
591
|
@section = args[:section] if args.key?(:section)
|
|
592
|
+
@subject = args[:subject] if args.key?(:subject)
|
|
587
593
|
@teacher_folder = args[:teacher_folder] if args.key?(:teacher_folder)
|
|
588
594
|
@teacher_group_email = args[:teacher_group_email] if args.key?(:teacher_group_email)
|
|
589
595
|
@update_time = args[:update_time] if args.key?(:update_time)
|
|
@@ -2000,6 +2006,58 @@ module Google
|
|
|
2000
2006
|
end
|
|
2001
2007
|
end
|
|
2002
2008
|
|
|
2009
|
+
# Response when listing students in a group.
|
|
2010
|
+
class ListStudentGroupMembersResponse
|
|
2011
|
+
include Google::Apis::Core::Hashable
|
|
2012
|
+
|
|
2013
|
+
# Token identifying the next page of results to return. If empty, no further
|
|
2014
|
+
# results are available.
|
|
2015
|
+
# Corresponds to the JSON property `nextPageToken`
|
|
2016
|
+
# @return [String]
|
|
2017
|
+
attr_accessor :next_page_token
|
|
2018
|
+
|
|
2019
|
+
# The student group members.
|
|
2020
|
+
# Corresponds to the JSON property `studentGroupMembers`
|
|
2021
|
+
# @return [Array<Google::Apis::ClassroomV1::StudentGroupMember>]
|
|
2022
|
+
attr_accessor :student_group_members
|
|
2023
|
+
|
|
2024
|
+
def initialize(**args)
|
|
2025
|
+
update!(**args)
|
|
2026
|
+
end
|
|
2027
|
+
|
|
2028
|
+
# Update properties of this object
|
|
2029
|
+
def update!(**args)
|
|
2030
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
|
2031
|
+
@student_group_members = args[:student_group_members] if args.key?(:student_group_members)
|
|
2032
|
+
end
|
|
2033
|
+
end
|
|
2034
|
+
|
|
2035
|
+
# Response when listing student groups.
|
|
2036
|
+
class ListStudentGroupsResponse
|
|
2037
|
+
include Google::Apis::Core::Hashable
|
|
2038
|
+
|
|
2039
|
+
# Token identifying the next page of results to return. If empty, no further
|
|
2040
|
+
# results are available.
|
|
2041
|
+
# Corresponds to the JSON property `nextPageToken`
|
|
2042
|
+
# @return [String]
|
|
2043
|
+
attr_accessor :next_page_token
|
|
2044
|
+
|
|
2045
|
+
# The student groups.
|
|
2046
|
+
# Corresponds to the JSON property `studentGroups`
|
|
2047
|
+
# @return [Array<Google::Apis::ClassroomV1::StudentGroup>]
|
|
2048
|
+
attr_accessor :student_groups
|
|
2049
|
+
|
|
2050
|
+
def initialize(**args)
|
|
2051
|
+
update!(**args)
|
|
2052
|
+
end
|
|
2053
|
+
|
|
2054
|
+
# Update properties of this object
|
|
2055
|
+
def update!(**args)
|
|
2056
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
|
2057
|
+
@student_groups = args[:student_groups] if args.key?(:student_groups)
|
|
2058
|
+
end
|
|
2059
|
+
end
|
|
2060
|
+
|
|
2003
2061
|
# Response when listing student submissions.
|
|
2004
2062
|
class ListStudentSubmissionsResponse
|
|
2005
2063
|
include Google::Apis::Core::Hashable
|
|
@@ -2657,6 +2715,68 @@ module Google
|
|
|
2657
2715
|
end
|
|
2658
2716
|
end
|
|
2659
2717
|
|
|
2718
|
+
# A student group in a course.
|
|
2719
|
+
class StudentGroup
|
|
2720
|
+
include Google::Apis::Core::Hashable
|
|
2721
|
+
|
|
2722
|
+
# The identifier of the course.
|
|
2723
|
+
# Corresponds to the JSON property `courseId`
|
|
2724
|
+
# @return [String]
|
|
2725
|
+
attr_accessor :course_id
|
|
2726
|
+
|
|
2727
|
+
# The identifier of the student group.
|
|
2728
|
+
# Corresponds to the JSON property `id`
|
|
2729
|
+
# @return [String]
|
|
2730
|
+
attr_accessor :id
|
|
2731
|
+
|
|
2732
|
+
# The title of the student group.
|
|
2733
|
+
# Corresponds to the JSON property `title`
|
|
2734
|
+
# @return [String]
|
|
2735
|
+
attr_accessor :title
|
|
2736
|
+
|
|
2737
|
+
def initialize(**args)
|
|
2738
|
+
update!(**args)
|
|
2739
|
+
end
|
|
2740
|
+
|
|
2741
|
+
# Update properties of this object
|
|
2742
|
+
def update!(**args)
|
|
2743
|
+
@course_id = args[:course_id] if args.key?(:course_id)
|
|
2744
|
+
@id = args[:id] if args.key?(:id)
|
|
2745
|
+
@title = args[:title] if args.key?(:title)
|
|
2746
|
+
end
|
|
2747
|
+
end
|
|
2748
|
+
|
|
2749
|
+
# A student member in a student group.
|
|
2750
|
+
class StudentGroupMember
|
|
2751
|
+
include Google::Apis::Core::Hashable
|
|
2752
|
+
|
|
2753
|
+
# The identifier of the course.
|
|
2754
|
+
# Corresponds to the JSON property `courseId`
|
|
2755
|
+
# @return [String]
|
|
2756
|
+
attr_accessor :course_id
|
|
2757
|
+
|
|
2758
|
+
# The identifier of the student group.
|
|
2759
|
+
# Corresponds to the JSON property `studentGroupId`
|
|
2760
|
+
# @return [String]
|
|
2761
|
+
attr_accessor :student_group_id
|
|
2762
|
+
|
|
2763
|
+
# Identifier of the student.
|
|
2764
|
+
# Corresponds to the JSON property `userId`
|
|
2765
|
+
# @return [String]
|
|
2766
|
+
attr_accessor :user_id
|
|
2767
|
+
|
|
2768
|
+
def initialize(**args)
|
|
2769
|
+
update!(**args)
|
|
2770
|
+
end
|
|
2771
|
+
|
|
2772
|
+
# Update properties of this object
|
|
2773
|
+
def update!(**args)
|
|
2774
|
+
@course_id = args[:course_id] if args.key?(:course_id)
|
|
2775
|
+
@student_group_id = args[:student_group_id] if args.key?(:student_group_id)
|
|
2776
|
+
@user_id = args[:user_id] if args.key?(:user_id)
|
|
2777
|
+
end
|
|
2778
|
+
end
|
|
2779
|
+
|
|
2660
2780
|
# Student submission for course work. `StudentSubmission` items are generated
|
|
2661
2781
|
# when a `CourseWork` item is created. Student submissions that have never been
|
|
2662
2782
|
# accessed (i.e. with `state` = NEW) may not have a creation time or update time.
|
|
@@ -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.50.0"
|
|
20
20
|
|
|
21
21
|
# Version of the code generator used to generate this client
|
|
22
22
|
GENERATOR_VERSION = "0.18.0"
|
|
23
23
|
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
|
25
|
-
REVISION = "
|
|
25
|
+
REVISION = "20260111"
|
|
26
26
|
end
|
|
27
27
|
end
|
|
28
28
|
end
|
|
@@ -310,6 +310,18 @@ module Google
|
|
|
310
310
|
include Google::Apis::Core::JsonObjectSupport
|
|
311
311
|
end
|
|
312
312
|
|
|
313
|
+
class ListStudentGroupMembersResponse
|
|
314
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
315
|
+
|
|
316
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
317
|
+
end
|
|
318
|
+
|
|
319
|
+
class ListStudentGroupsResponse
|
|
320
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
321
|
+
|
|
322
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
323
|
+
end
|
|
324
|
+
|
|
313
325
|
class ListStudentSubmissionsResponse
|
|
314
326
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
315
327
|
|
|
@@ -448,6 +460,18 @@ module Google
|
|
|
448
460
|
include Google::Apis::Core::JsonObjectSupport
|
|
449
461
|
end
|
|
450
462
|
|
|
463
|
+
class StudentGroup
|
|
464
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
465
|
+
|
|
466
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
467
|
+
end
|
|
468
|
+
|
|
469
|
+
class StudentGroupMember
|
|
470
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
471
|
+
|
|
472
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
473
|
+
end
|
|
474
|
+
|
|
451
475
|
class StudentSubmission
|
|
452
476
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
453
477
|
|
|
@@ -636,6 +660,7 @@ module Google
|
|
|
636
660
|
property :owner_id, as: 'ownerId'
|
|
637
661
|
property :room, as: 'room'
|
|
638
662
|
property :section, as: 'section'
|
|
663
|
+
property :subject, as: 'subject'
|
|
639
664
|
property :teacher_folder, as: 'teacherFolder', class: Google::Apis::ClassroomV1::DriveFolder, decorator: Google::Apis::ClassroomV1::DriveFolder::Representation
|
|
640
665
|
|
|
641
666
|
property :teacher_group_email, as: 'teacherGroupEmail'
|
|
@@ -1035,6 +1060,24 @@ module Google
|
|
|
1035
1060
|
end
|
|
1036
1061
|
end
|
|
1037
1062
|
|
|
1063
|
+
class ListStudentGroupMembersResponse
|
|
1064
|
+
# @private
|
|
1065
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1066
|
+
property :next_page_token, as: 'nextPageToken'
|
|
1067
|
+
collection :student_group_members, as: 'studentGroupMembers', class: Google::Apis::ClassroomV1::StudentGroupMember, decorator: Google::Apis::ClassroomV1::StudentGroupMember::Representation
|
|
1068
|
+
|
|
1069
|
+
end
|
|
1070
|
+
end
|
|
1071
|
+
|
|
1072
|
+
class ListStudentGroupsResponse
|
|
1073
|
+
# @private
|
|
1074
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1075
|
+
property :next_page_token, as: 'nextPageToken'
|
|
1076
|
+
collection :student_groups, as: 'studentGroups', class: Google::Apis::ClassroomV1::StudentGroup, decorator: Google::Apis::ClassroomV1::StudentGroup::Representation
|
|
1077
|
+
|
|
1078
|
+
end
|
|
1079
|
+
end
|
|
1080
|
+
|
|
1038
1081
|
class ListStudentSubmissionsResponse
|
|
1039
1082
|
# @private
|
|
1040
1083
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -1246,6 +1289,24 @@ module Google
|
|
|
1246
1289
|
end
|
|
1247
1290
|
end
|
|
1248
1291
|
|
|
1292
|
+
class StudentGroup
|
|
1293
|
+
# @private
|
|
1294
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1295
|
+
property :course_id, as: 'courseId'
|
|
1296
|
+
property :id, as: 'id'
|
|
1297
|
+
property :title, as: 'title'
|
|
1298
|
+
end
|
|
1299
|
+
end
|
|
1300
|
+
|
|
1301
|
+
class StudentGroupMember
|
|
1302
|
+
# @private
|
|
1303
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1304
|
+
property :course_id, as: 'courseId'
|
|
1305
|
+
property :student_group_id, as: 'studentGroupId'
|
|
1306
|
+
property :user_id, as: 'userId'
|
|
1307
|
+
end
|
|
1308
|
+
end
|
|
1309
|
+
|
|
1249
1310
|
class StudentSubmission
|
|
1250
1311
|
# @private
|
|
1251
1312
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -2147,11 +2147,11 @@ module Google
|
|
|
2147
2147
|
end
|
|
2148
2148
|
|
|
2149
2149
|
# Returns a list of student submissions that the requester is permitted to view,
|
|
2150
|
-
# factoring in the OAuth scopes of the request. `-` may be specified
|
|
2151
|
-
# course_work_id` to include student submissions for multiple course
|
|
2152
|
-
# Course students may only view their own work. Course teachers and
|
|
2153
|
-
# administrators may view all student submissions. This method returns
|
|
2154
|
-
# following error codes: * `PERMISSION_DENIED` if the requesting user is not
|
|
2150
|
+
# factoring in the OAuth scopes of the request. A hyphen (`-`) may be specified
|
|
2151
|
+
# as the `course_work_id` to include student submissions for multiple course
|
|
2152
|
+
# work items. Course students may only view their own work. Course teachers and
|
|
2153
|
+
# domain administrators may view all student submissions. This method returns
|
|
2154
|
+
# the following error codes: * `PERMISSION_DENIED` if the requesting user is not
|
|
2155
2155
|
# permitted to access the requested course or course work, or for access errors.
|
|
2156
2156
|
# * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the
|
|
2157
2157
|
# requested course does not exist.
|
|
@@ -3437,6 +3437,294 @@ module Google
|
|
|
3437
3437
|
execute_or_queue_command(command, &block)
|
|
3438
3438
|
end
|
|
3439
3439
|
|
|
3440
|
+
# Creates a student group for a course. This method returns the following error
|
|
3441
|
+
# codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create
|
|
3442
|
+
# the student group or for access errors. * `NOT_FOUND` if the course does not
|
|
3443
|
+
# exist or the requesting user doesn't have access to the course. * `
|
|
3444
|
+
# FAILED_PRECONDITION` if creating the student group would exceed the maximum
|
|
3445
|
+
# number of student groups per course.
|
|
3446
|
+
# @param [String] course_id
|
|
3447
|
+
# Required. The identifier of the course.
|
|
3448
|
+
# @param [Google::Apis::ClassroomV1::StudentGroup] student_group_object
|
|
3449
|
+
# @param [String] fields
|
|
3450
|
+
# Selector specifying which fields to include in a partial response.
|
|
3451
|
+
# @param [String] quota_user
|
|
3452
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
3453
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
3454
|
+
# @param [Google::Apis::RequestOptions] options
|
|
3455
|
+
# Request-specific options
|
|
3456
|
+
#
|
|
3457
|
+
# @yield [result, err] Result & error if block supplied
|
|
3458
|
+
# @yieldparam result [Google::Apis::ClassroomV1::StudentGroup] parsed result object
|
|
3459
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
3460
|
+
#
|
|
3461
|
+
# @return [Google::Apis::ClassroomV1::StudentGroup]
|
|
3462
|
+
#
|
|
3463
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
3464
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
3465
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
3466
|
+
def create_course_student_group(course_id, student_group_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
3467
|
+
command = make_simple_command(:post, 'v1/courses/{courseId}/studentGroups', options)
|
|
3468
|
+
command.request_representation = Google::Apis::ClassroomV1::StudentGroup::Representation
|
|
3469
|
+
command.request_object = student_group_object
|
|
3470
|
+
command.response_representation = Google::Apis::ClassroomV1::StudentGroup::Representation
|
|
3471
|
+
command.response_class = Google::Apis::ClassroomV1::StudentGroup
|
|
3472
|
+
command.params['courseId'] = course_id unless course_id.nil?
|
|
3473
|
+
command.query['fields'] = fields unless fields.nil?
|
|
3474
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
3475
|
+
execute_or_queue_command(command, &block)
|
|
3476
|
+
end
|
|
3477
|
+
|
|
3478
|
+
# Deletes a student group. This method returns the following error codes: * `
|
|
3479
|
+
# PERMISSION_DENIED` if the requesting user is not permitted to delete the
|
|
3480
|
+
# requested student group or for access errors. * `NOT_FOUND` if the student
|
|
3481
|
+
# group does not exist or the user does not have access to the student group.
|
|
3482
|
+
# @param [String] course_id
|
|
3483
|
+
# Required. The identifier of the course containing the student group to delete.
|
|
3484
|
+
# @param [String] id
|
|
3485
|
+
# Required. The identifier of the student group to delete.
|
|
3486
|
+
# @param [String] fields
|
|
3487
|
+
# Selector specifying which fields to include in a partial response.
|
|
3488
|
+
# @param [String] quota_user
|
|
3489
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
3490
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
3491
|
+
# @param [Google::Apis::RequestOptions] options
|
|
3492
|
+
# Request-specific options
|
|
3493
|
+
#
|
|
3494
|
+
# @yield [result, err] Result & error if block supplied
|
|
3495
|
+
# @yieldparam result [Google::Apis::ClassroomV1::Empty] parsed result object
|
|
3496
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
3497
|
+
#
|
|
3498
|
+
# @return [Google::Apis::ClassroomV1::Empty]
|
|
3499
|
+
#
|
|
3500
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
3501
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
3502
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
3503
|
+
def delete_course_student_group(course_id, id, fields: nil, quota_user: nil, options: nil, &block)
|
|
3504
|
+
command = make_simple_command(:delete, 'v1/courses/{courseId}/studentGroups/{id}', options)
|
|
3505
|
+
command.response_representation = Google::Apis::ClassroomV1::Empty::Representation
|
|
3506
|
+
command.response_class = Google::Apis::ClassroomV1::Empty
|
|
3507
|
+
command.params['courseId'] = course_id unless course_id.nil?
|
|
3508
|
+
command.params['id'] = id unless id.nil?
|
|
3509
|
+
command.query['fields'] = fields unless fields.nil?
|
|
3510
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
3511
|
+
execute_or_queue_command(command, &block)
|
|
3512
|
+
end
|
|
3513
|
+
|
|
3514
|
+
# Returns a list of groups in a course. This method returns the following error
|
|
3515
|
+
# codes: * `NOT_FOUND` if the course does not exist.
|
|
3516
|
+
# @param [String] course_id
|
|
3517
|
+
# Required. The identifier of the course.
|
|
3518
|
+
# @param [Fixnum] page_size
|
|
3519
|
+
# Maximum number of items to return. Zero or unspecified indicates that the
|
|
3520
|
+
# server may assign a maximum, which is currently set to 75 items. The server
|
|
3521
|
+
# may return fewer than the specified number of results.
|
|
3522
|
+
# @param [String] page_token
|
|
3523
|
+
# nextPageToken value returned from a previous list call, indicating that the
|
|
3524
|
+
# subsequent page of results should be returned. The list request must be
|
|
3525
|
+
# otherwise identical to the one that resulted in this token.
|
|
3526
|
+
# @param [String] fields
|
|
3527
|
+
# Selector specifying which fields to include in a partial response.
|
|
3528
|
+
# @param [String] quota_user
|
|
3529
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
3530
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
3531
|
+
# @param [Google::Apis::RequestOptions] options
|
|
3532
|
+
# Request-specific options
|
|
3533
|
+
#
|
|
3534
|
+
# @yield [result, err] Result & error if block supplied
|
|
3535
|
+
# @yieldparam result [Google::Apis::ClassroomV1::ListStudentGroupsResponse] parsed result object
|
|
3536
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
3537
|
+
#
|
|
3538
|
+
# @return [Google::Apis::ClassroomV1::ListStudentGroupsResponse]
|
|
3539
|
+
#
|
|
3540
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
3541
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
3542
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
3543
|
+
def list_course_student_groups(course_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
3544
|
+
command = make_simple_command(:get, 'v1/courses/{courseId}/studentGroups', options)
|
|
3545
|
+
command.response_representation = Google::Apis::ClassroomV1::ListStudentGroupsResponse::Representation
|
|
3546
|
+
command.response_class = Google::Apis::ClassroomV1::ListStudentGroupsResponse
|
|
3547
|
+
command.params['courseId'] = course_id unless course_id.nil?
|
|
3548
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
3549
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
3550
|
+
command.query['fields'] = fields unless fields.nil?
|
|
3551
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
3552
|
+
execute_or_queue_command(command, &block)
|
|
3553
|
+
end
|
|
3554
|
+
|
|
3555
|
+
# Updates one or more fields in a student group. This method returns the
|
|
3556
|
+
# following error codes: * `PERMISSION_DENIED` if the requesting user is not
|
|
3557
|
+
# permitted to modify the requested student group or for access errors. * `
|
|
3558
|
+
# NOT_FOUND` if the student group does not exist or the user does not have
|
|
3559
|
+
# access to the student group. * `INVALID_ARGUMENT` if invalid fields are
|
|
3560
|
+
# specified in the update mask or if no update mask is supplied.
|
|
3561
|
+
# @param [String] course_id
|
|
3562
|
+
# Required. Identifier of the course.
|
|
3563
|
+
# @param [String] id
|
|
3564
|
+
# Required. Identifier of the student group.
|
|
3565
|
+
# @param [Google::Apis::ClassroomV1::StudentGroup] student_group_object
|
|
3566
|
+
# @param [String] update_mask
|
|
3567
|
+
# Required. Mask that identifies which fields on the student group to update.
|
|
3568
|
+
# This field is required to do an update. The update fails if invalid fields are
|
|
3569
|
+
# specified. The following fields can be specified by teachers: * `title`
|
|
3570
|
+
# @param [String] fields
|
|
3571
|
+
# Selector specifying which fields to include in a partial response.
|
|
3572
|
+
# @param [String] quota_user
|
|
3573
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
3574
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
3575
|
+
# @param [Google::Apis::RequestOptions] options
|
|
3576
|
+
# Request-specific options
|
|
3577
|
+
#
|
|
3578
|
+
# @yield [result, err] Result & error if block supplied
|
|
3579
|
+
# @yieldparam result [Google::Apis::ClassroomV1::StudentGroup] parsed result object
|
|
3580
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
3581
|
+
#
|
|
3582
|
+
# @return [Google::Apis::ClassroomV1::StudentGroup]
|
|
3583
|
+
#
|
|
3584
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
3585
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
3586
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
3587
|
+
def patch_course_student_group(course_id, id, student_group_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
3588
|
+
command = make_simple_command(:patch, 'v1/courses/{courseId}/studentGroups/{id}', options)
|
|
3589
|
+
command.request_representation = Google::Apis::ClassroomV1::StudentGroup::Representation
|
|
3590
|
+
command.request_object = student_group_object
|
|
3591
|
+
command.response_representation = Google::Apis::ClassroomV1::StudentGroup::Representation
|
|
3592
|
+
command.response_class = Google::Apis::ClassroomV1::StudentGroup
|
|
3593
|
+
command.params['courseId'] = course_id unless course_id.nil?
|
|
3594
|
+
command.params['id'] = id unless id.nil?
|
|
3595
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
3596
|
+
command.query['fields'] = fields unless fields.nil?
|
|
3597
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
3598
|
+
execute_or_queue_command(command, &block)
|
|
3599
|
+
end
|
|
3600
|
+
|
|
3601
|
+
# Creates a student group member for a student group. This method returns the
|
|
3602
|
+
# following error codes: * `PERMISSION_DENIED` if the requesting user is not
|
|
3603
|
+
# permitted to create the student group or member for access errors. * `
|
|
3604
|
+
# NOT_FOUND` if the student group does not exist or the user does not have
|
|
3605
|
+
# access to the student group. * `ALREADY_EXISTS` if the student group member
|
|
3606
|
+
# already exists. * `FAILED_PRECONDITION` if attempting to add a member to a
|
|
3607
|
+
# student group that has reached its member limit.
|
|
3608
|
+
# @param [String] course_id
|
|
3609
|
+
# Required. The identifier of the course.
|
|
3610
|
+
# @param [String] student_group_id
|
|
3611
|
+
# Required. The identifier of the student group.
|
|
3612
|
+
# @param [Google::Apis::ClassroomV1::StudentGroupMember] student_group_member_object
|
|
3613
|
+
# @param [String] fields
|
|
3614
|
+
# Selector specifying which fields to include in a partial response.
|
|
3615
|
+
# @param [String] quota_user
|
|
3616
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
3617
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
3618
|
+
# @param [Google::Apis::RequestOptions] options
|
|
3619
|
+
# Request-specific options
|
|
3620
|
+
#
|
|
3621
|
+
# @yield [result, err] Result & error if block supplied
|
|
3622
|
+
# @yieldparam result [Google::Apis::ClassroomV1::StudentGroupMember] parsed result object
|
|
3623
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
3624
|
+
#
|
|
3625
|
+
# @return [Google::Apis::ClassroomV1::StudentGroupMember]
|
|
3626
|
+
#
|
|
3627
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
3628
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
3629
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
3630
|
+
def create_course_student_group_student_group_member(course_id, student_group_id, student_group_member_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
3631
|
+
command = make_simple_command(:post, 'v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers', options)
|
|
3632
|
+
command.request_representation = Google::Apis::ClassroomV1::StudentGroupMember::Representation
|
|
3633
|
+
command.request_object = student_group_member_object
|
|
3634
|
+
command.response_representation = Google::Apis::ClassroomV1::StudentGroupMember::Representation
|
|
3635
|
+
command.response_class = Google::Apis::ClassroomV1::StudentGroupMember
|
|
3636
|
+
command.params['courseId'] = course_id unless course_id.nil?
|
|
3637
|
+
command.params['studentGroupId'] = student_group_id unless student_group_id.nil?
|
|
3638
|
+
command.query['fields'] = fields unless fields.nil?
|
|
3639
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
3640
|
+
execute_or_queue_command(command, &block)
|
|
3641
|
+
end
|
|
3642
|
+
|
|
3643
|
+
# Deletes a student group member. This method returns the following error codes:
|
|
3644
|
+
# * `PERMISSION_DENIED` if the requesting user is not permitted to delete the
|
|
3645
|
+
# requested student group member or for access errors. * `NOT_FOUND` if the
|
|
3646
|
+
# student group member does not exist or the user does not have access to the
|
|
3647
|
+
# student group.
|
|
3648
|
+
# @param [String] course_id
|
|
3649
|
+
# Required. The identifier of the course containing the relevant student group.
|
|
3650
|
+
# @param [String] student_group_id
|
|
3651
|
+
# Required. The identifier of the student group containing the student group
|
|
3652
|
+
# member to delete.
|
|
3653
|
+
# @param [String] user_id
|
|
3654
|
+
# Required. The identifier of the student group member to delete.
|
|
3655
|
+
# @param [String] fields
|
|
3656
|
+
# Selector specifying which fields to include in a partial response.
|
|
3657
|
+
# @param [String] quota_user
|
|
3658
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
3659
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
3660
|
+
# @param [Google::Apis::RequestOptions] options
|
|
3661
|
+
# Request-specific options
|
|
3662
|
+
#
|
|
3663
|
+
# @yield [result, err] Result & error if block supplied
|
|
3664
|
+
# @yieldparam result [Google::Apis::ClassroomV1::Empty] parsed result object
|
|
3665
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
3666
|
+
#
|
|
3667
|
+
# @return [Google::Apis::ClassroomV1::Empty]
|
|
3668
|
+
#
|
|
3669
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
3670
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
3671
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
3672
|
+
def delete_course_student_group_student_group_member(course_id, student_group_id, user_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
3673
|
+
command = make_simple_command(:delete, 'v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers/{userId}', options)
|
|
3674
|
+
command.response_representation = Google::Apis::ClassroomV1::Empty::Representation
|
|
3675
|
+
command.response_class = Google::Apis::ClassroomV1::Empty
|
|
3676
|
+
command.params['courseId'] = course_id unless course_id.nil?
|
|
3677
|
+
command.params['studentGroupId'] = student_group_id unless student_group_id.nil?
|
|
3678
|
+
command.params['userId'] = user_id unless user_id.nil?
|
|
3679
|
+
command.query['fields'] = fields unless fields.nil?
|
|
3680
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
3681
|
+
execute_or_queue_command(command, &block)
|
|
3682
|
+
end
|
|
3683
|
+
|
|
3684
|
+
# Returns a list of students in a group. This method returns the following error
|
|
3685
|
+
# codes: * `NOT_FOUND` if the course or student group does not exist.
|
|
3686
|
+
# @param [String] course_id
|
|
3687
|
+
# Required. The identifier of the course.
|
|
3688
|
+
# @param [String] student_group_id
|
|
3689
|
+
# Required. The identifier of the student group.
|
|
3690
|
+
# @param [Fixnum] page_size
|
|
3691
|
+
# Maximum number of items to return. Zero or unspecified indicates that the
|
|
3692
|
+
# server may assign a maximum. The server may return fewer than the specified
|
|
3693
|
+
# number of results.
|
|
3694
|
+
# @param [String] page_token
|
|
3695
|
+
# nextPageToken value returned from a previous list call, indicating that the
|
|
3696
|
+
# subsequent page of results should be returned. The list request must be
|
|
3697
|
+
# otherwise identical to the one that resulted in this token.
|
|
3698
|
+
# @param [String] fields
|
|
3699
|
+
# Selector specifying which fields to include in a partial response.
|
|
3700
|
+
# @param [String] quota_user
|
|
3701
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
3702
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
3703
|
+
# @param [Google::Apis::RequestOptions] options
|
|
3704
|
+
# Request-specific options
|
|
3705
|
+
#
|
|
3706
|
+
# @yield [result, err] Result & error if block supplied
|
|
3707
|
+
# @yieldparam result [Google::Apis::ClassroomV1::ListStudentGroupMembersResponse] parsed result object
|
|
3708
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
3709
|
+
#
|
|
3710
|
+
# @return [Google::Apis::ClassroomV1::ListStudentGroupMembersResponse]
|
|
3711
|
+
#
|
|
3712
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
3713
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
3714
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
3715
|
+
def list_course_student_group_student_group_members(course_id, student_group_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
3716
|
+
command = make_simple_command(:get, 'v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers', options)
|
|
3717
|
+
command.response_representation = Google::Apis::ClassroomV1::ListStudentGroupMembersResponse::Representation
|
|
3718
|
+
command.response_class = Google::Apis::ClassroomV1::ListStudentGroupMembersResponse
|
|
3719
|
+
command.params['courseId'] = course_id unless course_id.nil?
|
|
3720
|
+
command.params['studentGroupId'] = student_group_id unless student_group_id.nil?
|
|
3721
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
3722
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
3723
|
+
command.query['fields'] = fields unless fields.nil?
|
|
3724
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
3725
|
+
execute_or_queue_command(command, &block)
|
|
3726
|
+
end
|
|
3727
|
+
|
|
3440
3728
|
# Adds a user as a student of a course. Domain administrators are permitted to [
|
|
3441
3729
|
# directly add](https://developers.google.com/workspace/classroom/guides/manage-
|
|
3442
3730
|
# users) users within their domain as students to courses within their domain.
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
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.50.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Google LLC
|
|
@@ -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.50.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:
|