DefinitelyTyped/types/gapi.client.classroom

TypeScript typings for Google Classroom API v1

Manages classes, rosters, and invitations in Google Classroom. For detailed description please check documentation.

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:

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

Then load api client wrapper:

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:

// declare client_id registered in Google Developers Console
var client_id = '',
    scope = [     
        // 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',
    
        // Manage your Google Classroom classes
        'https://www.googleapis.com/auth/classroom.courses',
    
        // View your Google Classroom classes
        'https://www.googleapis.com/auth/classroom.courses.readonly',
    
        // Manage your course work and view your grades in Google Classroom
        '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',
    
        // 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',
    
        // 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',
    ],
    immediate = true;
// ...

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

After that you can use Google Classroom API resources:

    
/* 
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.  
*/
await gapi.client.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.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.courses.get({ id: "id",  }); 
    
/* 
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.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  
*/
await gapi.client.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  
*/
await gapi.client.courses.update({ id: "id",  }); 
    
/* 
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.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 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.  
*/
await gapi.client.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.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.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.invitations.list({  }); 
    
/* 
Creates a `Registration`, causing Classroom to start sending notifications
from the provided `feed` to the provided `destination`.

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 `destination` 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 credential provided does not include the appropriate scope for the
      requested feed.
    * another access error is encountered.
* `INVALID_ARGUMENT` if:
    * no `destination` is specified, or the specified `destination` 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 `destination` cannot be located, or Classroom has not
      been granted permission to publish to it.  
*/
await gapi.client.registrations.create({  }); 
    
/* 
Deletes a `Registration`, causing Classroom to stop sending notifications
for that `Registration`.  
*/
await gapi.client.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.userProfiles.get({ userId: "userId",  });