Class: Google::Apis::ClassroomV1::ClassroomService

Inherits:
Google::Apis::Core::BaseService show all
Defined in:
generated/google/apis/classroom_v1/service.rb

Overview

Google Classroom API

Manages classes, rosters, and invitations in Google Classroom.

Examples:

require 'google/apis/classroom_v1'

Classroom = Google::Apis::ClassroomV1 # Alias the module
service = Classroom::ClassroomService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Google::Apis::Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Google::Apis::Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Constructor Details

#initialize ⇒ ClassroomService

Returns a new instance of ClassroomService



45
46
47
 
# File 'generated/google/apis/classroom_v1/service.rb', line 45

def initialize
  super('https://classroom.googleapis.com/', '')
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



38
39
40
 
# File 'generated/google/apis/classroom_v1/service.rb', line 38

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



43
44
45
 
# File 'generated/google/apis/classroom_v1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#accept_invitation(id, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::Empty

Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to accept the requested invitation or for access errors.
  • FAILED_PRECONDITION for the following request errors:
  • CourseMemberLimitReached
  • CourseNotModifiable
  • CourseTeacherLimitReached
  • UserGroupsMembershipLimitReached
  • NOT_FOUND if no invitation exists with the requested ID.

Parameters:

  • id (String) —

    Identifier of the invitation to accept.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



242
243
244
245
246
247
248
249
250
 
# File 'generated/google/apis/classroom_v1/service.rb', line 242

