List Assignments with Google Classroom API on Custom Interval from Schedule API

Pipedream makes it easy to connect APIs for Google Classroom, Schedule and 2,400+ other apps remarkably fast.

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

List Assignments with the Google Classroom API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Schedule trigger and Google Classroom action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Custom Interval trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the List Assignments action
1. Connect your Google Classroom account
2. Select a Course
3. Optional- Select a Assignment Type
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

Custom Interval on Schedule

Description:Trigger your workflow every N hours, minutes or seconds.

Version:0.0.2

Key:schedule-custom-interval

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

import schedule from "../../schedule.app.mjs";

export default {
  name: "Custom Interval",
  version: "0.0.2",
  key: "schedule-custom-interval",
  type: "source",
  description: "Trigger your workflow every N hours, minutes or seconds.",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
    },
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

List Assignments on Google Classroom

Description:Retrieve a list of assignments for a course. [See the documentation](https://developers.google.com/classroom/reference/rest/v1/courses.courseWork/list)

Version:0.0.2

Key:google_classroom-list-assignments

View on GitHub

Google Classroom Overview#

The Google Classroom API lets you tap into the educational space by managing courses, assignments, and student interactions programmatically. With this API, you can automate course creation, roster management, and content distribution, effectively bridging the gap between various educational tools and platforms. Leveraging Pipedream's serverless execution environment, you can build powerful workflows that respond to events in Classroom, sync data across platforms, and streamline the educational process for teachers and students alike.

Action Code#

import googleClassroom from "../../google_classroom.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "google_classroom-list-assignments",
  name: "List Assignments",
  description: "Retrieve a list of assignments for a course. [See the documentation](https://developers.google.com/classroom/reference/rest/v1/courses.courseWork/list)",
  version: "0.0.2",
  type: "action",
  props: {
    googleClassroom,
    course: {
      propDefinition: [
        googleClassroom,
        "course",
        (c) => ({
          courseStates: c.courseStates,
        }),
      ],
    },
    assignmentType: {
      type: "string",
      label: "Assignment Type",
      description: "Get only past due assignments, not yet due assignments, or all assignments",
      options: [
        "past due",
        "not yet due",
        "all",
      ],
      default: "all",
      optional: true,
    },
  },
  methods: {
    getDueTs(dueDate, dueTime) {
      const {
        year, month, day,
      } = dueDate;
      let dateString = `${year}-${utils.padZero(month)}-${utils.padZero(day)}`;
      if (dueTime) {
        const {
          hours, minutes,
        } = dueTime;
        dateString += `T${utils.padZero(hours)}:${minutes
          ? utils.padZero(minutes)
          : "00"}:00`;
      }
      return Date.parse(dateString);
    },
    isRelevant(assignment) {
      if (!this.assignmentType || this.assignmentType === "all") {
        return true;
      }
      if (!assignment.dueDate) {
        return false;
      }

      const dueDate = this.getDueTs(assignment.dueDate, assignment.dueTime);

      if (this.assignmentType === "past due") {
        return dueDate < Date.now();
      }
      if (this.assignmentType === "not yet due") {
        return dueDate > Date.now();
      }
    },
  },
  async run({ $ }) {
    const params = {
      courseId: this.course,
    };

    const assignments = [];

    do {
      const {
        courseWork, nextPageToken,
      } = await this.googleClassroom.listCoursework(params);
      if (!courseWork?.length) {
        break;
      }
      for (const assignment of courseWork) {
        if (this.isRelevant(assignment)) {
          assignments.push(assignment);
        }
      }
      params.pageToken = nextPageToken;
    } while (params.pageToken);

    $.export("$summary", `Successfully retrieved ${assignments.length} assignment${assignments.length === 1
      ? ""
      : "s"}.`);

    return assignments;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Google Classroom	`googleClassroom`	`app`	This component uses the Google Classroom app.
Course	`course`	`string`	Select a value from the drop down menu.
Assignment Type	`assignmentType`	`string`	Select a value from the drop down menu:`past duenot yet dueall`

Action Authentication#

Google Classroom uses OAuth authentication. When you connect your Google Classroom account, Pipedream will open a popup window where you can sign into Google Classroom and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Google Classroom API.

Pipedream requests the following authorization scopes when you connect your account:

https://www.googleapis.com/auth/userinfo.emailhttps://www.googleapis.com/auth/userinfo.profilehttps://www.googleapis.com/auth/classroom.courses.readonlyhttps://www.googleapis.com/auth/classroom.coursework.studentshttps://www.googleapis.com/auth/classroom.coursework.mehttps://www.googleapis.com/auth/classroom.announcements.readonly