npm package: @maxim_mazurok/gapi.client.classroom-v1
Description: TypeScript typings for Google Classroom API v1
Author: Maxim Mazurok
Latest version: 0.2.20260316

# TypeScript typings for Google Classroom API v1

Manages classes, rosters, and invitations in Google Classroom.
For detailed description please check [documentation](https://developers.google.com/workspace/classroom/).

## Installing

Install typings for Google Classroom API:

```
npm install @types/gapi.client.classroom-v1 --save-dev
```

## Usage

You need to initialize Google API client in your code:

```typescript
gapi.load('client', () => {
  // now we can use gapi.client
  // ...
});
```

Then load api client wrapper:

```typescript
gapi.client.load(
  'https://classroom.googleapis.com/$discovery/rest?version=v1',
  () => {
    // now we can use:
    // gapi.client.classroom
  },
);
```

```typescript
// Deprecated, use discovery document URL, see https://github.com/google/google-api-javascript-client/blob/master/docs/reference.md#----gapiclientloadname----version----callback--
gapi.client.load('classroom', 'v1', () => {
  // now we can use:
  // gapi.client.classroom
});
```

Don't forget to authenticate your client before sending any request to resources:

```typescript
// declare client_id registered in Google Developers Console
var client_id = '',
  scope = [
    // See and update its own attachments to posts in Google Classroom
    'https://www.googleapis.com/auth/classroom.addons.student',

    // See, create, and update its own attachments to posts in classes you teach in Google Classroom
    'https://www.googleapis.com/auth/classroom.addons.teacher',

    // View and manage announcements in Google Classroom
    'https://www.googleapis.com/auth/classroom.announcements',

    // View announcements in Google Classroom
    'https://www.googleapis.com/auth/classroom.announcements.readonly',

    // See, edit, create, and permanently delete your Google Classroom classes
    'https://www.googleapis.com/auth/classroom.courses',

    // View your Google Classroom classes
    'https://www.googleapis.com/auth/classroom.courses.readonly',

    // See, create and edit coursework items including assignments, questions, and grades
    'https://www.googleapis.com/auth/classroom.coursework.me',

    // View your course work and grades in Google Classroom
    'https://www.googleapis.com/auth/classroom.coursework.me.readonly',

    // Manage course work and grades for students in the Google Classroom classes you teach and view the course work and grades for classes you administer
    'https://www.googleapis.com/auth/classroom.coursework.students',

    // View course work and grades for students in the Google Classroom classes you teach or administer
    'https://www.googleapis.com/auth/classroom.coursework.students.readonly',

    // See, edit, and create classwork materials in Google Classroom
    'https://www.googleapis.com/auth/classroom.courseworkmaterials',

    // See all classwork materials for your Google Classroom classes
    'https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly',

    // View your Google Classroom guardians
    'https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly',

    // View and manage guardians for students in your Google Classroom classes
    'https://www.googleapis.com/auth/classroom.guardianlinks.students',

    // View guardians for students in your Google Classroom classes
    'https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly',

    // View the email addresses of people in your classes
    'https://www.googleapis.com/auth/classroom.profile.emails',

    // View the profile photos of people in your classes
    'https://www.googleapis.com/auth/classroom.profile.photos',

    // Receive notifications about your Google Classroom data
    'https://www.googleapis.com/auth/classroom.push-notifications',

    // Manage your Google Classroom class rosters
    'https://www.googleapis.com/auth/classroom.rosters',

    // View your Google Classroom class rosters
    'https://www.googleapis.com/auth/classroom.rosters.readonly',

    // View your course work and grades in Google Classroom
    'https://www.googleapis.com/auth/classroom.student-submissions.me.readonly',

    // View course work and grades for students in the Google Classroom classes you teach or administer
    'https://www.googleapis.com/auth/classroom.student-submissions.students.readonly',

    // See, create, and edit topics in Google Classroom
    'https://www.googleapis.com/auth/classroom.topics',

    // View topics in Google Classroom
    'https://www.googleapis.com/auth/classroom.topics.readonly',
  ],
  immediate = true;
// ...

gapi.auth.authorize(
  {client_id: client_id, scope: scope, immediate: immediate},
  authResult => {
    if (authResult && !authResult.error) {
      /* handle successful authorization */
    } else {
      /* handle authorization error */
    }
  },
);
```

After that you can use Google Classroom API resources: <!-- TODO: make this work for multiple namespaces -->

```typescript
/*
Creates a course. The user specified in `ownerId` is 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: * `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: * UserCannotOwnCourse * UserGroupsMembershipLimitReached * CourseTitleCannotContainUrl * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists.
*/
await gapi.client.classroom.courses.create({});

/*
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.
*/
await gapi.client.classroom.courses.delete({id: 'id'});

/*
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.
*/
await gapi.client.classroom.courses.get({id: 'id'});

/*
Returns the grading period settings in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user isn't permitted to access the grading period settings in the requested course or for access errors. * `NOT_FOUND` if the requested course does not exist.
*/
await gapi.client.classroom.courses.getGradingPeriodSettings({
  courseId: 'courseId',
});

/*
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.
*/
await gapi.client.classroom.courses.list({});

/*
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 * InactiveCourseOwner * IneligibleOwner * CourseTitleCannotContainUrl
*/
await gapi.client.classroom.courses.patch({id: 'id'});

/*
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 * CourseTitleCannotContainUrl
*/
await gapi.client.classroom.courses.update({id: 'id'});

/*
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](https://developers.google.com/workspace/classroom/grading-periods/manage-grading-periods#licensing_requirements). This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the grading period settings in a course or for access errors: * UserIneligibleToUpdateGradingPeriodSettings * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.
*/
await gapi.client.classroom.courses.updateGradingPeriodSettings({
  courseId: 'courseId',
});

/*
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.
*/
await gapi.client.classroom.invitations.accept({id: 'id'});

/*
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. * if the user already has this role or a role with greater permissions. * for the following request errors: * IneligibleOwner * `ALREADY_EXISTS` if an invitation for the specified user and course already exists.
*/
await gapi.client.classroom.invitations.create({});

/*
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.
*/
await gapi.client.classroom.invitations.delete({id: 'id'});

/*
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.
*/
await gapi.client.classroom.invitations.get({id: 'id'});

/*
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.
*/
await gapi.client.classroom.invitations.list({});

/*
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.
*/
await gapi.client.classroom.registrations.create({});

/*
Deletes a `Registration`, causing Classroom to stop sending notifications for that `Registration`.
*/
await gapi.client.classroom.registrations.delete({
  registrationId: 'registrationId',
});

/*
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.
*/
await gapi.client.classroom.userProfiles.get({userId: 'userId'});
```

For provenance information see [Provenance section on NPM](https://www.npmjs.com/package/@maxim_mazurok/gapi.client.classroom-v1#Provenance:~:text=none-,Provenance,-Built%20and%20signed)