def accept_invitation(id, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/invitations/{id}:accept', options)
  command.response_representation = Google::Apis::ClassroomV1::Empty::Representation
  command.response_class = Google::Apis::ClassroomV1::Empty
  command.params['id'] = id unless id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#create_course(course_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::Course

Creates a course. The user specified in ownerId is the owner of the created course and added as a teacher. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to create courses or for access errors.
  • NOT_FOUND if the primary teacher is not a valid user.
  • FAILED_PRECONDITION if the course owner's account is disabled or for the following request errors:
  • UserGroupsMembershipLimitReached
  • ALREADY_EXISTS if an alias was specified in the id and already exists.

Parameters:

  • course_object (Google::Apis::ClassroomV1::Course) (defaults to: nil)
  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



381
382
383
384
385
386
387
388
389
390
 
# File 'generated/google/apis/classroom_v1/service.rb', line 381

def create_course(course_object = nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/courses', options)
  command.request_representation = Google::Apis::ClassroomV1::Course::Representation
  command.request_object = course_object
  command.response_representation = Google::Apis::ClassroomV1::Course::Representation
  command.response_class = Google::Apis::ClassroomV1::Course
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#create_course_alias(course_id, course_alias_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::CourseAlias

Creates an alias for a course. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to create the alias or for access errors.
  • NOT_FOUND if the course does not exist.
  • ALREADY_EXISTS if the alias already exists.
  • FAILED_PRECONDITION if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to access a domain-scoped alias).

Parameters:

  • course_id (String) —

    Identifier of the course to alias. This identifier can be either the Classroom-assigned identifier or an alias.

  • course_alias_object (Google::Apis::ClassroomV1::CourseAlias) (defaults to: nil)
  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



741
742
743
744
745
746
747
748
749
750
751
 
# File 'generated/google/apis/classroom_v1/service.rb', line 741

def create_course_alias(course_id, course_alias_object = nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/courses/{courseId}/aliases', options)
  command.request_representation = Google::Apis::ClassroomV1::CourseAlias::Representation
  command.request_object = course_alias_object
  command.response_representation = Google::Apis::ClassroomV1::CourseAlias::Representation
  command.response_class = Google::Apis::ClassroomV1::CourseAlias
  command.params['courseId'] = course_id unless course_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#create_course_student(course_id, student_object = nil, enrollment_code: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::Student

Adds a user as a student of a course. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to create students in this course or for access errors.
  • NOT_FOUND if the requested course ID does not exist.
  • FAILED_PRECONDITION if the requested user's account is disabled, for the following request errors:
  • CourseMemberLimitReached
  • CourseNotModifiable
  • UserGroupsMembershipLimitReached
  • ALREADY_EXISTS if the user is already a student or teacher in the course.

Parameters:

  • course_id (String) —

    Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias.

  • student_object (Google::Apis::ClassroomV1::Student) (defaults to: nil)
  • enrollment_code (String) —

    Enrollment code of the course to create the student in. This code is required if userId corresponds to the requesting user; it may be omitted if the requesting user has administrative permissions to create students for any user.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



884
885
886
887
888
889
890
891
892
893
894
895
 
# File 'generated/google/apis/classroom_v1/service.rb', line 884

def create_course_student(course_id, student_object = nil, enrollment_code: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/courses/{courseId}/students', options)
  command.request_representation = Google::Apis::ClassroomV1::Student::Representation
  command.request_object = student_object
  command.response_representation = Google::Apis::ClassroomV1::Student::Representation
  command.response_class = Google::Apis::ClassroomV1::Student
  command.params['courseId'] = course_id unless course_id.nil?
  command.query['enrollmentCode'] = enrollment_code unless enrollment_code.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#create_course_teacher(course_id, teacher_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::Teacher

Creates a teacher of a course. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to create teachers in this course or for access errors.
  • NOT_FOUND if the requested course ID does not exist.
  • FAILED_PRECONDITION if the requested user's account is disabled, for the following request errors:
  • CourseMemberLimitReached
  • CourseNotModifiable
  • CourseTeacherLimitReached
  • UserGroupsMembershipLimitReached
  • ALREADY_EXISTS if the user is already a teacher or student in the course.

Parameters:

  • course_id (String) —

    Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

  • teacher_object (Google::Apis::ClassroomV1::Teacher) (defaults to: nil)
  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



560
561
562
563
564
565
566
567
568
569
570
 
# File 'generated/google/apis/classroom_v1/service.rb', line 560

def create_course_teacher(course_id, teacher_object = nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/courses/{courseId}/teachers', options)
  command.request_representation = Google::Apis::ClassroomV1::Teacher::Representation
  command.request_object = teacher_object
  command.response_representation = Google::Apis::ClassroomV1::Teacher::Representation
  command.response_class = Google::Apis::ClassroomV1::Teacher
  command.params['courseId'] = course_id unless course_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#create_course_work(course_id, course_work_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::CourseWork

Creates course work. The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the OAuth client ID used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the associated Developer Console project. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to access the requested course, create course work in the requested course, share a Drive attachment, or for access errors.
  • INVALID_ARGUMENT if the request is malformed.
  • NOT_FOUND if the requested course does not exist.
  • FAILED_PRECONDITION for the following request error:
  • AttachmentNotVisible

Parameters:

  • course_id (String) —

    Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

  • course_work_object (Google::Apis::ClassroomV1::CourseWork) (defaults to: nil)
  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
 
# File 'generated/google/apis/classroom_v1/service.rb', line 1070

def create_course_work(course_id, course_work_object = nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/courses/{courseId}/courseWork', options)
  command.request_representation = Google::Apis::ClassroomV1::CourseWork::Representation
  command.request_object = course_work_object
  command.response_representation = Google::Apis::ClassroomV1::CourseWork::Representation
  command.response_class = Google::Apis::ClassroomV1::CourseWork
  command.params['courseId'] = course_id unless course_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#create_invitation(invitation_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::Invitation

Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to create invitations for this course or for access errors.
  • NOT_FOUND if the course or the user does not exist.
  • FAILED_PRECONDITION if the requested user's account is disabled or if the user already has this role or a role with greater permissions.
  • ALREADY_EXISTS if an invitation for the specified user and course already exists.

Parameters:

  • invitation_object (Google::Apis::ClassroomV1::Invitation) (defaults to: nil)
  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



77
78
79
80
81
82
83
84
85
86
 
# File 'generated/google/apis/classroom_v1/service.rb', line 77

def create_invitation(invitation_object = nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/invitations', options)
  command.request_representation = Google::Apis::ClassroomV1::Invitation::Representation
  command.request_object = invitation_object
  command.response_representation = Google::Apis::ClassroomV1::Invitation::Representation
  command.response_class = Google::Apis::ClassroomV1::Invitation
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#create_user_profile_guardian_invitation(student_id, guardian_invitation_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::GuardianInvitation

Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian. Once the guardian accepts the invitation, their state will change to COMPLETED and they will start receiving guardian notifications. A Guardian resource will also be created to represent the active guardian. The request object must have the student_id and invited_email_address fields set. Failing to set these fields, or setting any other fields in the request, will result in an error. This method returns the following error codes:

  • PERMISSION_DENIED if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other access errors.
  • RESOURCE_EXHAUSTED if the student or guardian has exceeded the guardian link limit.
  • INVALID_ARGUMENT if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a user_id from this API). This error will also be returned if read-only fields are set, or if the state field is set to to a value other than PENDING.
  • NOT_FOUND if the student ID provided is a valid student ID, but Classroom has no record of that student.
  • ALREADY_EXISTS if there is already a pending guardian invitation for the student and invited_email_address provided, or if the provided invited_email_address matches the Google account of an existing Guardian for this user.

Parameters:

  • student_id (String) —

    ID of the student (in standard format)

  • guardian_invitation_object (Google::Apis::ClassroomV1::GuardianInvitation) (defaults to: nil)
  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
 
# File 'generated/google/apis/classroom_v1/service.rb', line 2003

def (student_id, guardian_invitation_object = nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/userProfiles/{studentId}/guardianInvitations', options)
  command.request_representation = Google::Apis::ClassroomV1::GuardianInvitation::Representation
  command.request_object = guardian_invitation_object
  command.response_representation = Google::Apis::ClassroomV1::GuardianInvitation::Representation
  command.response_class = Google::Apis::ClassroomV1::GuardianInvitation
  command.params['studentId'] = student_id unless student_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#delete_course(id, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::Empty

Deletes a course. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to delete the requested course or for access errors.
  • NOT_FOUND if no course exists with the requested ID.

Parameters:

  • id (String) —

    Identifier of the course to delete. This identifier can be either the Classroom-assigned identifier or an alias.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



515
516
517
518
519
520
521
522
523
 
# File 'generated/google/apis/classroom_v1/service.rb', line 515

def delete_course(id, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/courses/{id}', options)
  command.response_representation = Google::Apis::ClassroomV1::Empty::Representation
  command.response_class = Google::Apis::ClassroomV1::Empty
  command.params['id'] = id unless id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#delete_course_alias(course_id, alias_, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::Empty

Deletes an alias of a course. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to remove the alias or for access errors.
  • NOT_FOUND if the alias does not exist.
  • FAILED_PRECONDITION if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to delete a domain-scoped alias).

Parameters:

  • course_id (String) —

    Identifier of the course whose alias should be deleted. This identifier can be either the Classroom-assigned identifier or an alias.

  • alias_ (String) —

    Alias to delete. This may not be the Classroom-assigned identifier.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



834
835
836
837
838
839
840
841
842
843
 
# File 'generated/google/apis/classroom_v1/service.rb', line 834

def delete_course_alias(course_id, alias_, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/courses/{courseId}/aliases/{alias}', options)
  command.response_representation = Google::Apis::ClassroomV1::Empty::Representation
  command.response_class = Google::Apis::ClassroomV1::Empty
  command.params['courseId'] = course_id unless course_id.nil?
  command.params['alias'] = alias_ unless alias_.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#delete_course_course_work(course_id, id, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::Empty

Deletes a course work. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding course work item. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting developer project did not create the corresponding course work, if the requesting user is not permitted to delete the requested course or for access errors.
  • FAILED_PRECONDITION if the requested course work has already been deleted.
  • NOT_FOUND if no course exists with the requested ID.

Parameters:

  • course_id (String) —

    Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

  • id (String) —

    Identifier of the course work to delete. This identifier is a Classroom-assigned identifier.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
 
# File 'generated/google/apis/classroom_v1/service.rb', line 1291

def delete_course_course_work(course_id, id, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/courses/{courseId}/courseWork/{id}', options)
  command.response_representation = Google::Apis::ClassroomV1::Empty::Representation
  command.response_class = Google::Apis::ClassroomV1::Empty
  command.params['courseId'] = course_id unless course_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#delete_course_student(course_id, user_id, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::Empty

Deletes a student of a course. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to delete students of this course or for access errors.
  • NOT_FOUND if no student of this course has the requested ID or if the course does not exist.

Parameters:

  • course_id (String) —

    Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

  • user_id (String) —

    Identifier of the student to delete. The identifier can be one of the following:

    • the numeric identifier for the user
    • the email address of the user
    • the string literal "me", indicating the requesting user
  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
 
# File 'generated/google/apis/classroom_v1/service.rb', line 1022

def delete_course_student(course_id, user_id, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/courses/{courseId}/students/{userId}', options)
  command.response_representation = Google::Apis::ClassroomV1::Empty::Representation
  command.response_class = Google::Apis::ClassroomV1::Empty
  command.params['courseId'] = course_id unless course_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#delete_course_teacher(course_id, user_id, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::Empty

Deletes a teacher of a course. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to delete teachers of this course or for access errors.
  • NOT_FOUND if no teacher of this course has the requested ID or if the course does not exist.
  • FAILED_PRECONDITION if the requested ID belongs to the primary teacher of this course.

Parameters:

  • course_id (String) —

    Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

  • user_id (String) —

    Identifier of the teacher to delete. The identifier can be one of the following:

    • the numeric identifier for the user
    • the email address of the user
    • the string literal "me", indicating the requesting user
  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



699
700
701
702
703
704
705
706
707
708
 
# File 'generated/google/apis/classroom_v1/service.rb', line 699

def delete_course_teacher(course_id, user_id, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/courses/{courseId}/teachers/{userId}', options)
  command.response_representation = Google::Apis::ClassroomV1::Empty::Representation
  command.response_class = Google::Apis::ClassroomV1::Empty
  command.params['courseId'] = course_id unless course_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#delete_invitation(id, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::Empty

Deletes an invitation. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to delete the requested invitation or for access errors.
  • NOT_FOUND if no invitation exists with the requested ID.

Parameters:

  • id (String) —

    Identifier of the invitation to delete.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



201
202
203
204
205
206
207
208
209
 
# File 'generated/google/apis/classroom_v1/service.rb', line 201

def delete_invitation(id, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/invitations/{id}', options)
  command.response_representation = Google::Apis::ClassroomV1::Empty::Representation
  command.response_class = Google::Apis::ClassroomV1::Empty
  command.params['id'] = id unless id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#delete_user_profile_guardian(student_id, guardian_id, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::Empty

Deletes a guardian. The guardian will no longer receive guardian notifications and the guardian will no longer be accessible via the API. This method returns the following error codes:

  • PERMISSION_DENIED if no user that matches the provided student_id is visible to the requesting user, if the requesting user is not permitted to manage guardians for the student identified by the student_id, if guardians are not enabled for the domain in question, or for other access errors.
  • INVALID_ARGUMENT if a student_id is specified, but its format cannot be recognized (it is not an email address, nor a student_id from the API).
  • NOT_FOUND if the requesting user is permitted to modify guardians for the requested student_id, but no Guardian record exists for that student with the provided guardian_id.

Parameters:

  • student_id (String) —

    The student whose guardian is to be deleted. One of the following:

    • the numeric identifier for the user
    • the email address of the user
    • the string literal "me", indicating the requesting user
  • guardian_id (String) —

    The id field from a Guardian.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
 
# File 'generated/google/apis/classroom_v1/service.rb', line 1902

def (student_id, guardian_id, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/userProfiles/{studentId}/guardians/{guardianId}', options)
  command.response_representation = Google::Apis::ClassroomV1::Empty::Representation
  command.response_class = Google::Apis::ClassroomV1::Empty
  command.params['studentId'] = student_id unless student_id.nil?
  command.params['guardianId'] = guardian_id unless guardian_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#get_course(id, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::Course

Returns a course. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to access the requested course or for access errors.
  • NOT_FOUND if no course exists with the requested ID.

Parameters:

  • id (String) —

    Identifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



341
342
343
344
345
346
347
348
349
 
# File 'generated/google/apis/classroom_v1/service.rb', line 341

def get_course(id, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/courses/{id}', options)
  command.response_representation = Google::Apis::ClassroomV1::Course::Representation
  command.response_class = Google::Apis::ClassroomV1::Course
  command.params['id'] = id unless id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#get_course_student(course_id, user_id, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::Student

Returns a student of a course. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to view students of this course or for access errors.
  • NOT_FOUND if no student of this course has the requested ID or if the course does not exist.

Parameters:

  • course_id (String) —

    Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

  • user_id (String) —

    Identifier of the student to return. The identifier can be one of the following:

    • the numeric identifier for the user
    • the email address of the user
    • the string literal "me", indicating the requesting user
  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



930
931
932
933
934
935
936
937
938
939
 
# File 'generated/google/apis/classroom_v1/service.rb', line 930

def get_course_student(course_id, user_id, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/courses/{courseId}/students/{userId}', options)
  command.response_representation = Google::Apis::ClassroomV1::Student::Representation
  command.response_class = Google::Apis::ClassroomV1::Student
  command.params['courseId'] = course_id unless course_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#get_course_teacher(course_id, user_id, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::Teacher

Returns a teacher of a course. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to view teachers of this course or for access errors.
  • NOT_FOUND if no teacher of this course has the requested ID or if the course does not exist.

Parameters:

  • course_id (String) —

    Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

  • user_id (String) —

    Identifier of the teacher to return. The identifier can be one of the following:

    • the numeric identifier for the user
    • the email address of the user
    • the string literal "me", indicating the requesting user
  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



605
606
607
608
609
610
611
612
613
614
 
# File 'generated/google/apis/classroom_v1/service.rb', line 605

def get_course_teacher(course_id, user_id, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/courses/{courseId}/teachers/{userId}', options)
  command.response_representation = Google::Apis::ClassroomV1::Teacher::Representation
  command.response_class = Google::Apis::ClassroomV1::Teacher
  command.params['courseId'] = course_id unless course_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#get_course_work(course_id, id, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::CourseWork

Returns course work. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to access the requested course or course work, or for access errors.
  • INVALID_ARGUMENT if the request is malformed.
  • NOT_FOUND if the requested course or course work does not exist.

Parameters:

  • course_id (String) —

    Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

  • id (String) —

    Identifier of the course work.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
 
# File 'generated/google/apis/classroom_v1/service.rb', line 1111

def get_course_work(course_id, id, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/courses/{courseId}/courseWork/{id}', options)
  command.response_representation = Google::Apis::ClassroomV1::CourseWork::Representation
  command.response_class = Google::Apis::ClassroomV1::CourseWork
  command.params['courseId'] = course_id unless course_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#get_invitation(id, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::Invitation

Returns an invitation. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to view the requested invitation or for access errors.
  • NOT_FOUND if no invitation exists with the requested ID.

Parameters:

  • id (String) —

    Identifier of the invitation to return.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



112
113
114
115
116
117
118
119
120
 
# File 'generated/google/apis/classroom_v1/service.rb', line 112

def get_invitation(id, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/invitations/{id}', options)
  command.response_representation = Google::Apis::ClassroomV1::Invitation::Representation
  command.response_class = Google::Apis::ClassroomV1::Invitation
  command.params['id'] = id unless id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#get_student_submission(course_id, course_work_id, id, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::StudentSubmission

Returns a student submission.

  • PERMISSION_DENIED if the requesting user is not permitted to access the requested course, course work, or student submission or for access errors.
  • INVALID_ARGUMENT if the request is malformed.
  • NOT_FOUND if the requested course, course work, or student submission does not exist.

Parameters:

  • course_id (String) —

    Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

  • course_work_id (String) —

    Identifier of the course work.

  • id (String) —

    Identifier of the student submission.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
 
# File 'generated/google/apis/classroom_v1/service.rb', line 1576

def get_student_submission(course_id, course_work_id, id, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}', options)
  command.response_representation = Google::Apis::ClassroomV1::StudentSubmission::Representation
  command.response_class = Google::Apis::ClassroomV1::StudentSubmission
  command.params['courseId'] = course_id unless course_id.nil?
  command.params['courseWorkId'] = course_work_id unless course_work_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#get_user_profile(user_id, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::UserProfile

Returns a user profile. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to access this user profile, if no profile exists with the requested ID, or for access errors.

Parameters:

  • user_id (String) —

    Identifier of the profile to return. The identifier can be one of the following:

    • the numeric identifier for the user
    • the email address of the user
    • the string literal "me", indicating the requesting user
  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1735
1736
1737
1738
1739
1740
1741
1742
1743
 
# File 'generated/google/apis/classroom_v1/service.rb', line 1735

def (user_id, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/userProfiles/{userId}', options)
  command.response_representation = Google::Apis::ClassroomV1::UserProfile::Representation
  command.response_class = Google::Apis::ClassroomV1::UserProfile
  command.params['userId'] = user_id unless user_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#get_user_profile_guardian(student_id, guardian_id, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::Guardian

Returns a specific guardian. This method returns the following error codes:

  • PERMISSION_DENIED if no user that matches the provided student_id is visible to the requesting user, if the requesting user is not permitted to view guardian information for the student identified by the student_id, if guardians are not enabled for the domain in question, or for other access errors.
  • INVALID_ARGUMENT if a student_id is specified, but its format cannot be recognized (it is not an email address, nor a student_id from the API, nor the literal string me).
  • NOT_FOUND if the requesting user is permitted to view guardians for the requested student_id, but no Guardian record exists for that student that matches the provided guardian_id.

Parameters:

  • student_id (String) —

    The student whose guardian is being requested. One of the following:

    • the numeric identifier for the user
    • the email address of the user
    • the string literal "me", indicating the requesting user
  • guardian_id (String) —

    The id field from a Guardian.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
 
# File 'generated/google/apis/classroom_v1/service.rb', line 1782

def (student_id, guardian_id, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/userProfiles/{studentId}/guardians/{guardianId}', options)
  command.response_representation = Google::Apis::ClassroomV1::Guardian::Representation
  command.response_class = Google::Apis::ClassroomV1::Guardian
  command.params['studentId'] = student_id unless student_id.nil?
  command.params['guardianId'] = guardian_id unless guardian_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#get_user_profile_guardian_invitation(student_id, invitation_id, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::GuardianInvitation

Returns a specific guardian invitation. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to view guardian invitations for the student identified by the student_id, if guardians are not enabled for the domain in question, or for other access errors.
  • INVALID_ARGUMENT if a student_id is specified, but its format cannot be recognized (it is not an email address, nor a student_id from the API, nor the literal string me).
  • NOT_FOUND if Classroom cannot find any record of the given student or invitation_id. May also be returned if the student exists, but the requesting user does not have access to see that student.

Parameters:

  • student_id (String) —

    The ID of the student whose guardian invitation is being requested.

  • invitation_id (String) —

    The id field of the GuardianInvitation being requested.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
 
# File 'generated/google/apis/classroom_v1/service.rb', line 1946

def (student_id, invitation_id, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/userProfiles/{studentId}/guardianInvitations/{invitationId}', options)
  command.response_representation = Google::Apis::ClassroomV1::GuardianInvitation::Representation
  command.response_class = Google::Apis::ClassroomV1::GuardianInvitation
  command.params['studentId'] = student_id unless student_id.nil?
  command.params['invitationId'] = invitation_id unless invitation_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_course_aliases(course_id, page_size: nil, page_token: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::ListCourseAliasesResponse

Returns a list of aliases for a course. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to access the course or for access errors.
  • NOT_FOUND if the course does not exist.

Parameters:

  • course_id (String) —

    The identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

  • page_size (Fixnum) —

    Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.

  • page_token (String) —

    nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



790
791
792
793
794
795
796
797
798
799
800
 
# File 'generated/google/apis/classroom_v1/service.rb', line 790

def list_course_aliases(course_id, page_size: nil, page_token: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/courses/{courseId}/aliases', options)
  command.response_representation = Google::Apis::ClassroomV1::ListCourseAliasesResponse::Representation
  command.response_class = Google::Apis::ClassroomV1::ListCourseAliasesResponse
  command.params['courseId'] = course_id unless course_id.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_course_students(course_id, page_size: nil, page_token: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::ListStudentsResponse

Returns a list of students of this course that the requester is permitted to view. This method returns the following error codes:

  • NOT_FOUND if the course does not exist.
  • PERMISSION_DENIED for access errors.

Parameters:

  • course_id (String) —

    Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

  • page_size (Fixnum) —

    Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.

  • page_token (String) —

    nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



977
978
979
980
981
982
983
984
985
986
987
 
# File 'generated/google/apis/classroom_v1/service.rb', line 977

def list_course_students(course_id, page_size: nil, page_token: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/courses/{courseId}/students', options)
  command.response_representation = Google::Apis::ClassroomV1::ListStudentsResponse::Representation
  command.response_class = Google::Apis::ClassroomV1::ListStudentsResponse
  command.params['courseId'] = course_id unless course_id.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_course_teachers(course_id, page_size: nil, page_token: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::ListTeachersResponse

Returns a list of teachers of this course that the requester is permitted to view. This method returns the following error codes:

  • NOT_FOUND if the course does not exist.
  • PERMISSION_DENIED for access errors.

Parameters:

  • course_id (String) —

    Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

  • page_size (Fixnum) —

    Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.

  • page_token (String) —

    nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



652
653
654
655
656
657
658
659
660
661
662
 
# File 'generated/google/apis/classroom_v1/service.rb', line 652

def list_course_teachers(course_id, page_size: nil, page_token: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/courses/{courseId}/teachers', options)
  command.response_representation = Google::Apis::ClassroomV1::ListTeachersResponse::Representation
  command.response_class = Google::Apis::ClassroomV1::ListTeachersResponse
  command.params['courseId'] = course_id unless course_id.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_course_works(course_id, course_work_states: nil, page_size: nil, order_by: nil, page_token: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::ListCourseWorkResponse

Returns a list of course work that the requester is permitted to view. Course students may only view PUBLISHED course work. Course teachers and domain administrators may view all course work. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to access the requested course or for access errors.
  • INVALID_ARGUMENT if the request is malformed.
  • NOT_FOUND if the requested course does not exist.

Parameters:

  • course_id (String) —

    Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

  • course_work_states (Array<String>, String) —

    Restriction on the work status to return. Only courseWork that matches is returned. If unspecified, items with a work status of PUBLISHED is returned.

  • page_size (Fixnum) —

    Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.

  • order_by (String) —

    Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported fields are updateTime and dueDate. Supported direction keywords are asc and desc. If not specified, updateTime desc is the default behavior. Examples: dueDate asc,updateTime desc, updateTime,dueDate desc

  • page_token (String) —

    nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
 
# File 'generated/google/apis/classroom_v1/service.rb', line 1172

def list_course_works(course_id, course_work_states: nil, page_size: nil, order_by: nil, page_token: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/courses/{courseId}/courseWork', options)
  command.response_representation = Google::Apis::ClassroomV1::ListCourseWorkResponse::Representation
  command.response_class = Google::Apis::ClassroomV1::ListCourseWorkResponse
  command.params['courseId'] = course_id unless course_id.nil?
  command.query['courseWorkStates'] = course_work_states unless course_work_states.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_courses(course_states: nil, page_size: nil, teacher_id: nil, student_id: nil, page_token: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::ListCoursesResponse

Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. This method returns the following error codes:

  • PERMISSION_DENIED for access errors.
  • INVALID_ARGUMENT if the query argument is malformed.
  • NOT_FOUND if any users specified in the query arguments do not exist.

Parameters:

  • course_states (Array<String>, String) —

    Restricts returned courses to those in one of the specified states The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.

  • page_size (Fixnum) —

    Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.

  • teacher_id (String) —

    Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following:

    • the numeric identifier for the user
    • the email address of the user
    • the string literal "me", indicating the requesting user
  • student_id (String) —

    Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following:

    • the numeric identifier for the user
    • the email address of the user
    • the string literal "me", indicating the requesting user
  • page_token (String) —

    nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'generated/google/apis/classroom_v1/service.rb', line 301

def list_courses(course_states: nil, page_size: nil, teacher_id: nil, student_id: nil, page_token: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/courses', options)
  command.response_representation = Google::Apis::ClassroomV1::ListCoursesResponse::Representation
  command.response_class = Google::Apis::ClassroomV1::ListCoursesResponse
  command.query['courseStates'] = course_states unless course_states.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['teacherId'] = teacher_id unless teacher_id.nil?
  command.query['studentId'] = student_id unless student_id.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_invitations(course_id: nil, page_size: nil, user_id: nil, page_token: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::ListInvitationsResponse

Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. Note: At least one of user_id or course_id must be supplied. Both fields can be supplied. This method returns the following error codes:

  • PERMISSION_DENIED for access errors.

Parameters:

  • course_id (String) —

    Restricts returned invitations to those for a course with the specified identifier.

  • page_size (Fixnum) —

    Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.

  • user_id (String) —

    Restricts returned invitations to those for a specific user. The identifier can be one of the following:

    • the numeric identifier for the user
    • the email address of the user
    • the string literal "me", indicating the requesting user
  • page_token (String) —

    nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'generated/google/apis/classroom_v1/service.rb', line 164

def list_invitations(course_id: nil, page_size: nil, user_id: nil, page_token: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/invitations', options)
  command.response_representation = Google::Apis::ClassroomV1::ListInvitationsResponse::Representation
  command.response_class = Google::Apis::ClassroomV1::ListInvitationsResponse
  command.query['courseId'] = course_id unless course_id.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['userId'] = user_id unless user_id.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_student_submissions(course_id, course_work_id, states: nil, user_id: nil, page_size: nil, late: nil, page_token: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::ListStudentSubmissionsResponse

Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. - may be specified as the course_work_id to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submissions. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to access the requested course or course work, or for access errors.
  • INVALID_ARGUMENT if the request is malformed.
  • NOT_FOUND if the requested course does not exist.

Parameters:

  • course_id (String) —

    Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

  • course_work_id (String) —

    Identifer of the student work to request. This may be set to the string literal "-" to request student work for all course work in the specified course.

  • states (Array<String>, String) —

    Requested submission states. If specified, returned student submissions match one of the specified submission states.

  • user_id (String) —

    Optional argument to restrict returned student work to those owned by the student with the specified identifier. The identifier can be one of the following:

    • the numeric identifier for the user
    • the email address of the user
    • the string literal "me", indicating the requesting user
  • page_size (Fixnum) —

    Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.

  • late (String) —

    Requested lateness value. If specified, returned student submissions are restricted by the requested value. If unspecified, submissions are returned regardless of late value.

  • page_token (String) —

    nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
 
# File 'generated/google/apis/classroom_v1/service.rb', line 1528

def list_student_submissions(course_id, course_work_id, states: nil, user_id: nil, page_size: nil, late: nil, page_token: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions', options)
  command.response_representation = Google::Apis::ClassroomV1::ListStudentSubmissionsResponse::Representation
  command.response_class = Google::Apis::ClassroomV1::ListStudentSubmissionsResponse
  command.params['courseId'] = course_id unless course_id.nil?
  command.params['courseWorkId'] = course_work_id unless course_work_id.nil?
  command.query['states'] = states unless states.nil?
  command.query['userId'] = user_id unless user_id.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['late'] = late unless late.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_user_profile_guardian_invitations(student_id, page_size: nil, invited_email_address: nil, states: nil, page_token: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::ListGuardianInvitationsResponse

Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. This method returns the following error codes:

  • PERMISSION_DENIED if a student_id is specified, and the requesting user is not permitted to view guardian invitations for that student, if "-" is specified as the student_id and the user is not a domain administrator, if guardians are not enabled for the domain in question, or for other access errors.
  • INVALID_ARGUMENT if a student_id is specified, but its format cannot be recognized (it is not an email address, nor a student_id from the API, nor the literal string me). May also be returned if an invalid page_token or state is provided.
  • NOT_FOUND if a student_id is specified, and its format can be recognized, but Classroom has no record of that student.

Parameters:

  • student_id (String) —

    The ID of the student whose guardian invitations are to be returned. The identifier can be one of the following:

    • the numeric identifier for the user
    • the email address of the user
    • the string literal "me", indicating the requesting user
    • the string literal "-", indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations.
  • page_size (Fixnum) —

    Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.

  • invited_email_address (String) —

    If specified, only results with the specified invited_email_address will be returned.

  • states (Array<String>, String) —

    If specified, only results with the specified state values will be returned. Otherwise, results with a state of PENDING will be returned.

  • page_token (String) —

    nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
 
# File 'generated/google/apis/classroom_v1/service.rb', line 2072

def (student_id, page_size: nil, invited_email_address: nil, states: nil, page_token: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/userProfiles/{studentId}/guardianInvitations', options)
  command.response_representation = Google::Apis::ClassroomV1::ListGuardianInvitationsResponse::Representation
  command.response_class = Google::Apis::ClassroomV1::ListGuardianInvitationsResponse
  command.params['studentId'] = student_id unless student_id.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['invitedEmailAddress'] = invited_email_address unless invited_email_address.nil?
  command.query['states'] = states unless states.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_user_profile_guardians(student_id, page_size: nil, invited_email_address: nil, page_token: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::ListGuardiansResponse

Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request. To list guardians for any student that the requesting user may view guardians for, use the literal character - for the student ID. This method returns the following error codes:

  • PERMISSION_DENIED if a student_id is specified, and the requesting user is not permitted to view guardian information for that student, if "-" is specified as the student_id and the user is not a domain administrator, if guardians are not enabled for the domain in question, if the invited_email_address filter is set by a user who is not a domain administrator, or for other access errors.
  • INVALID_ARGUMENT if a student_id is specified, but its format cannot be recognized (it is not an email address, nor a student_id from the API, nor the literal string me). May also be returned if an invalid page_token is provided.
  • NOT_FOUND if a student_id is specified, and its format can be recognized, but Classroom has no record of that student.

Parameters:

  • student_id (String) —

    Filter results by the student who the guardian is linked to. The identifier can be one of the following:

    • the numeric identifier for the user
    • the email address of the user
    • the string literal "me", indicating the requesting user
    • the string literal "-", indicating that results should be returned for all students that the requesting user has access to view.
  • page_size (Fixnum) —

    Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.

  • invited_email_address (String) —

    Filter results by the email address that the original invitation was sent to, resulting in this guardian link. This filter can only be used by domain administrators.

  • page_token (String) —

    nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
 
# File 'generated/google/apis/classroom_v1/service.rb', line 1850

def (student_id, page_size: nil, invited_email_address: nil, page_token: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/userProfiles/{studentId}/guardians', options)
  command.response_representation = Google::Apis::ClassroomV1::ListGuardiansResponse::Representation
  command.response_class = Google::Apis::ClassroomV1::ListGuardiansResponse
  command.params['studentId'] = student_id unless student_id.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['invitedEmailAddress'] = invited_email_address unless invited_email_address.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#modify_student_submission_attachments(course_id, course_work_id, id, modify_attachments_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::StudentSubmission

Modifies attachments of student submission. Attachments may only be added to student submissions belonging to course work objects with a workType of ASSIGNMENT. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding course work item. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to access the requested course or course work, if the user is not permitted to modify attachments on the requested student submission, or for access errors.
  • INVALID_ARGUMENT if the request is malformed.
  • NOT_FOUND if the requested course, course work, or student submission does not exist.

Parameters:

  • course_id (String) —

    Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

  • course_work_id (String) —

    Identifier of the course work.

  • id (String) —

    Identifier of the student submission.

  • modify_attachments_request_object (Google::Apis::ClassroomV1::ModifyAttachmentsRequest) (defaults to: nil)
  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
 
# File 'generated/google/apis/classroom_v1/service.rb', line 1342

def modify_student_submission_attachments(course_id, course_work_id, id, modify_attachments_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments', options)
  command.request_representation = Google::Apis::ClassroomV1::ModifyAttachmentsRequest::Representation
  command.request_object = modify_attachments_request_object
  command.response_representation = Google::Apis::ClassroomV1::StudentSubmission::Representation
  command.response_class = Google::Apis::ClassroomV1::StudentSubmission
  command.params['courseId'] = course_id unless course_id.nil?
  command.params['courseWorkId'] = course_work_id unless course_work_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#patch_course(id, course_object = nil, update_mask: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::Course

Updates one or more fields in a course. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to modify the requested course or for access errors.
  • NOT_FOUND if no course exists with the requested ID.
  • INVALID_ARGUMENT if invalid fields are specified in the update mask or if no update mask is supplied.
  • FAILED_PRECONDITION for the following request errors:
  • CourseNotModifiable

Parameters:

  • id (String) —

    Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.

  • course_object (Google::Apis::ClassroomV1::Course) (defaults to: nil)
  • update_mask (String) —

    Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid:

    • name
    • section
    • descriptionHeading
    • description
    • room
    • courseState When set in a query parameter, this field should be specified as updateMask=<field1>,<field2>,...
  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'generated/google/apis/classroom_v1/service.rb', line 476

def patch_course(id, course_object = nil, update_mask: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v1/courses/{id}', options)
  command.request_representation = Google::Apis::ClassroomV1::Course::Representation
  command.request_object = course_object
  command.response_representation = Google::Apis::ClassroomV1::Course::Representation
  command.response_class = Google::Apis::ClassroomV1::Course
  command.params['id'] = id unless id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#patch_course_course_work(course_id, id, course_work_object = nil, update_mask: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::CourseWork

Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding course work item. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors.
  • INVALID_ARGUMENT if the request is malformed.
  • FAILED_PRECONDITION if the requested course work has already been deleted.
  • NOT_FOUND if the requested course, course work, or student submission does not exist.

Parameters:

  • course_id (String) —

    Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

  • id (String) —

    Identifier of the course work.

  • course_work_object (Google::Apis::ClassroomV1::CourseWork) (defaults to: nil)
  • update_mask (String) —

    Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the CourseWork object. If a field that does not support empty values is included in the update mask and not set in the CourseWork object, an INVALID_ARGUMENT error will be returned. The following fields may be specified by teachers:

    • title
    • description
    • state
    • due_date
    • due_time
    • max_points
    • submission_modification_mode
  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
 
# File 'generated/google/apis/classroom_v1/service.rb', line 1242

def patch_course_course_work(course_id, id, course_work_object = nil, update_mask: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v1/courses/{courseId}/courseWork/{id}', options)
  command.request_representation = Google::Apis::ClassroomV1::CourseWork::Representation
  command.request_object = course_work_object
  command.response_representation = Google::Apis::ClassroomV1::CourseWork::Representation
  command.response_class = Google::Apis::ClassroomV1::CourseWork
  command.params['courseId'] = course_id unless course_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#patch_student_submission(course_id, course_work_id, id, student_submission_object = nil, update_mask: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::StudentSubmission

Updates one or more fields of a student submission. See google.classroom.v1.StudentSubmission for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding course work item. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors.
  • INVALID_ARGUMENT if the request is malformed.
  • NOT_FOUND if the requested course, course work, or student submission does not exist.

Parameters:

  • course_id (String) —

    Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

  • course_work_id (String) —

    Identifier of the course work.

  • id (String) —

    Identifier of the student submission.

  • student_submission_object (Google::Apis::ClassroomV1::StudentSubmission) (defaults to: nil)
  • update_mask (String) —

    Mask that identifies which fields on the student submission to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields may be specified by teachers:

    • draft_grade
    • assigned_grade
  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
 
# File 'generated/google/apis/classroom_v1/service.rb', line 1692

def patch_student_submission(course_id, course_work_id, id, student_submission_object = nil, update_mask: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}', options)
  command.request_representation = Google::Apis::ClassroomV1::StudentSubmission::Representation
  command.request_object = student_submission_object
  command.response_representation = Google::Apis::ClassroomV1::StudentSubmission::Representation
  command.response_class = Google::Apis::ClassroomV1::StudentSubmission
  command.params['courseId'] = course_id unless course_id.nil?
  command.params['courseWorkId'] = course_work_id unless course_work_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#patch_user_profile_guardian_invitation(student_id, invitation_id, guardian_invitation_object = nil, update_mask: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::GuardianInvitation

Modifies a guardian invitation. Currently, the only valid modification is to change the state from PENDING to COMPLETE. This has the effect of withdrawing the invitation. This method returns the following error codes:

  • PERMISSION_DENIED if the current user does not have permission to manage guardians, if guardians are not enabled for the domain in question or for other access errors.
  • FAILED_PRECONDITION if the guardian link is not in the PENDING state.
  • INVALID_ARGUMENT if the format of the student ID provided cannot be recognized (it is not an email address, nor a user_id from this API), or if the passed GuardianInvitation has a state other than COMPLETE, or if it modifies fields other than state.
  • NOT_FOUND if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the id field does not refer to a guardian invitation known to Classroom.

Parameters:

  • student_id (String) —

    The ID of the student whose guardian invitation is to be modified.

  • invitation_id (String) —

    The id field of the GuardianInvitation to be modified.

  • guardian_invitation_object (Google::Apis::ClassroomV1::GuardianInvitation) (defaults to: nil)
  • update_mask (String) —

    Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid:

    • state When set in a query parameter, this field should be specified as updateMask=<field1>,<field2>,...
  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'generated/google/apis/classroom_v1/service.rb', line 2130

def (student_id, invitation_id, guardian_invitation_object = nil, update_mask: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v1/userProfiles/{studentId}/guardianInvitations/{invitationId}', options)
  command.request_representation = Google::Apis::ClassroomV1::GuardianInvitation::Representation
  command.request_object = guardian_invitation_object
  command.response_representation = Google::Apis::ClassroomV1::GuardianInvitation::Representation
  command.response_class = Google::Apis::ClassroomV1::GuardianInvitation
  command.params['studentId'] = student_id unless student_id.nil?
  command.params['invitationId'] = invitation_id unless invitation_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#reclaim_student_submission(course_id, course_work_id, id, reclaim_student_submission_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::Empty

Reclaims a student submission on behalf of the student that owns it. Reclaiming a student submission transfers ownership of attached Drive files to the student and update the submission state. Only the student that owns the requested student submission may call this method, and only for a student submission that has been turned in. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding course work item. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors.
  • FAILED_PRECONDITION if the student submission has not been turned in.
  • INVALID_ARGUMENT if the request is malformed.
  • NOT_FOUND if the requested course, course work, or student submission does not exist.

Parameters:

  • course_id (String) —

    Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

  • course_work_id (String) —

    Identifier of the course work.

  • id (String) —

    Identifier of the student submission.

  • reclaim_student_submission_request_object (Google::Apis::ClassroomV1::ReclaimStudentSubmissionRequest) (defaults to: nil)
  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
 
# File 'generated/google/apis/classroom_v1/service.rb', line 1398

def reclaim_student_submission(course_id, course_work_id, id, reclaim_student_submission_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim', options)
  command.request_representation = Google::Apis::ClassroomV1::ReclaimStudentSubmissionRequest::Representation
  command.request_object = reclaim_student_submission_request_object
  command.response_representation = Google::Apis::ClassroomV1::Empty::Representation
  command.response_class = Google::Apis::ClassroomV1::Empty
  command.params['courseId'] = course_id unless course_id.nil?
  command.params['courseWorkId'] = course_work_id unless course_work_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#return_student_submission(course_id, course_work_id, id, return_student_submission_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::Empty

Returns a student submission. Returning a student submission transfers ownership of attached Drive files to the student and may also update the submission state. Unlike the Classroom application, returning a student submission does not set assignedGrade to the draftGrade value. Only a teacher of the course that contains the requested student submission may call this method. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding course work item. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to access the requested course or course work, return the requested student submission, or for access errors.
  • INVALID_ARGUMENT if the request is malformed.
  • NOT_FOUND if the requested course, course work, or student submission does not exist.

Parameters:

  • course_id (String) —

    Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

  • course_work_id (String) —

    Identifier of the course work.

  • id (String) —

    Identifier of the student submission.

  • return_student_submission_request_object (Google::Apis::ClassroomV1::ReturnStudentSubmissionRequest) (defaults to: nil)
  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
 
# File 'generated/google/apis/classroom_v1/service.rb', line 1631

def return_student_submission(course_id, course_work_id, id, return_student_submission_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return', options)
  command.request_representation = Google::Apis::ClassroomV1::ReturnStudentSubmissionRequest::Representation
  command.request_object = return_student_submission_request_object
  command.response_representation = Google::Apis::ClassroomV1::Empty::Representation
  command.response_class = Google::Apis::ClassroomV1::Empty
  command.params['courseId'] = course_id unless course_id.nil?
  command.params['courseWorkId'] = course_work_id unless course_work_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#turn_in_student_submission(course_id, course_work_id, id, turn_in_student_submission_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::Empty

Turns in a student submission. Turning in a student submission transfers ownership of attached Drive files to the teacher and may also update the submission state. This may only be called by the student that owns the specified student submission. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding course work item. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to access the requested course or course work, turn in the requested student submission, or for access errors.
  • INVALID_ARGUMENT if the request is malformed.
  • NOT_FOUND if the requested course, course work, or student submission does not exist.

Parameters:

  • course_id (String) —

    Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

  • course_work_id (String) —

    Identifier of the course work.

  • id (String) —

    Identifier of the student submission.

  • turn_in_student_submission_request_object (Google::Apis::ClassroomV1::TurnInStudentSubmissionRequest) (defaults to: nil)
  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
 
# File 'generated/google/apis/classroom_v1/service.rb', line 1453

def turn_in_student_submission(course_id, course_work_id, id, turn_in_student_submission_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn', options)
  command.request_representation = Google::Apis::ClassroomV1::TurnInStudentSubmissionRequest::Representation
  command.request_object = turn_in_student_submission_request_object
  command.response_representation = Google::Apis::ClassroomV1::Empty::Representation
  command.response_class = Google::Apis::ClassroomV1::Empty
  command.params['courseId'] = course_id unless course_id.nil?
  command.params['courseWorkId'] = course_work_id unless course_work_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#update_course(id, course_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::Course

Updates a course. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to modify the requested course or for access errors.
  • NOT_FOUND if no course exists with the requested ID.
  • FAILED_PRECONDITION for the following request errors:
  • CourseNotModifiable

Parameters:

  • id (String) —

    Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.

  • course_object (Google::Apis::ClassroomV1::Course) (defaults to: nil)
  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



421
422
423
424
425
426
427
428
429
430
431
 
# File 'generated/google/apis/classroom_v1/service.rb', line 421

def update_course(id, course_object = nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:put, 'v1/courses/{id}', options)
  command.request_representation = Google::Apis::ClassroomV1::Course::Representation
  command.request_object = course_object
  command.response_representation = Google::Apis::ClassroomV1::Course::Representation
  command.response_class = Google::Apis::ClassroomV1::Course
  command.params['id'] = id unless id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end