Delete Objects with Algolia API on New Due Date from Google Classroom API

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

Trigger workflow on

New Due Date from the Google Classroom API

Next, do this

Delete Objects with the Algolia 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 Google Classroom trigger and Algolia action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Due Date trigger
1. Connect your Google Classroom account
2. Configure timer
3. Optional- Select one or more Course States
4. Select a Course
Configure the Delete Objects action
1. Connect your Algolia account
2. Select a Index Name
3. Configure Object Ids
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#

New Due Date on Google Classroom

Description:Emit new event when an assignment's due date is created or updated'.

Version:0.0.3

Key:google_classroom-new-due-date

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.

Trigger Code#

import common from "../common/common.mjs";

export default {
  ...common,
  key: "google_classroom-new-due-date",
  name: "New Due Date",
  description: "Emit new event when an assignment's due date is created or updated'.",
  version: "0.0.3",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    async getHistoricalEvents({ pageSize }) {
      const { courseWork } = await this.googleClassroom.listCoursework({
        ...this.getParams(),
        pageSize,
      });
      return courseWork;
    },
    async getResults(after) {
      return this.paginate(this.googleClassroom.listCoursework, this.getParams(), "courseWork", after);
    },
    getParams() {
      return {
        courseId: this.course,
        courseWorkStates: this.courseStates,
      };
    },
    isRelevant(assignment, after = null) {
      return assignment.dueDate && this.isAfter(assignment.updateTime, after);
    },
    createDueDate(assignment) {
      const {
        dueDate, dueTime = {},
      } = assignment;
      if (!dueDate) {
        return;
      }
      const {
        year, month, day,
      } = dueDate;
      const {
        hours = 0, minutes = 0,
      } = dueTime;
      return new Date(year, month - 1, day - 1, hours, minutes, 0, 0);
    },
    generateMeta(assignment) {
      const dueDate = this.createDueDate(assignment);
      return {
        id: `${assignment.id}${Date.parse(dueDate)}`,
        summary: `New due date ${dueDate.toISOString()} for assignment ${assignment.title}`,
        ts: Date.parse(assignment.updateTime),
      };
    },
  },
};

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
Google Classroom	`googleClassroom`	`app`	This component uses the Google Classroom app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Course States	`courseStates`	`string[]`	Select a value from the drop down menu:`COURSE_STATE_UNSPECIFIEDACTIVEARCHIVEDPROVISIONEDDECLINEDSUSPENDED`
Course	`course`	`string`	Select a value from the drop down menu.

Trigger 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

About Google Classroom#

Google Classroom helps educators create engaging learning experiences they can personalize, manage, and measure.

Action#

Delete Objects on Algolia

Description:Delete objects from the given index. [See docs here](https://www.algolia.com/doc/api-reference/api-methods/delete-objects/)

Version:0.0.2

Key:algolia-delete-objects

View on GitHub

Algolia Overview#

Algolia is a powerful search-as-a-service platform that makes it easy to deliver fast, relevant search experiences to users. The Algolia API allows developers to programmatically manage search indices, perform searches, and capture insights about search activity. With Pipedream, you can harness this API to automate and integrate Algolia's capabilities with other apps, creating efficient workflows that enhance search functionalities and user engagement. You can sync data across platforms, automate content indexing, and trigger actions based on search patterns or user behaviors.

Action Code#

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

export default {
  key: "algolia-delete-objects",
  name: "Delete Objects",
  description: "Delete objects from the given index. [See docs here](https://www.algolia.com/doc/api-reference/api-methods/delete-objects/)",
  version: "0.0.2",
  type: "action",
  props: {
    algolia,
    indexName: {
      propDefinition: [
        algolia,
        "indexName",
      ],
    },
    objectIds: {
      label: "Object Ids",
      description: "An array of JavaScript object IDs, each corresponding to a existing object in your search index",
      type: "string[]",
    },
  },
  async run({ $ }) {
    const response = await this.algolia.deleteObjects({
      indexName: this.indexName,
      objectIds: typeof this.objectIds === "string"
        ? JSON.parse(this.objectIds)
        : this.objectIds,
    });

    $.export("$summary", "Successfully deleted objects");

    return response;
  },
};

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
Algolia	`algolia`	`app`	This component uses the Algolia app.
Index Name	`indexName`	`string`	Select a value from the drop down menu.
Object Ids	`objectIds`	`string[]`	An array of JavaScript object IDs, each corresponding to a existing object in your search index

Action Authentication#

Algolia uses API keys for authentication. When you connect your Algolia account, Pipedream securely stores the keys so you can easily authenticate to Algolia APIs in both code and no-code steps.

In your Algolia Dashboard, select the API Keys section. Here you'll find your Application ID and API Keys. You can use either your Admin API Key or create another API key with permissions scoped to a specific index / operations (recommended).

Once done, enter both values below.