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

Methods included from Google::Apis::Core::Logging

#logger

Constructor Details

#initializeClassroomService

Returns a new instance of ClassroomService.


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

def initialize
  super('https://classroom.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

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_userString

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, fields: nil, quota_user: 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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def accept_invitation(id, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_course(course_object = nil, fields: nil, quota_user: 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)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def create_course(course_object = nil, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_course_alias(course_id, course_alias_object = nil, fields: nil, quota_user: 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)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


325
326
327
328
329
330
331
332
333
334
335
# File 'generated/google/apis/classroom_v1/service.rb', line 325

def create_course_alias(course_id, course_alias_object = nil, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_course_announcement(course_id, announcement_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::Announcement

Creates an announcement. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access the requested course, create announcements 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.

  • announcement_object (Google::Apis::ClassroomV1::Announcement) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


447
448
449
450
451
452
453
454
455
456
457
# File 'generated/google/apis/classroom_v1/service.rb', line 447

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

#create_course_student(course_id, student_object = nil, enrollment_code: nil, fields: nil, quota_user: 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) (defaults to: nil)

    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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
# File 'generated/google/apis/classroom_v1/service.rb', line 1371

def create_course_student(course_id, student_object = nil, enrollment_code: nil, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_course_teacher(course_id, teacher_object = nil, fields: nil, quota_user: 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)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
# File 'generated/google/apis/classroom_v1/service.rb', line 1533

def create_course_teacher(course_id, teacher_object = nil, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_course_topic(course_id, topic_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::Topic

Creates a topic. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access the requested course, create a topic in 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.

  • topic_object (Google::Apis::ClassroomV1::Topic) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

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

#create_course_work(course_id, course_work_object = nil, fields: nil, quota_user: 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)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


721
722
723
724
725
726
727
728
729
730
731
# File 'generated/google/apis/classroom_v1/service.rb', line 721

def create_course_work(course_id, course_work_object = nil, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_invitation(invitation_object = nil, fields: nil, quota_user: 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)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
# File 'generated/google/apis/classroom_v1/service.rb', line 1939

def create_invitation(invitation_object = nil, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_registration(registration_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::Registration

Creates a Registration, causing Classroom to start sending notifications from the provided feed to the destination provided in cloudPubSubTopic. Returns the created Registration. Currently, this will be the same as the argument, but with server-assigned fields such as expiry_time and id filled in. Note that any value specified for the expiry_time or id fields will be ignored. While Classroom may validate the cloudPubSubTopic and return errors on a best effort basis, it is the caller's responsibility to ensure that it exists and that Classroom has permission to publish to it. This method may return the following error codes: * PERMISSION_DENIED if: * the authenticated user does not have permission to receive notifications from the requested field; or * the current user has not granted access to the current Cloud project with the appropriate scope for the requested feed. Note that domain-wide delegation of authority is not currently supported for this purpose. If the request has the appropriate scope, but no grant exists, a Request Errors is returned. * another access error is encountered. * INVALID_ARGUMENT if: * no cloudPubsubTopic is specified, or the specified cloudPubsubTopic is not valid; or * no feed is specified, or the specified feed is not valid. * NOT_FOUND if: * the specified feed cannot be located, or the requesting user does not have permission to determine whether or not it exists; or * the specified cloudPubsubTopic cannot be located, or Classroom has not been granted permission to publish to it.

Parameters:

  • registration_object (Google::Apis::ClassroomV1::Registration) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
# File 'generated/google/apis/classroom_v1/service.rb', line 2105

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

#create_user_profile_guardian_invitation(student_id, guardian_invitation_object = nil, fields: nil, quota_user: 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)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
# File 'generated/google/apis/classroom_v1/service.rb', line 2223

def (student_id, guardian_invitation_object = nil, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_course(id, fields: nil, quota_user: 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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def delete_course(id, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_course_alias(course_id, alias_, fields: nil, quota_user: 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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


365
366
367
368
369
370
371
372
373
374
# File 'generated/google/apis/classroom_v1/service.rb', line 365

def delete_course_alias(course_id, alias_, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Deletes an announcement. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding announcement item. This method returns the following error codes: * PERMISSION_DENIED if the requesting developer project did not create the corresponding announcement, if the requesting user is not permitted to delete the requested course or for access errors. * FAILED_PRECONDITION if the requested announcement 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 announcement to delete. This identifier is a Classroom- assigned identifier.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


490
491
492
493
494
495
496
497
498
499
# File 'generated/google/apis/classroom_v1/service.rb', line 490

def delete_course_announcement(course_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/courses/{courseId}/announcements/{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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_course_course_work(course_id, id, fields: nil, quota_user: 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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


764
765
766
767
768
769
770
771
772
773
# File 'generated/google/apis/classroom_v1/service.rb', line 764

def delete_course_course_work(course_id, id, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_course_student(course_id, user_id, fields: nil, quota_user: 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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
# File 'generated/google/apis/classroom_v1/service.rb', line 1412

def delete_course_student(course_id, user_id, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_course_teacher(course_id, user_id, fields: nil, quota_user: 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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def delete_course_teacher(course_id, user_id, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Deletes a topic. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not allowed to delete the requested topic or for access errors. * FAILED_PRECONDITION if the requested topic has already been deleted. * NOT_FOUND if no course or topic 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 topic to delete.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def delete_course_topic(course_id, id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/courses/{courseId}/topics/{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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_invitation(id, fields: nil, quota_user: 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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1973
1974
1975
1976
1977
1978
1979
1980
1981
# File 'generated/google/apis/classroom_v1/service.rb', line 1973

def delete_invitation(id, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Deletes a Registration, causing Classroom to stop sending notifications for that Registration.

Parameters:

  • registration_id (String)

    The registration_id of the Registration to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2137
2138
2139
2140
2141
2142
2143
2144
2145
# File 'generated/google/apis/classroom_v1/service.rb', line 2137

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

#delete_user_profile_guardian(student_id, guardian_id, fields: nil, quota_user: 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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
# File 'generated/google/apis/classroom_v1/service.rb', line 2429

def (student_id, guardian_id, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_course(id, fields: nil, quota_user: 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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


144
145
146
147
148
149
150
151
152
# File 'generated/google/apis/classroom_v1/service.rb', line 144

def get_course(id, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Returns an announcement. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access the requested course or announcement, or for access errors. * INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if the requested course or announcement 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 announcement.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


528
529
530
531
532
533
534
535
536
537
# File 'generated/google/apis/classroom_v1/service.rb', line 528

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

#get_course_student(course_id, user_id, fields: nil, quota_user: 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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
# File 'generated/google/apis/classroom_v1/service.rb', line 1451

def get_course_student(course_id, user_id, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_course_teacher(course_id, user_id, fields: nil, quota_user: 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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
# File 'generated/google/apis/classroom_v1/service.rb', line 1614

def get_course_teacher(course_id, user_id, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Returns a topic. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access the requested course or topic, or for access errors. * INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if the requested course or topic does not exist.

Parameters:

  • course_id (String)

    Identifier of the course.

  • id (String)

    Identifier of the topic.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
# File 'generated/google/apis/classroom_v1/service.rb', line 1769

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

#get_course_work(course_id, id, fields: nil, quota_user: 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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


802
803
804
805
806
807
808
809
810
811
# File 'generated/google/apis/classroom_v1/service.rb', line 802

def get_course_work(course_id, id, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_invitation(id, fields: nil, quota_user: 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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def get_invitation(id, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_student_submission(course_id, course_work_id, id, fields: nil, quota_user: 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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
# File 'generated/google/apis/classroom_v1/service.rb', line 999

def get_student_submission(course_id, course_work_id, id, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_user_profile(user_id, fields: nil, quota_user: 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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2171
2172
2173
2174
2175
2176
2177
2178
2179
# File 'generated/google/apis/classroom_v1/service.rb', line 2171

def (user_id, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_user_profile_guardian(student_id, guardian_id, fields: nil, quota_user: 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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
# File 'generated/google/apis/classroom_v1/service.rb', line 2473

def (student_id, guardian_id, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_user_profile_guardian_invitation(student_id, invitation_id, fields: nil, quota_user: 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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
# File 'generated/google/apis/classroom_v1/service.rb', line 2266

def (student_id, invitation_id, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_course_aliases(course_id, page_size: nil, page_token: nil, fields: nil, quota_user: 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) (defaults to: nil)

    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) (defaults to: nil)

    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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


408
409
410
411
412
413
414
415
416
417
418
# File 'generated/google/apis/classroom_v1/service.rb', line 408

def list_course_aliases(course_id, page_size: nil, page_token: nil, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_course_announcements(course_id, announcement_states: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::ListAnnouncementsResponse

Returns a list of announcements that the requester is permitted to view. Course students may only view PUBLISHED announcements. Course teachers and domain administrators may view all announcements. 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.

  • announcement_states (Array<String>, String) (defaults to: nil)

    Restriction on the state of announcements returned. If this argument is left unspecified, the default value is PUBLISHED.

  • order_by (String) (defaults to: nil)

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

  • page_size (Fixnum) (defaults to: nil)

    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) (defaults to: nil)

    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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


582
583
584
585
586
587
588
589
590
591
592
593
594
# File 'generated/google/apis/classroom_v1/service.rb', line 582

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

#list_course_students(course_id, page_size: nil, page_token: nil, fields: nil, quota_user: 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) (defaults to: nil)

    Maximum number of items to return. The default is 30 if unspecified or 0. The server may return fewer than the specified number of results.

  • page_token (String) (defaults to: nil)

    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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
# File 'generated/google/apis/classroom_v1/service.rb', line 1492

def list_course_students(course_id, page_size: nil, page_token: nil, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_course_teachers(course_id, page_size: nil, page_token: nil, fields: nil, quota_user: 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) (defaults to: nil)

    Maximum number of items to return. The default is 30 if unspecified or 0. The server may return fewer than the specified number of results.

  • page_token (String) (defaults to: nil)

    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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
# File 'generated/google/apis/classroom_v1/service.rb', line 1655

def list_course_teachers(course_id, page_size: nil, page_token: nil, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Returns the list of topics that the requester is permitted to view. 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.

  • page_size (Fixnum) (defaults to: nil)

    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) (defaults to: nil)

    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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
# File 'generated/google/apis/classroom_v1/service.rb', line 1813

def list_course_topics(course_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/courses/{courseId}/topics', options)
  command.response_representation = Google::Apis::ClassroomV1::ListTopicResponse::Representation
  command.response_class = Google::Apis::ClassroomV1::ListTopicResponse
  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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_course_works(course_id, course_work_states: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: 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) (defaults to: nil)

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

  • order_by (String) (defaults to: nil)

    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_size (Fixnum) (defaults to: nil)

    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) (defaults to: nil)

    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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


856
857
858
859
860
861
862
863
864
865
866
867
868
# File 'generated/google/apis/classroom_v1/service.rb', line 856

def list_course_works(course_id, course_work_states: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: 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['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_courses(course_states: nil, page_size: nil, page_token: nil, student_id: nil, teacher_id: nil, fields: nil, quota_user: 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. Returned courses are ordered by creation time, with the most recently created coming first. 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) (defaults to: nil)

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

  • page_size (Fixnum) (defaults to: nil)

    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) (defaults to: nil)

    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.

  • student_id (String) (defaults to: nil)

    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

  • teacher_id (String) (defaults to: nil)

    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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def list_courses(course_states: nil, page_size: nil, page_token: nil, student_id: nil, teacher_id: nil, fields: nil, quota_user: 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['pageToken'] = page_token unless page_token.nil?
  command.query['studentId'] = student_id unless student_id.nil?
  command.query['teacherId'] = teacher_id unless teacher_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_invitations(course_id: nil, page_size: nil, page_token: nil, user_id: nil, fields: nil, quota_user: 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) (defaults to: nil)

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

  • page_size (Fixnum) (defaults to: nil)

    Maximum number of items to return. The default is 500 if unspecified or 0. The server may return fewer than the specified number of results.

  • page_token (String) (defaults to: nil)

    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.

  • user_id (String) (defaults to: nil)

    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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
# File 'generated/google/apis/classroom_v1/service.rb', line 2053

def list_invitations(course_id: nil, page_size: nil, page_token: nil, user_id: nil, fields: nil, quota_user: 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['pageToken'] = page_token unless page_token.nil?
  command.query['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_student_submissions(course_id, course_work_id, late: nil, page_size: nil, page_token: nil, states: nil, user_id: nil, fields: nil, quota_user: 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)

    Identifier 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.

  • late (String) (defaults to: nil)

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

  • page_size (Fixnum) (defaults to: nil)

    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) (defaults to: nil)

    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.

  • states (Array<String>, String) (defaults to: nil)

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

  • user_id (String) (defaults to: nil)

    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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
# File 'generated/google/apis/classroom_v1/service.rb', line 1064

def list_student_submissions(course_id, course_work_id, late: nil, page_size: nil, page_token: nil, states: nil, user_id: nil, fields: nil, quota_user: 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['late'] = late unless late.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['states'] = states unless states.nil?
  command.query['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_user_profile_guardian_invitations(student_id, invited_email_address: nil, page_size: nil, page_token: nil, states: nil, fields: nil, quota_user: 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.

  • invited_email_address (String) (defaults to: nil)

    If specified, only results with the specified invited_email_address are returned.

  • page_size (Fixnum) (defaults to: nil)

    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) (defaults to: nil)

    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.

  • states (Array<String>, String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
# File 'generated/google/apis/classroom_v1/service.rb', line 2327

def (student_id, invited_email_address: nil, page_size: nil, page_token: nil, states: nil, fields: nil, quota_user: 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['invitedEmailAddress'] = invited_email_address unless invited_email_address.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['states'] = states unless states.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_user_profile_guardians(student_id, invited_email_address: nil, page_size: nil, page_token: nil, fields: nil, quota_user: 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.

  • invited_email_address (String) (defaults to: nil)

    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_size (Fixnum) (defaults to: nil)

    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) (defaults to: nil)

    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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
# File 'generated/google/apis/classroom_v1/service.rb', line 2534

def (student_id, invited_email_address: nil, page_size: nil, page_token: nil, fields: nil, quota_user: 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['invitedEmailAddress'] = invited_email_address unless invited_email_address.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#modify_course_announcement_assignees(course_id, id, modify_announcement_assignees_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::Announcement

Modifies assignee mode and options of an announcement. Only a teacher of the course that contains the announcement may call this method. 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 announcement.

  • modify_announcement_assignees_request_object (Google::Apis::ClassroomV1::ModifyAnnouncementAssigneesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


625
626
627
628
629
630
631
632
633
634
635
636
# File 'generated/google/apis/classroom_v1/service.rb', line 625

def modify_course_announcement_assignees(course_id, id, modify_announcement_assignees_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/courses/{courseId}/announcements/{id}:modifyAssignees', options)
  command.request_representation = Google::Apis::ClassroomV1::ModifyAnnouncementAssigneesRequest::Representation
  command.request_object = modify_announcement_assignees_request_object
  command.response_representation = Google::Apis::ClassroomV1::Announcement::Representation
  command.response_class = Google::Apis::ClassroomV1::Announcement
  command.params['courseId'] = course_id unless course_id.nil?
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Modifies assignee mode and options of a coursework. Only a teacher of the course that contains the coursework may call this method. 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 coursework.

  • modify_course_work_assignees_request_object (Google::Apis::ClassroomV1::ModifyCourseWorkAssigneesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


899
900
901
902
903
904
905
906
907
908
909
910
# File 'generated/google/apis/classroom_v1/service.rb', line 899

def modify_course_course_work_assignees(course_id, id, modify_course_work_assignees_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/courses/{courseId}/courseWork/{id}:modifyAssignees', options)
  command.request_representation = Google::Apis::ClassroomV1::ModifyCourseWorkAssigneesRequest::Representation
  command.request_object = modify_course_work_assignees_request_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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#modify_student_submission_attachments(course_id, course_work_id, id, modify_attachments_request_object = nil, fields: nil, quota_user: 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)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
# File 'generated/google/apis/classroom_v1/service.rb', line 1115

def modify_student_submission_attachments(course_id, course_work_id, id, modify_attachments_request_object = nil, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_course(id, course_object = nil, update_mask: nil, fields: nil, quota_user: 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) (defaults to: nil)

    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 * ownerId Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as updateMask=,,...

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


247
248
249
250
251
252
253
254
255
256
257
258
# File 'generated/google/apis/classroom_v1/service.rb', line 247

def patch_course(id, course_object = nil, update_mask: nil, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_course_announcement(course_id, id, announcement_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::Announcement

Updates one or more fields of an announcement. This method returns the following error codes: * PERMISSION_DENIED if the requesting developer project did not create the corresponding announcement or for access errors. * INVALID_ARGUMENT if the request is malformed. * FAILED_PRECONDITION if the requested announcement has already been deleted. * NOT_FOUND if the requested course or announcement 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 announcement.

  • announcement_object (Google::Apis::ClassroomV1::Announcement) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Mask that identifies which fields on the announcement 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 Announcement object. If a field that does not support empty values is included in the update mask and not set in the Announcement object, an INVALID_ARGUMENT error is returned. The following fields may be specified by teachers: * text * state * scheduled_time

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


675
676
677
678
679
680
681
682
683
684
685
686
687
# File 'generated/google/apis/classroom_v1/service.rb', line 675

def patch_course_announcement(course_id, id, announcement_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/courses/{courseId}/announcements/{id}', options)
  command.request_representation = Google::Apis::ClassroomV1::Announcement::Representation
  command.request_object = announcement_object
  command.response_representation = Google::Apis::ClassroomV1::Announcement::Representation
  command.response_class = Google::Apis::ClassroomV1::Announcement
  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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_course_course_work(course_id, id, course_work_object = nil, update_mask: nil, fields: nil, quota_user: 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) (defaults to: nil)

    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 is returned. The following fields may be specified by teachers: * title * description * state * due_date * due_time * max_points * scheduled_time * submission_modification_mode * topic_id

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


956
957
958
959
960
961
962
963
964
965
966
967
968
# File 'generated/google/apis/classroom_v1/service.rb', line 956

def patch_course_course_work(course_id, id, course_work_object = nil, update_mask: nil, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_course_topic(course_id, id, topic_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClassroomV1::Topic

Updates one or more fields of a topic. This method returns the following error codes: * PERMISSION_DENIED if the requesting developer project did not create the corresponding topic or for access errors. * INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if the requested course or topic 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 topic.

  • topic_object (Google::Apis::ClassroomV1::Topic) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Mask that identifies which fields on the topic 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 Topic object. If a field that does not support empty values is included in the update mask and not set in the Topic object, an INVALID_ARGUMENT error is returned. The following fields may be specified:

    • name
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
# File 'generated/google/apis/classroom_v1/service.rb', line 1861

def patch_course_topic(course_id, id, topic_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/courses/{courseId}/topics/{id}', options)
  command.request_representation = Google::Apis::ClassroomV1::Topic::Representation
  command.request_object = topic_object
  command.response_representation = Google::Apis::ClassroomV1::Topic::Representation
  command.response_class = Google::Apis::ClassroomV1::Topic
  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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_student_submission(course_id, course_work_id, id, student_submission_object = nil, update_mask: nil, fields: nil, quota_user: 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) (defaults to: nil)

    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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def patch_student_submission(course_id, course_work_id, id, student_submission_object = nil, update_mask: nil, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_user_profile_guardian_invitation(student_id, invitation_id, guardian_invitation_object = nil, update_mask: nil, fields: nil, quota_user: 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) (defaults to: nil)

    Mask that identifies which fields on the course to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields are valid: * state When set in a query parameter, this field should be specified as updateMask=,,...

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
# File 'generated/google/apis/classroom_v1/service.rb', line 2381

def (student_id, invitation_id, guardian_invitation_object = nil, update_mask: nil, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#reclaim_student_submission(course_id, course_work_id, id, reclaim_student_submission_request_object = nil, fields: nil, quota_user: 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 updates 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)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
# File 'generated/google/apis/classroom_v1/service.rb', line 1222

def reclaim_student_submission(course_id, course_work_id, id, reclaim_student_submission_request_object = nil, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#return_student_submission(course_id, course_work_id, id, return_student_submission_request_object = nil, fields: nil, quota_user: 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)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
# File 'generated/google/apis/classroom_v1/service.rb', line 1274

def return_student_submission(course_id, course_work_id, id, return_student_submission_request_object = nil, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.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, fields: nil, quota_user: 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)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
# File 'generated/google/apis/classroom_v1/service.rb', line 1324

def turn_in_student_submission(course_id, course_work_id, id, turn_in_student_submission_request_object = nil, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_course(id, course_object = nil, fields: nil, quota_user: 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)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


286
287
288
289
290
291
292
293
294
295
296
# File 'generated/google/apis/classroom_v1/service.rb', line 286

def update_course(id, course_object = nil, fields: nil, quota_user: 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end