gws-classroom
Original:🇺🇸 English
Translated
Google Classroom: Manage classes, rosters, and coursework.
21installs
Sourcegoogleworkspace/cli
Added on
NPX Install
npx skill4agent add googleworkspace/cli gws-classroomTags
Translated version includes tags in frontmatterSKILL.md Content
View Translation Comparison →classroom (v1)
PREREQUISITE: Readfor auth, global flags, and security rules. If missing, run../gws-shared/SKILL.mdto create it.gws generate-skills
bash
gws classroom <resource> <method> [flags]API Resources
courses
- — Creates a course. The user specified in
createis the owner of the created course and added as a teacher. A non-admin requesting user can only create a course with themselves as the owner. Domain admins can create courses owned by any user within their domain. This method returns the following error codes: *ownerIdif the requesting user is not permitted to create courses or for access errors. *PERMISSION_DENIEDif the primary teacher is not a valid user.NOT_FOUND - — Deletes a course. This method returns the following error codes: *
deleteif the requesting user is not permitted to delete the requested course or for access errors. *PERMISSION_DENIEDif no course exists with the requested ID.NOT_FOUND - — Returns a course. This method returns the following error codes: *
getif the requesting user is not permitted to access the requested course or for access errors. *PERMISSION_DENIEDif no course exists with the requested ID.NOT_FOUND - — Returns the grading period settings in a course. This method returns the following error codes: *
getGradingPeriodSettingsif the requesting user isn't permitted to access the grading period settings in the requested course or for access errors. *PERMISSION_DENIEDif the requested course does not exist.NOT_FOUND - — 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: *
listfor access errors. *PERMISSION_DENIEDif the query argument is malformed. *INVALID_ARGUMENTif any users specified in the query arguments do not exist.NOT_FOUND - — Updates one or more fields in a course. This method returns the following error codes: *
patchif the requesting user is not permitted to modify the requested course or for access errors. *PERMISSION_DENIEDif no course exists with the requested ID. *NOT_FOUNDif invalid fields are specified in the update mask or if no update mask is supplied.INVALID_ARGUMENT - — Updates a course. This method returns the following error codes: *
updateif the requesting user is not permitted to modify the requested course or for access errors. *PERMISSION_DENIEDif no course exists with the requested ID. *NOT_FOUNDfor the following request errors: * CourseNotModifiable * CourseTitleCannotContainUrlFAILED_PRECONDITION - — Updates grading period settings of a course. Individual grading periods can be added, removed, or modified using this method. The requesting user and course owner must be eligible to modify Grading Periods. For details, see licensing requirements.
updateGradingPeriodSettings - — Operations on the 'aliases' resource
aliases - — Operations on the 'announcements' resource
announcements - — Operations on the 'courseWork' resource
courseWork - — Operations on the 'courseWorkMaterials' resource
courseWorkMaterials - — Operations on the 'posts' resource
posts - — Operations on the 'studentGroups' resource
studentGroups - — Operations on the 'students' resource
students - — Operations on the 'teachers' resource
teachers - — Operations on the 'topics' resource
topics
invitations
- — 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: *
acceptif the requesting user is not permitted to accept the requested invitation or for access errors.PERMISSION_DENIED - — 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: *
createif the requesting user is not permitted to create invitations for this course or for access errors. *PERMISSION_DENIEDif the course or the user does not exist. *NOT_FOUND: * if the requested user's account is disabled.FAILED_PRECONDITION - — Deletes an invitation. This method returns the following error codes: *
deleteif the requesting user is not permitted to delete the requested invitation or for access errors. *PERMISSION_DENIEDif no invitation exists with the requested ID.NOT_FOUND - — Returns an invitation. This method returns the following error codes: *
getif the requesting user is not permitted to view the requested invitation or for access errors. *PERMISSION_DENIEDif no invitation exists with the requested ID.NOT_FOUND - — 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
listoruser_idmust be supplied. Both fields can be supplied. This method returns the following error codes: *course_idfor access errors.PERMISSION_DENIED
registrations
- — Creates a
create, causing Classroom to start sending notifications from the providedRegistrationto the destination provided infeed. Returns the createdcloudPubSubTopic. Currently, this will be the same as the argument, but with server-assigned fields such asRegistrationandexpiry_timefilled in. Note that any value specified for theidorexpiry_timefields will be ignored.id - — Deletes a
delete, causing Classroom to stop sending notifications for thatRegistration.Registration
userProfiles
- — Returns a user profile. This method returns the following error codes: *
getif the requesting user is not permitted to access this user profile, if no profile exists with the requested ID, or for access errors.PERMISSION_DENIED - — Operations on the 'guardianInvitations' resource
guardianInvitations - — Operations on the 'guardians' resource
guardians
Discovering Commands
Before calling any API method, inspect it:
bash
# Browse resources and methods
gws classroom --help
# Inspect a method's required params, types, and defaults
gws schema classroom.<resource>.<method>Use output to build your and flags.
gws schema--params--json